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 to the JS7 Controller is performed from the same download file as we use for any fresh installation:
js7_controller_windows.x.x.x.zip
for windowsjs7_agent_unix.x.x.x.tar.gz
for Linux
Preparation
- Stop the JS7 Controller instance
- Prepare a rollback in case the updating the JS7 Controller is not successful then a backup is necessary.
- Create a .tar.gz/.zip archive for the:
- Installation Directory:
- The default installation paths for the Controller are:
/opt/sos-berlin.com/js7/controller
on Linux systems andC:\Program Files\sos-berlin.com\js7\controller
on Windows.
- The default installation paths for the Controller are:
- Configuration Directory
- The default configuration paths for the Controller are:
/home/sos/sos-berlin.com/js7/controller
on Linux systems andC:\ProgramData\sos-berlin.com\js7\controller
on Windows.
- The default configuration paths for the Controller are:
- Installation Directory:
- Create a .tar.gz/.zip archive for the:
- Take a Backup of the above archives created.
Note: For the Linux environments taking the backup of the directories and extracting them at the time of rollback is sufficient but in the case of Windows, it is also required to re-install the service of the Controller.
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 default location of the
controller
_install.xml
file is:/opt/sos-berlin.com/js7/controller/<controller-ID>
on Linux systems andC:\Program Files\sos-berlin.com\js7\controller\<controller-ID>
on Windows.
- The default location of the
The
controller
_install.xml
the file is shown in the code listing below. The extensive comments are intended to be self-explanatory.
Running the Installer
Running the installer of JS7 Controller on Linux systems with root permissions
Running the installer of JS7 Controller on Linux systems with root permissions/tmp/controller.[release]> ./setup.sh controller_install.xml
Running the installer of the JS7 Controller on Linux systems without root permissions
Running the installer of JS7 Controller on Linux systems without root permissions/tmp/controller.[release]> ./setup.sh -u controller_install.xml
Running the installer of JS7 Controller on Windows systems
Running the installer of JS7 Controller on Windows systemsC:\temp\controller.[release]> setup.cmd controller_install.xml
Note: Batch installation is started by opening a terminal or command window in the folder containing the
setup.*
file and typing
Rollback
To perform the rollback there are different steps to be followed for Windows and Linux.
Rollback JS7 Controller Instance on Windows
- To perform JS7 Controller instance rollback run the uninstaller from the command line.
- The default location of the
uninstall.cm|sh
file is:/opt/sos-berlin.com/js7/controller/<controller-ID>/Uninstaller
on Linux systems andC:\Program Files\sos-berlin.com\js7\controller\<controller-ID>\Uninstaller
on Windows.
- The default location of the
- Restore the folders from the backup by unzipping the .tar.gz/.zip archive for the installation directory and configuration directory to the respective location.
- Re-Install the windows service from the command line:
- Switch to the
./bin
directory for the Controller from the command line- The default location of the
./bin
directory is:/opt/sos-berlin.com/js7/controller/<controller-ID>/bin
on Linux systems andC:\Program Files\sos-berlin.com\js7\controller\<controller-ID>\bin
on Windows.
- The default location of the
Run the below command. This command installs the Controller's Windows Service.
controller.cmd
install
-service [-http-port=<number>] [-ip-address=<
hostname
or ip address>]
- Switch to the
Rollback JS7 Controller Instance on Linux
- To perform JS7 Controller instance rollback on Linux remove the newly created Installation and the configuration directory of the JS7 Controller.
- Restore the folders from the backup by unzipping the .tar.gz/.zip archive for the installation directory and configuration directory to the respective location.
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
subdirectory of the Controller configuration directory.
- The default path of the
logs
directory for the Controller are:/home/sos/sos-berlin.com/js7/controller/<Controller-ID>
on Linux systems andC:\ProgramData\sos-berlin.com\js7\controller/<Controller-ID>
on Windows.
- Installation log files are named according to the pattern,
Install_V[release]_[date&time]_....log
where release is the version release number and date and time refer to the installation.
- For further references about the logging refer to the complete overview of log files 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?
For Windows systems, the start-up of the Controller by installing it as a Windows Service is recommended.
Further References
JS7 - Controller - Command Line Operation