Configuration

Get the latest docs.

You are looking at documentation for an older release. Not what you want? Use the version selector on the top banner or click here.

Configuration Locations

Agent configuration consists of several locations that all adhere to the same schema. The schema is based on the cloudify.datatypes.AgentConfig datatype, which is defined in the standard types.yaml.

The order in which each property is resolved is as follows:

1. Operation Inputs

If a property has been provided as part of the operation inputs in agent_config (or the deprecated cloudify_agent), it is used. For example:

node_templates:
  my_vm:
    type: cloudify.nodes.Compute
    interfaces:
      cloudify.interfaces.cloudify_agent:
        create:
          inputs:
            agent_config:
              # configuration goes here
              user: centos
              ...

2. Node Instance Runtime Property

If the agent to be installed is a host agent (and not a central deployment agent), and the property is provided as part of the cloudify_agent node instance runtime property, it is used.

3. Node Property

If the agent to be installed is a host agent (and not a central deployment agent), and the property has been provided as part of the agent_config (or the deprecated cloudify_agent) node property, it is used. For example:

node_templates:
  my_vm:
    type: cloudify.nodes.Compute
    properties:
      agent_config:
        # configuration goes here
        user: centos
        ...

4. Installation Context

If the property has been provided during manager installation as part of the agent section in the config.yaml file, it is used. For example, consider the following excerpt from a config.yaml file:

...
agent:
  networks:
    some_network: 10.0.0.1
  min_workers: 2
  max_workers: 5
...

You can use this section to specify a global agent configuration that will apply to all installed agents. This is the only way to set deployment agents configuration.

Configuration Properties

Name	Type	Description
`user`	string	For host agents, the agent will be installed for this user.
`key`	string	For host agents that are installed via SSH, this may be either the path to the private key that will be used to connect to the host, or the actual private key (beginning with “`-----BEGIN RSA PRIVATE KEY-----`”).
`password`	string	For host agents that are installed via SSH (on Linux) and WinRM (on Windows), this property can be used to connect to the host. For Linux hosts, this property is optional if the `key` property is correctly configured. For Windows hosts that are installed via WinRM, this property is also optional and depends on whether the `password` runtime property has been set by the relevant IaaS plugin, prior to agent installation.
`port`	integer	For host agents that are installed via SSH (on Linux) and WinRM (on Windows), this is the port used to connect to the host. The default values are `22` for Linux hosts and `5985` for Windows hosts.
`min_workers`	integer	Minimum number of agent workers. By default, the value is `0`. See Auto Scaling for further details. Note: For Windows-based agents, this property is ignored and `min_workers` is set to the value of `max_workers`.
`max_workers`	integer	Maximum number of agent workers. By default, the value is `5`. See Auto Scaling for further details.
`disable_requiretty`	boolean	For Linux based agents, disables the `requiretty` setting in the sudoers file. By default, this value is `true`.
`process_management`	dictionary	Process management specific configuration. See Process Management.
`network`	string	Optional name of the network to use when communicating with the manager. The mapping of network names to IPs/hostnames is specified during manager installation. If not specified, the manager’s `private IP` will be used.
`env`	dictionary	Optional environment variables with which the agent will be started.
`extra`	dictionary	Optional additional low-level configuration details.

Extra configuration properties (that go under the `extra` property)

Name	Type	Description
`distro`	string	Linux operation system distribution. See Agent Package Resolution.
`distro_codename`	string	Linux operation system distribution release. See Agent Package Resolution.
`package_url`	string	Specify an explicit URL from which to download the agent package.
`uri`	string	For Windows-based agents, WinRM URI. By default, the value is `wsman`.
`protocol`	string	For Windows-based agents, WinRM protocol. By default, the value is `http`.
`fabric_env`	dictionary	For Linux-based agents, configure fabric that is used to SSH into the remote host.

Process Management

Additional configuration can be supplied to the service manager that will be used to manage the installed agent by using the process_management property.

Linux init.d Process Management

Name	Type	Description
`start_on_boot`	boolean	Specifies whether the agent service should be restarted after a system reboot. By default, the value is `true`.

Windows NSSM Process Management

Name	Type	Description
`startup_policy`	string	Specifies the start type for the service. By default, the value is `auto`. See sc config.
`failure_reset_timeout`	integer	`reset` value passed to `sc failure` during service configuration. By default, the value is 60. See sc failure.
`failure_restart_delay`	integer	Specifies delay time (in milliseconds) for the restart action. By default, the value is 5000. See sc failure

Linux Agent Package Resolution

In most cases, the agent package that will be used to install the agent is automatically resolved and does not require manual configuration. However, a mechanism exists that enables the implicit resolution to be overwritten. Following is a short description of the implicit resolution mechanism and details about how to override the implicit resolution with hard-coded values.

The install process attempts to identify the distribution and its release, and to deploy the correct type of agent for them. The identification process is based on Python’s platform.dist(). We reference the first attribute of the tuple returned by this call as distro, and the third attribute as distro_codename. For example, making this call on Ubuntu trusty returns a tuple in which the distro attribute is Ubuntu and the distro_codename attribute is trusty. After making the call, the package name that is downloaded from the management file server is {distro}-{distro_codename}-agent.tar.gz, where distro and distro_codename are converted to lowercase characters. In the case of Ubuntu trusty, the package name is ubuntu-trusty-agent.tar.gz.

If distro, distro_codename, or package_url are provided explicitly in the extra agent configuration, they will be used instead of the implicit mechanism.

Next Steps

For a more-technical explanation about agents, and how to create one, see the Agent-Packager tool.