Page History

...

• --deploy-dir
  • Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the <config> directory. A deployment directory allows to manage central copies of configuration files such as controller.conf, private.conf, log4j2.xml etc.
  • Use of a deployment directory has lower precedence as files can be overwritten by individual options such as --controller-conf, --private-conf etc.
• --controller-conf
  • Specifies the path to a configuration file for global JS7 - Controller Configuration Items. The file will be copied to the <config>/controller.conf file.
  • Any file name can be used as a value of this option, however, the target file name controller.conf will be used.
• --private-conf
  • Specifies the path to a configuration file for private JS7 - Controller Configuration Items. The file will be copied to the <config>/private/private.conf file.
  • Any file name can be used as a value of this option, however, the target file name private.conf will be used.
  • Users have a choice how to provide the required configuration:
    • Download the private.conf-template-controller template, the Controller Installation Script performs replacements of placeholders in the template file from option values, for details see chapter Replacements.
    • Users can manually adjust configuration items in their version of the private.conf file that they specify for the Controller Installation Script, see JS7 - Controller Configuration Items.
• --controller-primary-cert
  • Specifies the path to the SSL/TLS certificate of the Primary Controller Instance. The Controller Installation Script extracts the distinguished name from the given certificate and adds it to the Controller's private.conf file to allow HTTPS connections from the pairing Controller in a cluster using mutual authentication without the need for passwords.
• --controller-secondary-cert
  • Corresponds to the --controller-primary-cert setting and is used for the Secondary Controller Instance.
• --joc-primary-cert
  • Specifies the path to the SSL/TLS certificate of the Primary/Standalone JOC Cockpit Instance. The Controller Installation Script extracts the distinguished name from the given certificate and adds it to the Controller's private.conf file to allow HTTPS connections from the JOC Cockpit instance using mutual authentication without the need for passwords.
• --joc-secondary-cert
  • Corresponds to the --joc-primary-cert setting and is used for the Secondary JOC Cockpit Instance.
• --keystore
  • Specifies the path to a PKCS12 keystore file that holds the private key and certificate for HTTPS connections to the Controller.
  • Users are free to specify any file name, typically the name https-keystore.p12 is used. The keystore file will be copied to the <config>/private directory.
  • If a keystore file is made available then the Controller's <config>/private/private.conf file has to hold a reference to the keystore location and optionally the keystore password. It is therefore recommended to use the --private-conf option to deploy an individual private.conf file that holds settings related to a keystore.
  • For automating the creation of keystores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.
• --keystore-password
  • Specifies the password for access to the keystore. Use of a keystore password is required.
  • Consider use of quotes when specifying the password.
• --keystore-alias
  • If a keystore holds more than one private key, for example if separate pairs of private keys/certificates for server authentication and client authentication exist, then it is not determined which private key/certificate will be used. The alias name of a given private key/certificate is specified when the entry is added to the keystore. The alias name allows to indicate a specific private key/certificate to be used.
• --client-keystore
  • Use of this setting is optional. It can be used if separate certificates for Server Authentication and Client Authentication are used.
  • The Client Authentication private key and certificate can be added to a client keystore. The location and configuration of a client keystore correspond to the--keystore option.
• --client-keystore-password
  • Specifies the password for access to the client keystore. Use of a client keystore password is required if a client keystore is used.
  • Consider explanations for the --keystore-password option.
• --client-keystore-alias
  • If a client keystore holds more than one private key, for example if a number of private keys/certificates for client authentication exist, then it is not determined which private key/certificate will be used.
  • Consider explanations for the --keystore-alias option.
• --truststore
  • Specifies the path to a PKCS12 truststore file that holds the certificate(s) for HTTPS connections to the Controller using mutual authentication .
  • Users are free to specify any file name, typically the name https-truststore.p12 is used. The truststore file will be copied to the <config>/private directory.
  • If a truststore file is made available then the Controller's <config>/private/private.conf file has to hold a reference to the truststore location and optionally the truststore password. It is therefore recommended to use the --private-conf option to deploy an individual private.conf file that holds settings related to a truststore.
  • For automating the creation of truststores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.
• --truststore-password
  • Specifies the password for access to the truststore. Use of a password is recommended as it is not primarily intended to protect access to the truststore. The password is intended to allow verification that truststore entries have been added using the same password.
  • Consider use of quotes when specifying the password.
• --java-home
  • Specifies the Java home directory that will be made available to the Controller from the JAVA_HOME environment variable specified with the Controller Instance Start Script typically available from ./bin/controller_instance.sh.
• --java-options
  • Specifies the Java options that will be made available to the Controller from the JAVA_OPTIONS environment variable specified with the Controller Instance Start Script typically available from ./bin/controller_instance.sh.
  • Java options can be used for example to specify Java heap space settings for the Ccontroller.
  • If more than one Java option is used then the value has to be quoted, for example --java-options="-Xms256m -Xmx512m".
• --service-dir
  
  • Specifies the systemd service directory to which the Controller's service file will be copied if the --make-service switch is used.
  • By default the /usr/lib/systemd/system directory will be used. Users can specify an alternative location.
• --service-file
  
  • Specifies the path to a systemd service file that acts as a template and that is copied to the Controller's <home>/bin directory.
  • Users are free to choose any file name as a template for the service file. The resulting service file name will be controller.service.
  • The Controller Installation Script will not perform replacements in the service file to update paths and the port to be usedetc., for details see ./bin/controller.service-example.
• --service-name
  
  • Specifies the name of the systemd service that will be created if the --make-service switch is used.
  • By default the service name js7_controller will be used.

...