To configure r10k in an existing Puppet Enterprise (PE) installation, set r10k parameters in the PE console. You can also use the console to adjust r10k settings.
Before you beginYou need a control repo (with a Puppetfile) and the file path for the SSH private key you created when you set up your control repo. For information and instructions on setting up a control repo, go to Managing environments with a control repository.
In the PE console, go to , and locate the
r10k_remoteparameter, enter a string that is a valid SSH URL for your Git control repository, such as
git@<YOUR.GIT.SERVER.COM>:puppet/control.git.Important: Some Git providers have additional requirements for enabling SSH access. For example, BitBucket requires
ssh://at the beginning of the SSH URL (such as
ssh://git@<YOUR.GIT.SERVER.COM>:puppet/control.git). See your provider's documentation for this information.
r10k_private_keyparameter, enter a string specifying the path to the SSH private key you created when you set up your control repo, such as
"/etc/puppetlabs/puppetserver/ssh/id-control_repo.ed25519".This key permits the
pe-puppetuser to access your Git control repo. The private key file must be located on the primary server, owned by the
pe-puppetuser, and in a directory that the
pe-puppetuser has permission to view. We recommend
- Run Puppet on your primary server and compilers.
What to do next
You can customize your r10k configuration in Hiera, if needed.
To deploy environments with r10k, you must use the command line to manually trigger deployments. PE does not automatically run r10k after you configure it.