Orchestrator and pe-orchestration-services parameters

Boolean used to enable or disable the Puppet Execution Protocol (PXP) service.

Set to true to enable the PXP service, which is required to use the orchestrator and run Puppet from the console.

Set to false to disable the PXP service. If false, you can’t use the orchestrator or the Run Puppet button in the console.

Must be true to Configure PXP agent parameters.

Default: true

An integer that determines the maximum number of simultaneous task or plan requests the orchestrator can make to bolt-server.

This setting only limits task or plan executions on nodes with SSH or WinRM transport methods, because these are the only tasks and plans requiring requests to bolt-server.

Default: 100 requests

An integer that defines how many times an orchestrator job allows status requests to time out before a job is considered failed. Status requests wait 12 seconds between timeouts, so multiply the value of the allowed_pcp_status_requests by 12 to determine how many seconds the orchestrator waits on targets that aren’t responding to status requests.

Default: 35 timeouts

An integer specifying how long a deploy job can run on a single node before being force stopped.

Default: 1800 (30 minutes)

Deploy jobs triggered by puppet infra commands always have a one year timeout limit, regardless of the value of default_deploy_timeout.

An integer specifying how long a plan can run before being force stopped. This represents a timeout limit for the entire plan, not individual plan jobs.

Default: 3600 (60 minutes)

Plans triggered by puppet infra commands always have a one year timeout limit, regardless of the value of default_plan_timeout.

An integer specifying how many seconds a task can run on a single node before being force stopped.

Default: 2400 (40 minutes)

Tasks triggered by puppet infra commands always have a one year timeout limit, regardless of the value of default_task_node_timeout.

An integer specifying how many concurrent compile requests can be outstanding to the primary server across all orchestrator jobs.

Default: 8 requests

Specifies the Java heap size, which is the amount of JVM memory that each Java process is allowed to request from the OS for orchestration services to use.

The value is formatted as a JSON hash, where the maximum and minimum are usually the same. For example: {"Xmx": "256m", "Xms": "256m"}

Default: 704 MB

An integer of 2 or greater, which specifies the number of days to retain job reports.

This parameter sets the corresponding parameter job-prune-days-threshold.

While job_prune_threshold itself has no default value, job-prune-days-threshold has a default of 30 (30 days).

An integer that determines the maximum number of JRuby instances that the orchestrator creates to execute plans. Because each plan uses one JRuby to run, this value is effectively the maximum number of concurrent plans. Setting the orchestrator heap size (java_args) automatically sets the jruby_max_active_instances using the formula $java_args ÷ 1024. If the result is less than one, the default is one JRuby instance.

Default: 1 instance

An integer representing the maximum number of concurrent HTTP-client connections allowed for each route when requests include a client certificate.

Default: 20

An integer representing the maximum number of concurrent HTTP-client connections allowed for each route when requests do not include a client certificate.

Default: 20

An integer representing the maximum number of concurrent HTTP-client connections allowed for all routes when requests include a client certificate.

Default: 20

An integer representing the maximum number of concurrent HTTP-client connections allowed for all routes when requests do not include a client certificate.

Default: 20

An integer representing how long, in seconds, an agent can spend attempting to connect to a PCP broker during a Puppet run triggered by the orchestrator. If the agent can’t connect to the broker in the specified time frame, the Puppet run times out.

Default: 30

A Boolean used to enable (true) or disable (false) orchestration services.

Default: true

An integer specifying, in milliseconds, the maximum wait time before the orchestrator closes an HTTP connection when no data is available on the socket.

Default: 120000

An integer defining the maximum number of task or plan actions that can be executed simultaneously.

The defined concurrency limit applies to the nodes targeted by individual task or plan jobs. For example, if task_concurrency is set to 200 and four separate task jobs that each target 200 nodes are initiated, then task actions start executing on all 800 nodes.

If the number of nodes targeted by an individual task or plan job exceeds the concurrency limit, actions on some of the targeted nodes will be queued. For example, if task_concurrency is set to 200, and an individual task job is run on 300 targeted nodes, then task actions start executing on 200 nodes while the remaining 100 nodes wait in queue.

Default: 1000 actions per job

A Boolean used for Running plans alongside code deployments.

Set to true to enable versioned deployments of environment code.

Default: false