Recipes¶

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.

• 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.

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.

• 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'

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