Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

puppet_ent_agent

Management of Puppet Enterprise agent.
Project URLRSS FeedReport issues

264,569 downloads

250,097 latest version

4.5 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 2.0.5 (latest)
  • 2.0.4
  • 2.0.3
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.4.3
  • 1.4.2
  • 1.4.1 (deleted)
  • 1.4.0
  • 1.3.0
  • 1.2.6
  • 1.2.5
  • 1.2.4 (deleted)
  • 1.2.3 (deleted)
  • 1.2.2
  • 1.2.1
  • 1.2.0
  • 1.1.0
  • 1.0.0
  • 0.2.0
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3 (deleted)
  • 0.1.2
  • 0.1.1
  • 0.1.0
released May 12th 2016
This version is compatible with:
  • Puppet Enterprise >= 3.2.0 < 2016.2.0
  • , , , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'aharden-puppet_ent_agent', '2.0.5'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add aharden-puppet_ent_agent
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install aharden-puppet_ent_agent --version 2.0.5

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

aharden/puppet_ent_agent — version 2.0.5 May 12th 2016

#puppet_ent_agent

####Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with pe_agent
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.

##Overview

The puppet_ent_agent module configures and manages the Puppet Enterprise Agent software and service. It can also upgrade the agent software on PE 3.x deployments.

##Module Description

The puppet_ent_agent module's upgrade capability is dependent on the PE Package Repositories (pe_repo classes) available on any Puppet Enterprise Master version 3.2 or greater. This module was designed so that PE users can easily upgrade their managed PE agents after a version upgrade of a deployment's PE server(s). The upgrade capability is limited to PE 3.x deployments; to upgrade PE agents on PE 2015.x and later deployments, please use the puppetlabs-puppet_agent module.

Because pe_repo on PE 3.x doesn't include the Windows agents, they can be supported by hosting the Windows PE agent installers on SMB shares.

##Setup

###What puppet_ent_agent affects

  • puppet.conf configuration file.
  • PE agent service (PE 3.x: pe-puppet; PE 2015.x and later: puppet) (Note: Service is not managed on Solaris systems running PE 3.x agent to avoid a resource conflict with puppet_agent module.)
  • /usr/bin links for facter, hiera, puppet, pe-man binaries (Unix/Linux)
  • pe-agent package (and pe-* packages related to PE; PE 3.x only)

###Beginning with puppet_ent_agent

include '::puppet_ent_agent' is enough to get you up and running.

class { '::puppet_ent_agent':
  agent_caserver => 'puppetca.company.lan',
  ensure         => '3.8.3'
  windows_source => '\\myfileserver\pe-agent'
}

###Parameters

The following parameters are available in the puppet_ent_agent module:

####config

Path to the puppet.conf file. Defaults:

  • Unix/Linux: /etc/puppetlabs/puppet/puppet.conf
  • Windows: ${appdata}/PuppetLabs/puppet/etc/puppet.conf

####curl_path

Path to the curl binary (AIX and Solaris only). Defaults to /usr/bin/curl

####ensure

Default setting: 'present'

To disable PE agent upgrades, leave this set to 'present'. On PE 2015.x and later agents, it will be ignored.

To upgrade managed agents to a specific PE 3.x version, specify a PE agent version available on your pe_repo PE masters and/or Windows PE agent source.

If the pe_repo package repository of the specified version is not present on the pe_repo server, the module will fail. This module does not manage pe_repo.

####master

Hostname of a PE master with the required pe_repo classes properly applied to it. Defaults to the PE master that compiled the agent's catalog.

####agent_server & agent_caserver & agent_fileserver & agent_environment & agent_splay

Sets the server, ca_server, archive_file_server, environment, and splay settings in the agent's puppet.conf file.

The server settings default to undef and do not manage the settings unless overridden in node classification. agent_environment defaults to 'production'.

####agent_remove_modulepath

If set to true the module will ensure the deprecated modulepath setting is removed from puppet.conf. Default is 'false'.

####manage_symlinks

If set to 'true' the module will create symlinks to hiera, puppet, facter, etc in /usr/bin. (Unix/Linux only) Default is 'true'.

####staging_dir

The directory that will be used on non-Windows hosts to temporarily hold the PE Agent installation script. This defaults to '/tmp/puppet_ent_agent'.

####timeout

The time to wait for agent upgrade installation process to finish on Unix/Linux nodes

####windows_source

A UNC path to a publicly-readable SMB share that contains the PE Agent for Windows MSI files. Ensure that both 32-bit and 64-bit installers are hosted there; the default file names are assumed:

  • 32-bit installer: puppet-enterprise-<version>.msi
  • 64-bit installer: puppet-enterprise-<version>-x64.msi

The author recommends the use of Distributed File Services (DFS) namespaces with multiple folder targets to efficiently provide a single UNC path to the files for multi-site deployments.

####windows_task_min

The number of minutes to delay a scheduled task that will be configured to run an upgrade of the PE agent on a managed Windows system, if required. Defaults to 10 minutes. This is meant to allow an upgrade of the PE agent while it's not applying a catalog.

##Limitations

This module depends completely on the correct pe_repo classes being added to the target Puppet Enterprise master servers. If agent installers aren't present, the install class of this module will fail. Best practice is to add pe_repo classes corresponding to the OS families and architectures of all nodes managed in your infrastructure.

Windows support requires the MSI installers for the PE Agent for Windows to be hosted outside of the PE environment. PowerShell is required for upgrade support.

AIX, Debian/Ubuntu, and Windows OS Families have been tested. RedHat and Solaris testing is in progress, but should work. Windows support was changed to a scheduled task after it was found that managing the PE agent as a Puppet package resource produced unpredictable behavior and is not supported by Puppet Labs.

To upgrade PE agents on PE 2015.x and above deployments, please use the puppetlabs-puppet_agent module. Note that puppet_ent_agent and puppet_agent both manage puppet.conf, so only one of them can be classified at a time. On PE 2015.x deployments I recommend using puppet_ent_agent to proactively manage puppet.conf, and using puppet_agent as a tool to effect mass agent upgrades.