puppet_agent

Table of Contents

• puppet_agent

  - [Table of Contents](#table-of-contents)
  

  • Overview
  • Module Description
  • Setup
    • What puppet_agent affects
    • Setup requirements
    • Beginning with puppet_agent
  • Usage
  • Using alternate sources
    • Public downloads mirrors
    • Absolute paths to packages
    • Alternate PE master location
  • Reference
    • Public classes
    • Private classes
    • Parameters
      • Class: puppet_agent
        • arch
        • collection
        • is_pe
        • manage_repo
        • package_version
        • service_names
        • source
        • absolute_source
        • yum_source
        • apt_source
        • mac_source
        • windows_source
        • solaris_source
        • aix_source
        • use_alternate_sources
        • alternate_pe_source
        • install_dir
        • disable_proxy
        • proxy
        • install_options
        • msi_move_locked_files
        • wait_for_pxp_agent_exit
        • wait_for_puppet_run
        • config
    • Plans
      • puppet_agent::run
    • Tasks
      • puppet_agent::version
      • puppet_agent::install
      • puppet_agent::facts_diff
      • puppet_agent::delete_local_filebucket
  • Limitations
    • Known issues
  • Development
  • Maintenance

Overview

A module for installing, running, upgrading, and managing the configuration of Puppet agents. Supports upgrading from Puppet 4 puppet-agent packages to later versions including Puppet 4, Puppet 5, and Puppet 6.

Previous releases of this module, now unsupported, upgraded agents from later versions of Puppet 3 to Puppet 4.

Module Description

The puppet_agent module installs the appropriate official Puppet package repository (on systems that support repositories); migrates configuration required by Puppet to new locations used by puppet-agent; and installs the puppet-agent package, removing the previous Puppet installation.

If a package_version parameter is provided, it will ensure that puppet-agent version is installed. The package_version parameter is required to perform upgrades starting from a puppet-agent package, also this parameter can be set to "auto", ensuring that agent version matches the version on the master without having to manually update package_version after upgrading the master(s). On platforms that install packages through repos (EL, Fedora, Debian, Ubuntu, SLES), the parameter can be set to "latest" in order to install the latest available package. To only ensure the presence of the package, the parameter can be set to "present".

If a config parameter is provided, it will manage the defined agent configuration settings.

Setup

What puppet_agent affects

• Puppet, Facter, Hiera, and MCollective (MCollective is no longer included in Puppet 6 installs).
• Puppet's SSL directory and puppet.conf.
• Removes deprecated settings from puppet.conf.

Setup requirements

Your agents must be running a minimum version of Puppet 4. They should already be pointed at a master running Puppet Server 2.1 or greater, and thus successfully applying catalogs compiled with the Puppet 4 or newer language.

Beginning with puppet_agent

Install the puppet_agent module with puppet module install puppetlabs-puppet_agent.

Usage

Add the class to agents you want to upgrade, specifying the desired puppet-agent version:

class {'::puppet_agent':
  package_version => '1.4.0',
}

This will ensure the version 1.4.0 of the puppet-agent package is installed. For version 1.4.0 and later, it will also remove the deprecated pluginsync setting from puppet.conf, unless explicitly managed elsewhere.

Using alternate sources

In cases where you wish to download agents from sources other than the defaults you can use source parameters to change the location to grab packages from.

Public downloads mirrors

If you wish to mirror the Puppet public downloads sites (yum.puppet.com, apt.puppet.com, downloads.puppet.com) you can provide the following parameters to change the location of downloads:

• yum_source
• apt_source
• mac_source
• windows_source
• solaris_source
• aix_source

For AIX and Solaris packages: because AIX and Solaris are PE only you must use puppetlabs-pe_repo to create repos for these platforms on the PE master, then mirror the PE master package serve.

When working with a PE installation: if you set use_alternate_sources to true you can force agent downloads to come from downloads sites (or a mirror if you set the source parameters) rather than the PE master. WARNING This parameter will override the default settings in PE installations to download packages from the PE master. If you wish to continue to download from the PE master do not set this parameter.

Absolute paths to packages

If your packages are already available on the target system (for example if you are using a network share) you can provide absolute_source the path to the packages to use during installation.

WARNING You must provide the full path, including the package name, for this parameter to work. This also means you cannot provide the same absolute_source for two different types of packages.

Alternate PE master location

If you are using puppetlabs-pe_repo to serve packages, but want to provide a location other than the current master to serve packages: use alternate_pe_source to specify a seperate location where packages are located in the same structure that would be on a PE master.

Reference

Public classes

• puppet_agent

Private classes

• puppet_agent::install: Installs packages.
• puppet_agent::osfamily::*: Platform-specific preparation performed before upgrades.
• puppet_agent::prepare: Prepares the agent for upgrade.
• puppet_agent::prepare::package: Stages packages locally for install, on platforms that can't install from remote packages.
• puppet_agent::prepare::*: Prepare various file configurations.
• puppet_agent::service: Ensures the services are running.
• puppet_agent::windows::install: Handles Windows package installation.

Parameters

Class: puppet_agent

arch

The architecture version you wish to install. Defaults to $::facts['architecture'].

  arch => 'x86_64'

collection

The Puppet Collection to track, should be one of puppet5, puppet6 or puppet7. Puppet collections contain the latest agents included in the collection's series, so puppet5 will pull in the most recent Puppet 5 release (for example: 5.5.10) as also will puppet6 for Puppet 6 (for example: 6.3.0). This parameter is required for installations not connected to Puppet Enterprise

  collection => 'puppet6'

is_pe

Install from Puppet Enterprise (PE) repos. Enabled if communicating with a PE master.

  is_pe => true

manage_repo

Boolean to determine whether to configure zypper/yum/apt/solaris repositories. Defaults to true. If set to false, it is assumed an internally hosted repository will be used for the installation, and the native package providers will be used to query pre-configured repos on the host being upgraded.

  manage_repo => true

package_version

The package version to upgrade to. This must be explicitly specified.

  package_version => '5.5.10'

or

  package_version => 'auto'

or

  package_version => 'latest'

or

  package_version => 'present'

service_names

An array of services to start, normally puppet. If the array is empty, no services are started.

  service_names => ['puppet']

source

INCLUDED FOR COMPATIBILITY WITH MODULE VERSIONS 1.0/2.0. PREFER USE OF "absolute_source", "(yum/apt/mac etc.)_source", "alternate_pe_source" OVER USE OF "source".

The location to find packages. Replaces base URL for unix/MacOS agents, used as fully qualified path in windows.

Unix/MacOS

  source => 'https://alternate-pe-master.com:8140'

Windows

  source => 'C:/packages/puppet-agent-6.0.0-x64.msi'

absolute_source

Absolute ("fully qualified") source path from which you wish to download the latest version of Puppet. No path structure or package name is assumed: the fully qualified path to the package itself must be provided.

  absolute_source => 'C:/packages/puppet-agent-6.0.0-x64.msi'

yum_source

Base URL of a location or mirrors of yum.puppet.com downloads sites. Directories under the URL should match the structure of yum.puppet.com

  yum_source => 'https://my-puppet-yum-mirror.com'

apt_source

Base URL of a location or mirrors of apt.puppet.com downloads sites. Directories under the URL should match the structure of apt.puppet.com

  apt_source => 'https://my-puppet-apt-mirror.com'

mac_source

Base URL of a location or mirrors of downloads.puppet.com downloads site that serves MacOS packages. Directories under the URL should match the structure of the downloads.puppet.com site

  mac_source => 'https://my-puppet-downloads-mirror.com'

windows_source

URL of a location or mirrors of downloads.puppet.com downloads site that serves packages. Directories under the URL should match the structure of downloads.puppet.com site

  windows_source => 'https://my-puppet-downloads-mirror.com'

solaris_source

Base URL of the location of a mirror for Solaris packages. Currently, solaris packages can only be made available by using puppetlabs-pe_repo. This means the mirror must be of a PE master package serve.

  solaris_source => 'https://my-pe_master-mirror.com'

aix_source

Base URL of the location of a mirror for AIX packages. Currently, AIX packages can only be made available by using puppetlabs-pe_repo. This means the mirror must be of a PE master package serve.

  aix_source => 'https://my-pe_master-mirror.com'

use_alternate_sources

ONLY APPLICABLE WHEN WORKING WITH PE INSTALLTIONS

When set to true will force downloads to come from the values of $apt_source, $deb_source $mac_source etc. rather than from the default PE master package serve. Note that this will also force downloads to ignore alternate_pe_source.

  use_alternate_sources => true

alternate_pe_source

Base URL of a location where packages are located in the same structure that's served by a PE master (the directory structure in PE for serving packages is created by the puppetlabs-pe_repo module). The general structure served by PE is: /packages/${pe_server_version}/${platform_tag}/${package_name}

  alternate_pe_source => 'https://my-alternate-pe-master.com:8140'

install_dir

The directory the puppet agent should be installed to. This is only applicable for Windows operating systems and when upgrading the agent to a new version; it will not cause re-installation of the same version to a new location. This must use backslashes for the path separator, and be an absolute path, for example:

  install_dir => 'D:\Program Files\Puppet Labs'

disable_proxy

This setting controls whether or not the Puppet repositories are configured with proxies. Currently this is only supported on RedHat-based OSes.

  disable_proxy => true

proxy

This setting specifies the proxy with which to configure the Puppet repos. Currently this is only supported on RedHat-based OSes.

  proxy => 'http://myrepo-proxy.example.com'

install_options

An array of additional options to pass when installing puppet-agent. Each option in the array can be either a string or a hash. Each option is automatically quoted when passed to the install command.

With Windows packages, note that file paths in install_options must use backslashes. (Since install options are passed directly to the installation command, forward slashes aren't automatically converted like they are in file resources.) Backslashes in double-quoted strings must be escaped, while backslashes in single-quoted strings can be escaped. The default value for Windows packages is REINSTALLMODE="amus".

The full list of supported MSI properties can be found here.

The Puppet installer can disable the Windows path length limit (260 character MAX_PATH limitation, requires Windows 10 1607 or later). This behavior is opt-in and can be controlled by the presence of the ENABLE_LONG_PATHS install option (the value does not matter). (requires Puppet >= 6.25.0/7.10.0)

  install_options => ['PUPPET_AGENT_ACCOUNT_DOMAIN=ExampleCorp', 'PUPPET_AGENT_ACCOUNT_USER=bob', 'PUPPET_AGENT_ACCOUNT_PASSWORD=password', 'ENABLE_LONG_PATHS=true']

msi_move_locked_files

This is only applicable for Windows operating systems and for Puppet 5 prior to 5.5.17 or Puppet 6 prior to 6.8.0. There may be instances where file locks cause unnecessary service restarts. By setting to true, the module will move files prior to installation that are known to cause file locks. By default this is set to false.

  msi_move_locked_files => true

In case msi_move_locked_files is set to true while upgrading to Puppet 5 following 5.5.17 or Puppet 6 following 6.8.0, Puppet can get into a state where puppet --version reports the older version(5.5.16) while the package reported by Windows is the new version(5.5.17). To recover from this case ADDLOCAL=ALL must be added to install_options

  install_options => ['REINSTALLMODE="amus"', 'ADDLOCAL=ALL']

wait_for_pxp_agent_exit

This is only applicable for Windows operating systems and pertains to /files/install_puppet.ps1 script. This parameterizes the module to define the wait time for the PXP agent to end successfully. The default value is 2 minutes and the timeout value must be defined in milliseconds. Example below, 8 minutes is equal to 480000.

  wait_for_pxp_agent_exit => 480000

wait_for_puppet_run

This is only applicable for Windows operating systems and pertains to /files/install_puppet.ps1 script. This parameterizes the module to define the wait time for the current puppet agent run to end successfully. The default value is 2 minutes and the timeout value must be defined in milliseconds. Example below, 8 minutes is equal to 480000.

  wait_for_puppet_run => 480000

config

An array of configuration data to enforce. Each configuration data item must be a Puppet_agent::Config hash, which has keys for puppet.conf section, setting, and value. This parameter is constrained to managing only a predetermined set of configuration settings. E.g. runinterval. The optional "ensure" key in a Puppet_agent::Config hash can be used to ensure a setting is absent. In the example below, the runinterval setting in the main section is set to 1 hour, and a local environment setting is ensured absent.

  config => [{section => main, setting => runinterval, value => '1h'},
             {section => main, setting => environment, ensure => absent}]

Valid agent settings are defined by the Puppet_agent::Config_setting type alias.

Plans

puppet_agent::run

Starts a Puppet agent run on the specified targets.

Parameters

• targets: A list of targets to start the Puppet agent run on.

Return value

Returns a ResultSet object. Targets that do not have an agent installed will have a failing Result object. For targets that have an agent installed and successfully ran the agent, the Result object will include the output of the agent run, the detailed exit code, and the contents of the run report.

{
  "_output": <output>,
  "exitcode": <exitcode>,
  "report": <report>
}

Tasks

puppet_agent::version

Checks for the version of puppet-agent package installed.

Return value

The puppet_agent::version task returns a Result on success specifying the version of the agent installed and how it was detected.

{
  "version": <version>,
  "source": <source>
}

puppet_agent::install

Installs the puppet-agent package. This task should not be used for upgrading agents particularly Windows agents which have requirements other than just installing the puppet-agent msi. For upgrading Windows agents please use the puppet_agent class through your standard Puppet deployment or via Bolt with Puppet apply.

Note: The puppet_agent::install_shell task requires the facts::bash implementation from the facts module. Both the puppet_agent and facts modules are packaged with Bolt. For use outside of Bolt make sure the facts module is installed to the same modules directory as puppet_agent.

Return value

The task returns the output of the installation script.

puppet_agent::facts_diff

Executes puppet facts diff action to check if there are differences between Facter 3 and Facter 4 outputs. (requires Puppet >= 6.21.0)

Parameters

• exclude: Regex used to exclude specific facts from diff. (requires Puppet >= 6.22.0)

Return value

Returns a ResultSet object containing the differences.

{
  "foo": {
    "new_value": "bar",
    "old_value": "baz"
  }
}

puppet_agent::delete_local_filebucket

Removes the local filebucket cache. The location of the filebucket is determined using the clientbucketdir puppet config.

Parameters

• force: ignore nonexistent files and errors.

Return value

Returns a ResultSet object.

{:success=>true}

Limitations

Mac OS X/macOS open source packages are not supported in puppet_agent module releases prior to v2.1.0.

Known issues

Windows platforms:

• To upgrade the agent by executing puppet agent -t interactively in a console, you must leave the console open and wait for the upgrade to finish before attempting to use the puppet command again. During upgrades the upgrade scripts use a 'pid file' located at Drive:\ProgramData\PuppetLabs\puppet\cache\state\puppet_agent_upgrade.pid to indicate there is an upgrade in progress. The 'pid file' also contains the process ID of the upgrade, if you wish to track the process itself.

• MSI installation failures do not produce any error. If the install fails, puppet_agent continues to be applied to the agent. If this happens, you'll need to examine the MSI log file to determine the failure's cause. You can find the location of the log file in the debug output from either a puppet apply or an agent run; the log file name follows the pattern puppet-<timestamp>-installer.log.

• If the upgrade is from Puppet 5 prior to 5.5.17 or Puppet 6 prior to 6.8.0 to newer version and msi_move_locked_files is set to true, Puppet can get into a state where puppet --version reports the older version(5.5.16) while the package reported by Windows is the new version(5.5.17). To recover from this case ADDLOCAL=ALL must be added to install_options

  install_options => ['REINSTALLMODE="amus"', 'ADDLOCAL=ALL']

*NIX platforms:

• Upgrading on most *NIX platforms (Linux, AIX, Solaris 11) will end the run after the puppet-agent upgrade finishes. This is to avoid unexpected behavior if already loaded Ruby code happens to interact with newer code that came with the upgrade, or viceversa. If run as a daemon, Puppet will automatically start a new agent run after the upgrade finishes.

Development

Puppet, Inc. modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our module contribution guide.

Maintenance

See MAINTAINERS

Tickets: https://tickets.puppetlabs.com/browse/MODULES

Reference

Table of Contents

Classes

• 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_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: == Class puppet_agent::install::darwin Private class called from puppet_agent class Manage the install process for Darwin OSes specifically
• 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: == Class puppet_agent::install::suse Private class called from puppet_agent class Manage the install process for SUSE OSes specifically
• 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::darwin
• puppet_agent::osfamily::debian
• puppet_agent::osfamily::redhat
• puppet_agent::osfamily::solaris
• puppet_agent::osfamily::suse
• puppet_agent::osfamily::windows
• 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: == 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: == 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: == Class puppet_agent::prepare::puppet_config Private class called from puppet_agent::prepare class
• 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

• puppet_agent_end_run: Stops the current Puppet run if a puppet-agent upgrade was performed. Used on platforms that manage the Puppet Agent upgrade with a package r
• puppet_agent_upgrade_error: Fails when a previous background installation failed. The type will check for the existance of an installation failure log and raise an error

Functions

• any_resources_of_type
• uri_host_from_string: Return a uri host from a string
• windows_msi_installargs: Return the $install_options parameter as a string usable in an msiexec command
• windows_native_path: Return a windows native path

Data types

• Puppet_agent::Arch
• Puppet_agent::Config
• Puppet_agent::Config_setting: An enumerated list of settings which are permitted to be managed by this module.

Tasks

• delete_local_filebucket: Removes the local filebucket
• facts_diff: Run the Puppet agent facts diff action
• install: Install the Puppet agent package
• install_powershell: Install the Puppet agent package
• install_shell: Install the Puppet agent package
• run: Run the Puppet agent. This task may cause problems if run in Puppet Enterprise.
• version: Get the version of the Puppet agent package installed. Returns nothing if none present.
• version_powershell: Get the version of the Puppet agent package installed. Returns nothing if none present.
• version_shell: Get the version of the Puppet agent package installed. Returns nothing if none present.

Plans

• puppet_agent::run: Starts a Puppet agent run on the specified targets. Note: This plan may cause issues when run in Puppet Enterprise.

Classes

puppet_agent

== Class: puppet_agent

Upgrades Puppet 4 and newer to the requested version.

=== Parameters

[arch] The package architecture. Defaults to the architecture fact. [collection] The Puppet Collection to track. Defaults to 'PC1'. [is_pe] Install from Puppet Enterprise repos. Enabled if communicating with a PE master. [manage_pki_dir] Whether or not to manage the /etc/pki directory. Defaults to true. Managing the /etc/pki directory inside the puppet_agent module can be problematic for organizations that manage gpg keys and settings in other modules. [manage_repo] Boolean to determine whether to configure repositories This is intended to provide the ability to disable configuring a local repo in support of systems that manage external repositories (i.e. spacewalk/satellite) to enable users to add the proper packages to their internal repos and to utilize default package providers for the install [package_name] The package to upgrade to, i.e. puppet-agent. [package_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. 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", "apt_source", "deb_source" etc. OVER USE OF "source".

The location to find packages. Replaces base URL for unix/MacOS agents, used as fully qualified path in windows [absolute_source] The exact location of the package to install. The entire path to the package must be provided with this parameter. [yum_source] Base URL of the location of mirrors of yum.puppet.com downloads sites. Directories under the URL "yumsource" should match the structure of the yum.puppet.com [apt_source] Base URL of the location of mirrors of apt.puppet.com downloads sites. Directories under the URL "apt_source" should match the structure of the apt.puppet.com [mac_source] Base URL of the location of mirrors of downloads.puppet.com downloads site that serves MacOS packages. Directories under the URL "mac_source" should match the structure of the downloads.puppet.com site [windows_source] Base URL of the location of mirrors of downloads.puppet.com downloads site that serves Windows packages. Directories under the URL "windows_source" should match the structure of the downloads.puppet.com site [solaris_source] Base URL of the location of a mirror for Solaris packages. Currently, solaris packages can only be made available by using puppetlabs-pe_repo. This means the mirror must be of a PE master package serve. [aix_source] Base URL of the location of a mirror for AIX packages. Currently, AIX packages can only be made available by using puppetlabs-pe_repo. This means the mirror must be of a PE master package serve. [use_alternate_sources] ONLY APPLICABLE WHEN WORKING WITH PE INSTALLTIONS When set to true will force downloads to come from the values of $apt_source, $deb_source $mac_source etc. rather than from the default PE master package serve. Note that this will also force downloads to ignore alternate_pe_source [alternate_pe_source] Base URL of the location where packages are located in the same structure that's served by a PE master (the directory structure in PE for serving packages is created by the puppetlabs-pe_repo module). The general structure served by PE is: /packages/${pe_server_version}/${platform_tag}/${package_name} [install_dir] The directory the puppet agent should be installed to. This is only applicable for windows operating systems. This only applies when upgrading the agent to a new version; it will not cause re-installation of the same version to a new location. [install_options] An array of additional options to pass when installing puppet-agent. Each option in the array can either be a string or a hash. Each option will automatically be quoted when passed to the install command. With Windows packages, note that file paths in an install option must use backslashes. (Since install options are passed directly to the installation command, forward slashes won't be automatically converted like they are in file resources.) Note also that backslashes in double-quoted strings _must be escaped and backslashes in single-quoted strings can be escaped. [msi_move_locked_files] This is only applicable for Windows operating systems. There may be instances where file locks cause unncessary service restarts. By setting to true, the module will move files prior to installation that are known to cause file locks. [wait_for_pxp_agent_exit] This parameter is only applicable for Windows operating systems and pertains to the /files/install_agent.ps1 script. This parameterizes the module to define the wait time for the PXP agent to end successfully. The default value is set 2 minutes. [wait_for_puppet_run] This parameter is only applicable for Windows operating systems and pertains to the /files/install_agent.ps1 script. This parameterizes the module to define the wait time for the current puppet agent run to end successfully. The default value is set 2 minutes. [config] An array of configuration data to enforce. Each configuration data item must be a Puppet_agent::Config hash, which has keys for puppet.conf section, setting, and value. This parameter is constrained to managing only a predetermined set of configuration settings, e.g. runinterval.

Parameters

The following parameters are available in the puppet_agent class:

• arch
• collection
• is_pe
• manage_pki_dir
• manage_repo
• package_name
• package_version
• service_names
• source
• absolute_source
• yum_source
• apt_source
• mac_source
• windows_source
• solaris_source
• aix_source
• use_alternate_sources
• alternate_pe_source
• install_dir
• disable_proxy
• proxy
• install_options
• skip_if_unavailable
• msi_move_locked_files
• wait_for_pxp_agent_exit
• wait_for_puppet_run
• config

arch

Data type: Any

Default value: $::architecture

collection

Data type: Any

Default value: $::puppet_agent::params::collection

is_pe

Data type: Any

Default value: $::puppet_agent::params::_is_pe

manage_pki_dir

Data type: Any

Default value: true

manage_repo

Data type: Any

Default value: true

package_name

Data type: Any

Default value: 'puppet-agent'

package_version

Data type: Any

Default value: undef

service_names

Data type: Any

Default value: $::puppet_agent::params::service_names

source

Data type: Any

Default value: undef

absolute_source

Data type: Any

Default value: undef

yum_source

Data type: Any

Default value: 'http://yum.puppet.com'

apt_source

Data type: Any

Default value: 'https://apt.puppet.com'

mac_source

Data type: Any

Default value: 'https://downloads.puppet.com'

windows_source

Data type: Any

Default value: 'https://downloads.puppet.com'

solaris_source

Data type: Any

Default value: 'puppet:///pe_packages'

aix_source

Data type: Any

Default value: 'puppet:///pe_packages'

use_alternate_sources

Data type: Any

Default value: false

alternate_pe_source

Data type: Any

Default value: undef

install_dir

Data type: Any

Default value: undef

disable_proxy

Data type: Any

Default value: false

proxy

Data type: Any

Default value: undef

install_options

Data type: Any

Default value: []

skip_if_unavailable

Data type: Any

Default value: 'absent'

msi_move_locked_files

Data type: Any

Default value: false

wait_for_pxp_agent_exit

Data type: Any

Default value: undef

wait_for_puppet_run

Data type: Any

Default value: undef

config

Data type: Array[Puppet_agent::Config]

Default value: []

puppet_agent::configure

The puppet_agent::configure class.

puppet_agent::install

== Class puppet_agent::install

This class is called from puppet_agent for install.

=== Parameters

[version] The puppet-agent version to install.

Parameters

The following parameters are available in the puppet_agent::install class:

• package_version
• install_dir
• install_options

package_version

Data type: Any

Default value: 'present'

install_dir

Data type: Any

Default value: undef

install_options

Data type: Any

Default value: []

puppet_agent::install::darwin

== Class puppet_agent::install::darwin

Private class called from puppet_agent class

Manage the install process for Darwin OSes specifically

Parameters

The following parameters are available in the puppet_agent::install::darwin class:

• package_version
• install_options

package_version

Data type: Any

install_options

Data type: Any

Default value: []

puppet_agent::install::solaris

== Class puppet_agent::install::solaris

Private class called from puppet_agent class

Manage the install process for solaris specifically

Parameters

The following parameters are available in the puppet_agent::install::solaris class:

• package_version
• install_options

package_version

Data type: Any

install_options

Data type: Any

Default value: []

puppet_agent::install::suse

== Class puppet_agent::install::suse

Private class called from puppet_agent class

Manage the install process for SUSE OSes specifically

Parameters

The following parameters are available in the puppet_agent::install::suse class:

• package_version
• install_options

package_version

Data type: Any

install_options

Data type: Any

Default value: []

puppet_agent::install::windows

== Class puppet_agent::install::windows

Private class called from puppet_agent class

Manage the install process for windows specifically

Parameters

The following parameters are available in the puppet_agent::install::windows class:

• install_dir
• install_options

install_dir

Data type: Any

Default value: undef

install_options

Data type: Any

Default value: []

puppet_agent::osfamily::aix

The puppet_agent::osfamily::aix class.

puppet_agent::osfamily::darwin

The puppet_agent::osfamily::darwin class.

puppet_agent::osfamily::debian

The puppet_agent::osfamily::debian class.

puppet_agent::osfamily::redhat

The puppet_agent::osfamily::redhat class.

puppet_agent::osfamily::solaris

The puppet_agent::osfamily::solaris class.

puppet_agent::osfamily::suse

The puppet_agent::osfamily::suse class.

puppet_agent::osfamily::windows

The puppet_agent::osfamily::windows class.

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

== Class puppet_agent::prepare

This class is called from puppet_agent to prepare for the upgrade.

=== Parameters

[version] The puppet-agent version to install.

Parameters

The following parameters are available in the puppet_agent::prepare class:

• package_version

package_version

Data type: Any

Default value: undef

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 for installation. This is used on platforms without package managers capable of working with a remote https repository.

[package_file_name] The puppet-agent package file to retrieve from the master.

Parameters

The following parameters are available in the puppet_agent::prepare::package class:

• source

source

Data type: Any

puppet_agent::prepare::puppet_config

== Class puppet_agent::prepare::puppet_config

Private class called from puppet_agent::prepare class

Parameters

The following parameters are available in the puppet_agent::prepare::puppet_config class:

• package_version

package_version

Data type: Any

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

puppet_agent_end_run

Stops the current Puppet run if a puppet-agent upgrade was performed. Used on platforms that manage the Puppet Agent upgrade with a package resource, as resources evaluated after an upgrade might cause unexpected behavior due to a mix of old and new Ruby code being loaded in memory.

Platforms that shell out to external scripts for upgrading (Windows, macOS, and Solaris 10) do not need to use this type.

Properties

The following properties are available in the puppet_agent_end_run type.

end_run

Stops the current puppet run

Parameters

The following parameters are available in the puppet_agent_end_run type.

• name
• provider

name

namevar

The desired puppet-agent version

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.

puppet_agent_upgrade_error

Fails when a previous background installation failed. The type will check for the existance of an installation failure log and raise an error with the contents of the log if it exists

Properties

The following properties are available in the puppet_agent_upgrade_error type.

ensure_notexist

whether or not the error log exists

Parameters

The following parameters are available in the puppet_agent_upgrade_error type.

• name
• provider

name

namevar

The name of the failure log to check for in puppet's $statedir. If this log exists the resource will fail.

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.

Functions

any_resources_of_type

Type: Ruby 4.x API

The any_resources_of_type function.

any_resources_of_type(String $resource_type, Optional[Hash[Any, Any]] $parameters)

The any_resources_of_type function.

Returns: Any

resource_type

Data type: String

parameters

Data type: Optional[Hash[Any, Any]]

uri_host_from_string

Type: Ruby 3.x API

Return a uri host from a string

uri_host_from_string()

Return a uri host from a string

Returns: Any

windows_msi_installargs

Type: Ruby 3.x API

Return the $install_options parameter as a string usable in an msiexec command

windows_msi_installargs()

Return the $install_options parameter as a string usable in an msiexec command

Returns: Any

windows_native_path

Type: Ruby 3.x API

Return a windows native path

windows_native_path()

Return a windows native path

Returns: Any

Data types

Puppet_agent::Arch

The Puppet_agent::Arch data type.

Alias of

Pattern[/^x86$/, /^x64$/, /^i386$/, /^i86pc$/, /^amd64$/, /^x86_64$/, /^power$/, /^sun4[uv]$/, /^ppc64le$/, /^aarch64$/, /PowerPC_POWER/]

Puppet_agent::Config

The Puppet_agent::Config data type.

Alias of

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],
                                            setting          => Puppet_agent::Config_setting,
                                            Optional[ensure] => Enum[absent]}]]

