Managing configurations by using Puppet integration

1. Managing Puppet modules on the OpenVox server by 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 OpenVox agent on hosts and for configuration enforcement runs of the OpenVox server.
7. Monitoring configuration management using reports in the Satellite web UI.
8. Configuring email notifications.

Procedure

1. Install OpenVox 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. Optional: If you want manage configuration with Puppet on Capsule Servers, install OpenVox server on Capsule Servers:

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

Procedure

1. In the Satellite web UI, 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 OpenVox agent using a host parameter in global parameters, a host group, or for a single host. Add a host parameter named enable-puppet8, select the boolean type, and set the value to true.

5. Set configuration for the OpenVox agent.

   • If you use an integrated OpenVox 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 OpenVox 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 OpenVox server, such as openvox.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 OpenVox 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 OpenVox 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 OpenVox agent using a host parameter in global parameters or a host group. Add a host parameter named enable-puppet8, select the boolean type, and set the value to true.

3. Specify configuration for the OpenVox 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 OpenVox server, such as openvox.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 OpenVox 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 OpenVox agent configuration even in integrated setups where the OpenVox 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 by using global registration 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 OpenVox agent.

Procedure

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

2. Install the OpenVox agent package:

   # dnf install openvox-agent

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

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

4. Configure the OpenVox 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 OpenVox 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 OpenVox agent.

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

    # puppet ssl bootstrap

Procedure

1. Navigate to forge.puppet.com and search for the Puppet module you want.

2. Choose how to install the Puppet module:

   • To install from the Puppet forge, install the Puppet module on your Satellite Server:

     # puppet module install My_Puppet_Module -i /etc/puppetlabs/code/environments/production/modules

     Use the -i parameter to specify the path and Puppet environment, for example production.

     Once the installation is completed, the output looks as follows:

     Notice: Preparing to install into /etc/puppetlabs/code/environments/production/modules ...
     Notice: Created target directory /etc/puppetlabs/code/environments/production/modules
     Notice: Downloading from https://forgeapi.puppet.com ...
     Notice: Installing -- do not interrupt ...
     /etc/puppetlabs/code/environments/production/modules
     |-| puppetlabs-ntp (v8.3.0)
       |-- puppetlabs-stdlib (v4.25.1) [/etc/puppetlabs/code/environments/production/modules]

   • To install manually, copy the module and its dependencies to Satellite Server:

     $ scp -r My_Puppet_Module root@satellite.example.com:/etc/puppetlabs/code/environments/production/modules/My_Puppet_Module

Procedure

1. Connect to your OpenVox server using SSH and find out where the Puppet modules are located:

   # puppet config print modulepath

   This returns output as follows:

   /etc/puppetlabs/code/environments/production/modules:/etc/puppetlabs/code/environments/common:/etc/puppetlabs/code/modules:/opt/puppetlabs/puppet/modules:/usr/share/puppet/modules

2. If the module is located in the path as displayed above, the following command updates a module:

   # puppet module upgrade module name

1. Global parameters
2. Organization parameters
3. Location parameters
4. Host group parameters
5. Host parameters

Procedure

1. In the Satellite web UI, navigate to Configure > Puppet ENC > Classes.
2. Select the ntp Puppet class to change its configuration.
3. Select the Smart Class Parameter tab and search for servers.
4. Ensure the Override checkbox is selected.
5. Set the Parameter Type drop down menu to array.

6. Insert a list of ntp servers as Default Value:

   ["0.de.pool.ntp.org","1.de.pool.ntp.org","2.de.pool.ntp.org","3.de.pool.ntp.org"]

   An alternative way to describe the array is the yaml syntax:

   - 0.de.pool.ntp.org
   - 1.de.pool.ntp.org
   - 2.de.pool.ntp.org
   - 3.de.pool.ntp.org

7. Click Submit to change the default configuration of the Puppet module ntp.

Procedure

1. In the Satellite web UI, navigate to Configure > Puppet ENC > Classes.
2. Click a class name to select a class.
3. On the Smart Class Parameter tab, select a parameter.
4. Use the Order list to define the hierarchy of the Puppet parameters. The individual host (fqdn) marks the most and the organization context (organization) the least relevant.
5. Check Merge Overrides if you want to add all further matched parameters after finding the first match.
6. Check Merge Default if you want to also include the default value even if there are more specific values defined.
7. Check Avoid Duplicates if you want to create a list of unique values for the selected parameter.
8. The matcher field requires an attribute type from the order list.
9. Optional: Click Add Matcher to add more matchers.
10. Click Submit to save the changes.

Procedure

1. In the Satellite web UI, navigate to Configure > Puppet ENC > Classes.
2. Click a class name to select a class.
3. On the Smart Class Parameter tab, select a parameter.
4. Use the Order list to define the hierarchy of the Puppet parameters. The individual host (fqdn) marks the most and the location context (location) the least relevant.
5. Check Merge Overrides if you want to add all further matched parameters after finding the first match.
6. Check Merge Default if you want to also include the default value even if there are more specific values defined.
7. Check Avoid Duplicates if you want to create a list of unique values for the selected parameter.
8. The matcher field requires an attribute type from the order list. For example, you can choose Paris as location context and set the value to French ntp servers.
9. Optional: Click Add Matcher to add more matchers.
10. Click Submit to save the changes.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click a host name to select a host.
3. Click Edit.
4. On the Host tab, select a Puppet Environment.
5. Select the Puppet ENC tab.
6. Click Override to edit the Puppet parameter.
7. Click Submit to save the changes.

Procedure

1. Edit remote execution settings on Satellite:

   1. In the Satellite web UI, navigate to Administer > Remote Execution Features.
   2. Select the puppet_run_host remote execution feature.
   3. Assign the Puppet Run Once – Script Default job template.
2. To run Puppet on hosts, execute a remote job and select category Puppet and template Puppet Run Once - Script Default. Alternatively, click Run Puppet Once in the Schedule Remote Job drop down menu on the host details page.

Procedure

1. Set the interval when the OpenVox agent runs and sends reports to Satellite:

   1. Connect to your host using SSH.
   2. Add the OpenVox agent run interval to /etc/puppetlabs/puppet/puppet.conf, for example, runinterval = 1h:

2. Set the global out-of-sync interval:

   1. In the Satellite web UI, navigate to Administer > Settings.
   2. On the General tab, edit Out of sync interval. Set a duration, in minutes, after which hosts are considered to be out of sync.

3. Set the Puppet out-of-sync interval:

   1. In the Satellite web UI, navigate to Administer > Settings.
   2. Select the Config Management tab.
   3. In the Puppet interval field, set the value to the duration, in minutes, after which hosts reporting using Puppet are considered to be out of sync.

Procedure

1. In the Satellite web UI, navigate to Configure > Host Groups.
2. Select a host group.
3. On the Parameters tab, click Add Parameter.
4. In the Name field, enter outofsync_interval.
5. From the Type dropdown menu, select integer.
6. In the Value field, enter the new interval in minutes.
7. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click Edit for a selected host.
3. On the Parameters tab, click Add Parameter.
4. In the Name field, enter outofsync_interval.
5. From the Type dropdown menu, select integer.
6. In the Value field, enter the new interval in minutes.
7. Click Submit.