Overview
Artifactory provides full support for managing Puppet modules, ensuring optimal and reliable access toPuppet Forge.By aggregating multiple Puppet repositories under a single virtual repository Artifactoryenables upload and download access to all your Puppet modules through a single URL.
As a fully-fledged Puppet repository, on top of its capabilities foradvanced artifact management, Artifactory's support forPuppetprovides:
- The ability to provision Puppet modules from Artifactory to the Puppet command line tool for all repository types.
- Calculation of Metadata for Puppet modules hosted in Artifactory's local repositories.
- Access to remote Puppet repositories, such as
https://forgeapi.puppetlabs.com/, using theRemote Repositorieswhich provides proxy and caching functionalities. Access to multiple Puppet repositories from a single URL by aggregating them under aVirtual Repositories. This overcomes the limitation of the Puppet client which can only access a single registry at a time.
- Support forflexible puppet repository layoutsthat allow you to organize your Puppet modules, and assign access privileges according to projects or development teams.
Puppet version support
木偶不支持一个上下文路径中on 4.9.1, we recommend using Artifactory with Puppet version4.9.2and above. Please see below if you are usingPuppet 4.9.1 and below.
配置
Local Puppet Repository
To enable calculation of Puppet module metadata in local repositories, from theAdministrationmodule go toRepositories|Repositories|Localset thePackage TypetoPuppetwhen you create the repository.
Repository Layout
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 usingpuppet module build.
This creates a.tar.gzfile for your module which you can then upload to any path within your local Puppet repository.
Remote Puppet Repository
ARemote Repositoriesdefined in Artifactory serves as a caching proxy for a repository managed at a remote URL such ashttps://forgeapi.puppetlabs.com/.
Artifacts (such astar.gzfiles) 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 theAdministrationmodule, underRepositories | Repositories | Remote,clickNew Remote Repository.
- In the New Remote Repository dialog, set thePackage TypetoPuppet, set theRepository Keyvalue, and specify the URL to the remote repository in theURLfield as displayed below.
- ClickSave & Finish.
Virtual Puppet Repository
Avirtualrepository, in Artifactory, aggregates modules from bothlocalandremoterepositories.
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, from theAdministrationmodule, selectRepositories|Repositories|Virtual, set thePackage TypetoPuppet,and select the underlying local and remote Puppet repositories to include in theBasicsettingstab.
ClickSave & Finishto create the repository.
Using the Puppet Command Line
When accessing a Puppet repository through Artifactory, the repository URL path must be prefixed withapi/puppet.
This applies to all Puppet commands includingpuppet module installandpuppet 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:
http://localhost:8081/artifactory/api/puppet/
Or, if you are using Artifactory Cloud the URL would be:
https://.jfrog.io/artifactory/api/puppet/
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 theApplication Module | Artifactory | ArtifactsTree Browser and click theSet Me Upbutton to get useful code snippets. These allow you to change your Puppet repository URL in thepuppet.conffile, 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 yourpuppet.conffile:
Note:This example uses a repository with the keypuppet.
[main] module_repository=http://localhost:8080/artifactory/api/puppet/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_repositoryparameter 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, everypuppet module installcommand will fetch packages from the Puppet repository specified above. For example:
$ puppet module install --module_repository=http://localhost:8080/artifactory/api/puppet/puppet puppetlabs-mysql Notice: Preparing to install into /Users/jainishs/.puppetlabs/etc/code/modules ... Notice: Downloading from http://localhost:8080/artifactory/api/puppet/puppet ... Notice: Installing -- do not interrupt ... /Users/jainishs/.puppetlabs/etc/code/modules └── puppetlabs-mysql (v3.10.0)
Using librarian-puppet
librarian-puppetis a bundler for your Puppet infrastructure.From version 5.4.5, you can use librarian-puppet with Artifactory as a Puppet repository tomanage the Puppet modules your infrastructure depends on.
To configure librarian-puppet to fetch modules from Artifactory, add the following to yourPuppetfile:
forge "http://: /artifactory/api/puppet/ "
For example, a Puppetfile that uses librarian-puppet could look something like this:
forge "http://localhost:8080/artifactory/api/puppet/puppet-local" mod 'puppetlabs-mysql', '3.7.0' mod 'puppetlabs-apache', '1.5.0'
To fetch and install the Puppet modules from Artifactory, run the following command:
librarian-puppet install --no-use-v1-api
Using r10k
r10kis 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 yourr10k.yamlfile:
forge: baseurl: 'http://: /artifactory/api/puppet/ '
For example:
forge: baseurl: 'http://localhost:8080/artifactory/api/puppet/puppet-local'
To fetch and install the Puppet modules from Artifactory, run the following command:
r10k puppetfile install
Puppet Publish (Deploying Modules)
Setting Your Credentials
To support authentication, you need to add your Artifactory credentials to yourpuppet.conffile:
Note: your credentials should be formatted asusername:passwordas aBase64encoded strings
Your Artifactory credentials, formattedusername:passwordasBase64encoded strings.
For example:
[main] module_repository=http://admin:AP7eCk6M6JokQpjXbkGytt7r4sf@localhost:8080/artifactory/api/puppet/puppet-local
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 clickDeployto upload Puppet module.
选择您的模块(s),并单击Deploy.
- Using Artifactory REST API
例如:curl -uadmin:AP7eCk6M6JokQpjXbkGytt7r4sf -XPUThttp://localhost:8080/artifactory/puppet-local/
Working with Artifactory without Anonymous Access
By default, Artifactory allows anonymous access to Puppet repositories. This is defined in theAdministrationmodule underSecurity | General. For details please refer toAllow Anonymous Access.
To be able to trace how users interact with your repositories, you need to uncheck theAllow Anonymous Accesssetting. This means that users will be required to enter their username and password as described inSetting Your Credentialsabove.
Puppet Search
Artifactory supports a variety of ways to search for artifacts. For details, please refer toSearching for Artifacts_OLD. 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 theRetrieval Cache Periodsetting.
Artifactory annotates each deployed or cached Puppet module with two properties:puppet.nameandpuppet.version
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.cache.json).
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 fromhttps://forge.puppet.com.
Viewing Individual Puppet Module Information
Artifactory lets you view selected Puppet module metadata directly from the UI.
Drill down in theTree Browserand select thetar.gzfile you want to inspect, and view the metadata in thePuppet Infotab.
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/v3/*to/artifactory/api/puppet/
For example, if you have a repository calledpuppet-virtual, and you are using Puppet 3.0, you would configure your proxy server to rewrite/v3/*to/artifactory/api/puppet/puppet-virtual/v3/*.
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 namedpuppet-virtual.
Once you have your reverse proxy configured, you can install modules from Artifactory using the following commands:
Ports Method
puppet module install --module_repository http://localhost:8001 puppetlabs-apache
Subdomain Method
puppet module install --module_repository http://puppet-virtual.artifactory-cluster puppetlabs-apache
REST API
The following REST API endpoints are available to facilitate automation for configuration management with Puppet. Artifactory also uses these endpoints to support thelibrarian-puppetandr10kclients:
- Get Puppet ModulesReturns a list of all Puppet modules hosted by the specified repository.
- Get Puppet Module: Returns information about a specific Puppet module.
- Get Puppet Releases: Returns a list of all Puppet releases hosted by the specified repository.
- Get Puppet Release: Returns information about the specific Puppet module's release.
