Puppet
Create a Puppet registry, generate an identity token, then publish and install private Puppet modules using the Puppet CLI or r10k.
Use a Puppet registry to host private Puppet modules. The registry works with both the Puppet CLI and r10k.
What you will learn from this topic
By the end of this quickstart guide, you will be able to:
Create a registry in Harness Artifacts.
Publish a package to the registry.
Install the package from the registry, and confirm the working.
Before you begin
Install the Puppet CLI (
puppet) or r10k (r10k) on your local machine.Install the Harness CLI (
hc). You use it to publish packages to your registry.Make sure you have access to a Harness account with permission to create registries and connectors.
Create a Puppet registry
To create a Puppet registry, perform the following steps:
In Artifact Registry, select Registries.
Select + Create Registry.
Specify the Registry name.
Optionally, add a Description.
Choose visibility between Public and Private. The default is Private.
Select Puppet as the Registry type.
Click Save.
Select Create to finalize.
Configure an upstream proxy (optional)
An upstream proxy allows your registry to fetch Puppet modules from external sources, such as the Puppet Forge, when they are not available locally. The default upstream is https://forgeapi.puppet.com.
Create upstream proxy
To create an upstream proxy, perform the following steps:
In Artifact Registry, select Registries.
Select the drop-down next to + Create Registry and select Upstream Proxy.
Specify the Registry name.
Optionally, add a Description.
Choose visibility between Public and Private. The default is Private.
Select Puppet as the Registry type.
Select the Source: Puppet Forge or Custom.
If you select Custom, specify the Remote registry URL (for example,
https://forgeapi.puppet.com).
Select the Authentication method.
Username and password: Specify the username and password. Use an existing secret, or create a new secret by specifying the Name and entering the Secret text.
Anonymous: No credentials required. This works for the public Puppet Forge.
Optionally, configure Metadata configuration:
Metadata cache TTL (seconds)
Negative cache TTL (seconds)
Select Create to finalize.
Configure the upstream proxy in your registry
To configure the upstream proxy in your registry, perform the following steps:
In Artifact Registry, select an existing Puppet Artifact.
Navigate to the Configuration tab.
Select Edit in the Upstream proxy section.
Click + Add upstream proxy.
Select the required proxy from the list.
Click Apply.
Select Update to finalize.
Puppet client setup
In your Puppet Artifact, select the registry, then select Set Up Client. The dialog gives you an identity token, then setup instructions for the Puppet CLI or r10k.
Generate an identity token
An identity token serves as the password for authenticating with the registry.
In your Puppet Artifact Registry, select Set Up Client.
Select Generate Token.
Select an Expiration for the token:
30 Days
90 Days
180 Days
Custom
Copy the token. You use it in the following steps in place of
<IDENTITY_TOKEN>.
Configure the client
Select Puppet CLI or r10k for your client. In the code samples, replace the values in angle brackets with your own values.
1. Configure puppet.conf
Edit /etc/puppetlabs/puppet/puppet.conf:
2. Publish the module
Upload the module tarball to the registry:
3. Use the module
Install the module using the Puppet CLI:
1. Configure r10k.yaml
Edit r10k.yaml:
2. Publish the module
Upload the module tarball to the registry:
3. Use the module
Add the module to your Puppetfile:
Resolve the Puppetfile:
Setup verification
Confirm that your registry serves the module you published. To verify your setup, perform the following steps:
In a new directory with no cached Puppet modules and no existing
Puppetfile.lock, use the Puppet CLI or r10k to install or resolve the module you published.Confirm that the client downloaded the module from your Harness registry address, which is shown in Set Up Client.
In Harness, open your registry and confirm that the module and version appear in the package list.
If a step fails, go to Troubleshooting to resolve common authentication and resolution issues before you retry.
Pipeline automation (optional)
Publishing from a pipeline gives you a repeatable release process. Run the publish step when you create a version tag, so each release maps to one version in the registry.
The following Run step shows the shape of a publish step. Store the identity token as a Harness secret, and do not write it into the pipeline YAML.
Troubleshooting
Next steps
To add a pipeline that publishes a new version for every release tag, go to Harness CI.
To control who can publish and consume packages in your registry, go to RBAC and permissions.
To set retention and lifecycle rules for old versions, go to Lifecycle Management overview.
Last updated
Was this helpful?