Chapter 1. Introducing configuration management by using Puppet

1. Enable Puppet integration.
2. Import Puppet agent packages into Satellite. Puppet agent packages can be managed like any other content with Satellite by enabling Red Hat Repositories and by using activation keys and content views.
3. Install Puppet agent on hosts during provisioning, registration, manually, or by remote job execution.

Procedure

1. Enable Puppet integration and install Puppet server on Satellite Server:

   # satellite-installer \
   --enable-foreman-cli-puppet \
   --enable-foreman-plugin-puppet \
   --enable-puppet \
   --foreman-proxy-puppet true \
   --foreman-proxy-puppetca true \
   --puppet-server true

2. If you want to use Puppet integration on Capsule Servers, enable Puppet integration and install Puppet server on Capsule Servers:

   # satellite-installer \
   --enable-puppet \
   --foreman-proxy-puppet true \
   --foreman-proxy-puppetca true \
   --puppet-server true

Procedure

1. Navigate to Hosts > Templates > Provisioning Templates.
2. Select a provisioning template depending on your host provisioning method. For more information, see Kinds of Provisioning Templates in Provisioning hosts.

3. Ensure the puppet_setup snippet is included as follows:

   <%= snippet 'puppet_setup' %>

   Note that this snippet is already included in the templates shipped with Satellite, such as Kickstart default or Preseed default.

4. Enable the Puppet agent using a host parameter in global parameters, a host group, or for a single host. To use Puppet 8, add a host parameter named enable-puppet8, select the boolean type, and set the value to true. To use Puppet 7, add a host parameter named enable-puppet7, select the boolean type, and set the value to true.

5. Set configuration for the Puppet agent.

   • If you use an integrated Puppet server, ensure that you select a Puppet Capsule, Puppet CA Capsule, and Puppet environment when you create a host.

   • If you use a non-integrated Puppet server, either set the following host parameters in global parameters, or a host group, or when you create a host:

     • Add a host parameter named puppet_server, select the string type, and set the value to the hostname of your Puppet server, such as puppet.example.com.
     • Optional: Add a host parameter named puppet_ca_server, select the string type, and set the value to the hostname of your Puppet CA server, such as puppet-ca.example.com. If puppet_ca_server is not set, the Puppet agent will use the same server as puppet_server.
     • Optional: Add a host parameter named puppet_environment, select the string type, and set the value to the Puppet environment you want the host to use.
6. Ensure your host has access to the Puppet agent packages from Satellite Server by using an appropriate activation key.

Procedure

1. In the Satellite web UI, navigate to Configure > Global Parameters to add host parameters globally. Alternatively, you can navigate to Configure > Host Groups and edit or create a host group to add host parameters only to a host group.

2. Enable the Puppet agent using a host parameter in global parameters or a host group.

   Add a host parameter named enable-puppet7, select the boolean type, and set the value to true.

3. Specify configuration for the Puppet agent using the following host parameters in global parameters or a host group:

   • Add a host parameter named puppet_server, select the string type, and set the value to the hostname of your Puppet server, such as puppet.example.com.
   • Optional: Add a host parameter named puppet_ca_server, select the string type, and set the value to the hostname of your Puppet CA server, such as puppet-ca.example.com. If puppet_ca_server is not set, the Puppet agent will use the same server as puppet_server.
   • Optional: Add a host parameter named puppet_environment, select the string type, and set the value to the Puppet environment you want the host to use.

   Until the BZ2177730 is resolved, you must use host parameters to specify the Puppet agent configuration even in integrated setups where the Puppet server is a Capsule Server.

4. Navigate to Hosts > Register Host and register your host using an appropriate activation key. For more information, see Registering Hosts in Managing hosts.
5. Navigate to Infrastructure > Capsules.
6. From the list in the Actions column for the required Capsule Server, select Certificates.
7. Click Sign to the right of the required host to sign the SSL certificate for the Puppet agent.

Procedure

1. Log in to the host as the root user.

2. Install the Puppet agent package.

   • On hosts running Red Hat Enterprise Linux 8 and above:

     # dnf install puppet-agent

   • On hosts running Red Hat Enterprise Linux 7 and below:

     # yum install puppet-agent

3. Add the Puppet agent to PATH in your current shell using the following script:

   . /etc/profile.d/puppet-agent.sh

4. Configure the Puppet agent. Set the environment parameter to the name of the Puppet environment to which the host belongs:

   # puppet config set server satellite.example.com --section agent
   # puppet config set environment My_Puppet_Environment --section agent

5. Start the Puppet agent service:

   # puppet resource service puppet ensure=running enable=true

6. Create a certificate for the host:

   # puppet ssl bootstrap

7. In the Satellite web UI, navigate to Infrastructure > Capsules.
8. From the list in the Actions column for the required Capsule Server, select Certificates.
9. Click Sign to the right of the required host to sign the SSL certificate for the Puppet agent.

10. On the host, run the Puppet agent again:

    # puppet ssl bootstrap

1. Managing Puppet modules on the Puppet server, that is installing and updating them.
2. Importing Puppet classes and environments from Puppet modules into Satellite.
3. Optional: Creating config groups from Puppet classes.
4. Configuring overrides of Smart Class parameters on various levels.
5. Assigning Puppet classes or config groups to host groups or individual hosts.
6. Configuring intervals for runs of the Puppet agent on hosts and for configuration enforcement runs of the Puppet server.
7. Monitoring configuration management using reports in the Satellite web UI. For more information, see Monitoring Resources in Administering Red Hat Satellite.
8. Configuring email notifications. For more information, see Configuring Email Notification Preferences in Administering Red Hat Satellite.

Procedure

1. If you have used Puppet server on any Capsules, disable Puppet server on all Capsules:

   # satellite-maintain plugin purge-puppet --remove-all-data

2. Disable Puppet server on Satellite Server:

   # satellite-maintain plugin purge-puppet --remove-all-data