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 a .tar.gz tarball archive is available.
- For Windows systems a .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
Updating the JS7 Controller
The update is performed from the same download file as any fresh installation.
Preparation
- Stop the JS7 Controller instance
Notes
We have to explain what to do before running an update:
- Stop Controller
- How to verify that no workflows are running?
- Prepare Rollback
- create a .tar.gz/.zip archive from a) the installation directory and b) the configuration directory
- This is sufficient for Linux
- This is not sufficient for Windows
- Users will later on have to re-install the service
- Take a Backup
Update
Installer Options
- When the Controller was installed previously it adds a
controller_install.xml
file that includes 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.- Where is this file located? For Linux? For Windows?
Running the Installer
- 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
Batch installation is started by opening a terminal or command window in the folder containing the
setup.*
file and typing
Rollback
Note
Explain what steps have to be taken for a rollback:
- Linux: drop the newly created folder, restore from backup
- Windows:
- run uninstaller from the command line
- restore folders from backup
- re-install the Windows Service from the command line
Installation Log
- Installer Log File
- The installer creates a log file in the directory that is pointed to by the environment variable
JS7_CONTROLLER_LOGS
or in thevar/logs
subdirectory of the Controller installation directory. - Specify the installer log file name
- The installer creates a log file in the directory that is pointed to by the environment variable
- Further References
- For a complete overview of log files see JS7 - Logging
Automated Start-up and Shutdown
- 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 byroot
for a different user account. - What about use of systemd?
- Consider the use of the
- For Windows systems, the start-up of the Controller by installing it as a Windows Service is recommended.
Overview
Content Tools