X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=README.md;h=3ec5f436c3943a9d94f104ba09e791a121d716f3;hb=6e51be76ea09c83d5d1615ad2de50428829559f7;hp=52030c730a49a9cfb09b837299a5860ac1bf8022;hpb=6581d73f318cfa14970bb6b79372bbcdf66062b6;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/README.md b/README.md index 52030c7..3ec5f43 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 1. [Overview](#overview) 2. [Module Description - What the module does and why it is useful](#module-description) -3. [Setup - The basics of getting started with [apt]](#setup) +3. [Setup - The basics of getting started with apt](#setup) * [What apt affects](#what-apt-affects) * [Beginning with apt](#beginning-with-apt) 4. [Usage - Configuration options and additional functionality](#usage) @@ -217,6 +217,8 @@ apt::sources: * `apt_update_last_success`: The date, in epochtime, of the most recent successful `apt-get update` run (based on the mtime of /var/lib/apt/periodic/update-success-stamp). +* `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed. + #### Class: `apt` Main class, includes all other classes. @@ -276,7 +278,7 @@ Manages backports. * `pin`: *Optional.* Specifies a pin priority for the backports. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` define, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: '200'. -* `release`: Specifies a distribution of the Apt repository containing the backports to manage. Valid options: a string containing the release, used in populating the `source.list` configuration file. Default: on Debian and Ubuntu, ''${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating systems. +* `release`: Specifies a distribution of the Apt repository containing the backports to manage. Valid options: a string containing the release, used in populating the `source.list` configuration file. Default: on Debian and Ubuntu, '${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating systems. * `repos`: Specifies a component of the Apt repository containing the backports to manage. Valid options: A string containing the repos to include, used in populating the `source.list` configuration file. Defaults: @@ -305,7 +307,7 @@ The `apt::key` define makes use of the `apt_key` type, but includes extra functi * `content`: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Valid options: a string. Default: undef. -* `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: present. +* `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'. * `id`: Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters). Default: $title. @@ -327,7 +329,7 @@ Manages Apt pins. * `component`: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''. -* `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: present. +* `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'. * `explanation`: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}". @@ -400,7 +402,7 @@ Manages the Apt sources in `/etc/apt/sources.list.d/`. * `comment`: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name. -* `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: present. +* `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'. * `key`: Creates a declaration of the apt::key define Valid options: a string to be passed to the `id` parameter of the `apt::key` define, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. Default: undef. @@ -443,4 +445,4 @@ Puppet Labs modules on the Puppet Forge are open projects, and community contrib For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html) -To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors) \ No newline at end of file +To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)