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/Linux platforms.
      • controller_watchdog.cmd|sh
        • Restarts the Controller in for Windows/Linux platforms.
      • environment_variables.cmd|sh
        • Sets environment variables for the JS7 Controller.
    • lib
      • The directory for Java libraries.
    • 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 in place 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 archive that is used for any fresh installation:

• js7_controller_windows.x.x.x.zip for windows
• js7_controller_unix.x.x.x.tar.gz for Linux

Preparation

• Stop the JS7 Controller instance.
• Prepare to rollback in case that the update of the JS7 Controller is not successful:
  • Create a .tar.gz/.zip archive for the
    • Installation Directory:
      • The default installation paths for the Controller are:

        • /opt/sos-berlin.com/js7/controller/<controller-ID> on Linux systems and

        • C:\Program Files\sos-berlin.com\js7\controller\<controller-ID> on Windows.
    • Configuration Directory
      • The default configuration paths for the Controller are:
        • /home/sos/sos-berlin.com/js7/controller/<controller-ID> on Linux systems and 
        • C:\ProgramData\sos-berlin.com\js7\controller\<controller-ID> on Windows.
• Take a backup of the above archives created.

Note: For the Linux environments taking a 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 previously installed it added 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 and

    • C:\Program Files\sos-berlin.com\js7\controller\<controller-ID> on Windows.

• The controller_install.xml the file is shown in the code listing below. The extensive comments are intended to be self-explanatory.  

  Code 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 configuration file for JS7 Controller setup The JS7 Controller is available with a dual licensing model. - GNU GPL 2.0 License (see http://www.gnu.org/licenses/gpl-2.0.html) - JS7 Commercial License (see licence.txt) The setup asks you for the desired license model (see <entry key="licenceOptions" .../> below). If you call the setup with this XML file then you accept at the same time the terms of the chosen license agreement. --> <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="licenceOptions" value="GPL"/--> </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 installation expands this path with the JS7 ID as subdirectory. It must be absolute! For example 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 AND LOG FILES The installation expands this path with the JS7 ID as subdirectory. The path must be absolute! 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 is a Standby-Controller in a cluster --> <entry key="isStandby" value="no"/> <!-- Choose (yes or no) wether the JS7 Controller should be started at the end of the installation --> <entry key="launchController" value="yes"/> <!-- HTTP port of the JS7 Controller --> <entry key="controllerPort" value="4444"/> <!-- Set optionally an ip address or hostname. It could be used for indicating which network interfaces the JS7 Controller should listen to when using HTTP. If it is empty then it listens to all available network interfaces. --> <entry key="controllerHost" value=""/> <!-- The JS7 Controller will be installed as Windows service. You can set the service account otherwise the local system account will be used. The account has to be the form '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 user 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 all jobs which started by the JS7 Controller e.g. %USERPROFILE% (default: [installation path]) --> <entry key="workPath" value=""/> <!-- The JS7 Controller requires a Java JRE at least version '1.8'. You can choose a different Java environment than the Java which is used during this installation. --> <entry key="javaHome" value=""/> <!-- Set optionally 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

• Installing Install the JS7 Controller on Linux systems for the root user:

  Code Block
  language text title Running the installer of JS7 Controller on Linux systems with root permissions
  /tmp/controller.[release]> ./setup.sh controller_install.xml

• Installing Install the JS7 Controller on Linux systems for the current user:

  Code Block
  language text title 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:

  Code Block
  language text title Running the installer of JS7 Controller on Windows systems
  C:\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 a rollback there are different steps to be followed for Windows and Linux.

Rollback JS7 Controller Instance on Windows

• To perform a rollback of the JS7 Controller instance 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 and

    • C:\Program Files\sos-berlin.com\js7\controller\<controller-ID>\Uninstaller on Windows.
• 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 and

      • C:\Program Files\sos-berlin.com\js7\controller\<controller-ID>\bin on Windows.

  • 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>]

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 paths of the logs directory for the Controller are:
  • /home/sos/sos-berlin.com/js7/controller/<Controller-ID> on Linux systems and 
  • C:\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 and by use of systemd.

• Consider the use of the JS7_USER environment variable to run a Controller that is started by root for a different user account.
• For use with systemd find a sample service file from ./bin/controller.service-example file.

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

...