Regenerate certificates in monolithic installations

If your goal is to...	Do this...
Upgrade to the intermediate certificate architecture introduced in Puppet 6.0.	Complete these tasks in order: Delete and recreate the certificate authority Regenerate compiler certificates, if applicable Regenerate agent certificates
Fix a compromised or damaged certificate authority.
Fix a compromised compiler certificate or troubleshoot SSL errors on compilers.	Regenerate compiler certificates
Fix a compromised agent certificate or troubleshoot SSL errors on agent nodes.	Regenerate agent certificates
Specify a new DNS alt name or other trusted data.	Regenerate master certificates

Delete and recreate the certificate authority

Recreate the certificate authority only if you're upgrading to the new certificate architecture introduced in Puppet 6.0, or if your certificate authority was compromised or damaged beyond repair.

Before you begin

The puppet infrastructure run command leverages built-in Bolt plans to automate certain management tasks. To use this command, you must be able to connect using SSH from your master to any nodes that the command modifies. You can establish an SSH connection using key forwarding, a local key file, or by specifying keys in .ssh/config on your master. For more information, see Bolt OpenSSH configuration options.

To view all available parameters, use the --help flag. The logs for all puppet infrastructure run Bolt plans are located at /var/log/puppetlabs/installer/bolt_info.log.

CAUTION: Replacing your certificate authority invalidates all existing certificates in your environment. Complete this task only if and when you're prepared to regenerate certificates for both your infrastructure nodes and your entire agent fleet.

On your master logged in as root, run the command appropriate to your version of PE:

For PE 2019.1.3 and later versions: puppet infrastructure run rebuild_certificate_authority
For PE 2019.1.1 and earlier versions: puppet infrastructure run rebuild_certificate_authority caserver=<CA_SERVER_HOSTNAME>

Tip: If your master operates as your CA server, specify caserver=localhost. Running the command with localhost avoids the requirement to set up SSH between your master and itself.

You can specify this optional parameter:

tmpdir — Path to a directory to use for uploading and executing temporary files.

The SSL and cert directories on your CA server are backed up with "_bak" appended to the end, CA files are removed and certificates are rebuilt, and a Puppet run completes.

Note: To support recovery, backups of your certificates are saved and the location of the backup directory is output to the PE console. If the command fails after deleting the certificates, you can restore your certificates with the contents of this backup directory.

Regenerate compiler certificates

Regnerate compiler certificates to fix a compromised certificate or troubleshoot SSL errors on compilers, or if you recreated your certificate authority.

Before you begin

Configure Puppet Server with allow-subject-alt-names in the certificate-authority section of ca.conf.

If you did not recreate your certificate authority, you must log into your master as root and remove the compiler certificate: puppetserver ca clean --certname <COMPILE_MASTER_HOSTNAME>
Log into the compiler as root and back up the /etc/puppetlabs/puppet/ssl/ directory:
```
cp -r /etc/puppetlabs/puppet/ssl/ /etc/puppetlabs/puppet/ssl_bak/
```

Stop the Puppet agent, Puppet Server, and PXP agent services.

puppet resource service puppet ensure=stopped
puppet resource service pe-puppetserver ensure=stopped
puppet resource service pxp-agent ensure=stopped

Delete the compiler SSL directory: rm -rf /etc/puppetlabs/puppet/ssl
Remove the compiler cached catalog: rm -f /opt/puppetlabs/puppet/cache/client_data/catalog/<CERTNAME>.json
Adjust DNS alt names and trusted data, as needed.
Re-start the Puppet agent service: puppet resource service puppet ensure=running
After the agent starts, it automatically generates keys and request a new certificate from the Puppet CA.
Log into your master as root and sign the compiler's certificate request: puppetserver ca sign --certname <COMPILE_MASTER_HOSTNAME>
Log into your compiler as root and run Puppet: puppet agent -t

PE performs a full catalog run, and the compiler resumes its role in your deployment.

Regenerate agent certificates

Regenerate agent certificates to fix a compromised certificate or troubleshoot SSL errors on agents, or if you recreated your certificate authority.

Before you begin

The puppet infrastructure run command leverages built-in Bolt plans to automate certain management tasks. To use this command, you must be able to connect using SSH from your master to any nodes that the command modifies. You can establish an SSH connection using key forwarding, a local key file, or by specifying keys in .ssh/config on your master. For more information, see Bolt OpenSSH configuration options.

To view all available parameters, use the --help flag. The logs for all puppet infrastructure run Bolt plans are located at /var/log/puppetlabs/installer/bolt_info.log.

On your master logged in as root, run:

puppet infrastructure run regenerate_agent_certificate agent=<AGENT_HOSTNAME>

Important: If you rebuilt the certificate authority, you must clean up the CRL using the clean_crl parameter, for example:

puppet infrastructure run regenerate_agent_certificate agent=<AGENT_HOSTNAME> clean_crl=true

You can also specify these optional parameters:

dns_alt_names – Comma-separated list of alternate DNS names to be added to the certificates generated for your agents.
Important: To use the dns_alt_names parameter, you must configure Puppet Server with allow-subject-alt-names in the certificate-authority section of ca.conf. To ensure naming consistency, if your puppet.conf file includes a dns_alt_names entry, you must include the dns_alt_names parameter and pass in all alt names included in the entry when regenerating your agent certificates.
tmpdir — Path to a directory to use for uploading and executing temporary files.

To regenerate certificates for multiple *nix agents, use a comma-separated list of the agents' hostnames, such as:

puppet infrastructure run regenerate_agent_certificate agent=agent1.example.net,agent2.example.net,agent3.example.net

The *nix agent's SSL directory is backed up to /etc/puppetlabs/puppet/ssl_bak, its certificate is regenerated and signed, a Puppet run completes, and the agent resumes its role in your deployment.

Note: To support recovery, backups of your certificates are saved and the location of the backup directory is output to the PE console. Note that the location shown in the console is relative to your agent's files. If the command fails after deleting the certificates, you can restore your certificates with the contents of this backup directory.

Regenerate master certificates

Regenerate master certificates to specify a new DNS alt name or other trusted data.

Before you begin

The puppet infrastructure run command leverages built-in Bolt plans to automate certain management tasks. To use this command, you must be able to connect using SSH from your master to any nodes that the command modifies. You can establish an SSH connection using key forwarding, a local key file, or by specifying keys in .ssh/config on your master. For more information, see Bolt OpenSSH configuration options.

To view all available parameters, use the --help flag. The logs for all puppet infrastructure run Bolt plans are located at /var/log/puppetlabs/installer/bolt_info.log.

On your master logged in as root, run:

puppet infrastructure run regenerate_master_certificate

You can specify these optional parameters:

dns_alt_names – Comma-separated list of alternate DNS names to be added to the certificates generated for your master.
Important: To use the dns_alt_names parameter, you must configure Puppet Server with allow-subject-alt-names in the certificate-authority section of ca.conf. To ensure naming consistency, if your puppet.conf file includes a dns_alt_names entry, you must include the dns_alt_names parameter and pass in all alt names included in the entry when regenerating your master certificate.
tmpdir — Path to a directory to use for uploading and executing temporary files.

The certificates are regenerated for your primary infrastructure nodes.

Note: To support recovery, backups of your certificates are saved and the location of the backup directory is output to the PE console. If the command fails after deleting the certificates, you can restore your certificates with the contents of this backup directory.