X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=README.md;h=7c7a7b33fae65bcb5ab7921e696c9d537d4cbb98;hb=2b536b6a200e8f4f7f7ae37ec091abd06ca4cb70;hp=423c6c69fed29c3013d12380d1a52a28108beb7a;hpb=3760d350a8341b8726e9be5c8273a529d245285a;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/README.md b/README.md index 423c6c6..7c7a7b3 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ * [Defined Types](#defined-types) * [Types](#types) * [Facts](#facts) + * [Tasks](#tasks) 6. [Limitations - OS compatibility, etc.](#limitations) 7. [Development - Guide for contributing to the module](#development) @@ -58,7 +59,7 @@ include apt **Warning:** Using short key IDs presents a serious security issue, potentially leaving you open to collision attacks. We recommend you always use full fingerprints to identify your GPG keys. This module allows short keys, but issues a security warning if you use them. -Declare the `apt::key` class: +Declare the `apt::key` defined type: ```puppet apt::key { 'puppetlabs': @@ -91,6 +92,16 @@ class { 'apt': }, } ``` +When `Exec['apt_update']` is triggered, it generates a `Notice` message. Because the default [logging level for agents](https://docs.puppet.com/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in logs and agent reports. Some tools, such as [The Foreman](https://www.theforeman.org), report the update notice as a significant change. To eliminate these updates from reports, set the [loglevel](https://docs.puppet.com/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level: + +```puppet +class { 'apt': + update => { + frequency => 'daily', + loglevel => 'debug', + }, +} +``` ### Pin a specific release @@ -150,7 +161,7 @@ apt::source { 'puppetlabs': 'id' => '6F6B15509CF8E59E6E469F327F438280EF8D349F', 'server' => 'pgp.mit.edu', }, -}, +} ``` ### Configure Apt from Hiera @@ -192,21 +203,21 @@ apt::source { "archive.ubuntu.com-${lsbdistcodename}": key => '630239CC130E1A7FD81A27B140976EAF437D05B5', repos => 'main universe multiverse restricted', } - + apt::source { "archive.ubuntu.com-${lsbdistcodename}-security": location => 'http://archive.ubuntu.com/ubuntu', key => '630239CC130E1A7FD81A27B140976EAF437D05B5', repos => 'main universe multiverse restricted', release => "${lsbdistcodename}-security" } - + apt::source { "archive.ubuntu.com-${lsbdistcodename}-updates": location => 'http://archive.ubuntu.com/ubuntu', key => '630239CC130E1A7FD81A27B140976EAF437D05B5', repos => 'main universe multiverse restricted', release => "${lsbdistcodename}-updates" } - + apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports": location => 'http://archive.ubuntu.com/ubuntu', key => '630239CC130E1A7FD81A27B140976EAF437D05B5', @@ -254,6 +265,10 @@ apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports": * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed. +### Tasks + +The Apt module has an example task that allows a user to run apt-get update or upgrade. Please refer to to the [PE documentation](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html) or [Bolt documentation](https://puppet.com/docs/bolt/latest/bolt.html) on how to execute a task. + #### Class: `apt` Main class, includes all other classes. @@ -270,7 +285,7 @@ Main class, includes all other classes. * 'host': Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. Default: undef. - * 'port': Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a port number. Default: '8080'. + * 'port': Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number. Default: 8080. * 'https': Specifies whether to enable https proxies. Valid options: 'true' and 'false'. Default: 'false'. @@ -313,8 +328,7 @@ Manages backports. * `location`: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults: - * Debian (squeeze): 'http://httpredir.debian.org/debian-backports' - * Debian (other): 'http://httpredir.debian.org/debian' + * Debian: 'http://deb.debian.org/debian' * Ubuntu: 'http://archive.ubuntu.com/ubuntu' * `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` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: '200'. @@ -360,16 +374,6 @@ The `apt::key` defined type makes use of the `apt_key` type, but includes extra * `server`: Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or hkp://). Default: 'keyserver.ubuntu.com'. -* `key`: 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: undef. **Note** This parameter is deprecated and will be removed in a future release. - -* `key_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. **Note** This parameter is deprecated and will be removed in a future release. - -* `key_source`: Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef. **Note** This parameter is deprecated and will be removed in a future release. - -* `key_server`: Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or hkp://). Default: 'keyserver.ubuntu.com'. **Note** This parameter is deprecated and will be removed in a future release. - -* `key_options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef. **Note** This parameter is deprecated and will be removed in a future release. - #### Defined Type: `apt::pin` Manages Apt pins. Does not trigger an `apt-get update` run. @@ -473,20 +477,6 @@ Manages the Apt sources in `/etc/apt/sources.list.d/`. * `repos`: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'. -* `include_deb`: Specify whether to request the distrubution's compiled binaries. Valid options: 'true' and 'false'. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module. - -* `include_src`: Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module. - -* `required_packages`: Installs packages required for this Apt source via an exec. Default: 'false'. **Note**: This parameter is deprecated and will be removed in future versions of the module. - -* `key_content`: Specifies the content to be passed to `apt::key`. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module. - -* `key_server`: Specifies the server to be passed to `apt::key`. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module. - -* `key_source`: Specifies the source to be passed to `apt::key`. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module. - -* `trusted_source`: Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked. Valid options: 'true' and 'false'. Default: undef. This parameter is **deprecated** and will be removed in a future version of the module. - * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'. #### Type: `apt_key`