Page History

agents.controllerRefs[].members[].configuration: optional

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

• configuration: object, optionalconfiguration: object, optional
  controller: object, conditionalcontrollerId: object, conditionalUnique identifier of the Controller to which the Agent will be registered. The identifier is specified with the controllers section.
  • certificates: object, optional
    • keyStore: string, required
      • Path to a PKCS12 keystore that holds the Agents private key and Server Certificate.
    • keyStorePassword: string, required
      • Password for access to the Agent's keystore.
    • keyPassword: string, 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, required
      • Path to a PKCS12 truststore that holds the Root CA Certificate and optionally Intermediate CA Certificate(s).
    • trustStorePassword: string, 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.

controllers: optional

An array of Controller configuration objects is specified. Relevant settings correspond to the agents.controllerRefs[].members[] sections.

• controllerId: object, required
  • The unique identifier of a Controller is specified. If a Controller Cluster is operated then both Primary and Secondary Controller instances use the same Controller ID.
  • Any number of Controller configurations using unique Controller IDs can be specified.
• jocRef: object, optional
  • The unique identifier of a JOC Cockpit standalone instance or cluster that is used to manage the Controller.
• <instance-type>: object, required
  • If a Controller Cluster is operated then separate nodes are added to the Deployment Descriptor indicating the primary and secondary instance type.
  • For a Standalone Controller a single instance type primary is specified.
  • target: see agents
  • media: see agents
  • installation: see agents
  • configuration: see agents agents
    • certificates: object, optional
      • cert: string, optional
        
        • Path to the certificate file (.crt, .pem) that holds the Controller instance's base64 encoded Server Certificate.

joc.members[].instances[].configuration: optional

The following settings are available in addition to what is stated with the agents.controllersRefs[].members[].configuration section.

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

• configuration: object, optional
  • certificates: object, optional
    • cert: string, optional
      
      • Path to the certificate file (.crt, .pem) that holds the JOC Cockpit instance's base64 encoded Server Certificate.
  • responseDir: string, optional
    • The response directory can hold any files required when running the JOC Cockpit setup. The files and folders of the response directory will be copied to the JOC Cockpit' setupDir directory before running the installer.
  • startFiles: object, optional
    • The Jetty Servlet Container used with JOC Cockpit by default ships for HTTP connections. For use with HTTPS connections a number of configuration files are used that hold SSL related settings. All files are stored to the JETTY_BASE/start.d directory:
      
      • http.ini: enables/disables the Jetty HTTP module, specifies the port and optionally the network interface for HTTP connections.
      • https.ini: enables/disables the Jetty HTTPS module.
      • ssl.ini: specifies the port and optionally the network interface for HTTPS connections. In addition settings related to keystores and truststores are available.
    • httpIni: string, optional
      • Specifies the path to the http.ini file that should be copied to JOC Cockpit's JETTY_BASE/start.d directory.
      • When using HTTPS connections it is recommended to deploy a copy of the file that disables the HTTP module as HTTPS is not an invite to users to fall back to use of a less secure protocol.
      • Settings for port and network interface in this file will be updated from corresponding elements in the joc.<joc-id>.installation section.
    • httpsIni: string, optional
      • Specifies the path to the https.ini file that should be copied to JOC Cockpit's JETTY_BASE/start.d directory.
      • When using HTTPS connections it is recommended to deploy a copy of the file that enables the HTTPS module.
    • sslIni: string, optional
      • Specifies the path to the ssl.ini file that should be copied to JOC Cockpit's JETTY_BASE/start.d directory.
      • When using HTTPS connections it is recommended to deploy a copy of the file that specifies the SSL port and optionally the network interface. In addition, the file holds settings for the keystore and truststore used by Jetty.
      • Settings for port, network interface, keystore and truststore in this file will be updated from corresponding elements in the installation and configuration sections.
  • files: object, optional
    • jocProperties: string, optional
      • Specifies the path to the joc.properties file that should be copied to JOC Cockpit's JETTY_BASE/resources/joc directory.
      • Settings for keystore and truststore in this file will be updated from corresponding elements in the configuration section.