X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=REFERENCE.md;h=956b16d61d932d8b3688240211b9451010e2e7cf;hb=1c382e1e13e9539ef3c4f1a9d39e6765f9b169b6;hp=c859365bdc2b89feb377b34952651ec8c9498e48;hpb=47b92efb88ead2bad5845b6da9c07a0a5364d930;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/REFERENCE.md b/REFERENCE.md index c859365..956b16d 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -45,7 +45,7 @@ be manipulated through the `apt-key` command. ### Tasks -* [`init`](#init): Allows you to perform apt functions +* [`init`](#init): Allows you to perform apt-get functions ## Classes @@ -121,7 +121,7 @@ Default value: `$apt::params::key_options` ##### `ppa_options` -Data type: `Optional[String]` +Data type: `Optional[Array[String]]` Supplies options to be passed to the `add-apt-repository` command. @@ -165,10 +165,14 @@ Configures various update settings. Valid options: a hash made up from the follo Options: -* **:frequency** `String`: Specifies how often to run `apt-get update`. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value. -Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_update_last_success` is less than current epoch time minus 86400); -'weekly' (if the value of `apt_update_last_success` is less than current epoch time minus 604800); and 'reluctantly' (only if the exec resource -`apt_update` is notified). Default: 'reluctantly'. +* **:frequency** `String`: Specifies how often to run `apt-get update`. If the exec resource `apt_update` is notified, +`apt-get update` runs regardless of this value. +Valid options: + 'always' (at every Puppet run); + daily' (if the value of `apt_update_last_success` is less than current epoch time minus 86400); + 'weekly' (if the value of `apt_update_last_success` is less than current epoch time minus 604800); + 'reluctantly' (only if the exec resource `apt_update` is notified). +Default: 'reluctantly'. * **:loglevel** `Integer`: Specifies the log level of logs outputted to the console. Default: undef. * **:timeout** `Integer`: Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef. * **:tries** `Integer`: Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef. @@ -466,7 +470,7 @@ Default value: ``undef`` ##### `pin` -Data type: `Optional[Variant[Integer, String, Hash]]` +Data type: `Variant[Integer, String, Hash]` 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. @@ -475,7 +479,7 @@ Default value: `200` ##### `include` -Data type: `Optional[Variant[Hash]]` +Data type: `Variant[Hash]` Specifies whether to include 'deb' or 'src', or both. @@ -601,7 +605,7 @@ Data type: `Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+ Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04. -Default value: `$::apt::keyserver` +Default value: `$apt::keyserver` ##### `weak_ssl` @@ -617,7 +621,7 @@ Data type: `Optional[String]` Passes additional options to `apt-key adv --keyserver-options`. -Default value: `$::apt::key_options` +Default value: `$apt::key_options` ### `apt::mark` @@ -665,7 +669,7 @@ The following parameters are available in the `apt::pin` defined type: ##### `ensure` -Data type: `Optional[Enum['file', 'present', 'absent']]` +Data type: `Enum['file', 'present', 'absent']` Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. @@ -801,11 +805,11 @@ Default value: `'present'` ##### `options` -Data type: `Optional[String]` +Data type: `Optional[Array[String]]` Supplies options to be passed to the `add-apt-repository` command. Default: '-y'. -Default value: `$::apt::ppa_options` +Default value: `$apt::ppa_options` ##### `release` @@ -831,7 +835,7 @@ Data type: `Optional[String]` Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'. -Default value: `$::apt::ppa_package` +Default value: `$apt::ppa_package` ##### `package_manage` @@ -869,7 +873,7 @@ Default value: `50` ##### `ensure` -Data type: `Optional[Enum['file', 'present', 'absent']]` +Data type: `Enum['file', 'present', 'absent']` Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. @@ -935,8 +939,9 @@ The following parameters are available in the `apt::source` defined type: * [`pin`](#pin) * [`architecture`](#architecture) * [`allow_unsigned`](#allow_unsigned) -* [`notify_update`](#notify_update) * [`allow_insecure`](#allow_insecure) +* [`notify_update`](#notify_update) +* [`check_valid_until`](#check_valid_until) ##### `location` @@ -980,7 +985,7 @@ Default value: `'main'` ##### `include` -Data type: `Optional[Variant[Hash]]` +Data type: `Variant[Hash]` Configures include options. Valid options: a hash of available keys. @@ -1037,6 +1042,14 @@ Specifies whether to authenticate packages from this release, even if the Releas Default value: ``false`` +##### `allow_insecure` + +Data type: `Boolean` + +Specifies whether to allow downloads from insecure repositories. + +Default value: ``false`` + ##### `notify_update` Data type: `Boolean` @@ -1045,13 +1058,13 @@ Specifies whether to trigger an `apt-get update` run. Default value: ``true`` -##### `allow_insecure` +##### `check_valid_until` Data type: `Boolean` +Specifies whether to check if the package release date is valid. Defaults to `True`. - -Default value: ``false`` +Default value: ``true`` ## Resource types @@ -1193,7 +1206,7 @@ Specifies whether or not to use a `DIRECT` target to bypass the system default p ### `init` -Allows you to perform apt functions +Allows you to perform apt-get functions **Supports noop?** false @@ -1203,5 +1216,5 @@ Allows you to perform apt functions Data type: `Enum[update, upgrade, dist-upgrade, autoremove]` -Action to perform +Action to perform with apt-get