Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

puppet_agent

Upgrades All-In-One Puppet Agents
Project URLRSS FeedReport issues

1,739,474 downloads

3,763 latest version

4.3 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 4.21.0 (latest)
  • 4.20.1
  • 4.19.0
  • 4.18.0
  • 4.17.0
  • 4.16.0
  • 4.15.0
  • 4.14.0
  • 4.13.0
  • 4.12.1
  • 4.12.0
  • 4.11.0
  • 4.10.0
  • 4.9.0
  • 4.8.0
  • 4.7.0
  • 4.6.1
  • 4.6.0
  • 4.5.0
  • 4.4.0
  • 4.3.0
  • 4.2.0
  • 4.1.1
  • 4.0.0
  • 3.2.0
  • 3.1.0
  • 3.0.2
  • 3.0.1
  • 3.0.0
  • 2.2.3
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.2
  • 2.1.1
  • 2.1.0
  • 2.0.1
  • 1.7.0
  • 1.6.2
  • 1.6.1
  • 1.6.0
  • 1.5.0
  • 1.4.1
  • 1.4.0
  • 1.3.2
  • 1.3.1
  • 1.3.0
  • 1.2.0
  • 1.1.0
  • 1.0.0
  • 0.2.0
  • 0.1.0
released Sep 24th 2024
Passed malware scan
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • RedHat, CentOS, OracleLinux, Scientific, SLES, Debian, Ubuntu, Fedora, Solaris, Windows, AIX, OSX, AlmaLinux, Rocky, AmazonLinux
Tasks:
  • delete_local_filebucket
  • facts_diff
  • install
  • version
Plans:
  • run

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-puppet_agent', '4.21.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-puppet_agent
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-puppet_agent --version 4.21.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/puppet_agent — version 4.21.0 Sep 24th 2024

puppet_agent

Modules Status Modules Status Modules Status Modules Status Modules Status

Table of Contents

Overview

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

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, and Hiera.
  • 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 6. They should already be pointed at a master running Puppet Server 6 or greater, and thus successfully applying catalogs compiled with the Puppet 6 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 => '7.23.0',
}

This will ensure the version 7.23.0 of the puppet-agent package is installed.

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

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['os']['architecture'].

  arch => 'x86_64'
collection

The Puppet Collection to track, should be a supported collection (e.g. puppet7 or puppet8). Puppet collections contain the latest agents included in the collection's series, so puppet7 will pull in the most recent Puppet 5 release (for example: 7.23.0). This parameter is required for installations not connected to Puppet Enterprise

  collection => 'puppet7'
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 => '7.23.0'

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-7.23.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-7.23.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']

For gMSAs, you must specify the domain and gMSA user, such as:

  install_options => ['PUPPET_AGENT_ACCOUNT_DOMAIN=<AGENT_DOMAIN_NAME>', 'PUPPET_AGENT_ACCOUNT_USER=<gMSA_USER>']
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.

Codeowners

See CODEOWNERS

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