Page History
Table of Contents |
---|
Introduction
- The Controller can be installed for Linux systems without use of an installer by extracting a .tar.gz archive.
- The Controller can be installed for 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 - Use of 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 for any Unix environments, 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 is extracted to create the Controller's directory structure (see below).
js7_controller_windows.<release>.zip
- A .zip archive including the installer is available that is used to run the installer in headless mode.
js7_controller_windows_installer.<release>.zip
- A .zip archive is available that is extracted to create the Controller's directory structure (see below).
- For Unix systems:
Installation from .tar.gz/.zip Archive
Installation
- Extract the downloaded archive to a directory.
- After extraction the resulting directory structure includes (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)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
(directory for Java libraries)service
(directory for operation as a Windows Service)amd64
manager
x86
install_controller_windows_service.cmd
LICENSE.txt
(copy of Apache License, Version 2.0)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 the
-example
extension to activate this file.
- Sample configuration file to set individual environment variables. Drop the
var
(configuration directory)config
(directory for configuration files)controller.conf
(general Controller configuration)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
logs
(directory for log files)state
(directory for journal files)
- On Windows Systems:
- You have to modify the directory permissions for the above
.\logs
and.\service
directories if you extract the Controller to e.g.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 e.g.
Code Block language bash title Allow full acces for "Users" on .\service and .\logs directories cd "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
Update
Preparation
- Stop the JS7 Controller instance.
- 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 .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:
- Take a backup of the Controller's installation directory and configuration directory, 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 the same location then existing files with the same name will be overwritten. Files added by the user remain in place.
- This is particularly true for the Controller Start Script
./bin/controller.sh|cmd
that 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 ship with unique file names per Controller release.- Therefore, before extracting files, rename or remove an existing
./lib
directory in order to store libraries from the current Controller release only to this directory.
- Therefore, before extracting files, rename or remove an existing
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 - Use of Windows Graphical Installer.
- To run the Windows installer in headless mode consider the below information.
Installation
After extraction of the .zip archive that includes the installer find the following directory structure:
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 makes use the
controller_install.xml
response file that 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 that 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.
The
controller
_install.xml
file is explained with the code listing below. The comments included are intended to be self-explanatory.
Download: controller_install.xmlCode Block language xml title Configuration of the controller_install.xml file linenumbers true collapse true <?xml version="1.0" encoding="UTF-8" standalone="no"?> <!-- XML installer response file for JS7 Controller setup The JS7 Controller is available with a dual license model: - GNU GPL v3.0 License, see https://www.gnu.org/licenses/gpl-3.0.en.html - JS7 Commercial License, see license.txt The setup asks you for the desired license model, see below <entry key="licenseOptions" .../> If you run the installer and do not specify a commercial license key then at the same time you accept the terms of the licence agreement under the GNU GPL v3.0 License. --> <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="licenseOption" value="GPL"/> <!-- If you select GPL as a license model than the 'licenseFile' must be empty. Otherwise please enter the path to the license file if available. It is also possible to add the license file later on. --> <entry key="licenseFile" 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 installer expands this path with the JS7 Controller ID as a sub-directory. The path must be absolute! The default path is 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 FILES AND LOG FILES The installer expands this path with the JS7 Controller ID as a sub-directory. The path must be absolute! The 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 instance is a standby Controller instance in a cluster --> <entry key="isStandby" value="no"/> <!-- Choose 'yes' or 'no' whether the JS7 Controller should be started after installation --> <entry key="launchController" value="yes"/> <!-- HTTP port of the JS7 Controller --> <entry key="controllerPort" value="4444"/> <!-- Optionally specify an IP address or hostname that is used to indicate which network interface the JS7 Controller should listen to when using HTTP. If empty then the Controller listens to any available network interfaces. --> <entry key="controllerHost" value=""/> <!-- The JS7 Controller will be installed as a Windows Service. You can set the Windows Service account otherwise the local system account will be used. The account has to be specified according to the pattern '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 configuration 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 the JS7 Controller e.g. %USERPROFILE% (default: [installation path]) --> <entry key="workPath" value=""/> <!-- The JS7 Controller requires a Java JRE minimum version '1.8'. You can choose a different Java environment than the Java used during installation. --> <entry key="javaHome" value=""/> <!-- Optionally specify 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>
Running the Installer
Running the installer of the JS7 Controller on Windows systems:
Code Block language text title Running the installer of JS7 Controller on Windows systems C:\temp\controller.[release]> setup.cmd controller_install.xml
Directory Structure
After installation the resulting directory structure is similar to what is as explained with the above chapter Installation from .tar.gz/.zip Archive.
Directories for installation and configuration of the Controller might differ.
Update
Preparation
- Stop the JS7 Controller instance.
- 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 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:
- Take 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 explained for a fresh installation.
Steps to run the installer are the same as explained for a fresh installation.
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-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 directory and configuration directory 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 directory and configuration directory.
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 below command that will 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/environment_variables.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 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
- JS7 - Controller - Use of Windows Graphical Installer
- JS7 - Controller - Command Line Operation
- JS7 - Controller Configuration