r10k parameters

The following parameters are available for r10k. Parameters are optional unless otherwise stated.

Parameter Description Type Default value
cachedir The file path to the location where r10k caches Git repositories. String /var/cache/r10k
deploy For Configuring purge levels and Locking r10k deployments. Hash
  • purge_level: ['deployment', 'puppetfile']
  • write_lock: Omitted
forge_settings For Configuring Forge settings. Hash No default.
git_settings For Configuring Git settings. Hash Can use the default private-key value set in console. Otherwise, there are no default settings.
proxy For Configuring proxies. Can be global (all HTTP(s) transports) or part of the git_settings or forge_settings hashes. An empty string or a string indicating a proxy server (with or without authentication) The global proxy can use a *_proxy environment variable, if one is set. Otherwise, there are no defaults.
postrun For Configuring post-deployment commands. Array of strings to use as an argument vector No default.
remote A valid SSH URL specifying the location of your Git control repository, if you have only one control repo.

If you have multiple Git repos, specify sources instead of remote.

 String If r10k_remote is specified in the puppet_enterprise::profile::master class, that value is used here. Otherwise, there is no default value.
r10k_basedir For Configuring the r10k base directory, if you have only one control repo.

If you have multiple Git repos, specify basedir in sources instead.

 String No default, but must match the environmentpath in your puppet.conf file.
sources For Configuring sources if you have multiple control repos. Hash No default.