Puppet_agent::Config_setting

An enumerated list of settings which are permitted to be managed by this module.

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

delete_local_filebucket

Removes the local filebucket

Supports noop? false

Parameters

force

Data type: Optional[Boolean]

ignore nonexistent files and errors

facts_diff

Run the Puppet agent facts diff action

Supports noop? false

Parameters

exclude

Data type: Optional[String]

Regex used to exclude specific facts from diff

install

Install the Puppet agent package

Supports noop? true

Parameters

version

Data type: Optional[String]

The version of puppet-agent to install (defaults to latest when no agent is installed)

collection

Data type: Optional[Enum[puppet6, puppet7, puppet, puppet6-nightly, puppet7-nightly, puppet-nightly]]

The Puppet collection to install from (defaults to puppet, which maps to the latest collection released)

yum_source

Data type: Optional[String]

The source location to find yum repos (defaults to yum.puppet.com)

apt_source

Data type: Optional[String]

The source location to find apt repos (defaults to apt.puppet.com)

mac_source

Data type: Optional[String]

The source location to find mac packages (defaults to downloads.puppet.com)

windows_source

Data type: Optional[String]

The source location to find windows packages (defaults to downloads.puppet.com)

install_options

Data type: Optional[String]

optional install arguments to the windows installer (defaults to REINSTALLMODE="amus")

