diff --git a/CHANGELOG.md b/CHANGELOG.md
index ae3a022b55..e165b1a263 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,20 @@
All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
+## [v9.0.1](https://github.com/puppetlabs/puppetlabs-apt/tree/v9.0.1) (2022-12-20)
+
+[Full Changelog](https://github.com/puppetlabs/puppetlabs-apt/compare/v9.0.0...v9.0.1)
+
+### Fixed
+
+- \(bugfix\) - Declare minimum Puppet version 6.24.0 [\#1079](https://github.com/puppetlabs/puppetlabs-apt/pull/1079) ([pmcmaw](https://github.com/pmcmaw))
+- Do not remove PPA sources.list.d files if purge is enabled [\#1069](https://github.com/puppetlabs/puppetlabs-apt/pull/1069) ([Programie](https://github.com/Programie))
+- \(CONT-173\) - Updating deprecated facter instances [\#1068](https://github.com/puppetlabs/puppetlabs-apt/pull/1068) ([jordanbreen28](https://github.com/jordanbreen28))
+- pdksync - \(CONT-130\) Dropping Support for Debian 9 [\#1065](https://github.com/puppetlabs/puppetlabs-apt/pull/1065) ([jordanbreen28](https://github.com/jordanbreen28))
+- \(GH-1057\) Regex fix to allow dotted resources [\#1058](https://github.com/puppetlabs/puppetlabs-apt/pull/1058) ([LukasAud](https://github.com/LukasAud))
+- \(GH-1055\) Fix hardcoded cache path [\#1056](https://github.com/puppetlabs/puppetlabs-apt/pull/1056) ([chelnak](https://github.com/chelnak))
+- \(GH-cat-9\) Update module to match current syntax standard [\#1053](https://github.com/puppetlabs/puppetlabs-apt/pull/1053) ([david22swan](https://github.com/david22swan))
+
## [v9.0.0](https://github.com/puppetlabs/puppetlabs-apt/tree/v9.0.0) (2022-08-18)
[Full Changelog](https://github.com/puppetlabs/puppetlabs-apt/compare/v8.5.0...v9.0.0)
diff --git a/REFERENCE.md b/REFERENCE.md
index 956b16d61d..842ca67463 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -9,7 +9,7 @@
#### Public Classes
* [`apt`](#apt): Main class, includes all other classes.
-* [`apt::backports`](#aptbackports): Manages backports.
+* [`apt::backports`](#apt--backports): Manages backports.
#### Private Classes
@@ -18,19 +18,16 @@
### Defined types
-* [`apt::conf`](#aptconf): Specifies a custom Apt configuration file.
-* [`apt::key`](#aptkey): Manages the GPG keys that Apt uses to authenticate packages.
-* [`apt::mark`](#aptmark): Manages apt-mark settings
-* [`apt::pin`](#aptpin): Manages Apt pins. Does not trigger an apt-get update run.
-* [`apt::ppa`](#aptppa): Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
-* [`apt::setting`](#aptsetting): Manages Apt configuration files.
-* [`apt::source`](#aptsource): Manages the Apt sources in /etc/apt/sources.list.d/.
+* [`apt::conf`](#apt--conf): Specifies a custom Apt configuration file.
+* [`apt::key`](#apt--key): Manages the GPG keys that Apt uses to authenticate packages.
+* [`apt::mark`](#apt--mark): Manages apt-mark settings
+* [`apt::pin`](#apt--pin): Manages Apt pins. Does not trigger an apt-get update run.
+* [`apt::ppa`](#apt--ppa): Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
+* [`apt::setting`](#apt--setting): Manages Apt configuration files.
+* [`apt::source`](#apt--source): Manages the Apt sources in /etc/apt/sources.list.d/.
### Resource types
-#### Public Resource types
-
-
#### Private Resource types
* `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed
@@ -39,9 +36,9 @@ be manipulated through the `apt-key` command.
### Data types
-* [`Apt::Auth_conf_entry`](#aptauth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
-* [`Apt::Proxy`](#aptproxy): Configures Apt to connect to a proxy server.
-* [`Apt::Proxy_Per_Host`](#aptproxy_per_host): Adds per-host overrides to the system default APT proxy configuration
+* [`Apt::Auth_conf_entry`](#Apt--Auth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
+* [`Apt::Proxy`](#Apt--Proxy): Configures Apt to connect to a proxy server.
+* [`Apt::Proxy_Per_Host`](#Apt--Proxy_Per_Host): Adds per-host overrides to the system default APT proxy configuration
### Tasks
@@ -61,40 +58,40 @@ Main class, includes all other classes.
The following parameters are available in the `apt` class:
-* [`provider`](#provider)
-* [`keyserver`](#keyserver)
-* [`key_options`](#key_options)
-* [`ppa_options`](#ppa_options)
-* [`ppa_package`](#ppa_package)
-* [`backports`](#backports)
-* [`confs`](#confs)
-* [`update`](#update)
-* [`purge`](#purge)
-* [`proxy`](#proxy)
-* [`sources`](#sources)
-* [`keys`](#keys)
-* [`ppas`](#ppas)
-* [`pins`](#pins)
-* [`settings`](#settings)
-* [`manage_auth_conf`](#manage_auth_conf)
-* [`auth_conf_entries`](#auth_conf_entries)
-* [`auth_conf_owner`](#auth_conf_owner)
-* [`root`](#root)
-* [`sources_list`](#sources_list)
-* [`sources_list_d`](#sources_list_d)
-* [`conf_d`](#conf_d)
-* [`preferences`](#preferences)
-* [`preferences_d`](#preferences_d)
-* [`config_files`](#config_files)
-* [`sources_list_force`](#sources_list_force)
-* [`update_defaults`](#update_defaults)
-* [`purge_defaults`](#purge_defaults)
-* [`proxy_defaults`](#proxy_defaults)
-* [`include_defaults`](#include_defaults)
-* [`apt_conf_d`](#apt_conf_d)
-* [`source_key_defaults`](#source_key_defaults)
-
-##### `provider`
+* [`provider`](#-apt--provider)
+* [`keyserver`](#-apt--keyserver)
+* [`key_options`](#-apt--key_options)
+* [`ppa_options`](#-apt--ppa_options)
+* [`ppa_package`](#-apt--ppa_package)
+* [`backports`](#-apt--backports)
+* [`confs`](#-apt--confs)
+* [`update`](#-apt--update)
+* [`update_defaults`](#-apt--update_defaults)
+* [`purge`](#-apt--purge)
+* [`purge_defaults`](#-apt--purge_defaults)
+* [`proxy`](#-apt--proxy)
+* [`proxy_defaults`](#-apt--proxy_defaults)
+* [`sources`](#-apt--sources)
+* [`keys`](#-apt--keys)
+* [`ppas`](#-apt--ppas)
+* [`pins`](#-apt--pins)
+* [`settings`](#-apt--settings)
+* [`manage_auth_conf`](#-apt--manage_auth_conf)
+* [`auth_conf_entries`](#-apt--auth_conf_entries)
+* [`auth_conf_owner`](#-apt--auth_conf_owner)
+* [`root`](#-apt--root)
+* [`sources_list`](#-apt--sources_list)
+* [`sources_list_d`](#-apt--sources_list_d)
+* [`conf_d`](#-apt--conf_d)
+* [`preferences`](#-apt--preferences)
+* [`preferences_d`](#-apt--preferences_d)
+* [`config_files`](#-apt--config_files)
+* [`sources_list_force`](#-apt--sources_list_force)
+* [`include_defaults`](#-apt--include_defaults)
+* [`apt_conf_d`](#-apt--apt_conf_d)
+* [`source_key_defaults`](#-apt--source_key_defaults)
+
+##### `provider`
Data type: `String`
@@ -102,7 +99,7 @@ Specifies the provider that should be used by apt::update.
Default value: `$apt::params::provider`
-##### `keyserver`
+##### `keyserver`
Data type: `String`
@@ -111,7 +108,7 @@ hkp://).
Default value: `$apt::params::keyserver`
-##### `key_options`
+##### `key_options`
Data type: `Optional[String]`
@@ -119,7 +116,7 @@ Specifies the default options for apt::key resources.
Default value: `$apt::params::key_options`
-##### `ppa_options`
+##### `ppa_options`
Data type: `Optional[Array[String]]`
@@ -127,7 +124,7 @@ Supplies options to be passed to the `add-apt-repository` command.
Default value: `$apt::params::ppa_options`
-##### `ppa_package`
+##### `ppa_package`
Data type: `Optional[String]`
@@ -135,7 +132,7 @@ Names the package that provides the `apt-add-repository` command.
Default value: `$apt::params::ppa_package`
-##### `backports`
+##### `backports`
Data type: `Optional[Hash]`
@@ -149,7 +146,7 @@ Options:
Default value: `$apt::params::backports`
-##### `confs`
+##### `confs`
Data type: `Hash`
@@ -157,7 +154,7 @@ Creates new `apt::conf` resources. Valid options: a hash to be passed to the cre
Default value: `$apt::params::confs`
-##### `update`
+##### `update`
Data type: `Hash`
@@ -179,7 +176,15 @@ Default: 'reluctantly'.
Default value: `$apt::params::update`
-##### `purge`
+##### `update_defaults`
+
+Data type: `Hash`
+
+The default update settings that are combined and merged with the passed `update` value
+
+Default value: `$apt::params::update_defaults`
+
+##### `purge`
Data type: `Hash`
@@ -194,7 +199,15 @@ Options:
Default value: `$apt::params::purge`
-##### `proxy`
+##### `purge_defaults`
+
+Data type: `Hash`
+
+The default purge settings that are combined and merged with the passed `purge` value
+
+Default value: `$apt::params::purge_defaults`
+
+##### `proxy`
Data type: `Apt::Proxy`
@@ -202,7 +215,15 @@ Configures Apt to connect to a proxy server. Valid options: a hash matching the
Default value: `$apt::params::proxy`
-##### `sources`
+##### `proxy_defaults`
+
+Data type: `Hash`
+
+The default proxy settings that are combined and merged with the passed `proxy` value
+
+Default value: `$apt::params::proxy_defaults`
+
+##### `sources`
Data type: `Hash`
@@ -210,7 +231,7 @@ Creates new `apt::source` resources. Valid options: a hash to be passed to the c
Default value: `$apt::params::sources`
-##### `keys`
+##### `keys`
Data type: `Hash`
@@ -218,7 +239,7 @@ Creates new `apt::key` resources. Valid options: a hash to be passed to the crea
Default value: `$apt::params::keys`
-##### `ppas`
+##### `ppas`
Data type: `Hash`
@@ -226,7 +247,7 @@ Creates new `apt::ppa` resources. Valid options: a hash to be passed to the crea
Default value: `$apt::params::ppas`
-##### `pins`
+##### `pins`
Data type: `Hash`
@@ -234,7 +255,7 @@ Creates new `apt::pin` resources. Valid options: a hash to be passed to the crea
Default value: `$apt::params::pins`
-##### `settings`
+##### `settings`
Data type: `Hash`
@@ -242,7 +263,7 @@ Creates new `apt::setting` resources. Valid options: a hash to be passed to the
Default value: `$apt::params::settings`
-##### `manage_auth_conf`
+##### `manage_auth_conf`
Data type: `Boolean`
@@ -251,7 +272,7 @@ the auth_conf_entries parameter. When false, the file will be ignored (note that
Default value: `$apt::params::manage_auth_conf`
-##### `auth_conf_entries`
+##### `auth_conf_entries`
Data type: `Array[Apt::Auth_conf_entry]`
@@ -262,7 +283,7 @@ password and no others. Specifying manage_auth_conf and not specifying this para
Default value: `$apt::params::auth_conf_entries`
-##### `auth_conf_owner`
+##### `auth_conf_owner`
Data type: `String`
@@ -270,7 +291,7 @@ The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old relea
Default value: `$apt::params::auth_conf_owner`
-##### `root`
+##### `root`
Data type: `String`
@@ -278,7 +299,7 @@ Specifies root directory of Apt executable.
Default value: `$apt::params::root`
-##### `sources_list`
+##### `sources_list`
Data type: `String`
@@ -286,7 +307,7 @@ Specifies the path of the sources_list file to use.
Default value: `$apt::params::sources_list`
-##### `sources_list_d`
+##### `sources_list_d`
Data type: `String`
@@ -294,7 +315,7 @@ Specifies the path of the sources_list.d file to use.
Default value: `$apt::params::sources_list_d`
-##### `conf_d`
+##### `conf_d`
Data type: `String`
@@ -302,7 +323,7 @@ Specifies the path of the conf.d file to use.
Default value: `$apt::params::conf_d`
-##### `preferences`
+##### `preferences`
Data type: `String`
@@ -310,7 +331,7 @@ Specifies the path of the preferences file to use.
Default value: `$apt::params::preferences`
-##### `preferences_d`
+##### `preferences_d`
Data type: `String`
@@ -318,7 +339,7 @@ Specifies the path of the preferences.d file to use.
Default value: `$apt::params::preferences_d`
-##### `config_files`
+##### `config_files`
Data type: `Hash`
@@ -326,7 +347,7 @@ A hash made up of the various configuration files used by Apt.
Default value: `$apt::params::config_files`
-##### `sources_list_force`
+##### `sources_list_force`
Data type: `Boolean`
@@ -334,31 +355,7 @@ Specifies whether to perform force purge or delete. Default false.
Default value: `$apt::params::sources_list_force`
-##### `update_defaults`
-
-Data type: `Hash`
-
-
-
-Default value: `$apt::params::update_defaults`
-
-##### `purge_defaults`
-
-Data type: `Hash`
-
-
-
-Default value: `$apt::params::purge_defaults`
-
-##### `proxy_defaults`
-
-Data type: `Hash`
-
-
-
-Default value: `$apt::params::proxy_defaults`
-
-##### `include_defaults`
+##### `include_defaults`
Data type: `Hash`
@@ -366,28 +363,32 @@ Data type: `Hash`
Default value: `$apt::params::include_defaults`
-##### `apt_conf_d`
+##### `apt_conf_d`
Data type: `String`
-
+The path to the file `apt.conf.d`
Default value: `$apt::params::apt_conf_d`
-##### `source_key_defaults`
+##### `source_key_defaults`
Data type: `Hash`
+The fault `source_key` settings
+Default value:
-Default value: `{
+```puppet
+{
'server' => $keyserver,
'options' => undef,
'content' => undef,
'source' => undef,
- }`
+ }
+```
-### `apt::backports`
+### `apt::backports`
Manages backports.
@@ -411,14 +412,14 @@ class { 'apt::backports':
The following parameters are available in the `apt::backports` class:
-* [`location`](#location)
-* [`release`](#release)
-* [`repos`](#repos)
-* [`key`](#key)
-* [`pin`](#pin)
-* [`include`](#include)
+* [`location`](#-apt--backports--location)
+* [`release`](#-apt--backports--release)
+* [`repos`](#-apt--backports--repos)
+* [`key`](#-apt--backports--key)
+* [`pin`](#-apt--backports--pin)
+* [`include`](#-apt--backports--include)
-##### `location`
+##### `location`
Data type: `Optional[String]`
@@ -429,9 +430,9 @@ Ubuntu varies:
- Ubuntu: 'http://archive.ubuntu.com/ubuntu'
-Default value: ``undef``
+Default value: `undef`
-##### `release`
+##### `release`
Data type: `Optional[String]`
@@ -439,9 +440,9 @@ Specifies a distribution of the Apt repository containing the backports to manag
Default: on Debian and Ubuntu, `${fact('os.distro.codename')}-backports`. We recommend keeping this default, except on other operating
systems.
-Default value: ``undef``
+Default value: `undef`
-##### `repos`
+##### `repos`
Data type: `Optional[String]`
@@ -452,9 +453,9 @@ Default value for Debian and Ubuntu varies:
- Ubuntu: 'main universe multiverse restricted'
-Default value: ``undef``
+Default value: `undef`
-##### `key`
+##### `key`
Data type: `Optional[Variant[String, Hash]]`
@@ -466,9 +467,9 @@ for Debian and Ubuntu varies:
- Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
-Default value: ``undef``
+Default value: `undef`
-##### `pin`
+##### `pin`
Data type: `Variant[Integer, String, Hash]`
@@ -477,7 +478,7 @@ type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corre
Default value: `200`
-##### `include`
+##### `include`
Data type: `Variant[Hash]`
@@ -487,7 +488,7 @@ Default value: `{}`
## Defined types
-### `apt::conf`
+### `apt::conf`
Specifies a custom Apt configuration file.
@@ -495,20 +496,20 @@ Specifies a custom Apt configuration file.
The following parameters are available in the `apt::conf` defined type:
-* [`content`](#content)
-* [`ensure`](#ensure)
-* [`priority`](#priority)
-* [`notify_update`](#notify_update)
+* [`content`](#-apt--conf--content)
+* [`ensure`](#-apt--conf--ensure)
+* [`priority`](#-apt--conf--priority)
+* [`notify_update`](#-apt--conf--notify_update)
-##### `content`
+##### `content`
Data type: `Optional[String]`
Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
-Default value: ``undef``
+Default value: `undef`
-##### `ensure`
+##### `ensure`
Data type: `Enum['present', 'absent']`
@@ -516,7 +517,7 @@ Specifies whether the configuration file should exist. Valid options: 'present'
Default value: `present`
-##### `priority`
+##### `priority`
Data type: `Variant[String, Integer]`
@@ -525,15 +526,15 @@ Valid options: a string containing an integer or an integer.
Default value: `50`
-##### `notify_update`
+##### `notify_update`
Data type: `Optional[Boolean]`
Specifies whether to trigger an `apt-get update` run.
-Default value: ``undef``
+Default value: `undef`
-### `apt::key`
+### `apt::key`
Manages the GPG keys that Apt uses to authenticate packages.
@@ -555,15 +556,15 @@ apt::key { 'puppetlabs':
The following parameters are available in the `apt::key` defined type:
-* [`id`](#id)
-* [`ensure`](#ensure)
-* [`content`](#content)
-* [`source`](#source)
-* [`server`](#server)
-* [`weak_ssl`](#weak_ssl)
-* [`options`](#options)
+* [`id`](#-apt--key--id)
+* [`ensure`](#-apt--key--ensure)
+* [`content`](#-apt--key--content)
+* [`source`](#-apt--key--source)
+* [`server`](#-apt--key--server)
+* [`weak_ssl`](#-apt--key--weak_ssl)
+* [`options`](#-apt--key--options)
-##### `id`
+##### `id`
Data type: `Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/, /\A(0x)?[0-9a-fA-F]{16}\Z/, /\A(0x)?[0-9a-fA-F]{40}\Z/]`
@@ -572,7 +573,7 @@ characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadec
Default value: `$title`
-##### `ensure`
+##### `ensure`
Data type: `Enum['present', 'absent', 'refreshed']`
@@ -581,24 +582,24 @@ update when they have expired (assuming a new key exists on the key server).
Default value: `present`
-##### `content`
+##### `content`
Data type: `Optional[String]`
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.
-Default value: ``undef``
+Default value: `undef`
-##### `source`
+##### `source`
Data type: `Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]]`
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 value: ``undef``
+Default value: `undef`
-##### `server`
+##### `server`
Data type: `Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?(\/[a-zA-Z\d\-_.]+)*\/?$/]`
@@ -607,15 +608,15 @@ hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 1
Default value: `$apt::keyserver`
-##### `weak_ssl`
+##### `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``
+Default value: `false`
-##### `options`
+##### `options`
Data type: `Optional[String]`
@@ -623,7 +624,7 @@ Passes additional options to `apt-key adv --keyserver-options`.
Default value: `$apt::key_options`
-### `apt::mark`
+### `apt::mark`
Manages apt-mark settings
@@ -631,9 +632,9 @@ Manages apt-mark settings
The following parameters are available in the `apt::mark` defined type:
-* [`setting`](#setting)
+* [`setting`](#-apt--mark--setting)
-##### `setting`
+##### `setting`
Data type: `Enum['auto','manual','hold','unhold']`
@@ -641,7 +642,7 @@ auto, manual, hold, unhold
specifies the behavior of apt in case of no more dependencies installed
https://manpages.debian.org/stable/apt/apt-mark.8.en.html
-### `apt::pin`
+### `apt::pin`
Manages Apt pins. Does not trigger an apt-get update run.
@@ -653,21 +654,21 @@ Manages Apt pins. Does not trigger an apt-get update run.
The following parameters are available in the `apt::pin` defined type:
-* [`ensure`](#ensure)
-* [`explanation`](#explanation)
-* [`order`](#order)
-* [`packages`](#packages)
-* [`priority`](#priority)
-* [`release`](#release)
-* [`release_version`](#release_version)
-* [`component`](#component)
-* [`originator`](#originator)
-* [`label`](#label)
-* [`origin`](#origin)
-* [`version`](#version)
-* [`codename`](#codename)
-
-##### `ensure`
+* [`ensure`](#-apt--pin--ensure)
+* [`explanation`](#-apt--pin--explanation)
+* [`order`](#-apt--pin--order)
+* [`packages`](#-apt--pin--packages)
+* [`priority`](#-apt--pin--priority)
+* [`release`](#-apt--pin--release)
+* [`release_version`](#-apt--pin--release_version)
+* [`component`](#-apt--pin--component)
+* [`originator`](#-apt--pin--originator)
+* [`label`](#-apt--pin--label)
+* [`origin`](#-apt--pin--origin)
+* [`version`](#-apt--pin--version)
+* [`codename`](#-apt--pin--codename)
+
+##### `ensure`
Data type: `Enum['file', 'present', 'absent']`
@@ -675,15 +676,15 @@ Specifies whether the pin should exist. Valid options: 'file', 'present', and 'a
Default value: `present`
-##### `explanation`
+##### `explanation`
Data type: `Optional[String]`
Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}".
-Default value: ``undef``
+Default value: `undef`
-##### `order`
+##### `order`
Data type: `Variant[Integer]`
@@ -691,7 +692,7 @@ Determines the order in which Apt processes the pin file. Files with lower order
Default value: `50`
-##### `packages`
+##### `packages`
Data type: `Variant[String, Array]`
@@ -699,7 +700,7 @@ Specifies which package(s) to pin.
Default value: `'*'`
-##### `priority`
+##### `priority`
Data type: `Variant[Numeric, String]`
@@ -708,71 +709,71 @@ priority number (subject to dependency constraints). Valid options: an integer.
Default value: `0`
-##### `release`
+##### `release`
Data type: `Optional[String]`
Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'.
-Default value: `''`
+Default value: `undef`
-##### `release_version`
+##### `release_version`
Data type: `Optional[String]`
Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7).
-Default value: `''`
+Default value: `undef`
-##### `component`
+##### `component`
Data type: `Optional[String]`
Names the licensing component associated with the packages in the directory tree of the Release file.
-Default value: `''`
+Default value: `undef`
-##### `originator`
+##### `originator`
Data type: `Optional[String]`
Names the originator of the packages in the directory tree of the Release file.
-Default value: `''`
+Default value: `undef`
-##### `label`
+##### `label`
Data type: `Optional[String]`
Names the label of the packages in the directory tree of the Release file.
-Default value: `''`
+Default value: `undef`
-##### `origin`
+##### `origin`
Data type: `Optional[String]`
+The package origin
+Default value: `undef`
-Default value: `''`
-
-##### `version`
+##### `version`
Data type: `Optional[String]`
+The version of the package
+Default value: `undef`
-Default value: `''`
-
-##### `codename`
+##### `codename`
Data type: `Optional[String]`
+The codename of the package
+Default value: `undef`
-Default value: `''`
-
-### `apt::ppa`
+### `apt::ppa`
Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
@@ -788,14 +789,14 @@ apt::ppa{ 'ppa:openstack-ppa/bleeding-edge': }
The following parameters are available in the `apt::ppa` defined type:
-* [`ensure`](#ensure)
-* [`options`](#options)
-* [`release`](#release)
-* [`dist`](#dist)
-* [`package_name`](#package_name)
-* [`package_manage`](#package_manage)
+* [`ensure`](#-apt--ppa--ensure)
+* [`options`](#-apt--ppa--options)
+* [`release`](#-apt--ppa--release)
+* [`dist`](#-apt--ppa--dist)
+* [`package_name`](#-apt--ppa--package_name)
+* [`package_manage`](#-apt--ppa--package_manage)
-##### `ensure`
+##### `ensure`
Data type: `String`
@@ -803,7 +804,7 @@ Specifies whether the PPA should exist. Valid options: 'present' and 'absent'.
Default value: `'present'`
-##### `options`
+##### `options`
Data type: `Optional[Array[String]]`
@@ -811,7 +812,7 @@ Supplies options to be passed to the `add-apt-repository` command. Default: '-y'
Default value: `$apt::ppa_options`
-##### `release`
+##### `release`
Data type: `Optional[String]`
@@ -820,7 +821,7 @@ Optional if `puppet facts show os.distro.codename` returns your correct distribu
Default value: `fact('os.distro.codename')`
-##### `dist`
+##### `dist`
Data type: `Optional[String]`
@@ -829,7 +830,7 @@ Optional if `puppet facts show os.name` returns your correct distribution name.
Default value: `$facts['os']['name']`
-##### `package_name`
+##### `package_name`
Data type: `Optional[String]`
@@ -837,15 +838,15 @@ Names the package that provides the `apt-add-repository` command. Default: 'soft
Default value: `$apt::ppa_package`
-##### `package_manage`
+##### `package_manage`
Data type: `Boolean`
Specifies whether Puppet should manage the package that provides `apt-add-repository`.
-Default value: ``false``
+Default value: `false`
-### `apt::setting`
+### `apt::setting`
Manages Apt configuration files.
@@ -857,13 +858,13 @@ Manages Apt configuration files.
The following parameters are available in the `apt::setting` defined type:
-* [`priority`](#priority)
-* [`ensure`](#ensure)
-* [`source`](#source)
-* [`content`](#content)
-* [`notify_update`](#notify_update)
+* [`priority`](#-apt--setting--priority)
+* [`ensure`](#-apt--setting--ensure)
+* [`source`](#-apt--setting--source)
+* [`content`](#-apt--setting--content)
+* [`notify_update`](#-apt--setting--notify_update)
-##### `priority`
+##### `priority`
Data type: `Variant[String, Integer, Array]`
@@ -871,7 +872,7 @@ Determines the order in which Apt processes the configuration file. Files with h
Default value: `50`
-##### `ensure`
+##### `ensure`
Data type: `Enum['file', 'present', 'absent']`
@@ -879,33 +880,33 @@ Specifies whether the file should exist. Valid options: 'present', 'absent', and
Default value: `file`
-##### `source`
+##### `source`
Data type: `Optional[String]`
Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination
with `content`. Valid options: see link above for Puppet's native file type source attribute.
-Default value: ``undef``
+Default value: `undef`
-##### `content`
+##### `content`
Data type: `Optional[String]`
Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid
options: see link above for Puppet's native file type content attribute.
-Default value: ``undef``
+Default value: `undef`
-##### `notify_update`
+##### `notify_update`
Data type: `Boolean`
Specifies whether to trigger an `apt-get update` run.
-Default value: ``true``
+Default value: `true`
-### `apt::source`
+### `apt::source`
Manages the Apt sources in /etc/apt/sources.list.d/.
@@ -928,30 +929,30 @@ apt::source { 'puppetlabs':
The following parameters are available in the `apt::source` defined type:
-* [`location`](#location)
-* [`comment`](#comment)
-* [`ensure`](#ensure)
-* [`release`](#release)
-* [`repos`](#repos)
-* [`include`](#include)
-* [`key`](#key)
-* [`keyring`](#keyring)
-* [`pin`](#pin)
-* [`architecture`](#architecture)
-* [`allow_unsigned`](#allow_unsigned)
-* [`allow_insecure`](#allow_insecure)
-* [`notify_update`](#notify_update)
-* [`check_valid_until`](#check_valid_until)
-
-##### `location`
+* [`location`](#-apt--source--location)
+* [`comment`](#-apt--source--comment)
+* [`ensure`](#-apt--source--ensure)
+* [`release`](#-apt--source--release)
+* [`repos`](#-apt--source--repos)
+* [`include`](#-apt--source--include)
+* [`key`](#-apt--source--key)
+* [`keyring`](#-apt--source--keyring)
+* [`pin`](#-apt--source--pin)
+* [`architecture`](#-apt--source--architecture)
+* [`allow_unsigned`](#-apt--source--allow_unsigned)
+* [`allow_insecure`](#-apt--source--allow_insecure)
+* [`notify_update`](#-apt--source--notify_update)
+* [`check_valid_until`](#-apt--source--check_valid_until)
+
+##### `location`
Data type: `Optional[String]`
Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL.
-Default value: ``undef``
+Default value: `undef`
-##### `comment`
+##### `comment`
Data type: `String`
@@ -959,7 +960,7 @@ Supplies a comment for adding to the Apt source file.
Default value: `$name`
-##### `ensure`
+##### `ensure`
Data type: `String`
@@ -967,15 +968,15 @@ Specifies whether the Apt source file should exist. Valid options: 'present' and
Default value: `present`
-##### `release`
+##### `release`
Data type: `Optional[String]`
Specifies a distribution of the Apt repository.
-Default value: ``undef``
+Default value: `undef`
-##### `repos`
+##### `repos`
Data type: `String`
@@ -983,7 +984,7 @@ Specifies a component of the Apt repository.
Default value: `'main'`
-##### `include`
+##### `include`
Data type: `Variant[Hash]`
@@ -996,7 +997,7 @@ Options:
Default value: `{}`
-##### `key`
+##### `key`
Data type: `Optional[Variant[String, Hash]]`
@@ -1004,27 +1005,27 @@ Creates a declaration of the apt::key defined type. Valid options: a string to b
defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, `weak_ssl`,
and/or `options` parameters.
-Default value: ``undef``
+Default value: `undef`
-##### `keyring`
+##### `keyring`
Data type: `Optional[Stdlib::AbsolutePath]`
Absolute path to a file containing the PGP keyring used to sign this repository. Value is used to set signed-by on the source entry.
See https://wiki.debian.org/DebianRepository/UseThirdParty for details.
-Default value: ``undef``
+Default value: `undef`
-##### `pin`
+##### `pin`
Data type: `Optional[Variant[Hash, Numeric, String]]`
Creates a declaration of the apt::pin defined type. 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 value: ``undef``
+Default value: `undef`
-##### `architecture`
+##### `architecture`
Data type: `Optional[String]`
@@ -1032,45 +1033,43 @@ Tells Apt to only download information for specified architectures. Valid option
separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures
defined in the Apt::Architectures option).
-Default value: ``undef``
+Default value: `undef`
-##### `allow_unsigned`
+##### `allow_unsigned`
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.
-Default value: ``false``
+Default value: `false`
-##### `allow_insecure`
+##### `allow_insecure`
Data type: `Boolean`
Specifies whether to allow downloads from insecure repositories.
-Default value: ``false``
+Default value: `false`
-##### `notify_update`
+##### `notify_update`
Data type: `Boolean`
Specifies whether to trigger an `apt-get update` run.
-Default value: ``true``
+Default value: `true`
-##### `check_valid_until`
+##### `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
+Default value: `true`
## Data types
-### `Apt::Auth_conf_entry`
+### `Apt::Auth_conf_entry`
Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
@@ -1092,23 +1091,23 @@ Struct[{
The following parameters are available in the `Apt::Auth_conf_entry` data type:
-* [`machine`](#machine)
-* [`login`](#login)
-* [`password`](#password)
+* [`machine`](#-Apt--Auth_conf_entry--machine)
+* [`login`](#-Apt--Auth_conf_entry--login)
+* [`password`](#-Apt--Auth_conf_entry--password)
-##### `machine`
+##### `machine`
Hostname of machine to connect to.
-##### `login`
+##### `login`
Specifies the username to connect with.
-##### `password`
+##### `password`
Specifies the password to connect with.
-### `Apt::Proxy`
+### `Apt::Proxy`
Configures Apt to connect to a proxy server.
@@ -1130,33 +1129,33 @@ Struct[{
The following parameters are available in the `Apt::Proxy` data type:
-* [`ensure`](#ensure)
-* [`host`](#host)
-* [`port`](#port)
-* [`https`](#https)
-* [`direct`](#direct)
+* [`ensure`](#-Apt--Proxy--ensure)
+* [`host`](#-Apt--Proxy--host)
+* [`port`](#-Apt--Proxy--port)
+* [`https`](#-Apt--Proxy--https)
+* [`direct`](#-Apt--Proxy--direct)
-##### `ensure`
+##### `ensure`
Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'.
-##### `host`
+##### `host`
Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
-##### `port`
+##### `port`
Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
-##### `https`
+##### `https`
Specifies whether to enable https proxies.
-##### `direct`
+##### `direct`
Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not.
-### `Apt::Proxy_Per_Host`
+### `Apt::Proxy_Per_Host`
Adds per-host overrides to the system default APT proxy configuration
@@ -1176,29 +1175,29 @@ Struct[{
The following parameters are available in the `Apt::Proxy_Per_Host` data type:
-* [`scope`](#scope)
-* [`host`](#host)
-* [`port`](#port)
-* [`https`](#https)
-* [`direct`](#direct)
+* [`scope`](#-Apt--Proxy_Per_Host--scope)
+* [`host`](#-Apt--Proxy_Per_Host--host)
+* [`port`](#-Apt--Proxy_Per_Host--port)
+* [`https`](#-Apt--Proxy_Per_Host--https)
+* [`direct`](#-Apt--Proxy_Per_Host--direct)
-##### `scope`
+##### `scope`
Specifies the scope of the override. Valid options: a string containing a hostname.
-##### `host`
+##### `host`
Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
-##### `port`
+##### `port`
Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
-##### `https`
+##### `https`
Specifies whether to enable https for this override.
-##### `direct`
+##### `direct`
Specifies whether or not to use a `DIRECT` target to bypass the system default proxy.
diff --git a/metadata.json b/metadata.json
index 7b6bc1d6bf..ace916f630 100644
--- a/metadata.json
+++ b/metadata.json
@@ -1,6 +1,6 @@
{
"name": "puppetlabs-apt",
- "version": "9.0.0",
+ "version": "9.0.1",
"author": "puppetlabs",
"summary": "Provides an interface for managing Apt source, key, and definitions with Puppet",
"license": "Apache-2.0",