Page History
...
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
...
title | Notes |
---|
We have to explain what to do before running an update:
...
- How to verify that no workflows are running?
...
- Prepare a rollback in case the updating the JS7 Controller is not successful then a backup is necessary.
- Create
...
- a .tar.gz/.zip archive
...
- Users will later on have to re-install the service
- 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:
- 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
- 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
- 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
controller
_install.xml
the file is shown in 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?
Code Block 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"/--> <!-- If you selected GPL as license model than the licence must be empty. Otherwise please enter a license key if available. It is also possible to modify the license key later. --> <!--entry key="licence" 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 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
Running the installer of JS7 Controller on Linux systems with root permissions
Code Block language text title Starting batch installation of the JOC Cockpit 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
Code Block language text title Starting batch installation of the 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 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
Info | ||
---|---|---|
| ||
Explain what steps have to be taken for a rollback:
|
Installation Log
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 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
- 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 ReferencesFor 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?
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