JS7 - Controller Installation On Premises

Pages

Navigation

All the rest will be dropped

Installing the JS7 Controller

Prerequisites

A Java Runtime Environment starting from version 1.8 is required.
For details see Which Java versions is JobScheduler available for?

Preparation

Choose the Controller archive for the target system from the JobScheduler Download page.
- For Unix systems an installer .tar.gz tarball archive is available.
- For Windows systems an installer .zip archive is available.

Installation

- Unzip the downloaded archive to an arbitrary directory.
- Directory structure (only files and folders directly relevant):
  - bin
    - controller.cmd|sh
      - The start script for Windows platforms.
    - controller_watchdog.cmd|sh
      - Notes the task that is being forwarded for execution by a JS7 Controller to Agent
    - environment_variables.cmd|sh
      - includes environment variables used by JS7 Controller
  - lib
    - The directory for Java libraries.
    - Configure the settings in log4j2.xml file if you want to adjust the logger settings.
  - service (for Windows)
    - amd64 (directory)
    - manager (directory)
    - x86 (directory)
    - install_controller_windows_service.cmd
    - js7_controller_<Controller ID>.exe
    - js7_controller_<Controller ID>w.exe
    - LICENSE.txt
    - NOTICE.txt
    - RELEASE-NOTES.txt
    - set_java_home_for_jetty_windows_service.cmd
    - start_jetty_windows_service.cmd
    - uninstall_controller_windows_service.cmd
  - user_bin
    - environment_variables.cmd-example - example script to set the Controller environment variables (Microsoft Windows)
  - Uninstaller (the empty directory remains after uninstall)
    - install.log
    - js7.ico
    - shortcut.vbs
    - uninstall.cmd
    - uninstall_prepare.cmd
    - uninstaller.jar
  - var
    - logs
    - config
    - state

Update of JS7 Controller

Preparations for an update

Stop the JS7 Controller instance
When the Controller was installed previously it add a controller_install.xml file which includes the parameters such as the installation path, ports, etc.

The controller_install.xml the file is shown in the code listing below. The extensive comments are intended to be self-explanatory.

Configuration of the controller_install.xml file

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- 
XML configuration file for JS7 Controller setup

