(GH-1055) Fix hardcoded cache path

[puppet-modules/puppetlabs-apt.git] / REFERENCE.md

diff --git a/REFERENCE.md b/REFERENCE.md
index 0293856408b95d8eaf483a24542018e7f7e59fd6..1648c40a1ed75c1a8a9ae4b6a0bec0d6a7faf9c5 100644 (file)
--- 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`
 
 ##### <a name="ppa_options"></a>`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.
@@ -432,7 +436,7 @@ Default value: ``undef``
 Data type: `Optional[String]`
 
 Specifies a distribution of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
-Default: on Debian and Ubuntu, `${facts['os']['distro']['codename']}-backports`. We recommend keeping this default, except on other operating
+Default: on Debian and Ubuntu, `${fact('os.distro.codename')}-backports`. We recommend keeping this default, except on other operating
 systems.
 
 Default value: ``undef``
@@ -466,7 +470,7 @@ Default value: ``undef``
 
 ##### <a name="pin"></a>`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`
 
 ##### <a name="include"></a>`include`
 
-Data type: `Optional[Variant[Hash]]`
+Data type: `Variant[Hash]`
 
 Specifies whether to include 'deb' or 'src', or both.
 
@@ -665,7 +669,7 @@ The following parameters are available in the `apt::pin` defined type:
 
 ##### <a name="ensure"></a>`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,7 +805,7 @@ Default value: `'present'`
 
 ##### <a name="options"></a>`options`
 
-Data type: `Optional[String]`
+Data type: `Optional[Array[String]]`
 
 Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
 
@@ -814,7 +818,7 @@ Data type: `Optional[String]`
 Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
 Optional if `puppet facts show os.distro.codename` returns your correct distribution release codename.
 
-Default value: `$facts['os']['distro']['codename']`
+Default value: `fact('os.distro.codename')`
 
 ##### <a name="dist"></a>`dist`
 
@@ -869,7 +873,7 @@ Default value: `50`
 
 ##### <a name="ensure"></a>`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'.
 
@@ -937,6 +941,7 @@ The following parameters are available in the `apt::source` defined type:
 * [`allow_unsigned`](#allow_unsigned)
 * [`allow_insecure`](#allow_insecure)
 * [`notify_update`](#notify_update)
+* [`check_valid_until`](#check_valid_until)
 
 ##### <a name="location"></a>`location`
 
@@ -980,7 +985,7 @@ Default value: `'main'`
 
 ##### <a name="include"></a>`include`
 
-Data type: `Optional[Variant[Hash]]`
+Data type: `Variant[Hash]`
 
 Configures include options. Valid options: a hash of available keys.
 
@@ -1041,9 +1046,7 @@ Default value: ``false``
 
 Data type: `Boolean`
 
-Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked.
-Unlike the `allow_unsigned` (trusted=yes) option, this should throw a warning that the interaction is insecure.  
-See [this comment](https://unix.stackexchange.com/a/480550) for a brief discussion of the difference and why this option might be preferable to `allow_unsigned`.
+Specifies whether to allow downloads from insecure repositories.
 
 Default value: ``false``
 
@@ -1055,6 +1058,14 @@ Specifies whether to trigger an `apt-get update` run.
 
 Default value: ``true``
 
+##### <a name="check_valid_until"></a>`check_valid_until`
+
+Data type: `Boolean`
+
+Specifies whether to check if the package release date is valid. Defaults to `True`.
+
+Default value: ``true``
+
 ## Resource types
 
 ## Data types
@@ -1195,7 +1206,7 @@ Specifies whether or not to use a `DIRECT` target to bypass the system default p
 
 ### <a name="init"></a>`init`
 
-Allows you to perform apt functions
+Allows you to perform apt-get functions
 
 **Supports noop?** false
 
@@ -1205,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