...

The JS7 Controller includes a Start Script to manage for managing the Controller instance:

• The default location of the Start Script is:

  • /opt/sos-berlin.com/js7/controller/<controller-id>/bin\controller.sh on Unix and

  • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\bin\controller.cmd on Windows.

...

• --id=<JS7 Controller ID>
  • Specifies a unique identifier for a Controller. Identifiers such as "controller-test", "controller-production" etc. can be used. Upper case and lower case characters are considered, the characters a-z, A-Z, 0-9, underscore and hyphen are allowed. Spaces are not allowed in a Controller ID.
  • If users intend to operate a Controller cluster with two Controller instances for the active and for the standby cluster member, then the same Controller ID must be specified for both Controller instances as otherwise the instances will not be considered to be members of the same cluster.
• --http-port=<[hostname or ip address:]number>
  • Specifies the HTTP port that which the Controller instance is listening to in order to receive requests from JOC Cockpit or a partnering Controller instance in a cluster.

    • controller.sh|.cmd command --http-port=####

    • where #### is the port number.
    • This option can be also used to indicate which network interface the JS7 Controller should listen to if a hostname or IP address is specified , - for example with --http-port=myhost:4444.
  • Without When this option being is not used the port defaults to 4444 and the Controller listens to all available network interfaces.
  • Should If a port be is specified then the following order of precedence order applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_CONTROLLER_HTTP_PORT (see below)
    • Third precedence: use of default value
• --https-port=<[hostname or ip address:]number>
  • Specifies the HTTPS port that the Controller is listening to in order to receive requests from JOC Cockpit or a pairing Controller instance in a cluster:

    • controller.sh|.cmd command --https-port=####

    • where #### is the port number.
    • This option can be used to indicate which network interface the Controller should listen to if a hostname or IP address is specified , - for example with --https-port=myhost:4443.
    • When using the HTTPS protocol for connections from JOC Cockpit and from a pairing Controller instance the the HTTP protocol has to be allowed for local connections such as --http-port=localhost:4444. As the Controller Start Script makes use of an uses a HTTP connection this protocol has to be in place to allow the Controller instance to be started, stopped etc. by its Start Script.
  • Should If a port be is specified then the following order of precedence order applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_CONTROLLER_HTTPS_PORT (see below)
    • Third precedence: use of default value
• --data-directory=<location of data directory>
  • Specifies the location of the data directory that usually includes the config, logs and state directories.
  • Should If a data directory be is specified then the following order of precedence order applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_CONTROLLER_DATA (see below)
    • Third precedence: use of default value JS7_CONTROLLER_HOME\var
• --config-directory=<location of config directory>
  • Specifies the location of the config directory for configuration data.
  • Should If a configuration directory be is specified then the following following order of precedence order applies:
    • First precedence: command line option
    • Second precedence: environment variable JS7_CONTROLLER_CONFIG_DIR (see below)
    • Third precedence: use of default value JS7_CONTROLLER_DATA/config
• --java-options=<java options>
  • This option can be used to apply Java options for the Controller, e.g. for memory settings.

  • Without this option being used Java options default to -Xms500m.

  • In order to specify a number of Java options quotes have to be used like this:
    • --java-options="-Xms100m -Xmx1g"

  • When specifying Java options then the following following order of precedence order applies:

    • First precedence: command line option
    • Second precedence: environment variable JAVA_OPTIONS (see below)
    • Third precedence: use of default value

...

The JS7 Controller includes a template file for an Instance Start Script that which can be adjusted modified to specify start-up parameters.

• The Instance Start Script sets a number of environment variables and then executes the Start Script.
• In the Instance Start Script users Users can adjust start-up parameters from environment variables as in the Instance Start Script as described below.

It is recommended to create that an individual Instance Start Script is created from the template file as this allows individual start-up parameters to be specified using environment variables.

...

• The default location of the Instance Start Script template file is:

  • /opt/sos-berlin.com/js7/controller/<controller-id>/bin/controller_instance.sh-example on Unix and

  • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\bin\controller_instance.cmd-example on Windows.
• Users can create a copy of the template file and remove the -example extension from the file name. The renamed Instance Start Script controller_instance.sh (Unix) or controller_instance.cmd (Windows) will not be overwritten when updating the Controller later on.
  • If the Controller installation is performed on Windows using the installer, either in headless mode or in graphical mode, then the installer automatically creates the script.
  • If the Controller installation is performed by extracting a .tar.gz/.zip archive then the Instance Start Script has to be created from a copy of the template file.
  • Once the Instance Start Script been copied users can adjust modify start-up parameters from environment variables, as described below.

...

• JS7_CONTROLLER_ID
  • The unique identifier of a Controller. Identifiers such as "controller-test", "controller-production" etc. can be used. Upper case and lower case characters are considered, the characters a-z, A-Z, 0-9, underscore and hyphen are allowed. Spaces are not allowed in a Controller ID.
  • If a Controller cluster is operated with two Controller instances for the active and for the standby cluster member, then the same Controller ID must be specified for both Controller instances, as otherwise the instances will not be considered members of the same cluster. This identifier cannot be modified after initial start of a Controller. Changes to the Controller ID require to drop dropping the Controller's journal, i.e. the contents of its JS7_CONFIG_DIR\state directory.
  • Corresponding command line option: --id
