Installing the JS7 Controller
Prerequisites
- Java Runtime Environment 1.8 or newer is required.
- For details see Which Java versions is JobScheduler available for?
Download
- Choose the Controller archive for the target system from the JS7 - Download page.
- For Windows systems a .zip archive including the installer is available from
js7_controller_windows_installer.<release>.zip
.
Installation
Extract the downloaded archive to a directory, e.g.
C:\Temp
.The installer can be run in graphical mode or in headless mode, see JS7 - Controller - Use of Linux/Windows Headless Installation.
- The installer asks for elevated administrator privileges, therefore it is not required to change the permissions in the
.\service
directory and the installer sets read/write permissions for the.\logs
directory. - After the installation you will find
- a Windows Service "
SOS JS7 Controller -id=<controller-id>
" - an executable file
.\service\
js7_controller_<controller-id>.exe
that is started by the Windows Service.
- a Windows Service "
Directory Structure
- The resulting directory structure after installation includes (only files and folders immediately relevant):
C:\Program Files\sos-berlin.com\js7\controller
(installation directory)bin
controller.cmd|sh
- The Start Script for Windows/Unix platforms
controller_watchdog.cmd|sh
- Restarts the Controller for Windows/Unix platforms
environment_variables.cmd|sh
- Environment Startup Script for the JS7 Controller
lib
- The directory for Java libraries
service
(for operation as a Windows Service)amd64
manager
x86
install_controller_windows_service.cmd
js7_controller_<Controller ID>.exe
js7_controller_<Controller ID>w.exe
LICENSE.txt
NOTICE.txt
RELEASE-NOTES.txt
uninstall_controller_windows_service.cmd
user_bin
environment_variables.cmd|sh-example
- Sample configuration file to set individual environment variables. Drop
-example
extension to activate this file.
- Sample configuration file to set individual environment variables. Drop
Uninstaller
(Windows only, the empty directory remains in place after uninstall)install.log
js7.ico
shortcut.vbs
uninstall.cmd
uninstall_prepare.cmd
uninstaller.jar
license.gpl
(copy of GPLv3 (General Public License) )license.html, license.txt
(copy of JS7 JobScheduler Commercial License)ThirdParty.txt
(list of 3rd party components and licenses included with Controller)
C:\ProgramData\sos-berlin.com\js7\controller
(configuration directory)
var
logs
(directory for log files)config
(directory for configuration files)state
(directory for Controller journal files)
Start Installer
Run the installer for the JS7 Controller using
Windows command to run the graphical installer> C:\Temp\controller.<release>\setup.cmd
- The installer asks for administrative permissions.
- Select the language to be used for the setup: English and German are available.
Welcome Window
- Click Next on the welcome window.
License Options
- The License window displays licenses available for the JS7 Controller.
- The Open Source License GPLv3 (General Public License) is available.
- The SOS Commercial License can be used by adding a license certificate file that you receive from SOS after purchase of a license. For details see JS7 - FAQ - How to apply a JS7 License Key.
License Agreement
- The License Agreement corresponding to the license option selected has to be accepted before installation can occur.
Installation Directory
- The installer opens a window to specify the installation directory after you accept the terms of the License Agreement.
Installation Settings
- With the next window specify the Controller ID that is a unique identifier for a Controller. You can use identifiers such as "controller-test", "controller-production" etc.
- 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 identifier during installation of each Controller instance as otherwise the instances will not be considered members of the same cluster. This identifier cannot be modified after installation, changes to the Controller ID require reinstallation of the Controller.
- A checkbox allows to specify if the currently installed Controller instance will initially start with an active or standby role. Do not select this checkbox if you operate a standalone Controller instance.
- Consider that operation of a Controller cluster requires to add a license certificate from a previous above step, see JS7 - Licensing.
- Add the HTTP port that is used by the JS7 Controller. Make sure that the HTTP port is available, i.e. is not otherwise used. If you run other applications that use this port then choose a different port.
- If you specify a Windows Service account then make sure that this account has "Log on as service permissions". Consider that credentials that you enter to this window are stored in clear text with the installer response file. It is considered more secure not to add credentials with this step, but to add credentials directly with the Windows Service panel after installation.
Configuration Directory
- Choose the configuration directory for the Controller to which you want to store the Controller's configuration files and journal files.
Specific Directories
- If you choose the installation directory to be located in
C:\Program Files
then it is recommended to choose the log directory outside of the installation path, e.g.C:\ProgramData\sos-berlin.com\js7\controller\logs
. - The installer sets read/write permissions for the specified Windows Service account. Typically only the administrator group should have write permissions for
C:\Program Files
.
Installation Progress
- This step displays progress of the first part of the installation procedure.
- Changes to installer options can no longer be applied once this step is started.
Configuration Progress
- The processing panel displays progress of the second part of the installation procedure that includes to set permissions and to install the Windows Service.
The information displayed with this step is written to the installation log file that can be found in the
JS7_CONTROLLER_DATA/logs
folder.
Completion
The last step of the installation displays a summary of the installation (success/error) and paths to relevant files.
Note that if a problem occurs during installation a warning will be displayed and a link to the installation log file will be provided.
- A failed installation can be repeated at any time, no uninstallation is required.
Updating the JS7 Controller
The update of the JS7 Controller is performed from the same download archive as used for any fresh installation:
js7_controller_windows_installer.<release>.zip
Preparation
- Stop the JS7 Controller instance, e.g. from the Controller's Windows Service.
- Prepare to rollback in case that the update of the JS7 Controller is not successful:
- Take a backup of the Controller's installation directory and configuration directory, e.g. by creating a .zip archive.
- Installation Directory
- The default installation directory for the Controller is
C:\Program Files\sos-berlin.com\js7\controller\<controller-id>
- The default installation directory for the Controller is
- Configuration Directory
- The default configuration directory for the Controller is
C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>
- The default configuration directory for the Controller is
- Installation Directory
- Take a backup of the Controller's installation directory and configuration directory, e.g. by creating a .zip archive.
Update
The update using the graphical installer can be done by rerunning the installer setup.cmd
file from the .zip archive and by providing the same parameters such as installation directory, port etc.
Rollback
To perform a rollback on Windows systems follow the below steps:
- Run the JS7 Controller uninstaller.
- The default location of the
uninstall.cmd
file is:C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\Uninstaller
- The default location of the
- Restore the Controller folders from the backup by unzipping the .zip archive for the installation directory and configuration directory to the respective locations.
- Re-install the Windows Service from the command line:
- Switch to the Controller's
.\bin
directory from the command line.- The default location of the
.\bin
directory is:C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\bin
- The default location of the
Run the following command that installs the Controller's Windows Service:
controller.cmd
install
-service [--http-port=<number>] [--ip-address=<
hostname
or ip address>]
- Switch to the Controller's
Installation Log
The installer creates a log file in the directory that is pointed to by the environment variable JS7_CONTROLLER_LOGS
or in the logs
sub-directory of the Controller's configuration directory.
- The default location of the
logs
directory for the Controller is:C:\ProgramData\sos-berlin.com\js7\controller/<controller-id>
on Windows.
- Installation log files use names according to the pattern,
Install_V<release>_<date-time>_....log
where<
release>
is the release number and<
date-time>
refers to the point in time of installation. - For further information about logging see JS7 - Logging .
Further References
- JS7 - Controller - Use of Linux/Windows Headless Installation
- JS7 - Controller - Command Line Operation
- JS7 - Controller Configuration