stop_service

Data type: Optional[Boolean]

Whether to stop the puppet agent service after install

retry

Data type: Optional[Integer]

The number of retries in case of network connectivity failures

install_powershell

Install the Puppet agent package

Supports noop? true

Parameters

version

Data type: Optional[String]

The version of puppet-agent to install

collection

Data type: Optional[Enum[puppet6, puppet7, puppet, puppet6-nightly, puppet7-nightly, puppet-nightly]]

The Puppet collection to install from (defaults to puppet, which maps to the latest collection released)

yum_source

Data type: Optional[String]

The source location to find yum repos (defaults to yum.puppet.com)

apt_source

Data type: Optional[String]

The source location to find apt repos (defaults to apt.puppet.com)

mac_source

Data type: Optional[String]

The source location to find mac packages (defaults to downloads.puppet.com)

windows_source

Data type: Optional[String]

The source location to find windows packages (defaults to downloads.puppet.com)

install_options

Data type: Optional[String]

optional install arguments to the windows installer (defaults to REINSTALLMODE="amus")

stop_service

Data type: Optional[Boolean]

Whether to stop the puppet agent service after install

retry

Data type: Optional[Integer]

The number of retries in case of network connectivity failures

install_shell

Install the Puppet agent package

Supports noop? true

Parameters

