Code Manager parameters
Parameter | Description | Type | Default value |
---|---|---|---|
r10k_remote (also referred to as Code Manager's global 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 |
String | If r10k_remote is specified in the puppet_enterprise::profile::master class, that value is used here.
Otherwise, there is no default value. |
authenticate_webhook
|
Indicates whether to enable RBAC authentication for the POST /v1/webhook endpoint. | Boolean | true
|
cachedir
|
The file path to the location where Code Manager caches Git repositories. | String | /opt/puppetlabs/server/data/code-manager/cache
|
certname
|
The certname of the Puppet signed certs to use for SSL | String or string variable | $::clientcert
|
data
|
The file path to the directory where Code Manager stores internal file content. | String | /opt/puppetlabs/server/data/code-manager
|
deploy_pool_cleanup_interval
|
Specifies how often workers pause to clean their on-disk caches. If cleanup takes too long, increase this value so that cleanup happens less often. | Integer indicating a 1 out of n percent chance. | 100 (Cleanup occurs after 1 of every 100
code deployments, or after 1% of code deployments.) |
deploy_pool_size
|
Specifies the number of threads in the worker pool, which determines how many deployment processes can run in parallel. | Integer | 2
|
download_pool_size
|
Specifies the number of threads used to download modules. | Integer | 4
|
deploy_ttl
|
For Configuring garbage collection. | String with a required suffix | 1h
|
full_deploy
|
For Configuring module deployment scope. | Boolean | false
|
hostcrl
|
The file path to the SSL CRL. | String or string variable | $puppet_enterprise::params::hostcrl
|
localcacert
|
The file path to the SSL CA cert. | String or string variable | $puppet_enterprise::params::localcacert
|
post_environment_hooks
|
For Configuring post-environment hooks, which are hooks that you want to run after Code Manager deploys an environment. | Array of hashes | No default. |
timeouts_deploy
|
Maximum execution time (in seconds) allowed for deploying a single environment. | Integer | 600
|
timeouts_fetch
|
Maximum execution time (in seconds) allowed for updating the control repo state. | Integer | 30
|
timeouts_hook
|
Maximum time (in seconds) to wait for a single post-environment hook URL to respond. Controls both the socket connect timeout and the read timeout; therefore, the longest total timeout is twice the specified value. | Integer | 30
|
timeouts_shutdown
|
Maximum time (in seconds) to wait for in-progress deployments to complete when shutting down the service. | Integer | 610
|
timeouts_wait
|
Maximum time (in seconds) to wait for the environment's deployment to
finish before timing out. Only applies to requests sent with the
wait key. |
Integer | 700
|
timeouts_sync
|
Maximum time (in seconds) to wait for all compilers to receive deployed
code before timing out. Only applies to requests sent with the
wait key. |
Integer | 300
|
webserver_ssl_host
|
The IP address of the host that Code Manager listens on. | IP address | 0.0.0.0
|
webserver_ssl_port
|
The port that Code Manager listens on. Port 8170 must be open if you're using Code Manager. |
Integer | 8170
|
Code Management parameters
These parameters are NOT part of the
code_manager
class, they are part of the code_management
class. The full parameter names, including class, are
listed below for clarity.Parameter | Description | Type | Default value |
---|---|---|---|
puppet_enterprise::master::code_management::git_provider
|
Whether R10K uses the built in Git library shipped with PE or the system
Git CLI. Consult Support before setting to shellgit . Valid values are one of rugged or shellgit . It is
overridden by puppet_enterprise::profile::master::r10k_git_provider if set. |
String | rugged
|
puppet_enterprise::master::code_management::git_private_key
|
A path on the Primary’s files system to an SSH key that can access Git
repositories that use the SSH protocol. It is overridden by puppet_enterprise::profile::master::r10k_private_key . |
String | No default. We recommend placing the key in the /etc/puppetlabs/puppetserver/ssh/ directory. |
puppet_enterprise::master::code_management::git_default_ref
|
The valid value is the name of a branch that R10K uses if the given ref does not exist. | String | No default. |
puppet_enterprise::master::code_management::git_proxy
|
The proxy to use for Git repos. This is only necessary if there is a
separate proxy for Git repos vs Forge modules. Values include the protocol
and port, for example, http://proxy.example.com:3128 . |
String | No default. |
puppet_enterprise::master::code_management::git_oauth_token
|
The path on the Primary file system OAuth
token to use when authenticating to Git repos that require OAuth tokens. |
String | No default. |
puppet_enterprise::master::code_management::git_repositories
|
An array of objects that contain repo specific configuration. The valid
keys in each object are remote , private-key , proxy , and oauth-token . This is
only required if you have multiple control repos and do not share
authentication methods between them. |
Array | No default. |
puppet_enterprise::master::code_management::forge_proxy
|
The proxy to use to download Forge modules. This is only needed if there
is a Forge specific proxy different from downloading Git repositories.
Values include the protocol and port, for example, http://proxy.example.com:3128 . |
String | No default. |
puppet_enterprise::master::code_management::forge_baseurl
|
An HTTPS address of your custom Forge, if you have one. | String | No default. |
puppet_enterprise::master::code_management::forge_authorization_token
|
The authorization token to your Forge account, if necessary. In the
format of Bearer <TOKEN> . |
String | No default. |
r10k-specific parameters
Code Manager uses r10k in the background. In the context of Code Manager, the following r10k parameters apply.
Parameter | Description | Type | Default value |
---|---|---|---|
environmentdir
|
The file path to the single directory where Code Manager deploys all sources. | String | If file_sync_auto_commit is set to
true , then this defaults to:
/etc/puppetlabs/code-staging/environments |
forge_settings
(deprecated) |
For Configuring Forge settings. | Hash | No default. |
invalid_branches
|
Specifies how you want Code Manager to handle branch names that can't cleanly map to Puppet environment names. | Either of these strings:
|
'error'
|
git_settings
(deprecated) |
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) | No default. |
sources
|
For Configuring sources when you have multiple control repos. | Hash | No default. |