• JS7_CONTROLLER_USER
  • The operating system user account that the Controller instance is started with. The Controller Start Script will switch to this account when being executed from a different account, for example if started by the root account.
  • There is no corresponding command line option.
• JS7_CONTROLLER_HTTP_PORT
  
  • The HTTP port that the JS7 Controller is listening to.
  • This setting optionally indicates which network interface the JS7 Controller should listen to if a host or IP address is specified such as JS7_CONTROLLER_HTTP_PORT=myHost:4444.
  • If only a port number only is specified then the JS7 Controller listens to all available network interfaces via HTTP.
  • Without setting this environment variable the port defaults to 4444.
  • Corresponding command line option: --http-port
• JS7_CONTROLLER_HTTPS_PORT
  
  • Sets the HTTPS port that the JS7 Controller is listening to.
  • This setting indicates which network interface the JS7 Controller should listen to if a host or IP address is specified as for example with JS7_CONTROLLER_HTTPS_PORT=myHost:4443
  • If a port number only is specified then the JS7 Controller listens to all available network interfaces via HTTPS.
  • When using the HTTPS protocol for connections from JOC Cockpit and from a paired Controller instance then the HTTP protocol has to be allowed for local connections such as JS7_CONTROLLER_HTTP_PORT=localhost:4444. As the Controller Start Script makes use of an HTTP connection this protocol has to be in place to allow the Controller instance to be started, stopped etc. by its Start Script.
  • Without setting The HTTPS protocol is not used if this environment variable the HTTPS protocol is not usedset.
  • Corresponding command line option: --https-port
• JS7_CONTROLLER_DATA
  • Points to the parent directory where the JS7 Controller finds its configuration data, log data and journals.
  • Without setting this environment variable the default value is JS7_CONTROLLER_HOME\var.
  • For Windows systems for which where the JS7 Controller is installed in the program directory that this is pointed to indicated by the %ProgramFiles% system environment variable. It is recommended that the default setting is not used. Instead a different path should be specified via the JS7_CONTROLLER_DATA environment variable, such as a location in the system data directory that is pointed to indicated by the %ProgramData% environment variable, for example, JS7_CONTROLLER_DATA=C:\ProgramData\sos-berlin.com\js7\controller.
  • Corresponding command line option: --data-directory
• JS7_CONTROLLER_CONFIG_DIR
  • Specifies the directory where configuration files are stored.
  • Without specifying When this environment variable is not specified, the default value is of JS7_CONTROLLER_DATA/config will be used.
  • Corresponding command line option: --config-directory
• JS7_CONTROLLER_LOGS
  
  • Specifies the directory where the JS7 Controller log files are created.
  • This setting defaults to the JS7_CONTROLLER_DATA/logs directory.
  • There is no corresponding command line option.
• JS7_CONTROLLER_PID_FILE_DIR
  
  • Sets the directory where the JS7 Controller PID file is created.
  • This setting defaults to the directory that which is specified with the JS7_CONTROLLER_LOGS environment variable or the log directory default value.
  • There is no corresponding command line option.
• JAVA_HOME
  • Points to the location of the JVM, either a JRE (Java Runtime Environment) or JDK (Java Development Kit).
  • Without setting this environment variable Java will be used from the location specified by the system path.
  • The JAVA_HOME environment variable does not necessarily point to the location of a JDK but to a JRE directory where the bin/java executable resides, for example if the location of the Java executable is /opt/java/jdk8u202-b08/jre/bin/java then JAVA_HOME=/opt/java/jdk8u202-b08/jre.
  • There is no corresponding command line option.
• JAVA_OPTIONS
  • Specifies Java options, for example the Java memory settings for the Controller instance.
  • Without setting When this environment variable is not set, the Java options will default to -Xms500m.
  • Corresponding command line option: --java-options

Running the Controller Instance

• SOS does not recommend to run running the JS7 Controller as the root account (for Unix) or as the Administrator account (for Windows) for a simple reason: there is no need to do so.
• The Controller does not execute any jobs as this task is performed by Agents. Therefore any user account can be used to operate the Controller.

The examples below examples make use of an Instance Start Script a controller_instance.sh (Unix) or controller_instance.cmd (Windows) that Instance Start Script which is created from the template file.

...

If a Controller cluster is being operated then fail-over will not occur.

...

If a Controller cluster is being operated then this command will cause a fail-over.

...

If a Controller cluster is being operated then this command will cause a fail-over.

...

The following information applies to headless installation for on Windows systems. For installation with a GUI and user dialog see JS7 - Controller - Installation Using the Windows Graphical Installer.

...

...

• The Controller instance log level can be increased using the Controller's Apache ProcRun Daemon Service Manager daemon/service.
• For On Windows systems this is installed in the Controller instance's service folder with a name such as js7_controller_<controller-id>w.exe  where <controller-id> is the unique Controller ID.
• Users can start the ProcRun Manager, select the Logging tab in the user interface and set the level to Debug. 
• The location of log files is explained above. 
• Users should consider to revert reverting the log level back to its original value once they are finished with debugging.

...