Introduction
- The Controller can be installed on Linux systems without use of an installer by extracting a .tar.gz archive.
- The Controller can be installed on Windows systems
- without use of an installer by extracting a .zip archive. This allows a portable installation that requires no administrative privileges or
- by running the Controller installer in headless mode or
- by running the graphical installer see JS7 - Controller - Using the Windows Graphical Installer.
Prerequisites
- A Java Runtime Environment starting from version 1.8 is required. For details see Which Java versions is JobScheduler available for?
- Technically the Controller can be operated in any Unix environment. However, the JS7 - Platforms include support for Controller operation with Linux.
Download
- Download the Controller archive for the target system from the JS7 - Download page.
- For Unix systems:
- A .tar.gz archive is available that is extracted to create the Controller's directory structure (see below).
js7_controller_unix.<release>.tar.gz
- A .tar.gz archive is available that is extracted to create the Controller's directory structure (see below).
- For Windows systems:
- A .zip archive is available that will create the Controller's directory structure when it is extracted (see below).
js7_controller_windows.<release>.zip
- A .zip archive including the installer is available that can be used to run the installer in headless mode.
js7_controller_windows_installer.<release>.zip
- A .zip archive is available that will create the Controller's directory structure when it is extracted (see below).
- For Unix systems:
Installation Video
This video explains the installation.
Installation from the .tar.gz/.zip Archive
Installation
- Extract the downloaded archive to a directory.
- After extraction the resulting directory structure will include (only files and folders immediately relevant):
controller
license.gpl
(copy of GPLv3 (General Public License) )license.html, license.txt
(copy of JS7 JobScheduler Commercial License Agreement)ThirdParty.txt
(list of 3rd party components and licenses included with the JS7 Controller).version
(release information)bin
controller.cmd|sh
- The Start Script for Windows/Unix platforms
controller_instance.cmd|sh-example
- Sample Instance Start Script to set individual environment variables. Drop the
-example
extension to activate this file.
- Sample Instance Start Script to set individual environment variables. Drop the
controller_watchdog.cmd|sh
- Restarts the Controller on Windows/Unix platforms
lib
(directory for Java libraries)service
(directory for operation as a Windows Service)install_controller_windows_service.cmd
LICENSE.txt
(copy of Apache License, Version 2.0)NOTICE.txt
RELEASE-NOTES.txt
uninstall_controller_windows_service.cmd
amd64
manager
x86
var
(configuration directory)config
(directory for configuration files)controller.conf
(general Controller configuration)lib
(optional directory for JDBC Drivers and licensed binary code)license
(optional directory for license certificate files)private
(directory for security related configuration files)private.conf-example
(security related configuration)- For setting up HTTPS connections - see JS7 - Controller Configuration Items
- For setting up authentication and digital signature checks
trusted-pgp-keys
(empty directory, can be used to add individual PGP public keys for signing, see JS7 - Secure Deployment)trusted-x509-keys
(directory to hold X.509 certificates for signing, see JS7 - Secure Deployment)sos.intermediate-ca.pem
(default certificate of SOS to allow deployment with JOC Cockpit)
logs
(directory for log files)state
(directory for journal files)work
(directory for work files)
- On Windows Systems:
- You have to modify the directory permissions for the above
.\logs
and.\service
directories if you extract the Controller to, forexample:C:\Program Files
.- This step is not required if you extract the Controller e.g. to
C:\ProgamData
. Start a command prompt with elevated administrative rights and execute, for example:
Allow full acces for "Users" on .\service and .\logs directoriescd "path\to\installation-directory" icacls "service" /L /grant *S-1-5-32-545:(OI)(CI)F icacls "logs" /L /grant *S-1-5-32-545:(OI)(CI)F
- This step is not required if you extract the Controller e.g. to
- You have to modify the directory permissions for the above
- To start the Controller you can use the commands explained with the JS7 - Controller - Command Line Operation article or your can automate startup from the instructions provided by the below chapter "Automated Startup and Shutdown".
Customers with a commercial license wishing to cluster the JS7 Controller for high availability have to add the license key during initial operation, see JS7 - Initial Operation for Controller Cluster
Update
Preparation
- Stop the JS7 Controller instance.
- Prepare to rollback in case the update of the JS7 Controller is not successful:
- Make a backup of the Controller's installation and configuration directories, e.g. by creating a .tar.gz/.zip archive.
- Installation Directory:
- The default installation directory for the Controller is:
/opt/sos-berlin.com/js7/controller/<controller-id>
for Unix systems,C:\Program Files\sos-berlin.com\js7\controller\<controller-id>
for Windows systems.
- The default installation directory for the Controller is:
- Configuration Directory
- The default configuration directory for the Controller is:
/home/sos/sos-berlin.com/js7/controller/<controller-id>
for Unix systems,C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>
for Windows systems.
- The default configuration directory for the Controller is:
- Installation Directory:
- Make a backup of the Controller's installation and configuration directories, e.g. by creating a .tar.gz/.zip archive.
Running the Update
The update of the JS7 Controller is performed from the same download archive as used for any fresh installation.
- When extracting files to a location that has already been used then existing files with the same name will be overwritten. Files added by the user will remain in place
- This is particularly true for the Controller Start Script
./bin/controller.sh|cmd
which should not be modified by users.
- This is particularly true for the Controller Start Script
- The .tar.gz/.zip archive includes Java libraries in the
./lib
directory that ships with file names that are unique to every Controller release.- Therefore, before extracting files, rename or remove an existing
./lib
directory in order to store libraries from the current Controller release only in this directory.
- Therefore, before extracting files, rename or remove an existing
Example for Installation from the Unix Command Line
The Controller is installed with a few straightforward commands:
# download archive (consider to use a current release) curl 'https://download.sos-berlin.com/JobScheduler.2.1/js7_controller_unix.2.1.0.tar.gz' --output js7_controller_unix.2.1.0.tar.gz # extract archive tar xvzf js7_controller_unix.2.1.0.tar.gz # find extracted files in the "controller" sub-directory ls -la controller # prepare an instance start script from the example cd controller/bin cp -p controller_instance.sh-example controller_instance.sh # optionally activate/adjust environment variables in controller_instance.sh # JS7_CONTROLLER_HTTP_PORT=4444 # JAVA_HOME=... # run the Controller ./controller_instance.sh start
Installation by Windows Installer in Headless Mode
The Controller installer is available for Windows systems only.
- To run the Windows installer in graphical mode see JS7 - Controller - Installation Using the Windows Graphical Installer.
- To run the Windows installer in headless mode consider the information below.
Installation
After extraction of the installer .zip archive the directory structure will include:
controller_install.xml
(installer response file)install_controller.txt
(installation notes)js7_controller_windows.<release>.jar
(installer library for a given release)license.txt, license.html
(copy of JS7 JobScheduler Commercial License Agreement)setup.cmd
(installer script)
Installer Response File
- The Controller installation uses the
controller_install.xml
response file, which includes parameters such as the installation path, ports, etc.- For a fresh installation the installer response file is included with the downloaded archive.
- The default location of the
controller
_install.xml
file from a previous installation is:C:\Program Files\sos-berlin.com\js7\controller\<controller-id>
- The
<controller-id>
is a unique identifier for a Controller which you specify from the installer response file:- You are free to choose an identifier, e.g.
controller-test
,controller-prod
if you intend to run a separate Controller for each environment. Upper case and lower case characters are considered, the characters a-z, A-Z, 0-9, underscore and hyphen are allowed. Spaces are not allowed in a Controller ID. - If you intend to operate a Controller cluster then both Controller instances have to use the same Controller ID.
- You are free to choose an identifier, e.g.
- Customers with a commercial license should choose the relevant license option and specify the location of the license key with the installer response file.
The
controller
_install.xml
file is explained with the code listing below. The comments included are intended to be self-explanatory.
Download: controller_install.xml
Running the Installer
Running the installer of the JS7 Controller on Windows systems:
Running the installer of JS7 Controller on Windows systemsC:\temp\controller.[release]> setup.cmd controller_install.xml
Directory Structure
After installation the resulting directory structure will be similar to that described in the Installation from .tar.gz/.zip Archive chapter above.
Directories for installation and configuration of the Controller might differ.
Update
Preparation
- Stop the JS7 Controller instance.
- Prepare to rollback in case the update of the JS7 Controller is not successful.
- Make 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 instance is
C:\Program Files\sos-berlin.com\js7\controller\<controller-id>
- The default installation directory for the Controller instance is
- Configuration Directory
- The default configuration directory for the Controller instance is
C:\ProgramData\sos-berlin.com\js7\controller\<controller-id>
- The default configuration directory for the Controller instance is
- Installation Directory:
- Make a backup of the Controller's installation directory and configuration directory, e.g. by creating a .zip archive.
Running the Update
The update procedure makes use of the same installer response file as described for a fresh installation.
Steps to run the installer are the same as described for a fresh installation.
Installation Log
The installer creates a log file in the directory specified in the JS7_CONTROLLER_LOGS
environment variable or in the logs
sub-folder of the Controller configuration directory.
- The default location of the
logs
directory for the Controller isC:\ProgramData\sos-berlin.com\js7\controller\<controller-id>
- Installation log files are named 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
Rollback
Rollback Installation from .tar.gz/.zip Archive
- To rollback the installation of a JS7 Controller instance, remove the newly created installation and configuration directories of the JS7 Controller.
- Restore the directories from a previous backup, e.g. by extracting the respective .tar.gz/.zip backup archives to the installation and configuration directories.
Rollback Installation by Windows Installer in Headless Mode
- To perform the rollback of the JS7 Controller instance run the uninstaller from the command line.
- 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 from a previous backup, e.g. by extracting the .tar.gz/.zip archive to the installation directory and configuration directory.
- 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:C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\bin
- The default location of the
Run the following command to install the Controller's Windows Service.
controller.cmd
install
-service
- Switch to the
Automated Startup and Shutdown
For Unix systems startup and shutdown configurations apply that are executed by the root
account e.g. from /etc/init.d
scripts and by use of systemd
.
- Consider use of the
JS7_CONTROLLER_USER
environment variable from the./bin/controller_instance.sh
script to run a Controller that is started byroot
for a different user account. - For use with
systemd
find a sample service file from./bin/controller.service-example
. - For details see JS7 - systemd Service Files for automated Startup / Shutdown with Unix Systems
For Windows systems operation of the Controller by a Windows Service is recommended as such services can be configured to start/stop automatically on server startup and shutdown.
- Consider to assign a service account to the JS7 Controller service with the Windows Service Panel.
- Consider to allow the JS7 Controller service to be automatically started on server startup.
Initial Operation
- Having completed the installation or update of a JS7 Controller you can start the Controller either manually or from its Unix daemon/Windows Service, see JS7 - Controller Command Line Operation.
- Consider the following information about initial operation:
Further References
- Installation
- Operation
- Configuration