Repository files navigation

1. Description
2. Setup - The basics of getting started withpuppet
   • Whatpuppet affects
   • Setup requirements
   • Beginning with puppet
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

This Puppet module is primarily designed to manage the Puppet server itself,automating its configuration, deployment, and maintenance tasks. This ensuresthe Puppet server operates efficiently and remains up-to-date.

Additionally, the module includes functionality to manage the Puppet agent as well.

This module can be utilized in two primary ways:

1. As a Regular Puppet Module (e.g., included in a Puppetfile)

   For direct inclusion in your Puppet environment, specify the module in your Puppetfile as follows:

   mod 'puppet',  git: 'https://github.com/aursu/puppet-puppet.git',  tag: 'v0.19.1'

   Alternatively, you can specify the version directly if it’s available from the module repository onPuppet Forge:

   mod 'aursu/puppet', '0.19.1'

2. As a Puppet Server Bootstrap Tool Using Puppet Bolt

   The module includes a Bolt project located in thebootstrap/bolt subfolder. Within this project, there is a Bolt plan namedpuppet_bootstrap::server that is specifically designed for bootstrapping a Puppet server.

   Using this setup with Puppet Bolt facilitates a more efficient and straightforward installation process for the Puppet server. This method provides a predefined sequence of actions that automate much of the manual setup, streamlining the deployment of Puppet server environments. It also significantly reduces the complexity of the initial server configuration.

   Initiate the bootstrapping and subsequent Puppet agent run in the production environment with the following commands:

   bolt plan run puppet_bootstrap::server -t puppetserversbolt plan run puppet_agent::run -t puppetservers environment=production

   For a more detailed description, refer to thebootstrap directory.

When integrated into a Puppet catalog to configure a Puppet server, thepuppet module offers comprehensive control over several crucial configurations and components of both the Puppet server and the overall Puppet infrastructure:

To configure a custom cache directory forr10k instead of the default (/var/cache/r10k, as defined inpuppet::params), there are a few options:

1. Define ther10k_cachedir parameter:

   • If thepuppet::profile::server profile is in use, you can set ther10k_cachedir parameter to the desired cache directory.
   • Similarly, if thepuppet::profile::puppet profile is in use, you can also define this parameter for that profile.

2. Set the global variablepuppet::globals::r10k_cachedir:

   • Alternatively, define the global variablepuppet::globals::r10k_cachedir. This corresponds to ther10k_cachedir parameter in thepuppet::globals class, allowing you to override the default cache directory across the entire configuration. This option is particularly useful when Bolt plans, such aspuppet_bootstrap::server orpuppet::server::bootstrap, are in use.

To schedule ther10k command incron, use thepuppet::r10k_crontab_setup flag. Set this flag totrue to enable the setup ofr10k in the crontab.

Thepuppet::agent::bootstrap class is responsible for bootstrapping a Puppet node. It performs the following steps:

1. First Run:It executes thepuppet agent --test command to initiate the creation of a Puppet private key and request a certificate from the Puppet server.

2. Subsequent Runs:On subsequent executions, it attempts to download the certificate from the Puppet server. If the certificate is not yet available, the agent will continue to attempt fetching it on each run until the certificate is successfully retrieved.

3. Handlingcertname:If acertname is specified during the certificate request, the private key and certificate will be propagated into the appropriate locations using thefqdn (fully qualified domain name), if it differs fromcertname.

The Bolt planpuppet::bootstrap is available to automate the setup of Puppet agents on nodes. This plan performs the following tasks:

1. Install Puppet Agent:It uses thepuppet::agent::install Bolt plan to install the Puppet agent on the target node.

2. Configure Puppet:It configures thepuppet.conf file with the necessary settings, including the Puppet server name and, if provided, thecertname.

3. Run Bootstrap:Finally, it runs thepuppet::agent::bootstrap Bolt plan to initiate the Puppet agent bootstrap process, which handles certificate requests and private key creation.