Recipes¶

Mirror Puppet Forge¶

Start by creating a new repository that includes the URL for Puppet Forge. Use any repo-id you like, as long as it is unique within Pulp.

$ pulp-admin puppet repo create --repo-id=forge --feed=http://forge.puppetlabs.com
Successfully created repository [forge]

Next synchronize the repository, which downloads all of the modules into the local repository.

$ pulp-admin puppet repo sync run --repo-id=forge
+----------------------------------------------------------------------+
                    Synchronizing Repository [forge]
+----------------------------------------------------------------------+

This command may be exited by pressing ctrl+c without affecting the actual
operation on the server.

Downloading metadata...
[==================================================] 100%
Metadata Query: 1/1 items
... completed

Downloading new modules...
[==================================================] 100%
Module: 669/669 items
... completed

Publishing modules...
[==================================================] 100%
Module: 669/669 items
... completed

Generating repository metadata...
[\]
... completed

Publishing repository over HTTP...
... completed

Publishing repository over HTTPS...
... skipped

Let’s take a moment to display the repository and admire your work!

$ pulp-admin puppet repo list
+----------------------------------------------------------------------+
                          Puppet Repositories
+----------------------------------------------------------------------+

Id:                 forge
Display Name:       forge
Description:        None
Content Unit Count: 669

Also point a browser to http://localhost/pulp/puppet/forge/ (adjust the host name as needed) to view the published repository.

Install Modules¶

Installing With Puppet Client 3.3+¶

To install from a specific pulp repository, the forge URL is formed as http://<hostname>/pulp_puppet/forge/repository/<repository_id>. To install as a consumer from any bound repository, the URL is formed as http://<hostname>/pulp_puppet/forge/consumer/<consumer_id>.

For example, to install module puppetlabs-stdlib from the repository “demo”, run the following command.

$ puppet module install --module_repository=http://localhost/pulp_puppet/forge/repository/demo puppetlabs-stdlib

Or to install module puppetlabs-stdlib as the consumer “con1” from any repository to which that consumer is bound, run the following command.

$ puppet module install --module_repository=http://localhost/pulp_puppet/forge/consumer/con1 puppetlabs-stdlib

Installing With Puppet Client < 3.3¶

You might notice that this command does not work:

$ puppet module install --module_repository http://localhost/pulp/puppet/forge author/name

For technical reasons described in the note below, the puppet module install tool in versions prior to 3.3 ignores the part of the URL after the host name, which means we cannot put the repository ID in the URL. We have a work-around that will still allow you to use the puppet module install command with Pulp, and it involves the use of basic auth credentials as part of the URL.

Note

Puppet Forge implements a web API that their client uses to obtain dependency data when installing a module. Unfortunately, their command line tool has hard-coded absolute paths instead of relative, which means the API must live at the root of a web server. As a result, we cannot put the repository ID in the path as you would expect with the above example.

Consumer ID For a consumer registered with Pulp, just specify its consumer ID as the username in the URL, and a ”.” for the password. A consumer’s ID is a unique identifier just like a username, so this isn’t actually a bad use of that field. When a consumer ID is provided, Pulp searches all of that consumer’s bound repositories for either the newest version of the requested module, or if a version is specified, searches for the exact version requested. Once a suitable module has been located in a bound repository, all dependency data returned is scoped to that same repository.

$ puppet module install --module_repository http://consumer1:.@localhost

Repository ID For machines that are not bound to a repository, or for a bound machine where you want to specify a repository, do so in the password field. If a repository ID is specified, any value in the username field is ignored. To keep the convention, use a single ”.” as a null value.

$ puppet module install --module_repository http://.:forge@localhost

The repository URL can be set in /etc/puppet/puppet.conf so that it does not need to be provided on the command line every time. See Puppet’s own documentation for details.

Note

The dependency API from Puppet Forge has been re-implemented by Pulp and can be accessed at /api/v1/releases.json. Puppet Forge also implements a search API that Pulp has not re-implemented due to even more restrictive use of absolute URLs in the puppet tool.

At this time, Puppet Labs is working on a new version of their API that will include public documentation, and we believe that new API will be much easier to integrate with.

Installing With r10k¶

You can use r10k with Pulp to install a set of Puppet modules specified in a Puppetfile.

The repository URL must be set in the r10k.yaml configuration file in order for r10k to connect to Pulp instead of the default puppet forge. See the r10k documentation for details and the specific location of this file in your environment.

For technical reasons described in the note below, r10k ignores the part of the URL after the host name, which means we cannot put the repository ID in the URL. We have a work-around that will still allow you to use r10k with Pulp, and it involves the use of basic auth credentials as part of the URL.

Note

Puppet Forge implements a web API that r10k uses to obtain the download location of modules that it needs to install. Unfortunately, r10k has hard-coded absolute paths instead of relative, which means the API must live at the root of a web server. As a result, we cannot put the repository ID in the path as you would expect with the above example.