The JS7 Controller is available with a dual licensing model.
- GNU GPL 2.0 License (see http://www.gnu.org/licenses/gpl-2.0.html)
- JS7 Commercial License (see licence.txt)

The setup asks you for the desired license model 
(see <entry key="licenceOptions" .../> below).

If you call the setup with this XML file then you accept 
at the same time the terms of the chosen license agreement. 
-->
<AutomatedInstallation langpack="eng">
    <com.izforge.izpack.panels.UserInputPanel id="home">
        <userInput/>
    </com.izforge.izpack.panels.UserInputPanel>
    <!--com.izforge.izpack.panels.UserInputPanel id="licences">
        <userInput-->
        
            <!-- Select the license model (GPL or Commercial) -->
            <!--entry key="licenceOptions" value="GPL"/-->
            
            <!-- If you selected GPL as license model than the licence must be empty.
                 Otherwise please enter a license key if available.
                 It is also possible to modify the license key later. -->
            <!--entry key="licence" value=""/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel-->
    <com.izforge.izpack.panels.HTMLLicencePanel id="gpl_licence"/>
    <com.izforge.izpack.panels.HTMLLicencePanel id="commercial_licence"/>
    <com.izforge.izpack.panels.TargetPanel id="target">
        
        <!-- SELECT THE INSTALLATION PATH
             The installation expands this path with the JS7 ID as subdirectory.
             It must be absolute!
             For example C:\Program Files\sos-berlin.com\js7\controller -->
        <installpath>C:\Program Files\sos-berlin.com\js7\controller</installpath>
        
    </com.izforge.izpack.panels.TargetPanel>
    <com.izforge.izpack.panels.UserPathPanel id="userpath">
        
        <!-- SELECT THE DIRECTORY FOR CONFIGURATION AND LOG FILES
             The installation expands this path with the JS7 ID as subdirectory.
             The path must be absolute!
             Default path is C:\ProgramData\sos-berlin.com\js7\controller -->
        <UserPathPanelElement>C:\ProgramData\sos-berlin.com\js7\controller</UserPathPanelElement>
        
    </com.izforge.izpack.panels.UserPathPanel>
    <com.izforge.izpack.panels.UserInputPanel id="network">
        <userInput>
        
            <!-- ID of the JS7 Controller -->
            <entry key="controllerId" value="controller"/>
            
            <!-- Choose yes if the JS7 Controller is a Standby-Controller in a cluster -->
            <entry key="isStandby" value="no"/>
            
            <!-- Choose (yes or no) wether the JS7 Controller should be started at the end of the installation -->
            <entry key="launchController" value="yes"/>
            
            <!-- HTTP port of the JS7 Controller -->
            <entry key="controllerPort" value="4444"/>
            
            <!-- Set optionally an ip address or hostname. It could be used for indicating which network 
                 interfaces the JS7 Controller should listen to when using HTTP. If it is empty then 
                 it listens to all available network interfaces. -->
            <entry key="controllerHost" value=""/>
            
            <!-- The JS7 Controller will be installed as Windows service. You can set the service
                 account otherwise the local system account will be used. The account has to be the form 
                 'Domain\User'. -->
            <entry key="serviceAccount" value=""/>
            <entry key="servicePassword" value=""/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="environment">
        <userInput>

            <!-- Directory where the JS7 Controller's log files are stored (default: 
                 '[above user path]\logs'). -->
            <entry key="logPath" value=""/>
            
            <!-- Directory where the JS7 Controller's pid file is stored (default: 
                 above log path). -->
            <entry key="pidFilePath" value=""/>
            
            <!-- Working directory for all jobs which started by the JS7 Controller
                 e.g. %USERPROFILE% (default: [installation path]) -->
            <entry key="workPath" value=""/>
            
            <!-- The JS7 Controller requires a Java JRE at least version '1.8'. You can choose 
                 a different Java environment than the Java which is used during this installation. -->
            <entry key="javaHome" value=""/>
            
            <!-- Set optionally Java options (default: -Xmx500m). -->
            <entry key="javaOptions" value=""/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.UserInputPanel id="end">
        <userInput/>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.InstallPanel id="install"/>
    <com.izforge.izpack.panels.ProcessPanel id="process"/>
    <com.izforge.izpack.panels.FinishPanel id="finish"/>
</AutomatedInstallation>

Batch installation is started by opening a terminal or command window in the folder containing the setup.* file and typing:
- Starting batch installation of the JOC Cockpit on Linux systems with root permissions
```
/tmp/controller.[release]> ./setup.sh controller_install.xml
```
  Starting batch installation of the Controller on Linux systems without root permissions
```
/tmp/controller.[release]> ./setup.sh -u controller_install.xml
```
- Starting batch installation of the Controller on Windows systems
```
C:\temp\controller.[release]> setup.cmd controller_install.xml
```

Usage

Running the start script without parameters shows the usage clause:

Usage for Unix

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 data 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/kQiX for more information.

Usage for Unix

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 data 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/kQiX for more information.

Command-Line Options

-id=<JS7 Controller ID>
- is a unique identifier for an instance of Controller within a network
-http-port=<[hostname or ip address:]number>
- is the HTTP port that the Controller is listening to in order to receive requests from JOC Cockpit and Agent
  - ```
  controller.cmd|sh command -http-port=####
```
- where #### is the numeric port.
- This option can be also used for indicating which network interfaces the JS7 Controller should listen to if you specify a hostname or IP address in addition
- 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
-https-port=<[hostname or ip address:]number>
- is 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 for indicating which network interfaces the Controller should listen to if you specify a hostname or IP address in addition
- 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
-data-directory=<number>
- Location of the data directory.
- It 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_JS7_CONTROLLER_HTTP_PORT)
-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. the 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
--config-directory
- configuration files are stored.
- It 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_CONFIG_DIR (see below)
  - Third precedence: use of default value (JS7_CONTROLLER_DATA\config)

