Controller Startup
Start Script
Usage
Running the Controller Start Script without parameters displays the usage clause:
Usage: controller.sh command [options] command: start [options] start_docker [options] stop [options] abort [options] restart [options] status [options] kill [options] options: --id=<JS7 Controller Id> | default: controller --http-port=<[hostname or ip address:]number> | default: 4444 --https-port=<[hostname or ip address:]number> | default: --data-directory=<location of data directory> | default: /var/sos-berlin.com/js7/controller/var --config-directory=<location of config directory> | default: /var/sos-berlin.com/js7/controller/var/config --java-options=<java options> | default: -Dfile.encoding=UTF-8 -Xmx500m -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector -Dlog4j2.asyncLoggerWaitStrategy=Block; see also https://kb.sos-berlin.com/x/aIC9 see also https://kb.sos-berlin.com/x/CKrAAw for more information.
Usage: controller.cmd command [options] command: start [options] stop [options] abort [options] restart [options] status [options] kill [options] install-service [options] remove-service [options] start-service [options] options: --id=<JS7 Controller ID> | default: controller --http-port=<[hostname or ip address:]number> | default: 7444 --https-port=<[hostname or ip address:]number> | default: --data-directory=<location of data directory> | default: C:\ProgramData\sos-berlin.com\js7\controller\controller --config-directory=<location of config directory> | default: C:\ProgramData\sos-berlin.com\js7\controller\controller\config --java-options=<java options> | default: -Dfile.encoding=UTF-8 -Xmx500m -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector -Dlog4j2.asyncLoggerWaitStrategy=Block; see also https://kb.sos-berlin.com/x/aIC9 see also https://kb.sos-berlin.com/x/CKrAAw for more information.
Command Line Options
- --id=<JS7 Controller ID>
- is a unique identifier for a Controller within a network
- --http-port=<[hostname or ip address:]number>
- specifies the HTTP port that the Controller is listening to in order to receive requests from JOC Cockpit.
controller.cmd|sh command --http-port=####
- where
####
is the numeric port. - This option can be also used to indicate which network interface the JS7 Controller should listen to if in addition you specify a hostname or IP address for example with
--http-port=myhost:4444
.
- Without this option being used the port defaults to
4444
and the Controller listens to all available network interfaces. - Should you want to specify a port then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_CONTROLLER_HTTP_PORT
(see below) - Third precedence: use of default value
- specifies the HTTP port that the Controller is listening to in order to receive requests from JOC Cockpit.
--https-port=<[hostname or ip address:]number>
- specifies the HTTPS port that the Controller is listening to in order to receive requests from a Controller:
agent.cmd|sh command -https-port=####
- where
####
is the numeric port. - This option can be also used to indicate which network interface the Controller should listen to if in addition you specify a hostname or IP address for example with
--https-port=myhost:4444
.
- Should you want to specify a port then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_CONTROLLER_HTTPS_PORT
(see below) - Third precedence: use of default value
- specifies the HTTPS port that the Controller is listening to in order to receive requests from a Controller:
--data-directory=<location of data directory>
- specifies the location of the data directory.
- This location has to be unique over all JS7 Controller instances
- Should you want to specify a data directory then the following precedence 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.
- This location has to be unique for any Controller instances
- Should you want to specify a config directory then the following precedence 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>
With Java 1.8 the initial memory allocation has changed, for details see How to manage the Java heap space.
This option can be used to apply Java options for the Controller, e.g. for memory settings.
Without this option being used the Java options default to '-Xms500m'.
Should you want to specify the Java options then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JAVA_OPTIONS
(see below) - Third precedence: use of default value
Environment Startup Script: environment_variables.sh, environment_variables.cmd
Usage
The JS7 Controller includes an environment startup script that can be used to specify startup parameters.
- The default location of the
environment_variables.cmd
|sh
file is:/opt/sos-berlin.com/js7/controller/<Controller ID>/bin
on Linux andC:\Program Files\sos-berlin.com\js7\controller\<Controller ID>\bin
on Windows.
Environment Variables
The following environment variables can be used:
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 thebin/java
executable resides.
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'
.
JS7_CONTROLLER_CONFIG_DIR
- configuration files are stored.
- The location has to be unique for all JS7 Controller instances on the same server.
JS7_CONTROLLER_DATA
- points to the directory where the JS7 Controller finds its data directory.
- Without setting this environment variable the default value is
JS7_CONTROLLER_HOME\var_JS7_CONTROLLER_HTTP_PORT
JS7_CONTROLLER_HTTP_PORT
- sets the HTTP port that the JS7 Controller is listening to.
- 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 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.
- 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.
- Without setting this environment variable the HTTPS protocol is not used.
JS7_CONTROLLER_LOGS
- sets the directory where the JS7 Controller log file is created.
- This setting defaults to the directory
logs
in the JS7 Controller data directory. - For Windows systems for which the JS7 Controller is installed in the program directory that is pointed to by the
%ProgramFiles%
environment variable, it is recommended not to use the default setting. Instead specify a different path via theJS7_CONTROLLER_LOGS
environment variable, e.g. some location in the data directory that is pointed to by the%ProgramData%
environment variable.
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.
Running the Controller
- SOS does not recommend to run the JS7 Controller as
root
(for Unix) or asAdministrator
(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
controller.cmd|sh start [options]
Stopping the Controller
controller.cmd|sh stop [options]
This command will safely terminate the Controller(recommended).
controller.cmd|sh abort [options]
The Controller process is aborted immediately.
controller.cmd|sh kill [options]
The controller process is killed.
- This corresponds to sending SIGKILL with a kill command.
Restarting the Controller
controller.cmd|sh restart [options]
Checking the Controller Status
controller.cmd|sh status [options]
Should the Controller be up and running then this command will result in some output such as:
id: controller version: 2.0.0-alpha.20210706 (2021-07-06) buildId: KvsbZFR9QfOT-GAJg33fLA startedAt: 1625646518935 totalRunningTime: 632857.312 orderCount: 1973 system: hostname: KA0054 cpuModel: Intel64 Family 6 Model 94 Stepping 3, GenuineIntel mxBeans: operatingSystem: availableProcessors: 4 systemLoadAverage: -1 java: version: 1.8.0_171 memory: maximum: 501743616 total: 501743616 free: 420687192 systemProperties: java.vendor: Oracle Corporation os.arch: amd64 java.runtime.name: Java(TM) SE Runtime Environment os.version: '10.0' os.name: Windows 10 java.vm.name: Java HotSpot(TM) 64-Bit Server VM java.version: 1.8.0_171
Should the Controller not be running then some output is provided such as:
ERROR: java.nio.file.NoSuchFileException: C:\ProgramData\sos-berlin.com\js7\controller\controller\state\session-token ...JS7 Controller(controller) not started!
Windows Service Interface
The following information applies to headless installation for Windows systems. For installation with a GUI and user dialog see JS7 - Controller - Use of Windows Graphical Installer.
The Controller is operable as a Windows Service. The Start Script of the Controller allows to install/remove the Windows Service.
Installing the Windows Service
controller.cmd install-service [--http-port=<number>]
This command installs the Controller'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.
During service installation, it tries to copy the executable file for the Windows Service to the .\service
directory. This operation could fail with the error "Access denied" if you have extracted the JS7 Controller to e.g. C:\Program Files\. In this case, you can change the permissions of the .\service
directory or open the command prompt with elevated administrator rights and execute the above command once more.
Starting the Windows Service
controller.cmd start-service [--http-port=<number>]
This command starts the Windows Service with the name SOS JS7 Controller -id=<Controller ID>.
The stop
command performs more than a simple stop-service
command: the stop
command checks whether the Controller was started by the CLI or as a Windows Service and stops the Controller accordingly. Therefore there is no stop-service
command.
Removing the Windows Service
controller.cmd remove-service [--http-port=<number>]
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 ID>
in the Services Manager Console any longer.
Configuring the Windows Service
After installation of the Windows Service, you will find the .\service\js7_controller_<Controller ID>w.exe
file. Start this program to configure the Windows Service.
For example, goto the "Startup" tab |
Debugging
- The Controller log level can be increased using the Controller's Apache ProcRun Demon Service Manager demon/service.
- On Windows systems, this is installed in the Controller
service
Folder and will have a name such asjs7_controller_<Controller ID>w.exe
where Controller ID is the unique ID for the Controller - Start the ProcRun Manager, select the Logging tab in the Manager interface and set the level to Debug.
- The location of the log files has already been described above.
- (Do not forget to set the debug level back to Info once finished.)
Consider that this chapter is the same as for JS7 - Controller - Use of Windows Graphical Installer
Usage Examples
Running the Controller on 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 on Linux
For Linux the location of the Java Runtime Environment can be specified like this: