Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

puppet

Puppet agent and server configuration
Project URLRSS FeedReport issues

1,802,821 downloads

1,553 latest version

5.0 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

  • 20.0.0 (latest)
  • 19.2.0
  • 19.1.0
  • 19.0.0
  • 18.0.0
  • 17.1.0
  • 17.0.0
  • 16.5.0
  • 16.4.0
  • 16.3.0
  • 16.2.0
  • 16.1.0
  • 16.0.0
  • 15.2.0
  • 15.1.0
  • 15.0.0
  • 14.2.1
  • 14.2.0
  • 14.1.0
  • 14.0.0
  • 13.0.0
  • 12.1.0
  • 12.0.1
  • 12.0.0
  • 11.0.1
  • 11.0.0
  • 10.1.0
  • 10.0.0
  • 9.1.0
  • 9.0.3
  • 9.0.1
  • 9.0.0
  • 8.2.0
  • 8.1.0
  • 8.0.4
  • 8.0.3
  • 8.0.2
  • 8.0.1
  • 8.0.0
  • 7.1.4
  • 7.1.3
  • 7.1.2
  • 7.1.1
  • 7.1.0
  • 7.0.2
  • 7.0.1
  • 7.0.0
  • 6.0.1
  • 6.0.0
  • 5.0.1
  • 5.0.0
  • 4.3.2
  • 4.3.1
  • 4.3.0
  • 4.2.0
  • 4.1.0
  • 4.0.2 (deleted)
  • 4.0.1
  • 4.0.0
  • 3.0.0
  • 2.3.1
  • 2.3.0
  • 2.2.1
  • 2.2.0
  • 2.1.2
  • 2.1.1
  • 2.1.0
  • 2.0.0 (deleted)
  • 1.4.0
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.2.0-rc3-1 (pre-release)
  • 1.2.0-rc3 (pre-release)
  • 1.2.0-rc2 (pre-release)
  • 1.2.0-rc1 (pre-release)
released Aug 12th 2024
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
  • , , , , , , , , , , , Archlinux, ,

Start using this module

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

Add this module to your Puppetfile:

mod 'theforeman-puppet', '20.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add theforeman-puppet
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install theforeman-puppet --version 20.0.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
Tags: foreman, puppet, puppetserver, puppet-server

Documentation

theforeman/puppet — version 20.0.0 Aug 12th 2024

Puppet Forge CI

Puppet module for installing the Puppet agent and server

Installs and configures the Puppet agent and optionally a Puppet server (when server is true). Part of the Foreman installer or to be used as a Puppet module.

Many puppet.conf options for agents, servers and other are parameterized, with class documentation provided at the top of the manifests. In addition, there are hash parameters for each configuration section that can be used to supply any options that are not explicitly supported.

Compatibility

See the module metadata for supported operating systems and compatible Puppet versions. The Puppetserver version should also match this.

Environments support

The module helps configure Puppet environments using directory environments. These are set up under /etc/puppetlabs/code/environments.

Git repo support

Environments can be backed by git by setting server_git_repo to true, which sets up /var/lib/puppet/puppet.git where each branch maps to one environment. Avoid using 'server' as this name isn't permitted. On each push to the repo, a hook updates /etc/puppet/environments with the contents of the branch.

Permissions can be controlled via the git_repo_{user,group,hook_mode,umask} parameters.

Requires puppetlabs/vcsrepo >= 5.2.0.

Foreman integration

The Foreman integration is optional, but on by default when server is true. It can be disabled by setting server_foreman to false.

Requires theforeman/puppetserver_foreman.

Since version 15.0.0 the integration bits depend on the standalone module where previously it depended on theforeman/foreman

There is also optional integration for katello/certs. This can be enabled via Hiera:

puppet::server::foreman::katello: true

Then the foreman_ssl_{ca,cert,key} parameters are ignored and certs::puppet is used as a source.

PuppetDB integration

The Puppet server can be configured to export catalogs and reports to a PuppetDB instance, using the puppetlabs/puppetdb module. Use its puppetdb::server class to install the PuppetDB server and this module to configure the Puppet server to connect to PuppetDB.

Requires puppetlabs/puppetdb

class { 'puppet':
  server              => true,
  server_reports      => 'puppetdb,foreman',
  server_storeconfigs => true,
}
class { 'puppet::server::puppetdb':
  server => 'mypuppetdb.example.com',
}

