Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titlejoc.<joc-id>.installation

joc.<joc-id>.installation: required

The following settings are available in addition to what is stated with the agents.<agent-id>.installation section.

  • installation: object, required
    • setupDir: objectstring, optional required
      • Path to the directory to which the JOC Cockpit .tar.gz installation file is extracted. The directory is required to extract the installation file and to run the JOC Cockpit installer.
      • If this setting is omitted then a temporary directory will be used.
    • isUser: boolean, optional
      • Specifies that the JOC Cockpit installation will be performed for a user account, not for the root account. This setting corresponds to the -u switch that can be used when manually installing JOC Cockpit, for example using ./setup.sh -u joc_install.xml.
    • isPreserveEnv: boolean, optional
      • Specifies that during JOC Cockpit installation environment variables of the user account performing installation are passed to sudo
      • This corresponds to use of the sudo -E switch, for example using ./setup.sh -u -E joc_install.xml.
    • title: string, optional
      • The title is used in the JOC Cockpit dashboard view and serves to distinguish a number of JOC Cockpit instances operated as a cluster.
    • securityLevel: string, optional
    • dbmsConfig: string, optional
      • Path to a Hibernate configuration file that specifies access to the DBMS. See JS7 - Database for Hibernate example files.
    • dbmsDriver: string, optional
      • Path to a JDBC Driver *.jar file for access to the DBMS. See JS7 - Database for JDBC Drivers that ship with JS7.
    • dbmsInit: string, optional
      • Specifies the point in time when objects will be created in the database.
      • One of the options byInstaller, byJoc, off can be used.
Expand
titlejoc.<joc-id>.configuration

joc.<joc-id>.configuration: optional

The following settings are available in addition to what is stated with the agents.<agent-id>.configuration section.

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

  • configuration: object, optional
    • 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 joc.<joc-id>.installation section.
    • 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 joc.<joc-id>.installation section.

...