diff --git a/CHANGELOG.md b/CHANGELOG.md index cbb3b6a3..8d4642cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,54 +2,85 @@ 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). -## [v4.12.1](https://github.com/puppetlabs/puppetlabs-puppet_agent/tree/v4.12.1) (2022-07-13) +## [v4.13.0](https://github.com/puppetlabs/puppetlabs-puppet_agent/tree/v4.13.0) (2023-03-21) -[Full Changelog](https://github.com/puppetlabs/puppetlabs-puppet_agent/compare/v4.12.0...v4.12.1) +[Full Changelog](https://github.com/puppetlabs/puppetlabs-puppet_agent/compare/v4.12.1...v4.13.0) -### Fixed +### Added -- \(maint\) Unnest module and class names in Ruby tasks [\#613](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/613) ([beechtom](https://github.com/beechtom)) +- \(PA-5242\) Updates install tasks for puppet8 [\#642](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/642) ([mhashizume](https://github.com/mhashizume)) +- \(MODULES-11365\) Enable rspec tests on Ruby 3.2 [\#641](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/641) ([mhashizume](https://github.com/mhashizume)) +- \(MODULES-11392\) Add Puppet 7 to 8 upgrade test [\#639](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/639) ([mhashizume](https://github.com/mhashizume)) +- \(MODULES-11361\) Updates legacy facts [\#637](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/637) ([mhashizume](https://github.com/mhashizume)) +- \(MODULES-11361\) Puppet 8 compatibility work [\#636](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/636) ([mhashizume](https://github.com/mhashizume)) +- \(MODULES-11348\) Replace lsbdistcodename with os.distro.codename [\#634](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/634) ([AriaXLi](https://github.com/AriaXLi)) +- run task/plan: Allow noop and environment option [\#632](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/632) ([bastelfreak](https://github.com/bastelfreak)) +- \(maint\) replace legacy validate function with datatype [\#628](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/628) ([bastelfreak](https://github.com/bastelfreak)) +- \(MODULES-11346\) Update dependency for APT module [\#624](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/624) ([MartyEwings](https://github.com/MartyEwings)) +- \(FM-8983\) Add Fedora 36 [\#619](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/619) ([joshcooper](https://github.com/joshcooper)) +- Support for Linux Mint 21 [\#616](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/616) ([luckyraul](https://github.com/luckyraul)) +- \(FM-8969\) Add support for macOS 12 ARM [\#615](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/615) ([joshcooper](https://github.com/joshcooper)) +- Add support for absolute\_source in puppet\_agent::install task [\#484](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/484) ([scbjans](https://github.com/scbjans)) -## [v4.12.0](https://github.com/puppetlabs/puppetlabs-puppet_agent/tree/v4.12.0) (2022-07-13) +## [v4.12.1] - 2022-07-13 -[Full Changelog](https://github.com/puppetlabs/puppetlabs-puppet_agent/compare/v4.11.0...v4.12.0) +### Summary -### Added +Bug fix release. -- \(FM-8943\) Add Ubuntu 22.04 to puppet\_agent module [\#610](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/610) ([AriaXLi](https://github.com/AriaXLi)) -- \(maint\) Adds cases for newly-supported OSes [\#607](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/607) ([mhashizume](https://github.com/mhashizume)) +### Bug Fixes -### Fixed +- Unnest module and class names in Ruby tasks ([#613](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/613)) -- \(MODULES-11334\) Handle TLS 1.2 on older Windows systems [\#611](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/611) ([chelnak](https://github.com/chelnak)) +## [v4.12.0] - 2022-07-13 -## [v4.11.0](https://github.com/puppetlabs/puppetlabs-puppet_agent/tree/v4.11.0) (2022-05-13) +### Summary -[Full Changelog](https://github.com/puppetlabs/puppetlabs-puppet_agent/compare/v4.10.0...v4.11.0) +Add support for Ubuntu 22.04, Debian 11, Red Hat Enterprise Linux 9, and Fedora 34. Handle TLS 1.2 on older Windows systems. +### Features -### Added +- ([FM-8943](https://tickets.puppetlabs.com/browse/FM-8943)) Add Ubuntu 22.04 support. ([#610](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/610)) +- Add support for Debian 11, Red Hat Enterprise Linux 9, and Fedora 34. ([#607](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/607)) -- \(maint\) Add macOS 12 [\#602](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/602) ([joshcooper](https://github.com/joshcooper)) +### Bug Fixes -### Fixed +- ([MODULES-11334](https://tickets.puppetlabs.com/browse/MODULES-11334)) Handle TLS 1.2 on older Windows systems. ([#611](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/611)) -- \(MODULES-11315\) Updates AIO auto version logic [\#604](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/604) ([mhashizume](https://github.com/mhashizume)) -- DOC-5213 install\_options for gMSAs [\#601](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/601) ([aimurphy](https://github.com/aimurphy)) +## [v4.11.0] - 2022-05-13 -## [v4.10.0](https://github.com/puppetlabs/puppetlabs-puppet_agent/tree/v4.10.0) (2022-01-26) +### Summary -[Full Changelog](https://github.com/puppetlabs/puppetlabs-puppet_agent/compare/4.9.0...v4.10.0) +Add support for macOS 12. Allow module to function properly if there is a discrepancy between the AIO puppet-agent and Puppet versions. -### Added +### Features + +- Add additional configuration options for puppet.conf ([#602](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/602)) + +### Bug Fixes -- \(maint\). Add fact-limit configuration options to list. [\#584](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/584) ([Heidistein](https://github.com/Heidistein)) -- \(MODULES-11192\)\(MODULES-11168\) Add AlmaLinux and Rocky to the puppet-agent module [\#583](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/583) ([BobosilaVictor](https://github.com/BobosilaVictor)) -- \(IAC-1751/IAC-1753\) Add Rocky and AlmaLinux support to the install agent task [\#582](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/582) ([david22swan](https://github.com/david22swan)) -- Allow detection of non-AIO Puppet [\#581](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/581) ([smortex](https://github.com/smortex)) +- ([MODULES-11315](https://tickets.puppetlabs.com/browse/MODULES-11315)) Allow module to function properly if there is a discrepancy between the AIO puppet-agent and Puppet versions. ([#604](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/604)) +- ([MODULES-11262](https://tickets.puppetlabs.com/browse/MODULES-11262)) Fix issue with version check on acceptance upgrade tests. ([#599](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/599)) -### Fixed +## [v4.10.0] - 2022-01-26 + +### Summary + +Improve AlmaLinux and Rocky Linux support. Converted this module to be PDK-compliant. Other fixes and improvements + +### Features + +- ([MODULES-11168](https://tickets.puppetlabs.com/browse/MODULES-11168), [MODULES-11192](https://tickets.puppetlabs.com/browse/MODULES-11192)) Add AlmaLinux and Rocky to the puppet-agent module ([#582](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/582), [#583](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/583)) +- ([MODULES-11244](https://tickets.puppetlabs.com/browse/MODULES-11244)) Convert puppet_agent module to PDK ([#588](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/588)) +- Allow detection of non-AIO Ppuppet ([#581](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/581)) +- Add additional configuration options for puppet.conf ([#584](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/584)) + +### Bug fixes + +- ([MODULES-11214](https://tickets.puppetlabs.com/browse/MODULES-11214)) Fix wrong URL generated for macOS 11 ([#586](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/586)) + +### Acknowledgements -- \(MODULES-11214\) Wrong url generated for darwin 11 [\#586](https://github.com/puppetlabs/puppetlabs-puppet_agent/pull/586) ([BobosilaVictor](https://github.com/BobosilaVictor)) +Thanks to [smortex](https://github.com/smortex) and [Heidistein](https://github.com/Heidistein) who have contributed to this release 🎉! ## [4.9.0] - 2021-09-09 diff --git a/REFERENCE.md b/REFERENCE.md index b4887a61..aff8e321 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -7,24 +7,24 @@ ### Classes * [`puppet_agent`](#puppet_agent): == Class: puppet_agent Upgrades Puppet 4 and newer to the requested version. === Parameters [arch] The package architecture. Defaults to -* [`puppet_agent::configure`](#puppet_agentconfigure) -* [`puppet_agent::install`](#puppet_agentinstall): == Class puppet_agent::install This class is called from puppet_agent for install. === Parameters [version] The puppet-agent version to -* [`puppet_agent::install::darwin`](#puppet_agentinstalldarwin): == Class puppet_agent::install::darwin Private class called from puppet_agent class Manage the install process for Darwin OSes specifically -* [`puppet_agent::install::solaris`](#puppet_agentinstallsolaris): == Class puppet_agent::install::solaris Private class called from puppet_agent class Manage the install process for solaris specifically -* [`puppet_agent::install::suse`](#puppet_agentinstallsuse): == Class puppet_agent::install::suse Private class called from puppet_agent class Manage the install process for SUSE OSes specifically -* [`puppet_agent::install::windows`](#puppet_agentinstallwindows): == Class puppet_agent::install::windows Private class called from puppet_agent class Manage the install process for windows specifically -* [`puppet_agent::osfamily::aix`](#puppet_agentosfamilyaix) -* [`puppet_agent::osfamily::darwin`](#puppet_agentosfamilydarwin) -* [`puppet_agent::osfamily::debian`](#puppet_agentosfamilydebian) -* [`puppet_agent::osfamily::redhat`](#puppet_agentosfamilyredhat) -* [`puppet_agent::osfamily::solaris`](#puppet_agentosfamilysolaris) -* [`puppet_agent::osfamily::suse`](#puppet_agentosfamilysuse) -* [`puppet_agent::osfamily::windows`](#puppet_agentosfamilywindows) -* [`puppet_agent::params`](#puppet_agentparams): == Class puppet_agent::params This class is meant to be called from puppet_agent It sets variables according to platform. -* [`puppet_agent::prepare`](#puppet_agentprepare): == Class puppet_agent::prepare This class is called from puppet_agent to prepare for the upgrade. === Parameters [version] The puppet-ag -* [`puppet_agent::prepare::package`](#puppet_agentpreparepackage): == Class puppet_agent::prepare::package The only job this class has is to ensure that the correct puppet-agent package is downloaded locally -* [`puppet_agent::prepare::puppet_config`](#puppet_agentpreparepuppet_config): == Class puppet_agent::prepare::puppet_config Private class called from puppet_agent::prepare class -* [`puppet_agent::service`](#puppet_agentservice): == Class puppet_agent::service This class is meant to be called from puppet_agent. It ensures that managed services are running. +* [`puppet_agent::configure`](#puppet_agent--configure) +* [`puppet_agent::install`](#puppet_agent--install): == Class puppet_agent::install This class is called from puppet_agent for install. === Parameters [version] The puppet-agent version to +* [`puppet_agent::install::darwin`](#puppet_agent--install--darwin): == Class puppet_agent::install::darwin Private class called from puppet_agent class Manage the install process for Darwin OSes specifically +* [`puppet_agent::install::solaris`](#puppet_agent--install--solaris): == Class puppet_agent::install::solaris Private class called from puppet_agent class Manage the install process for solaris specifically +* [`puppet_agent::install::suse`](#puppet_agent--install--suse): == Class puppet_agent::install::suse Private class called from puppet_agent class Manage the install process for SUSE OSes specifically +* [`puppet_agent::install::windows`](#puppet_agent--install--windows): == Class puppet_agent::install::windows Private class called from puppet_agent class Manage the install process for windows specifically +* [`puppet_agent::osfamily::aix`](#puppet_agent--osfamily--aix) +* [`puppet_agent::osfamily::darwin`](#puppet_agent--osfamily--darwin) +* [`puppet_agent::osfamily::debian`](#puppet_agent--osfamily--debian) +* [`puppet_agent::osfamily::redhat`](#puppet_agent--osfamily--redhat) +* [`puppet_agent::osfamily::solaris`](#puppet_agent--osfamily--solaris) +* [`puppet_agent::osfamily::suse`](#puppet_agent--osfamily--suse) +* [`puppet_agent::osfamily::windows`](#puppet_agent--osfamily--windows) +* [`puppet_agent::params`](#puppet_agent--params): == Class puppet_agent::params This class is meant to be called from puppet_agent It sets variables according to platform. +* [`puppet_agent::prepare`](#puppet_agent--prepare): == Class puppet_agent::prepare This class is called from puppet_agent to prepare for the upgrade. === Parameters [version] The puppet-ag +* [`puppet_agent::prepare::package`](#puppet_agent--prepare--package): == Class puppet_agent::prepare::package The only job this class has is to ensure that the correct puppet-agent package is downloaded locally +* [`puppet_agent::prepare::puppet_config`](#puppet_agent--prepare--puppet_config): == Class puppet_agent::prepare::puppet_config Private class called from puppet_agent::prepare class +* [`puppet_agent::service`](#puppet_agent--service): == Class puppet_agent::service This class is meant to be called from puppet_agent. It ensures that managed services are running. ### Resource types @@ -40,9 +40,9 @@ ### Data types -* [`Puppet_agent::Arch`](#puppet_agentarch) -* [`Puppet_agent::Config`](#puppet_agentconfig) -* [`Puppet_agent::Config_setting`](#puppet_agentconfig_setting): An enumerated list of settings which are permitted to be managed by this module. +* [`Puppet_agent::Arch`](#Puppet_agent--Arch) +* [`Puppet_agent::Config`](#Puppet_agent--Config) +* [`Puppet_agent::Config_setting`](#Puppet_agent--Config_setting): An enumerated list of settings which are permitted to be managed by this module. ### Tasks @@ -58,7 +58,7 @@ ### Plans -* [`puppet_agent::run`](#puppet_agentrun): Starts a Puppet agent run on the specified targets. Note: This plan may cause issues when run in Puppet Enterprise. +* [`puppet_agent::run`](#puppet_agent--run): Starts a Puppet agent run on the specified targets. Note: This plan may cause issues when run in Puppet Enterprise. ## Classes @@ -92,7 +92,7 @@ Upgrades Puppet 4 and newer to the requested version. The package version to upgrade to. Explicitly specify the version to upgrade to, or set to 'auto' to specify the version of the compiling master. [service_names] - An array of services to start, normally `puppet` and `mcollective`. + An array of services to start, normally `puppet`. None will be started if the array is empty. [source] **INCLUDED FOR COMPATIBILITY WITH MODULE VERSIONS 1.0/2.0. PREFER USE OF "absolute_source", @@ -169,43 +169,43 @@ Upgrades Puppet 4 and newer to the requested version. The following parameters are available in the `puppet_agent` class: -* [`arch`](#arch) -* [`collection`](#collection) -* [`is_pe`](#is_pe) -* [`manage_pki_dir`](#manage_pki_dir) -* [`manage_repo`](#manage_repo) -* [`package_name`](#package_name) -* [`package_version`](#package_version) -* [`service_names`](#service_names) -* [`source`](#source) -* [`absolute_source`](#absolute_source) -* [`yum_source`](#yum_source) -* [`apt_source`](#apt_source) -* [`mac_source`](#mac_source) -* [`windows_source`](#windows_source) -* [`solaris_source`](#solaris_source) -* [`aix_source`](#aix_source) -* [`use_alternate_sources`](#use_alternate_sources) -* [`alternate_pe_source`](#alternate_pe_source) -* [`install_dir`](#install_dir) -* [`disable_proxy`](#disable_proxy) -* [`proxy`](#proxy) -* [`install_options`](#install_options) -* [`skip_if_unavailable`](#skip_if_unavailable) -* [`msi_move_locked_files`](#msi_move_locked_files) -* [`wait_for_pxp_agent_exit`](#wait_for_pxp_agent_exit) -* [`wait_for_puppet_run`](#wait_for_puppet_run) -* [`config`](#config) - -##### `arch` +* [`arch`](#-puppet_agent--arch) +* [`collection`](#-puppet_agent--collection) +* [`is_pe`](#-puppet_agent--is_pe) +* [`manage_pki_dir`](#-puppet_agent--manage_pki_dir) +* [`manage_repo`](#-puppet_agent--manage_repo) +* [`package_name`](#-puppet_agent--package_name) +* [`package_version`](#-puppet_agent--package_version) +* [`service_names`](#-puppet_agent--service_names) +* [`source`](#-puppet_agent--source) +* [`absolute_source`](#-puppet_agent--absolute_source) +* [`yum_source`](#-puppet_agent--yum_source) +* [`apt_source`](#-puppet_agent--apt_source) +* [`mac_source`](#-puppet_agent--mac_source) +* [`windows_source`](#-puppet_agent--windows_source) +* [`solaris_source`](#-puppet_agent--solaris_source) +* [`aix_source`](#-puppet_agent--aix_source) +* [`use_alternate_sources`](#-puppet_agent--use_alternate_sources) +* [`alternate_pe_source`](#-puppet_agent--alternate_pe_source) +* [`install_dir`](#-puppet_agent--install_dir) +* [`disable_proxy`](#-puppet_agent--disable_proxy) +* [`proxy`](#-puppet_agent--proxy) +* [`install_options`](#-puppet_agent--install_options) +* [`skip_if_unavailable`](#-puppet_agent--skip_if_unavailable) +* [`msi_move_locked_files`](#-puppet_agent--msi_move_locked_files) +* [`wait_for_pxp_agent_exit`](#-puppet_agent--wait_for_pxp_agent_exit) +* [`wait_for_puppet_run`](#-puppet_agent--wait_for_puppet_run) +* [`config`](#-puppet_agent--config) + +##### `arch` Data type: `Any` -Default value: `$::architecture` +Default value: `$facts['os']['architecture']` -##### `collection` +##### `collection` Data type: `Any` @@ -213,7 +213,7 @@ Data type: `Any` Default value: `$::puppet_agent::params::collection` -##### `is_pe` +##### `is_pe` Data type: `Any` @@ -221,23 +221,23 @@ Data type: `Any` Default value: `$::puppet_agent::params::_is_pe` -##### `manage_pki_dir` +##### `manage_pki_dir` Data type: `Any` -Default value: ``true`` +Default value: `true` -##### `manage_repo` +##### `manage_repo` Data type: `Any` -Default value: ``true`` +Default value: `true` -##### `package_name` +##### `package_name` Data type: `Any` @@ -245,15 +245,15 @@ Data type: `Any` Default value: `'puppet-agent'` -##### `package_version` +##### `package_version` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `service_names` +##### `service_names` Data type: `Any` @@ -261,23 +261,23 @@ Data type: `Any` Default value: `$::puppet_agent::params::service_names` -##### `source` +##### `source` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `absolute_source` +##### `absolute_source` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `yum_source` +##### `yum_source` Data type: `Any` @@ -285,7 +285,7 @@ Data type: `Any` Default value: `'http://yum.puppet.com'` -##### `apt_source` +##### `apt_source` Data type: `Any` @@ -293,7 +293,7 @@ Data type: `Any` Default value: `'https://apt.puppet.com'` -##### `mac_source` +##### `mac_source` Data type: `Any` @@ -301,7 +301,7 @@ Data type: `Any` Default value: `'https://downloads.puppet.com'` -##### `windows_source` +##### `windows_source` Data type: `Any` @@ -309,7 +309,7 @@ Data type: `Any` Default value: `'https://downloads.puppet.com'` -##### `solaris_source` +##### `solaris_source` Data type: `Any` @@ -317,7 +317,7 @@ Data type: `Any` Default value: `'puppet:///pe_packages'` -##### `aix_source` +##### `aix_source` Data type: `Any` @@ -325,47 +325,47 @@ Data type: `Any` Default value: `'puppet:///pe_packages'` -##### `use_alternate_sources` +##### `use_alternate_sources` Data type: `Any` -Default value: ``false`` +Default value: `false` -##### `alternate_pe_source` +##### `alternate_pe_source` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `install_dir` +##### `install_dir` -Data type: `Any` +Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `disable_proxy` +##### `disable_proxy` Data type: `Any` -Default value: ``false`` +Default value: `false` -##### `proxy` +##### `proxy` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `install_options` +##### `install_options` Data type: `Any` @@ -373,7 +373,7 @@ Data type: `Any` Default value: `[]` -##### `skip_if_unavailable` +##### `skip_if_unavailable` Data type: `Any` @@ -381,31 +381,31 @@ Data type: `Any` Default value: `'absent'` -##### `msi_move_locked_files` +##### `msi_move_locked_files` Data type: `Any` -Default value: ``false`` +Default value: `false` -##### `wait_for_pxp_agent_exit` +##### `wait_for_pxp_agent_exit` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `wait_for_puppet_run` +##### `wait_for_puppet_run` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `config` +##### `config` Data type: `Array[Puppet_agent::Config]` @@ -413,11 +413,11 @@ Data type: `Array[Puppet_agent::Config]` Default value: `[]` -### `puppet_agent::configure` +### `puppet_agent::configure` The puppet_agent::configure class. -### `puppet_agent::install` +### `puppet_agent::install` == Class puppet_agent::install @@ -432,11 +432,11 @@ This class is called from puppet_agent for install. The following parameters are available in the `puppet_agent::install` class: -* [`package_version`](#package_version) -* [`install_dir`](#install_dir) -* [`install_options`](#install_options) +* [`package_version`](#-puppet_agent--install--package_version) +* [`install_dir`](#-puppet_agent--install--install_dir) +* [`install_options`](#-puppet_agent--install--install_options) -##### `package_version` +##### `package_version` Data type: `Any` @@ -444,15 +444,15 @@ Data type: `Any` Default value: `'present'` -##### `install_dir` +##### `install_dir` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `install_options` +##### `install_options` Data type: `Any` @@ -460,7 +460,7 @@ Data type: `Any` Default value: `[]` -### `puppet_agent::install::darwin` +### `puppet_agent::install::darwin` == Class puppet_agent::install::darwin @@ -472,16 +472,16 @@ Manage the install process for Darwin OSes specifically The following parameters are available in the `puppet_agent::install::darwin` class: -* [`package_version`](#package_version) -* [`install_options`](#install_options) +* [`package_version`](#-puppet_agent--install--darwin--package_version) +* [`install_options`](#-puppet_agent--install--darwin--install_options) -##### `package_version` +##### `package_version` Data type: `Any` -##### `install_options` +##### `install_options` Data type: `Any` @@ -489,7 +489,7 @@ Data type: `Any` Default value: `[]` -### `puppet_agent::install::solaris` +### `puppet_agent::install::solaris` == Class puppet_agent::install::solaris @@ -501,16 +501,16 @@ Manage the install process for solaris specifically The following parameters are available in the `puppet_agent::install::solaris` class: -* [`package_version`](#package_version) -* [`install_options`](#install_options) +* [`package_version`](#-puppet_agent--install--solaris--package_version) +* [`install_options`](#-puppet_agent--install--solaris--install_options) -##### `package_version` +##### `package_version` Data type: `Any` -##### `install_options` +##### `install_options` Data type: `Any` @@ -518,7 +518,7 @@ Data type: `Any` Default value: `[]` -### `puppet_agent::install::suse` +### `puppet_agent::install::suse` == Class puppet_agent::install::suse @@ -530,16 +530,16 @@ Manage the install process for SUSE OSes specifically The following parameters are available in the `puppet_agent::install::suse` class: -* [`package_version`](#package_version) -* [`install_options`](#install_options) +* [`package_version`](#-puppet_agent--install--suse--package_version) +* [`install_options`](#-puppet_agent--install--suse--install_options) -##### `package_version` +##### `package_version` Data type: `Any` -##### `install_options` +##### `install_options` Data type: `Any` @@ -547,7 +547,7 @@ Data type: `Any` Default value: `[]` -### `puppet_agent::install::windows` +### `puppet_agent::install::windows` == Class puppet_agent::install::windows @@ -559,18 +559,18 @@ Manage the install process for windows specifically The following parameters are available in the `puppet_agent::install::windows` class: -* [`install_dir`](#install_dir) -* [`install_options`](#install_options) +* [`install_dir`](#-puppet_agent--install--windows--install_dir) +* [`install_options`](#-puppet_agent--install--windows--install_options) -##### `install_dir` +##### `install_dir` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -##### `install_options` +##### `install_options` Data type: `Any` @@ -578,42 +578,42 @@ Data type: `Any` Default value: `[]` -### `puppet_agent::osfamily::aix` +### `puppet_agent::osfamily::aix` The puppet_agent::osfamily::aix class. -### `puppet_agent::osfamily::darwin` +### `puppet_agent::osfamily::darwin` The puppet_agent::osfamily::darwin class. -### `puppet_agent::osfamily::debian` +### `puppet_agent::osfamily::debian` The puppet_agent::osfamily::debian class. -### `puppet_agent::osfamily::redhat` +### `puppet_agent::osfamily::redhat` The puppet_agent::osfamily::redhat class. -### `puppet_agent::osfamily::solaris` +### `puppet_agent::osfamily::solaris` The puppet_agent::osfamily::solaris class. -### `puppet_agent::osfamily::suse` +### `puppet_agent::osfamily::suse` The puppet_agent::osfamily::suse class. -### `puppet_agent::osfamily::windows` +### `puppet_agent::osfamily::windows` The puppet_agent::osfamily::windows class. -### `puppet_agent::params` +### `puppet_agent::params` == Class puppet_agent::params This class is meant to be called from puppet_agent It sets variables according to platform. -### `puppet_agent::prepare` +### `puppet_agent::prepare` == Class puppet_agent::prepare @@ -628,17 +628,17 @@ This class is called from puppet_agent to prepare for the upgrade. The following parameters are available in the `puppet_agent::prepare` class: -* [`package_version`](#package_version) +* [`package_version`](#-puppet_agent--prepare--package_version) -##### `package_version` +##### `package_version` Data type: `Any` -Default value: ``undef`` +Default value: `undef` -### `puppet_agent::prepare::package` +### `puppet_agent::prepare::package` == Class puppet_agent::prepare::package @@ -653,15 +653,15 @@ without package managers capable of working with a remote https repository. The following parameters are available in the `puppet_agent::prepare::package` class: -* [`source`](#source) +* [`source`](#-puppet_agent--prepare--package--source) -##### `source` +##### `source` Data type: `Any` -### `puppet_agent::prepare::puppet_config` +### `puppet_agent::prepare::puppet_config` == Class puppet_agent::prepare::puppet_config @@ -671,15 +671,15 @@ Private class called from puppet_agent::prepare class The following parameters are available in the `puppet_agent::prepare::puppet_config` class: -* [`package_version`](#package_version) +* [`package_version`](#-puppet_agent--prepare--puppet_config--package_version) -##### `package_version` +##### `package_version` Data type: `Any` -### `puppet_agent::service` +### `puppet_agent::service` == Class puppet_agent::service @@ -711,16 +711,16 @@ Stops the current puppet run The following parameters are available in the `puppet_agent_end_run` type. -* [`name`](#name) -* [`provider`](#provider) +* [`name`](#-puppet_agent_end_run--name) +* [`provider`](#-puppet_agent_end_run--provider) -##### `name` +##### `name` namevar The desired puppet-agent version -##### `provider` +##### `provider` The specific backend to use for this `puppet_agent_end_run` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. @@ -743,16 +743,16 @@ whether or not the error log exists The following parameters are available in the `puppet_agent_upgrade_error` type. -* [`name`](#name) -* [`provider`](#provider) +* [`name`](#-puppet_agent_upgrade_error--name) +* [`provider`](#-puppet_agent_upgrade_error--provider) -##### `name` +##### `name` namevar The name of the failure log to check for in puppet's $statedir. If this log exists the resource will fail. -##### `provider` +##### `provider` The specific backend to use for this `puppet_agent_upgrade_error` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. @@ -821,41 +821,33 @@ Returns: `Any` ## Data types -### `Puppet_agent::Arch` +### `Puppet_agent::Arch` The Puppet_agent::Arch data type. -Alias of - -```puppet -Pattern[/^x86$/, /^x64$/, /^i386$/, /^i86pc$/, /^amd64$/, /^x86_64$/, /^power$/, /^sun4[uv]$/, /^ppc64le$/, /^aarch64$/, /PowerPC_POWER/] -``` +Alias of `Pattern[/^x86$/, /^x64$/, /^i386$/, /^i86pc$/, /^amd64$/, /^x86_64$/, /^power$/, /^sun4[uv]$/, /^ppc64le$/, /^aarch64$/, /PowerPC_POWER/]` -### `Puppet_agent::Config` +### `Puppet_agent::Config` The Puppet_agent::Config data type. Alias of ```puppet -Variant[Struct[{section => Enum[main, server, agent, user, master], +Variant[Struct[{ section => Enum[main, server, agent, user, master], setting => Puppet_agent::Config_setting, value => String, - Optional[ensure] => Enum[present, absent]}], Struct[{section => Enum[main, server, agent, user, master], + Optional[ensure] => Enum[present, absent] }], Struct[{ section => Enum[main, server, agent, user, master], setting => Puppet_agent::Config_setting, - Optional[ensure] => Enum[absent]}]] + Optional[ensure] => Enum[absent] }]] ``` -### `Puppet_agent::Config_setting` +### `Puppet_agent::Config_setting` An enumerated list of settings which are permitted to be managed by this module. -Alias of - -```puppet -Enum[agent_catalog_run_lockfile, agent_disabled_lockfile, allow_duplicate_certs, always_retry_plugins, autoflush, autosign, basemodulepath, binder_config, bucketdir, ca_fingerprint, ca_name, ca_port, ca_server, ca_ttl, cacert, cacrl, cadir, cakey, capub, catalog_cache_terminus, catalog_terminus, cert_inventory, certdir, certificate_revocation, certname, ciphers, classfile, client_datadir, clientbucketdir, clientyamldir, code, codedir, color, confdir, config, config_file_name, config_version, configprint, crl_refresh_interval, csr_attributes, csrdir, daemonize, data_binding_terminus, default_file_terminus, default_manifest, default_schedules, deviceconfdir, deviceconfig, devicedir, diff, diff_args, digest_algorithm, disable_i18n, disable_per_environment_manifest, disable_warnings, dns_alt_names, document_all, environment, environment_data_provider, environment_timeout, environment_timeout_mode, environmentpath, evaltrace, external_nodes, fact_name_length_soft_limit, fact_value_length_soft_limit, facterng, factpath, facts_terminus, fileserverconfig, filetimeout, forge_authorization, freeze_main, func3x_check, future_features, genconfig, genmanifest, graph, graphdir, group, hiera_config, hostcert, hostcrl, hostcsr, hostprivkey, hostpubkey, http_connect_timeout, http_debug, http_extra_headers, http_keepalive_timeout, http_proxy_host, http_proxy_password, http_proxy_port, http_proxy_user, http_read_timeout, http_user_agent, ignore_plugin_errors, ignoremissingtypes, ignoreschedules, key_type, keylength, lastrunfile, lastrunreport, ldapattrs, ldapbase, ldapclassattrs, ldapparentattr, ldappassword, ldapport, ldapserver, ldapssl, ldapstackedattrs, ldapstring, ldaptls, ldapuser, libdir, localcacert, localedest, localesource, log_level, logdest, logdir, manage_internal_file_permissions, manifest, masterport, max_deprecations, max_errors, max_warnings, maximum_uid, maxwaitforcert, maxwaitforlock, merge_dependency_warnings, mkusers, module_groups, module_repository, module_working_dir, modulepath, name, named_curve, no_proxy, node_cache_terminus, node_name, node_name_fact, node_name_value, node_terminus, noop, number_of_facts_soft_limit, onetime, passfile, path, payload_soft_limit, pidfile, plugindest, pluginfactdest, pluginfactsource, pluginsignore, pluginsource, pluginsync, postrun_command, preferred_serialization_format, prerun_command, preview_outputdir, priority, privatedir, privatekeydir, profile, publickeydir, puppet_trace, puppetdlog, report, report_include_system_store, report_port, report_server, reportdir, reports, reporturl, requestdir, resourcefile, rest_authconfig, resubmit_facts, rich_data, route_file, rundir, runinterval, runtimeout, serial, server, server_datadir, server_list, serverport, show_diff, signeddir, skip_tags, sourceaddress, splay, splaylimit, srv_domain, ssl_client_ca_auth, ssl_client_header, ssl_client_verify_header, ssl_lockfile, ssl_server_ca_auth, ssl_trust_store, ssldir, statedir, statefile, statettl, static_catalogs, storeconfigs, storeconfigs_backend, strict, strict_environment_mode, strict_hostname_checking, strict_variables, summarize, supported_checksum_types, syslogfacility, tags, tasks, top_level_facts_soft_limit, trace, transactionstorefile, trusted_external_command, trusted_oid_mapping_file, use_cached_catalog, use_srv_records, usecacheonfailure, user, vardir, vendormoduledir, versioned_environment_dirs, waitforcert, waitforlock, yamldir] -``` +Alias of `Enum[agent_catalog_run_lockfile, agent_disabled_lockfile, allow_duplicate_certs, always_retry_plugins, autoflush, autosign, basemodulepath, binder_config, bucketdir, ca_fingerprint, ca_name, ca_port, ca_server, ca_ttl, cacert, cacrl, cadir, cakey, capub, catalog_cache_terminus, catalog_terminus, cert_inventory, certdir, certificate_revocation, certname, ciphers, classfile, client_datadir, clientbucketdir, clientyamldir, code, codedir, color, confdir, config, config_file_name, config_version, configprint, crl_refresh_interval, csr_attributes, csrdir, daemonize, data_binding_terminus, default_file_terminus, default_manifest, default_schedules, deviceconfdir, deviceconfig, devicedir, diff, diff_args, digest_algorithm, disable_i18n, disable_per_environment_manifest, disable_warnings, dns_alt_names, document_all, environment, environment_data_provider, environment_timeout, environment_timeout_mode, environmentpath, evaltrace, external_nodes, fact_name_length_soft_limit, fact_value_length_soft_limit, facterng, factpath, facts_terminus, fileserverconfig, filetimeout, forge_authorization, freeze_main, func3x_check, future_features, genconfig, genmanifest, graph, graphdir, group, hiera_config, hostcert, hostcrl, hostcsr, hostprivkey, hostpubkey, http_connect_timeout, http_debug, http_extra_headers, http_keepalive_timeout, http_proxy_host, http_proxy_password, http_proxy_port, http_proxy_user, http_read_timeout, http_user_agent, ignore_plugin_errors, ignoremissingtypes, ignoreschedules, key_type, keylength, lastrunfile, lastrunreport, ldapattrs, ldapbase, ldapclassattrs, ldapparentattr, ldappassword, ldapport, ldapserver, ldapssl, ldapstackedattrs, ldapstring, ldaptls, ldapuser, libdir, localcacert, localedest, localesource, log_level, logdest, logdir, manage_internal_file_permissions, manifest, masterport, max_deprecations, max_errors, max_warnings, maximum_uid, maxwaitforcert, maxwaitforlock, merge_dependency_warnings, mkusers, module_groups, module_repository, module_working_dir, modulepath, name, named_curve, no_proxy, node_cache_terminus, node_name, node_name_fact, node_name_value, node_terminus, noop, number_of_facts_soft_limit, onetime, passfile, path, payload_soft_limit, pidfile, plugindest, pluginfactdest, pluginfactsource, pluginsignore, pluginsource, pluginsync, postrun_command, preferred_serialization_format, prerun_command, preview_outputdir, priority, privatedir, privatekeydir, profile, publickeydir, puppet_trace, puppetdlog, report, report_include_system_store, report_port, report_server, reportdir, reports, reporturl, requestdir, resourcefile, rest_authconfig, resubmit_facts, rich_data, route_file, rundir, runinterval, runtimeout, serial, server, server_datadir, server_list, serverport, show_diff, signeddir, skip_tags, sourceaddress, splay, splaylimit, srv_domain, ssl_client_ca_auth, ssl_client_header, ssl_client_verify_header, ssl_lockfile, ssl_server_ca_auth, ssl_trust_store, ssldir, statedir, statefile, statettl, static_catalogs, storeconfigs, storeconfigs_backend, strict, strict_environment_mode, strict_hostname_checking, strict_variables, summarize, supported_checksum_types, syslogfacility, tags, tasks, top_level_facts_soft_limit, trace, transactionstorefile, trusted_external_command, trusted_oid_mapping_file, use_cached_catalog, use_srv_records, usecacheonfailure, user, vardir, vendormoduledir, versioned_environment_dirs, waitforcert, waitforlock, yamldir]` ## Tasks @@ -903,10 +895,16 @@ The version of puppet-agent to install (defaults to latest when no agent is inst ##### `collection` -Data type: `Optional[Enum[puppet6, puppet7, puppet, puppet6-nightly, puppet7-nightly, puppet-nightly]]` +Data type: `Optional[Enum[puppet7, puppet, puppet7-nightly, puppet8-nightly, puppet-nightly]]` The Puppet collection to install from (defaults to puppet, which maps to the latest collection released) +##### `absolute_source` + +Data type: `Optional[String]` + +The absolute source location to find the Puppet agent package + ##### `yum_source` Data type: `Optional[String]` @@ -965,10 +963,16 @@ The version of puppet-agent to install ##### `collection` -Data type: `Optional[Enum[puppet6, puppet7, puppet, puppet6-nightly, puppet7-nightly, puppet-nightly]]` +Data type: `Optional[Enum[puppet7, puppet, puppet7-nightly, puppet8-nightly, puppet-nightly]]` The Puppet collection to install from (defaults to puppet, which maps to the latest collection released) +##### `absolute_source` + +Data type: `Optional[String]` + +The absolute source location to find the Puppet agent package + ##### `yum_source` Data type: `Optional[String]` @@ -1027,10 +1031,16 @@ The version of puppet-agent to install ##### `collection` -Data type: `Optional[Enum[puppet6, puppet7, puppet, puppet6-nightly, puppet7-nightly, puppet-nightly]]` +Data type: `Optional[Enum[puppet7, puppet, puppet7-nightly, puppet8-nightly, puppet-nightly]]` The Puppet collection to install from (defaults to puppet, which maps to the latest collection released) +##### `absolute_source` + +Data type: `Optional[String]` + +The absolute source location to find the Puppet agent package + ##### `yum_source` Data type: `Optional[String]` @@ -1079,6 +1089,20 @@ Run the Puppet agent. This task may cause problems if run in Puppet Enterprise. **Supports noop?** false +#### Parameters + +##### `noop` + +Data type: `Boolean` + +run the puppet agent with --noop + +##### `environment` + +Data type: `Optional[String[1]]` + +The desired puppet code environment to use + ### `version` Get the version of the Puppet agent package installed. Returns nothing if none present. @@ -1099,7 +1123,7 @@ Get the version of the Puppet agent package installed. Returns nothing if none p ## Plans -### `puppet_agent::run` +### `puppet_agent::run` Starts a Puppet agent run on the specified targets. Note: This plan may cause issues when run in Puppet Enterprise. @@ -1108,11 +1132,29 @@ Note: This plan may cause issues when run in Puppet Enterprise. The following parameters are available in the `puppet_agent::run` plan: -* [`targets`](#targets) +* [`targets`](#-puppet_agent--run--targets) +* [`noop`](#-puppet_agent--run--noop) +* [`environment`](#-puppet_agent--run--environment) -##### `targets` +##### `targets` Data type: `TargetSpec` The targets to start a Puppet agent run on. +##### `noop` + +Data type: `Boolean` + +if true, all runs will use --noop + +Default value: `false` + +##### `environment` + +Data type: `Optional[String[1]]` + +the desired puppet code environment + +Default value: `undef` + diff --git a/metadata.json b/metadata.json index 6b12a991..85c5e14b 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-puppet_agent", - "version": "4.12.1", + "version": "4.13.0", "author": "puppetlabs", "summary": "Upgrades All-In-One Puppet Agents", "license": "Apache-2.0",