Above example manages Puppetserver + PuppetDB integration. It won't install the PuppetDB. To do so, you also need the puppetdb class

class { 'puppet':
  server              => true,
  server_reports      => 'puppetdb,foreman',
  server_storeconfigs => true,
}
include puppetdb
class { 'puppet::server::puppetdb':
  server => 'mypuppetdb.example.com',
}

Then the PuppetDB module will also configure postgresql and setup the database. If you want to manage postgresql installation on your own:

class { 'postgresql::globals':
  encoding            => 'UTF-8',
  locale              => 'en_US.UTF-8',
  version             => '15',
  manage_package_repo => true,
}
class { 'postgresql::server':
  listen_addresses => '127.0.0.1',
}
postgresql::server::extension { 'pg_trgm':
  database => 'puppetdb',
  require  => Postgresql::Server::Db['puppetdb'],
  before   => Service['puppetdb'],
}
class { 'puppetdb':
  manage_dbserver => false,
}
class { 'puppet::server::puppetdb':
  server => 'mypuppetdb.example.com',
}

Above code will install Puppetserver/PuppetDB/PostgreSQL on a single server. It will use the upstream postgresql repositories. It was tested on Ubuntu.

Please also make sure your puppetdb ciphers are compatible with your puppet server ciphers, ie that the two following parameters match:

puppet::server::cipher_suites
puppetdb::server::cipher_suites

Installation

Available from GitHub (via cloning or tarball), Puppet Forge or as part of the Foreman installer.

Usage

As a parameterized class, all the configurable options can be overridden from your wrapper classes or even your ENC (if it supports param classes). For example:

# Agent and cron (or daemon):
class { 'puppet': runmode => 'cron', agent_server_hostname => 'hostname' }

# Agent and puppetserver:
class { 'puppet': server => true }

# You want to use git?
class { 'puppet':
  server          => true
  server_git_repo => true
}

# Maybe you're using gitolite, new hooks, and a different port?
class { 'puppet':
  server                   => true
  server_port              => 8141,
  server_git_repo          => true,
  server_git_repo_path     => '/var/lib/gitolite/repositories/puppet.git',
  server_post_hook_name    => 'post-receive.puppet',
  server_post_hook_content => 'puppetserver/post-hook.puppet',
}

# Configure server without Foreman integration
class { 'puppet':
  server                => true,
  server_foreman        => false,
  server_reports        => 'store',
  server_external_nodes => '',
}

# Want to integrate with an existing PuppetDB?
class { 'puppet':
  server              => true,
  server_reports      => 'puppetdb,foreman',
  server_storeconfigs => true,
}
class { 'puppet::server::puppetdb':
  server => 'mypuppetdb.example.com',
}

Look in init.pp for what can be configured this way, see Contributing if anything doesn't work.

To use this in standalone mode, edit a file (e.g. install.pp), put in a class resource, as per the examples above, and the execute puppet apply e.g:

puppet apply --modulepath /path_to/extracted_tarball <<EOF
class { 'puppet': server => true }
EOF

Advanced scenarios

An HTTP (non-SSL) puppetserver instance can be set up (standalone or in addition to the SSL instance) by setting the server_http parameter to true. This is useful for reverse proxy or load balancer scenarios where the proxy/load balancer takes care of SSL termination. The HTTP puppetserver instance expects the X-Client-Verify, X-SSL-Client-DN and X-SSL-Subject HTTP headers to have been set on the front end server.

The listening port can be configured by setting server_http_port (which defaults to 8139).

For puppetserver, this HTTP instance accepts ALL connections and no further restrictions can be configured.

Note that running an HTTP puppetserver is a huge security risk when improperly configured. Allowed hosts should be tightly controlled; anyone with access to an allowed host can access all client catalogues and client certificates.

# Configure an HTTP puppetserver vhost in addition to the standard SSL vhost
class { '::puppet':
  server               => true,
  server_http          => true,
  server_http_port     => 8130, # default: 8139
}

Contributing

  • Fork the project
  • Commit and push until you are happy with your contribution

More info

See https://theforeman.org or at #theforeman irc channel on freenode

Copyright (c) 2010-2012 Ohad Levy

This program and entire repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.