version

Data type: Optional[String]

The version of puppet-agent to install

collection

Data type: Optional[Enum[puppet6, puppet7, puppet, puppet6-nightly, puppet7-nightly, puppet-nightly]]

The Puppet collection to install from (defaults to puppet, which maps to the latest collection released)

yum_source

Data type: Optional[String]

The source location to find yum repos (defaults to yum.puppet.com)

apt_source

Data type: Optional[String]

The source location to find apt repos (defaults to apt.puppet.com)

mac_source

Data type: Optional[String]

The source location to find mac packages (defaults to downloads.puppet.com)

windows_source

Data type: Optional[String]

The source location to find windows packages (defaults to downloads.puppet.com)

install_options

Data type: Optional[String]

optional install arguments to the windows installer (defaults to REINSTALLMODE="amus")

stop_service

Data type: Optional[Boolean]

Whether to stop the puppet agent service after install

retry

Data type: Optional[Integer]

The number of retries in case of network connectivity failures

run

Run the Puppet agent. This task may cause problems if run in Puppet Enterprise.

Supports noop? false

version

Get the version of the Puppet agent package installed. Returns nothing if none present.

Supports noop? false

version_powershell

Get the version of the Puppet agent package installed. Returns nothing if none present.

Supports noop? false

version_shell