Consumer ID For a consumer registered with Pulp, just specify its consumer ID as the username in the URL, and a ”.” for the password. A consumer’s ID is a unique identifier just like a username, so this isn’t actually a bad use of that field. When a consumer ID is provided, Pulp searches all of that consumer’s bound repositories for the exact version of each module defined in the Puppetfile.

forge:
  baseurl: 'http://consumer1:.@localhost'

Repository ID For machines that are not bound to a repository, or for a bound machine where you want to specify a repository, do so in the password field. If a repository ID is specified, any value in the username field is ignored. To keep the convention, use a single ”.” as a null value.

forge:
  baseurl: 'http://.:forge@localhost'

Note

At this time, Pulp requires that all modules defined in a Puppetfile have their versions explicitly declared. For any modules that do not have versions specified in the Puppetfile, r10k will attempt to search for the latest version of the module by using modules endpoint of the Puppet Forge v3 API, which is not currently supported by Pulp.

Puppet Consumers¶

Puppet modules installed on puppet masters can be managed with Pulp’s consumer features. Start by registering the system as a consumer. This process only needs to happen once, after which the consumer can bind to repositories of any content type (puppet modules, RPMs, or any other content supported by Pulp). Note that the following command requires root privileges.

$ sudo pulp-consumer register --consumer-id=fred
Enter password:
Consumer [fred] successfully registered

Next the consumer should be bound to a repository. This can be done with the pulp-consumer command from a shell on the consumer machine.

$ pulp-consumer puppet bind --repo-id=forge
Bind tasks successfully created:

Task Id: 9531a15f-d19d-4c77-9a61-ac67e1223c93

Task Id: 9f06e091-e54c-47d4-8b17-cebfc4451215

The same could be accomplished using the pulp-admin command, which interacts with the Pulp server. The server then notifies the consumer of the binding.

$ pulp-admin puppet consumer bind --repo-id=forge --consumer-id=fred
Bind tasks successfully created:

Task Id: 88a49289-2dc8-49f3-9050-92bcd8ddc8de

Task Id: 8e8f3cd7-420e-447c-8feb-8cf5703a2324

Either way, we can now see from pulp-admin that the consumer is bound to the repository with ID “forge”.

$ pulp-admin consumer list
+----------------------------------------------------------------------+
                               Consumers
+----------------------------------------------------------------------+

Id:            fred
Display Name:  fred
Description:   None
Bindings:
  Confirmed:   forge
  Unconfirmed:
Notes:

Install¶

For install requests, Pulp will search all repositories to which the consumer is bound to find the requested module. If no version is specified, it will find the newest version available. Once the module has been found in a repository, dependency resolution will occur only within that repository. The install command will automatically install any dependencies.

This example installs a specific version of the puppetlabs/stdlib module.

$ pulp-admin puppet consumer install run --consumer-id=fred -u puppetlabs/stdlib/3.1.1
This command may be exited via ctrl+c without affecting the request.

[\]
1 change was made

Install Succeeded

Update¶

Updates follow the same repository matching process as installs. This example updates the puppetlabs/stdlib module. Since a version is not specified, the newest available version will be installed.

$ pulp-admin puppet consumer update run --consumer-id=fred -u puppetlabs/stdlib
Update task created with id [ 672d34e9-e0c3-40ea-942f-76da2d7dbad1 ]

This command may be exited via ctrl+c without affecting the request.

[|]
1 change was made

Update Succeeded

Uninstall¶

Uninstall requests merely uninstall the specified module.

$ pulp-admin puppet consumer uninstall run --consumer-id=fred -u puppetlabs/stdlib
Uninstall task created with id [ 0f040d05-d37d-4a4d-a1aa-1c882aeea771 ]

This command may be exited via ctrl+c without affecting the request.

[-]
Waiting to begin
1 change was made

Uninstall Succeeded

Building and Importing Modules¶

Start by creating a working directory. The directory will be used for git cloning and for building puppet modules. This directory will be the feed for our Pulp repository. Use any directory you like so long as you have write and execute permissions.

$ sudo mkdir -p /opt/puppet/modules
$ sudo chmod -R 777 /opt/puppet

Next, create a new repository that specifies a feed URL for the directory that will be created in a subsequent step. Use any repo-id you like, as long as it is unique within Pulp.

$ pulp-admin puppet repo create --repo-id=puppet-builds --feed=file:///opt/puppet/modules/
Successfully created repository [puppet-builds]

Next, build the puppet modules from source. The pulp-puppet-module-builder tool is provided with Pulp puppet support to make this step easier. The tool uses the puppet module tool to build modules. It also supports basic Git repository operations such a cloning and the checkout of branches and tags to simplify the building and importing of pupppet modules from git repositories.