Using Artifactory 6.x ?
JFrog Artifactory 6.x User Guide
Have a question? Want to report an issue? Contact JFrog support
Artifactory allows you to define any layout for your Puppet repositories. To upload a module according to your custom layout, you need to package your Puppet files using
puppet module build.
This creates a .tar.gz file for your module which you can then upload to any path within your local Puppet repository.
Remote Puppet Repository
Artifacts (such as tar.gz files) requested from a remote repository are cached on demand. You can remove downloaded artifacts from the remote repository cache, however, you can not manually deploy artifacts to a remote Puppet repository.
To define a remote repository to proxy a remote Puppet resource follow the steps below:
- In the Admin module, under Repositories | Remote, click "New".
- In the New Repository dialog, set the Package Type to Puppet, set the Repository Key value, and specify the URL to the remote repository in the URL field as displayed below.
- Click "Save & Finish".
Virtual Puppet Repository
A virtual repository, in Artifactory, aggregates modules from both local and remote repositories.
This allows you to access both locally hosted Puppet modules and those from remote proxied Puppet repositories from a single URL defined for the virtual repository.
To define a virtual Puppet repository, create a virtual repository, set the Package Type to Puppet, and select the underlying local and remote Puppet repositories to include in the Basic settings tab.
Click "Save & Finish" to create the repository.
Using the Puppet Command Line
When accessing a Puppet repository through Artifactory, the repository URL path must be prefixed with api/puppet.
This applies to all Puppet commands including
puppet module install and
puppet module search.
For example, if you are using Artifactory standalone or as a local service, you would access your Puppet repositories using the following URL:
Or, if you are using Artifactory SaaS the URL would be:
To use the Puppet command line you need to make sure Puppet is installed on your client.
Once you have created your Puppet repository, you can select it in the Tree Browser and click the Set Me Up button to get useful code snippets. These allow you to change your Puppet repository URL in the puppet.conf file, and resolve modules using the Puppet command line tool.
Replacing the default repository
To replace the default repository with a URL pointing to a Puppet repository in Artifactory, add following in your puppet.conf file:
Note: This example uses a repository with the key puppet
Tip: We recommend referencing a Virtual Repository URL as a repository. This gives you the flexibility to reconfigure and aggregate other external sources and local repositories of Puppet modules you deploy.
Note that if you do this, you can also use the
--module_repository parameter to specify the local repository from which you want to resolve your module when using the Puppet module install command.
Once the Puppet command line tool is configured, every
puppet module install command will fetch packages from the Puppet repository specified above. For example:
librarian-puppet is a bundler for your Puppet infrastructure. From version 5.4.5, you can use librarian-puppet with Artifactory as a Puppet repository to manage the Puppet modules your infrastructure depends on.
To configure librarian-puppet to fetch modules from Artifactory, add the following to your
For example, a Puppetfile that uses librarian-puppet could look something like this:
To fetch and install the Puppet modules from Artifactory, run the following command:
r10k is a Puppet environment and module deployment tool. From version 5.4.5, you can use r10k to fetch Puppet environments and modules from an Artifactory Puppet repository for deployment.
To configure r10k to fetch modules from Artifactory, add the following to your
To fetch and install the Puppet modules from Artifactory, run the following command:
Puppet Publish (Deploying Modules)
Setting Your Credentials
To support authentication, you need to add your Artifactory credentials to your
Note: your credentials should be formatted as
username:password as a Base64 encoded strings
Your Artifactory credentials, formatted
username:password as Base64 encoded strings.
Make sure you have an Artifactory user in order to publish modules.
Deploying Your Modules
There are two ways to deploy packages to a local repository:
Using the Artifactory UI
Once you have created your Puppet repository, you can select it in the Tree Browser and click Deploy to upload Puppet module.
Select your module(s), and click Deploy.
- Using Artifactory REST API
curl -uadmin:AP7eCk6M6JokQpjXbkGytt7r4sf -XPUT http://localhost:8080/artifactory/puppet-local/<TARGET_FILE_PATH> -T <PATH_TO_FILE>
Working with Artifactory without Anonymous Access
By default, Artifactory allows anonymous access to Puppet repositories. This is defined in the Admin module under Security | General. For details please refer to Allow Anonymous Access.
To be able to trace how users interact with your repositories, you need to uncheck the Allow Anonymous Access setting. This means that users will be required to enter their username and password as described in Setting Your Credentials above.
Artifactory supports a variety of ways to search for artifacts. For details, please refer to Searching Artifacts.
Artifactory also supports, the
puppet module search [search terms ...] command. However, a module may not be available immediately after being published, for the following reasons:
- When publishing modules to a local repository, Artifactory calculates the search index asynchronously and will wait for indexing the newly published module.
- Since a virtual repository may contain local repositories, a newly published package may not be available immediately for the same reason.
- In the case of remote repositories, a new package will only be found once Artifactory checks for it according to the Retrieval Cache Period setting.
Artifactory annotates each deployed or cached Puppet module with two properties:
You can use Property Search to search for Puppet packages according to their name or version.
Cleaning Up the Local Puppet Cache
The Puppet client saves caches of modules that were downloaded, as well as their JSON metadata responses (called
The JSON metadata cache files contain the Puppet modules metadata.
We recommend removing the Puppet caches, both modules and metadata, before using Artifactory for the first time. This is to ensure that your caches only contain elements that are due to requests from Artifactory and not directly from https://forge.puppet.com.
Viewing Individual Puppet Module Information
Artifactory lets you view selected Puppet module metadata directly from the UI.
Drill down in the Tree Browser and select the tar.gz file you want to inspect, and view the metadata in the Puppet Info tab.
Using Puppet 4.9.1 and Below
Up till version 4.9.1, the Puppet client does not support context path for remote Puppet Forge repositories. Therefore, we recommend using Artifactory with Puppet 4.9.2 and above.
If you need to use Puppet 4.9.1 and below you can use a workaround which uses NGINX or Apache to rewrite all requests from
For example, if you have a repository called
puppet-virtual, and you are using Puppet 3.0, you would configure your proxy server to rewrite
The following sections show sample configurations for NGINX and Apache for both the ports method and the sub-domain method to use a virtual repository named
Once you have your reverse proxy configured, you can install modules from Artifactory using the following commands:
The following REST API endpoints are available to facilitate automation for configuration management with Puppet. Artifactory also uses these endpoints to support the
Get Puppet Modules
Returns a list of all Puppet modules hosted by the specified repository.
For details, please refer to Get Puppet Modules in the Artifactory REST API documentation.
Get Puppet Module
Returns information about a specific Puppet module
For details, please refer to Get Puppet Module in the Artifactory REST API documentation.
Get Puppet Releases
Returns a list of all Puppet releases hosted by the specified repository.
For details, please refer to Get Puppet Releases in the Artifactory REST API documentation.
Get Puppet Release
Returns information about the specific Puppet module's release.
For details, please refer to Get Puppet Release in the Artifactory REST API documentation.