Orchestrator configuration files

The configuration file for the orchestrator allows you to run commands from the CLI without having to pass additional flags. Whether you are running the orchestrator from the primary server or from a separate work station, there are two types of configuration files: a global configuration file and a user-specified configuration file.

Orchestrator global configuration file

If you're running the orchestrator from a PE-managed machine, on either the primary server or an agent node, PE manages the global configuration file.

This file is installed on both managed and non-managed workstations at:

*nix systems --- /etc/puppetlabs/client-tools/orchestrator.conf
Windows --- C:/ProgramData/PuppetLabs/client-tools/orchestrator.conf

The class that manages the global configuration file is puppet_enterprise::profile::controller. The following parameters and values are available for this class:

Parameter	Value
`manage_orchestrator`	`true` or `false` (default is `true`)
`orchestrator_url`	url and port (default is primary server url and port 8143)

The only value PE sets in the global configuration file is the orchestrator_url (which sets the orchestrator's service-url in /etc/puppetlabs/client-tools/orchestrator.conf).

If you're using a managed workstation, do not edit or change the global configuration file. If you're using an unmanaged workstation, you can edit this file as needed.

Orchestrator user-specified configuration file

You can manually create a user-specified configuration file and populate it with orchestrator configuration file settings. PE does not manage this file.

This file needs to be located at ~/.puppetlabs/client-tools/orchestrator.conf for both *nix and Windows.

If present, the user specified configuration always takes precedence over the global configuration file. For example, if both files have contradictory settings for the environment, the user specified settings prevail.

Orchestrator configuration file settings

The orchestrator configuration file is formatted in JSON. For example:

{
  "options" : {
    "service-url": "https://<PRIMARY SERVER HOSTNAME>:8143",
    "cacert": "/etc/puppetlabs/puppet/ssl/certs/ca.pem",
    "token-file": "~/.puppetlabs/token",
    "color": true
  }
}

The orchestrator configuration files (the user-specified or global files) can take the following settings:

Setting	Definition
`service-url`	The URL that points to the primary server and the port used to communicate with the orchestration service. (You can set this with the `orchestrator_url` parameter in the `puppet_enterprise::profile::controller` class.) Default value: `https://<PRIMARY SERVER HOSTNAME>:8143`
`environment`	The environment used when you issue commands with Puppet orchestrator.
`cacert`	The path for the Puppet Enterprise CA cert. *nix: `/etc/puppetlabs/puppet/ssl/certs/ca.pem` Windows: C:\ProgramData\PuppetLabs\puppet\etc\ssl\certs\ca.pem
`token-file`	The location for the authentication token. Default value: `~/.puppetlabs/token`
`color`	Determines whether the orchestrator output uses color. Set to `true` or `false`.
`noop`	Determines whether the orchestrator runs the Puppet agent in no-op mode. Set to `true` or `false`.