Page History

agents.<agent-id>.target: optional

• target: object, optional
  • connection: object, required
    • host: string, required
      • The hostname/FQDN to which the Agent should be deployed.
    • port: number, optional
      • The port number used for SSH connections, default: 22.
  • authentication
    • method: string, required
      • Supported authentication methods include public/private key. The value publickey has to be specified.
    • user: string, required
      • The user account for SSH connections to the target host.
    • keyFile: string, optional
      • The path to the private key file of the user account connecting to the target host, for example /home/sos/.ssh/id_rsa.
  • forceSudo: boolean, optional
    • Specifies that sudo will be used by most commands in Deployment Scripts.
  • packagingLocation: string, required
    • The path to a directory on the target host to which the deployment tarballs will be stored during rollout.
  • execPre: string, optional
    • Holds a command that will be executed on the target host before extraction of deployment tarballs has been performed.
    • Deployment scripts provide shell functions to start and to stop the systemd service for the Agent.
    • Specifying the command StopService will stop the Agent's systemd service. Users are free to specify commands at their will.
  • execPost: string, optional
    
    • Holds a command that will be executed on the target host after extraction of deployment tarballs has been performed.
    • Deployment scripts provide shell functions to start and to stop the systemd service for the Agent.
    • Specifying the command StartService will start the Agent's systemd service. Users are free to specify commands at their will.
  • makeService: boolean, optional
    • Specifies that a systemd service should be created or renewed for JS7 components such as the Agent. This includes that a service file will be created and will be stored to the relevant systemd service file directory. In addition, the service will be enabled for automated start-up and shutdown of the JS7 component.
  • serviceName: string, optional
    • Specifies the name of the systemd service and its corresponding service file that will be created if the makeService setting is active.
    • The Agent's systemd service file is created in the Agent's <home>/bin directory with the file name agent_<http-port>.service. By default the file will be copied to the systemd's /usr/lib/systemd/system directory with the file name js7_agent_<http-port>.service which results in the corresponding systemd service name. Users who wish to use a different service name can use this setting. If the indicated service name does not include the .service extension then it will be added.
  • serviceDir: string, optional
    • Specifies the location of the systemd directory for service files. By default the /usr/lib/systemd/system directory will be used. An alternative location is the /etc/systemd/system directory. Users are free to specify the systemd directory that is in place on the target host.

agents.<agent-id>.media: required

• media: object, required
  • release: object, required
    • The JS7 release number, for example 2.5.0.
  • tarball: string, required
    • Path to the .tar.gz installation file as downloaded from the SOS Web Site.
    • Any relative paths specified are prepended the release directory of the Deployment Area, see JS7 - Deployment Area - Directory Layout.

agents.<agent-id>.configuration: optional

Any relative paths specified are prepended the config directory of the Deployment Area, see JS7 - Deployment Area - Directory Layout.

• configuration: object, optional
  • controller: object, conditional
    • controllerId: object, conditional
      • Unique identifier of the Controller to which the Agent will be registered. The identifier is specified with the controllers section.
  • certificates: object, optional
    • keyStore: string, optional required
      • Path to a PKCS12 keystore that holds the Agents private key and Server Certificate.
    • keyStorePassword: string, optional required
      • Password for access to the Agent's keystore.
    • keyPassword: string, optional required
      • Password for access to the Agent's private key (same as keyStorePassword when using a PKCS12 keystore).
    • keyAlias: string, optional
      • The alias name of the Agent's private key. The setting is relevant only should more than one private key be included in the Agent's keystore.
    • trustStore: string, optional required
      • Path to a PKCS12 truststore that holds the Root CA Certificate and optionally Intermediate CA Certificate(s).
    • trustStorePassword: string, optional required
      • Password for access to the truststore.
    • The intention for use of passwords for access to keystore and truststore is not targeted at implementing some level of secrecy. Instead, it is intended to allow verification that the keystore and truststore have not been tampered or changed accidentally. The passwords are used when retrieving keys and certificates to verify integrity of the keystore/truststore.
  • templates: array, optional
    • <config-directory>: string, required
      • Any directories specified will be copied to the Agent's data directory. Specified directories have to use config and/or config/private sub-directories as the final part of the directory hierarchy.
      • Any files and sub-directories of the specified directories will be copied to the Agent's data directory.
      • Any number of configuration directories can be specified by repeatedly using the element.
  • files: object, optional
    • agentConf: string, optional
      • Path to a configuration file that will be copied to the Agent's config configuration directory with the  agent.conf file name.
    • privateConf: string, optional
      
      • Path to a configuration file that will be copied to the Agent's config/private configuration directory with the  private.conf file name.