Forge Home

Modules

Resources

PuppetEcosystemPuppet CommunityUpdates

puppet_ent_agent

Management of Puppet Enterprise agent.
Project URLRSS FeedReport issues

256,084 downloads

241,853 latest version

4.6 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

  • 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 Apr 20th 2015
This version is compatible with:
  • Puppet Enterprise 3.x
  • AIX, , Solaris, , Windows

Start using this module

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

Add this module to your Puppetfile:

mod 'aharden-puppet_ent_agent', '0.1.1'
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 0.1.1

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 0.1.1 Apr 20th 2015

#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 installs, configures and manages the Puppet Enterprise Agent software and the pe-puppet service.

##Module Description

The puppet_ent_agent module 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).

##Setup

###What puppet_ent_agent affects

  • pe-agent package (and pe-* packages related to PE)
  • /etc/puppetlabs/puppet/puppet.conf configuration file.
  • pe-puppet service.

###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',
  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 to /etc/puppetlabs/puppet/puppet.conf)

####package_ensure

Version of pe-agent to ensure, by default this is set to latest, and uses the 'current' package repository on the master. This will auto upgrade agents if master is updated.

If you specify a version number, it may cause issues with general vs specific version differences (ie 3.2.0 vs 3.2.0.el6.1).

See the related version variable documented below for AIX/Solaris/Windows.

####master

Hostname of apt/yum repository with pe-agent packages on it, assumes the hostname is 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

Sets the server, ca_server, archive_file_server and environment 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'.

####staging_dir

The directory that will be used on AIX and Solaris hosts to temporarily hold the PE Agent installation files. This defaults to PE's default: /tmp/puppet-enterprise-installer

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

####version

The desired version of the PE agent to install. This is applicable to the AIX, Solaris, and Windows agents since they don't support package => latest. This defaults to the version of PE on the agent (which means agent upgrades are armed unless a newer version is set in the class declaration or hieradata).

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

AIX, Debian/Ubuntu, and Windows OS Families have been tested. Solaris testing is in progress. RedHat support with yumrepo is potentially problematic on PE <= 3.3 due to bug PUP-2271.