Puppet Class: pipelines::agent

Defined in:
manifests/agent.pp

Overview

Install the Puppet Pipelines agent

Parameters:

  • access_token (Sensitive[String[1]]) —

    First half of the credentials to authenticate the agent.

  • secret_key (Sensitive[String[1]]) —

    Second half of the credentials to authenticate the agent.

  • version (Optional[String[1]]) (defaults to: undef) —

    Version of the agent to install (optional).

  • download_url (String[1]) (defaults to: 'https://pipelines.puppet.com/download/client') —

    The URL that contains the agent download. Defaults to the SaaS download url, if running an on-premise instance you will need to set this.

  • install_dir (Optional[String[1]]) (defaults to: undef) —

    The directory in which the distelli executable will be downloaded into.

  • data_dir (Optional[String[1]]) (defaults to: undef) —

    The agent base directory, defaults to /distelli (or %systemdrive%distelli on Windows).

  • environments (Optional[Array[String[1]]]) (defaults to: undef) —

    Pre-configure the agent so this server is added to a set of PfA environments.

  • start_agent (Boolean) (defaults to: true) 


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'manifests/agent.pp', line 12

class pipelines::agent (
  Sensitive[String[1]]           $access_token,
  Sensitive[String[1]]           $secret_key,
  Boolean                        $start_agent    = true,
  Optional[String[1]]            $data_dir       = undef,
  Optional[String[1]]            $install_dir    = undef,
  String[1]                      $download_url   = 'https://pipelines.puppet.com/download/client',
  Optional[String[1]]            $version        = undef,
  Optional[Array[String[1]]]     $environments   = undef,
) {
  if 'windows' == $facts['kernel'] {
    contain pipelines::agent::windows
  } else {
    contain pipelines::agent::unix
  }
}