Running the Controller

SOS does not recommend running the JS7 Controller as root (for Unix) or as Administrator (for Windows).

Start the Controller

controller.cmd|sh start [options]

Stop the Controller

controller.cmd|sh stop [options]

This command will safely terminate the Controller(recommended).

controller.cmd|sh abort [options]

The Controller process is terminated immediately.

controller.cmd|sh kill [options]

The controller process is killed.

This corresponds to sending SIGKILL with a kill command.

Restart the Controller

controller.cmd|sh restart [options]

Check 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!

Monitoring Controller

See the How to perform active checks with a System Monitor such as Nagios/op5 article for information about configuring an automated status check of Controllers for monitoring purposes.

Windows Service Interface: Usage

The following information applies to batch installation on 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 installing/removing the Windows Service.

Install the Windows Service

controller.cmd install-service [-http-port=<number>] [-ip-address=<hostname or ip address>]

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 the 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.

Start 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 contains more than a simple stop-service command: the stop command checks whether the Controller was started through the CLI or as a Windows Service and stops the Controller accordingly. Therefore there is no stop-service command.

Remove the Windows Service

controller.cmd remove-service [-http-port=<number>]

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

During removal of the service, it tries to remove the executable file of the Windows Service from the .\service directory. This operation could fail with the error "Access denied" if you have extracted the Agent 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.

Configure the Windows Service

After the 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
to modify the start parameter

Logging

Log File
- On startup, the Controller creates a log file in the directory that is pointed to by the environment variable JS7_CONTROLLER_LOGS or in the var/logs subdirectory of the Controller installation directory.
- Logfile names are created from a prefix and the port used by the Controller like this:
  - controller.log
- Log files are rotated for each day (see ./lib/log4j2.xml) for which job activities occur.
- Rotated log files are assigned file names like this: controller.<yyyy-MM-dd>.log.gz
- For days where the Controller has no jobs to execute no log rotation will be performed.
PID File
- On startup, the Controller creates a PID file in the directory that is pointed to by the environment variable JS7_CONTROLLER_PID_FILE_DIR or in the log directory. The PID file contains the Process ID of the system process that the Controller is running in.
- The PID file is used in order to prevent the Controller to be started twice with the same settings and it can be used for shutdown scripts that require the PID to terminate the process.
- PID file names are created like this:
  - controller.pid
Further References
- For individual configuration of log rotation and log, retention see JS7 - Log Rotation

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 the bin/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.
- It has to be unique over all JS7 Controller instances
JS7_CONTROLLER_DATA
- points to the directory where the JS7 Controller has 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 interfaces 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 JobScheduler Agent is listening to.
- indicates which network interfaces 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 doesn't use.
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 installation 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 the JS7_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.

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\agent.cmd" start

Running the Agent on Mac OS X

For Mac® OS X the location of the Java Runtime Environment can be specified like this:

JAVA_HOME=/Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home
export JAVA_HOME
/Users/ap/Documents/js7/controller/bin/controller.sh start

Automated Start-up and Shutdown of an Agent

For Unix systems, the start-up and shutdown configurations apply that are executed by root, e.g. in /etc/init.d or corresponding locations.
- Consider the use of the JS7_USER environment variable to run a Controller that is started by root for a different user account.
For Windows systems, the start-up of the Controller by installing it as a Windows Service is recommended.

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 as js7_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.)

Behavior in the event of the Controller crashing

The Controller is the component in JS7 that holds the job-related configurations and orchestrates the Agent. The outage of a Controller instance does not prevent the execution of workflows having the jobs running on a single Agent. However, it affects the execution of workflows that include jobs that are running on a number of Agents as switching of Agents during workflow execution is performed by the Controller. Refer the article JS7 - Troubleshooting - How to troubleshoot the outage of a Controller for details.

Space shortcuts

Page tree