Controller Instance Startup

Start Script

Usage

Running the Controller Start Script without parameters displays the usage clause:

...

The following environment variables can be used in this script:

• JS7_CONTROLLER_ID
  • The unique identifier of a Controller. You can use identifiers such as "controller-test", "controller-production" etc. 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 you intend to operate a Controller cluster with two Controller instances for the active and for the standby cluster member, then specify the same Controller ID 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 the Controller's journal, i.e. the contents of its JS7_CONFIG_DIR\state directory..
• JS7_CONTROLLER_USER
  • The operating system user account that the Controller instance is started for. The Controller Start Script will switch to this account when being executed from a different account, e.g. if started by the root account.
• 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, as e.g. with JS7_CONTROLLER_PORT=myHost:4444.
  • If only a port number is specified then the JS7 Controller listens to all available network interfaces via HTTP.
  • Without setting this environment variable the port defaults to 4444.
• 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.
  • if only a port number 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 pairing Controller instance consider to allow the HTTP protocol in addition for local connections as with JS7_CONTROLLER_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 this environment variable the HTTPS protocol is not used.
• 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 the JS7 Controller is installed in the program directory that is pointed to by the %ProgramFiles% system environment variable, it is recommended not to use the default setting. Instead specify a different path via the JS7_CONTROLLER_DATA environment variable, e.g. a location in the system data directory that is pointed to by the %ProgramData% environment variable such as JS7_CONTROLLER_DATA=C:\ProgramData\sos-berlin.com\js7\controller.
• JS7_CONTROLLER_CONFIG_DIR
  • Specifies the directory where configuration files are stored.
  • Without specifying this environment variable the default value is JS7_CONTROLLER_DATA/config.
• JS7_CONTROLLER_LOGS
  
  • Specifies the directory where the JS7 Controller log files are created.
  • This setting defaults to the JS7_CONTROLLER_DATA/logs directory.
• JS7_CONTROLLER_PID_FILE_DIR
  
  • Sets the directory where the JS7 Controller PID file is created.
  • This setting defaults to the directory that is specified with the JS7_CONTROLLER_LOGS environment variable or the log directory default value.
• JAVA_HOME
  • Points to the location of the Java Runtime Environment (JRE).
  • Without setting this environment variable Java will be used from the location specified by the system path.
  • Please consider that JAVA_HOME does not point to the location of a JDK but to a JRE directory where the bin/java executable resides, for example
• JAVA_OPTIONS
  • sets Java options, e.g. the Java memory settings for the Controller.
  • Without setting this environment variable the Java options default to '-Xms500m'.

Running the Controller Instance

• SOS does not recommend to run the JS7 Controller as root (for Unix) or as Administrator (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.

Starting the Controller Instance

controller.cmd|sh start [options]

Stopping the Controller Instance

controller.cmd|sh stop [options]

...

• This corresponds to sending SIGKILL with a kill command as e.g. kill -9.

Restarting the Controller Instance

controller.cmd|sh restart [options]

Checking the Controller Instance Status

controller.cmd|sh status [options]

...

The Controller can be operated as a Windows Service. The Start Script of the Controller instance allows to install/remove the Windows Service.

...

This command installs the Controller instance's Windows Service. After the installation, you find the Windows Service with the name SOS JS7 Controller -id=<Controller ID> in the Services Manager Console. The Windows Service uses the "local system" account.

...

This command starts the Windows Service with the name SOS JS7 Controller -id=<Controller ID><controller-id>.

...

This command removes the Windows Service. After executing this command you should not find the Windows Service with the name SOS JS7 Controller -id=<controller<controller-id>id> in the Services Manager Console any longer.

...

After installation of the Windows Service, you will find the .\service\js7_controller_<controller-id>w.exe file. Run this program to configure the Windows Service.

Debugging

• The Controller instance log level can be increased using the Controller's Apache ProcRun Demon Service Manager demon/service.
• For Windows systems this is installed in the Controller service Folder Controller instance's service folder with a name such as js7_controller_<controller-id>w.exe  where <controller-id> is the unique Controller ID.
• Start the ProcRun Manager, select the Logging tab in the Manager interface and set the level to Debug. 
• The location of the log files is explained above. 
• Consider to revert a debug log level once you are finished with debugging.

Usage Examples

Running the Controller Instance for Windows

For Windows® operating systems the location of the Java Runtime Environment and of the log directory can be specified like this:

set JAVA_HOME=%ProgramFiles%\Java\jre8
set JS7_CONTROLLER_LOGS=%ProgramData%\sos-berlin.com\js7\controller\controller\var\logs
"%ProgramFiles%\sos-berlin.com\agent\js7\controller\bin\controller.cmd" start

Running the Controller Instance for Unix

For Unix the location of the Java Runtime Environment can be specified like this:

...