MODULES-9066 - release prep v7.0.1

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

diff --git a/REFERENCE.md b/REFERENCE.md
index 081866dcd89c67be39c737977c75bae1748030ca..06aff2140df92acfae30e2d77dcd2e171f50d552 100644 (file)
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -65,8 +65,8 @@ Default value: $apt::params::provider
 
 Data type: `String`
 
-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.
+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 value: $apt::params::keyserver
 
@@ -189,6 +189,15 @@ Creates new `apt::setting` resources. Valid options: a hash to be passed to the
 
 Default value: $apt::params::settings
 
+##### `manage_auth_conf`
+
+Data type: `Boolean`
+
+Specifies whether to manage the /etc/apt/auth.conf file. When true, the file will be overwritten with the entries specified in
+the auth_conf_entries parameter. When false, the file will be ignored (note that this does not set the file to absent.
+
+Default value: $apt::params::manage_auth_conf
+
 ##### `auth_conf_entries`
 
 Data type: `Array[Apt::Auth_conf_entry]`
@@ -196,10 +205,18 @@ Data type: `Array[Apt::Auth_conf_entry]`
 An optional array of login configuration settings (hashes) that are recorded in the file /etc/apt/auth.conf. This file has a netrc-like
 format (similar to what curl uses) and contains the login configuration for APT sources and proxies that require authentication. See
 https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details. If specified each hash must contain the keys machine, login and
-password and no others.
+password and no others. Specifying manage_auth_conf and not specifying this parameter will set /etc/apt/auth.conf to absent.
 
 Default value: $apt::params::auth_conf_entries
 
+##### `auth_conf_owner`
+
+Data type: `String`
+
+The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases.
+
+Default value: $apt::params::auth_conf_owner
+
 ##### `root`
 
 Data type: `String`
@@ -488,6 +505,14 @@ hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 1
 
 Default value: $::apt::keyserver
 
+##### `weak_ssl`
+
+Data type: `Boolean`
+
+Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
+
+Default value: `false`
+
 ##### `options`
 
 Data type: `Optional[String]`
@@ -859,7 +884,7 @@ Allows you to perform apt functions
 
 ##### `action`
 
-Data type: `Enum[update, upgrade]`
+Data type: `Enum[update, upgrade, dist-upgrade, autoremove]`
 
 Action to perform