Get the version of the Puppet agent package installed. Returns nothing if none present.

Supports noop? false

Plans

puppet_agent::run

Starts a Puppet agent run on the specified targets. Note: This plan may cause issues when run in Puppet Enterprise.

Parameters

The following parameters are available in the puppet_agent::run plan:

• targets

targets

Data type: TargetSpec

The targets to start a Puppet agent run on.

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v4.10.0 (2022-01-26)

Full Changelog

Added

• (maint). Add fact-limit configuration options to list. #584 (Heidistein)
• (MODULES-11192)(MODULES-11168) Add AlmaLinux and Rocky to the puppet-agent module #583 (BobosilaVictor)
• (IAC-1751/IAC-1753) Add Rocky and AlmaLinux support to the install agent task #582 (david22swan)
• Allow detection of non-AIO Puppet #581 (smortex)

Fixed

• (MODULES-11214) Wrong url generated for darwin 11 #586 (BobosilaVictor)

[4.9.0] - 2021-09-09

Summary

Add Debian 11 support. Add Rocky Linux support for the install task. Allow present and latest as package_version. Other fixes and improvements.

Features

• (MODULES-11085) Add Fedora 34 support to module (#564)
• Update GPG-KEY-puppet (#579)
• Allow stdlib 8.0.0 (#576)
• (MODULES-11060) Add Debian 11 to puppet_agent module (#575)
• (MODULES-11148) Document Windows long paths support (#573)
• Update readme for clarification on Windows agent updates (#502)
• (MODULES-11113) Allow present and latest as package version (#565)
• (MODULES-11135) Add Rocky as EL platform in task install_shell.sh (#571)
• (MODULES-11078) Bump Bolt to 3.x (#566)
• (MODULES-11112) Add parameter puppet_agent::proxy (#567)

Bug fixes

• (MODULES-11123) Avoid loading puppet facts in install/windows.pp (#577)
• (MODULES-11077) Allow all settings to be managed (#569)

Acknowledgements

Thanks to smortex, murdok5, relearnshuffle, Guillaume001 and chrekh who have contributed to this release 🎉!

[4.8.0] - 2021-06-22

Summary

Add Fedora 34 support to module. Add macOS 11 support to install task. Fix facts_diff task argument parsing on Windows.

Features

• (MODULES-11085) Add Fedora 34 support to module (#564)
• (PE-31118) Add macOS 11 support to install task (#560)

Bug fixes

• (MODULES-11074) Fix facts_diff task argument parsing on Windows (#561)

[4.7.0] - 2021-05-12

Summary

Support running puppet_agent::install task in no-operation mode.

Features

• (MODULES-11066) Support running puppet_agent::install task in no-operation mode (#559)

[4.6.1] - 2021-04-27

Summary

Fix upgrades when files from /tmp directory cannot be executed

Bug fixes

• (MODULES-11057) Do not use /tmp directory for executables (#557)

[4.6.0] - 2021-04-22

Summary

Fix PE upgrades for SLES 11 and improve GPG key checks. Remove puppet5 task support. Add exclude flag to puppet facts diff and add task to remove local filebucket cache.

Features

• (MODULES-10987) Add Fedora32 support to puppet_agent module (#548)
• (MODULES-11045) add exclude parameter to facts_diff task (#552)
• (MODULES-11048) task to remove local filebucket (#550)

Bug fixes

• (MODULES-10996) Fix SLES 11 PE upgrades and improve GPG key check (#551)

Removals

• (MODULES-10989) Remove puppet5 collection from puppet_agent::install task (#549)

[4.5.0] - 2021-03-23

Summary

The module can now manage agent configuration. Various Windows fixes and additions, task updates.

Features

• (MODULES-10879) Implement configuration management (#525)
• (MODULES-10909) Retry task commands in case of network connectivity failures (#536)
• (MODULES-9798) Add timeout parameter for current Puppet run (#537)
• Ignore unneeded paths when packaging the module (#540)
• (MODULES-10925) Add facts_diff task (#542)

Bug fixes

• Update puppet-20250406 GPG key (#538)
• Fix upgrading Puppet on Windows (#539)

Acknowledgements

Thanks to smortex and phil4business who have contributed to this release 🎉!

[4.4.0] - 2021-01-20

Summary

Add the new GPG signing key and default to puppet 7 for PE 2021.0.

Features

• (MODULES-10910) Default to puppet 7 for PE 2021.0 (#529)
• (MODULES-10897) Add new GPG signing key and remove the old one (#532)

Bug fixes

• Speed up unit tests by bumping apt dependency to 7.4.2 (#531)

[4.3.0] - 2020-12-14

Summary

Task support for puppet7 collection. Use correct AIX packages when upgrading.

Features

• (MODULES-10873) Add support for puppet7 collection (#524)

Bug fixes

• (MODULES-10878) Use correct packages when upgrading AIX (#527)

[4.2.0] - 2020-10-30

Summary

Various Windows fixes and additions to facilitate upgrading to Puppet 7.

The fixes for (MODULES-10850) and (MODULES-10851) do not affect any released version of the module, but are still included in the changelog.

Features

• (MODULES-10799) Ensure upgradability to Puppet 7 when remote filebuckets are enabled (#511)

Bug fixes

• (MODULES-10813) Mismatched versions stops install on Windows (#512)
• (MODULES-10818) Ignore msi_move_locked_files on newer puppet versions (#515)
• (MODULES-10850) Determine PSScriptRoot if it does not exist (#519)
• (MODULES-10851) Fix Windows nightly prerequisites check (#520)

[4.1.0] - 2020-08-19

Summary

Add support for Linux Mint 20, and add puppet agent run plan to run the agent against remote targets.

Features

• Support for Linux Mint 20, LDME 4 (#500)
• (MODULES-10739) add task support for puppet7-nightly (#501)
• (MODULES-10768) Add task and plan for running the Puppet agent (#503)

Bug fixes

• (MODULES-10713) Fix agent upgrade on Solaris 11 (#499)

[4.0.0] - 2020-06-15

Summary

Stop agent run after upgrade. Fix absolute_source on RPM platforms. Update puppetlabs-facts dependency. Do not allow install task to upgrade Windows agents if services are still running.

Features

• (MODULES-10673) Update dependency for puppetlabs-facts (#495)

Bug fixes

• (MODULES-10653) Failed to upgrade agent using puppet task (#494)
• (MODULES-10655) Fix up/downgrade of agent to specified version (#488)
• (MODULES-10666) Stop agent run after an upgrade (#496)

[3.2.0] - 2020-05-13

Summary

Install task can download Ubuntu 20.04. Fixed mcollective being included as a default service.

Features

• Allow install task to download puppet-agent for Ubuntu 20.04 (#491)

Bug fixes

• Fix mcollective being included as a default service to manage in client version >= 6.0.0 (#485)

[3.1.0] - 2020-04-02

Summary

Update puppetlabs-inifile dependency. Install task can download macOS 10.15. Windows FIPS. Pidlock, puppet.list config and root check fixes for install_shell task.

Features

• Update inifile dependency to allow all 4.x versions (#477)
• Allow install task to downlad macOS 10.15 (#471)

Bug fixes

• Fix windowsfips upgrades (MODULES-10606)
• Remove pidlock if service states cannot be restored (MODULES-10594)
• Exit early when puppet.list config file has been modified (MODULES-10589)
• Check that user is root only if installation is required (#475)

[3.0.2] - 2020-02-14

Summary

Remove config from bolt_plugin.json.

Bug fixes

• Removed unsupported config field from the bolt_plugin.json file.(#469)

[3.0.1] - 2020-01-28

Summary

Fix install_powershell task for Powershell < 3.0.

Bug fixes

• Fixed install_powershell task failure when using Powershell < 3.0 (MODULES-10514)

[3.0.0] - 2020-01-24

Summary

Assume latest version of the puppet-agent package only when no version is specified and the puppet-agent package is not installed (puppet_agent::install task).

[2.2.3] - 2019-12-10

Summary

Support for Fedora 31, Windows FIPS. WaitForExit can be parameterized. Fix for downgrades using apt.

Features

• Fedora 31 support (MODULES-10238
• Windows FIPS support (MODULES-10043)
• WaitForExit for PXP agent can now be parameterized (MODULES-10052

Bug fixes

• Improve error message when install task could not download puppet-agent package (MODULES-10067
• Fixed lint warnings (MODULES-10055

[2.2.2] - 2019-11-7

Summary

Support for puppet nightly collection on Windows(puppet_agent::install task).

Features

• Puppet Agent module downloads the wrong nightly builds for Windows (MODULES-10038)

[2.2.1] - 2019-10-21

Summary

Support for Debian 10, Linux Mint, Amazon Linux 2. Stop puppet agent service after install. Puppet_agent task as a plugin.

Features

• Debian 10 amd64 support
• Linux Mint Support
• Amazon Linux 2 support (MODULES-9981)
• Update facts module used for testing install task (MODULES-9698)
• Add option to stop the puppet agent service after install (GH-1204)
• Added task to check commit messages
• Make the puppet_agent task available as a plugin

Bug fixes

• Failed puppet agent upgrade prevents future upgrading because of locked .pid file (MODULES-9497
• Update bash implementation metadata to require facts implementation
• Add bolt team as codeowners
• Cached Catalog on Windows not idempotent (MODULES-9846)
• Fix failing tests due to rspec changes

[2.2.0] - 2019-08-05

Summary

Autodetect package_version for compiling master. Fedora 30 support. Upgrade to Beaker 4. Handle mcollective service restarts on agent upgrades.

Features

• autodetect package_version based upon the compiling master (MODULES-8923)
• Fedora 30 support
• Handle mcollective service restarts on agent upgrades (MODULES-9173)
• Migrate puppet_agent module to Beaker 4 (MODULES-9444)
• Support upgrade of RedHat Satellite puppet agent packages (MODULES-7760)

Bug fixes

• Missing puppetlabs-facts dependency for the install task(MODULES-8665)

[2.1.2] - 2019-05-13

Summary

Update for the URLs used to retrieve Puppet Agent. Fix for using the modules in a non PE Environment

Bug fixes

• The Puppet Agent artifacts are now retrieved from .puppet.com instead of .puppetlabs.com (RE-12326)
• set PC1 as the default Puppet Agent repository

[2.1.1] - 2019-03-28

Summary

Quick fix release for windows environment issue

Bug fixes

• Update installation .ps1 script to force environment to production when executing "puppet config" (MODULES-8821)

[2.1.0] - 2019-03-26

Summary

New parameters for managing package sources to allow for targeting mirrors. SLES and MacOS support for open-source installs. Better service management for windows installations

Features

• Added SLES support for open-source installations (MODULES-8598)
• Added MacOS support for open-source installations (MODULES-8599)
• Error reporting for windows background upgrades (MODULES-8554)
• New source parameters for managing alternate sources (like mirrors) (MODULES-6604)

Bug fixes

• Fix inherited permissions exec resource on windows (MODULES-8406)
• Fix service management for puppet > 6 (MODULES-8319)
• No longer passing environment for windows installations (MODULES-4730)
• Fix rpm import of gpg keys for newer SLES (MODULES-8583)
• Wait on any hanging pxp-agent processes in windows installations (FM-7628)
• Update parameters to use 'server_list' when provided rather than the 'server' setting
• Update windows installations to always run service management outside of the initial puppet run (i.e. restart any services after the upgrade without using puppet)

[2.0.1] - 2019-01-17

Summary

New Installation tasks using Bolt, Updated module deps, Migration from batch to powershell for windows upgrades

Features

• Bolt task installations
• Updated module dependencies
• Powershell scripts for Windows upgrades

Bug fixes

• Windows installations now recover service state on failed upgrades

[1.7.0] - 2018-09-18

Summary

Bugfix and compatibility update for Puppet 6

Features

• Support for changes to Fedora package naming in Puppet 5 and 6
• Refactor OSX upgrades to be like Solaris and Windows, using an external script

[1.6.2] - 2018-07-26

Summary

Compatibility update for PE packaging changes

Features

• Support for new pe_repo tarballs that use repo names matching open source.

[1.6.1] - 2018-06-29

Summary

Minor bugfix release

Features

• Add Ubuntu 18.04 support
• Add skip_if_unavailable to yumrepo resource (MODULES-4424)

Bug fixes

• Do not manage PA version on PE infra nodes (MODULES-5230)
• Fix update failure for FIPS (MODULES-7329)

[1.6.0] - 2018-03-21

Summary

This is the last release that will support Puppet 3.x

Features

• Make management of /etc/pki directory optional (MODULES-6068)
• OSX 10.13 is now supported
• RHEL 7 AArch64 is now supported

Bug fixes

• Fix version tag on Amazon Linux (MODULES-5637)
• Stop all services prior to upgrading on Windows (PE-23563)
• Output token privileges for current user on Windows
• Update testing matrix
• Pin resources for Puppet 3.x compatibility (MODULES-6708, MODULES-6717)
• Pin rspec-puppet to 2.6 due to bug in rspec-puppet (MODULES-6717)

[1.5.0] - 2017-11-29

Summary

This is a feature and bug-fix release

Features

• Add ability to manage the stringify_facts setting (MODULES-5953)
• Upgrades to Puppet 5 are now supported on RPM-based platform (MODULES-5633)
• Debian 9 is now supported

Bug fixes

• Solaris 10 upgrades now work for Puppet Enterprise 2017.3 (MODULES-5942) and (MODULES-3787)
• AIX upgrades now work for Puppet Enterprise 2017.3 (MODULES-5979)
• Downgrading the agent on Windows no longer breaks the installation (MODULES-5622)

[1.4.1] - 2017-07-27

Summary

This is a bug-fix release

Bug fixes

• The system package provider is explicitly selected on Solaris 10 for installing puppet-agent (MODULES-4547)
• puppet lookup and other operations with strict_variables enabled will now work with this module (MODULES-5168)
• Use HTTP instead of HTTPS for RedHat repositories. This is consistent with Puppet's repo packages, and continues to use GPG signing for security.

[1.4.0] - 2017-06-12

Summary

This is a feature and bug-fix release

Known issues

Carried-over from prior releases:

• For Windows, trigger an agent run after upgrade to get Puppet to create the necessary directory structures.
• Upgrades on EL4-based systems are not supported.
• Mac OS X Open Source package upgrades are not yet implemented.

Features

• AIX 7.2 agents can now be upgraded (PA-1160)

Bug fixes

• Fix a race condition when upgrading agents on certain platforms (MODULES-4732)
• Avoid duplicate GPG imports on RPM-based systems (MODULE-4478)
• Silence some redundant notices on Debian-based systems (MODULES-4171)
• Avoid the new to fetch GPG keys from the internet (MODULES-4521)

[1.3.2] - 2017-02-09

Summary

This is a bug-fix release

Known issues

Carried-over from prior releases:

• For Windows, trigger an agent run after upgrade to get Puppet to create the necessary directory structures.
• Upgrades on EL4-based systems are not supported.
• Mac OS X Open Source package upgrades are not yet implemented.

Bug fixes

• Service management wasn't always applied when intended (MODULES-3994)
• Allow setting MSI installation parameters on Windows (MODULES-4214)
• Ensure all variables are populated to prevent failures when STRICT_VARIABLES='yes'
• Only update server.cfg if not already managed by PE
• Enable the puppet service on Windows if service param includes it (MODULES-4243)
• Add custom fact puppet_agent_appdata, as common_appdata was only defined in PE (MODULES-4241)
• Use getvar to fix facts to work with the strict_variables setting (MODULES-3710)
• Optionally move puppetres.dll on Windows upgrade (MODULES-4207)
• Allow disabling proxy settings for yum repo (MODULES-4236)

[1.3.1] - 2016-11-17

Summary

This is a bug-fix release

Known issues

Carried-over from prior releases:

• For Windows, trigger an agent run after upgrade to get Puppet to create the necessary directory structures.
• Upgrades on EL4-based systems are not supported.
• Mac OS X Open Source package upgrades are not yet implemented.

Bug fixes

• Fix upgrading a global Solaris zone would break upgrading other zones (MODULES-4092)
• Fix line endings of install_puppet.bat
• Fix upgrading between releases of the same package version (MODULES-4030)

[1.3.0] - 2016-10-19

Summary

The addition of several OS support features and a considerable amount of compatibility and bug fixes.

Known issues

Carried-over from prior releases:

• For Windows, trigger an agent run after upgrade to get Puppet to create the necessary directory structures.
• Upgrades on EL4-based systems are not supported.
• Mac OS X Open Source package upgrades are not yet implemented.

Features

• Add support for Ubuntu 16.04 and Fedora 23
• Allow MSI install path to be defined on Windows (MODULES-3571)
• Allow agent upgrade on non-English versions for Windows (MODULES-3636)
• Allow the use of a hosted repository for packages (MODULES-3872)
• Remove POWER8 restriction for AIX (MODULES-3912)

Bug fixes

• Fix upgrade process on Windows using a PID file (MODULES-3433)
• Fix metadata to indicate support for Puppet 3.7
• Fix upgrade process on Windows by stopping PXP service (MODULES-3449)
• Add extra logging during upgrade process on Windows
• Disable SSL verification on Xenial (PE-16317)
• Fix preserving the environment name when upgrading on Windows (MODULES-3517)
• Puppet run will fail if stringify_facts is set to true (MODULES-3591 MODULES-3951)
• Fix infinite loop scenario on Windows during upgrade (MODULES-3434)
• Fix the waiting process on Windows during an upgrade (MODULES-3657)
• Fix duplicate resource error on AIX with PE (MODULES-3893)
• Fix minor errors in RakeFile and spec_helper_acceptance
• Fix setting permissions on Windows package
• Update GPG Keys (RE-7976)
• Fix puppet-agent suffix on Fedora (PE-16317)
• Fix unless condition on SUSE and RedHat GPG key imports (MODULES-3894)
• Avoid Unknown variable errors in Puppet 4 (MODULES-3896)
• Fix logic for detecting Solaris 11 package name (PE-17663)
• Fix spec test fixtures to use the Forge
• Add Windows examples to README
• Fix acceptance tests ignoring resource errors (MODULES-3953)
• Add acceptance tests for manage_repo parameter (MODULES-3872)
• Fix Windows package download URL (MODULES-3970)

[1.2.0] - 2016-05-04

Summary

Supports upgrades from puppet-agent packages! Applies to both PE and FOSS, for example upgrades from PE 2015.3.2 to 2015.3.3 and puppet-agent 1.3.0 to 1.4.0 are supported. Upgrading from older Puppet 3 versions is also no longer explicitly prevented. Adds support for Solaris 11.

Known issues

Carried-over from prior releases:

• For Windows, trigger an agent run after upgrade to get Puppet to create the necessary directory structures.
• Upgrades on EL4-based systems are not supported.
• Upgrades on Fedora systems are not supported.

Newly identified issues:

• Mac OS X Open Source package upgrades are not yet implemented.
• AIX package names are based on PowerPC architecture version. PowerPC 8 is not yet supported.

Features

• Upgrades between puppet-agent packages, such as 2015.2.x to 2015.3.x.
• Adds support for Solaris 11.
• The pluginsync setting was deprecated in puppet-agent 1.4.0. This module removes it when upgrading to that version or later unless otherwise managed.
• Remove the lower-version requirement. All Puppet 3 versions potentially can be upgraded, although testing is only performed starting with Puppet/PE 3.8. Earlier versions likely work back to 3.5, as long as the manifest is compiled using 3.7+ with future parser enabled.

Bug fixes

• Fixes the release identification for Amazon Linux distributions to use EL 6 packages.
• Fix Debian upgrades for PE.
• Support upgrades of 32-bit Windows packages for PE (via pe_repo).
• Fixed an issue that would cause compilation to fail with Unknown function: 'pe_compiling_server_aio_build' in some environments.

[1.1.0] - 2016-03-01

Summary

The addition of several OS support features and a considerable amount of compatibility and bug fixes.

Known issues

While this release adds considerable features and bug fixes the following areas are known issues and require more work:

• For Windows, trigger an agent run after upgrade to get Puppet to create the necessary directory structures.
• There is currently ongoing work to allow for upgrading from 2015.2.x to 2015.3.x.
• Solaris 11 support work is in progess, but currently still buggy.

Features

• Adds support for SLES 10, Solaris 10, AIX.
• Add OSX 10.9 upgrades.
• Add no-internet Windows upgrade in PE.
• Added puppet_master_server fact.
• Adds /opt/puppetlabs to the managed directories.
• Additional test checks for /opt/puppetlabs.

Bug fixes

• Use rspec expect syntax for catching errors.
• Base master_agent_version on pe_compiling_server_aio_build().
• Update in metadata to include support for SLES 10 and 11.
• Ensure pe-puppet/mcollective services stopped after removing the PUPpuppet and PUPmcollective packages.
• Small readme typo fix.
• Pass in Puppet agent PID as command line parameter to avoid recreating install_puppet.bat at every agent run.
• Allow using the internal mirror when resolving gems.
• Add Solaris 10 sparc to supported arch.
• No longer converts Windows file resource to RAL catalog.
• Create/use local_package_dir in params.pp.
• Fix behavior for non-PE.
• Fix specs for Windows changes.
• Remove check for null $service_names.
• Fix linter errors on Windows PR 66.
• Use common_appdata on Windows.
• Removes management of the puppet/mco services on Windows systems.
• Add start/wait to Windows upgrade.
• Pass in configured server to Windows MSI.
• Fixes SLES11 GPG key import issue.
• Fixed regex for SLES compatibility.
• Ensures local MSI package resource defined on Windows.

[1.0.0] - 2015-07-28

Summary

Fixed minor bugs and improved documentation. Now a Puppet Supported module.

Features

• Improved documentation of upgrade process.

Bug fixes

• For Windows PE upgrades, by default install the agent version corresponding to the PE master.
• Reset puppet.conf's classfile setting.

[0.2.0] - 2015-07-21

Summary

Added support for most systems with both Puppet 3.8 and Puppet-Agent packages released by Puppet Labs.

Features

• Support for Debian 6/7, Ubuntu 12.04/14.04, SLES 12, and Windows 2003 through 2012R2.

Bug fixes

• Fix puppet_agent module doesn't touch puppet.conf settings outside an INI section (PUP-4886)
• Made internal classes private, using stdlib's assert_private helper
• Migrate SSL cert directories individually to account for individual settings (PUP-4690)
• Migrated mcollective configuration should prefer the new plugin location (PUP-4658)
• Fixed updating mcollective configuration files with multiple libdir or plugin.yaml definitions (PUP-4746)

[0.1.0] - 2015-06-02

Added

• Initial release of puppetlabs-puppet_agent, supporting Redhat and Centos 5/6/7.

* This Changelog was automatically generated by github_changelog_generator