Skip to end of metadata
Go to start of metadata

Introduction

Updates and upgrades are performed using the .tar.gz/.zip installer archives provided for the initial installation of newer releases.

  • The JS7 - Installation instructions apply to updates and upgrades.
  • The update and upgrade processes can be automated for environments with a larger number of JOC Cockpit instances, Controllers and Agents.
    • Users can use their preferred tools such as Ansible®, Puppet®, Chef®.
    • Users can apply the Controller Installer Script that is described in this article.

Security

Secure rollout of JS7 components is critical. It is therefore recommended that the solution described here is adjusted to suit specific security needs.

  • Rollout of JS7 Controllers is considered critical as the software allows jobs to be executed on a larger number of servers.
    • Integrity of the sources for downloads of JS7 components deserves attention.
    • This includes intermediate devices on which JS7 software installers are stored in a user's environment.
    • It is an option to run the Controller Installer Script from sudo and to use the digest functionality that compares the script to a hash value stored with the sudoers file.
  • The solution provided for updating, upgrading and patching JS7 Controllers is based on shell scripting by design:
    • to provide readability and to rely on OS commands only,
    • to deny the use of any 3rd-party components and additional dependencies that require code to be executed on the machines running Controllers.
  • The Controller Installer Script can be integrated in a number of ways:
    • by running one's own SSH script on top of the Controller Installer Script,
    • by using tools such as Ansible®, Puppet® that make use of an SSH Client,
    • by using JS7 workflow automation as explained below.
      • It is recommended that a separate Standalone Controller and Agent are used for rollout purposes.
      • Access to the Controller and Agent for rollout should be securely managed.

Controller Installer Script

The Controller Installer Script is provided for download and can be used to automate updates, upgrades and patches of JS7 Controllers.

  • The script is available for Linux, MacOS® and AIX® using bash, dash, ksh and zsh shells.
  • The script terminates with exit code 0 to signal success, with exit code 1 for command line argument errors and with exit code 2 for non-recoverable errors.
  • The script is intended as a baseline example for customization by JS7 users and by SOS within the scope of professional services.
  • Refer also to information in the  JS7 - Controller Command Line Operation article.

Download

Find the Controller Installer Script for download from JS7 - Download.

Usage

Invoking the Controller Installer Script without arguments displays the usage clause:


Controller Installer Script: js7_install_controller.sh
Usage: js7_install_controller.sh [Options] [Switches]

  Options:
    --home=<directory>          | required: directory to which the Controller should be installed
    --data=<directory>          | optional: directory for Controller data files if different from <home>/var directory
    --release=<release-number>  | optional: release number such as 2.3.1 for download if --tarball option is not used
    --tarball=<tar-gz-archive>  | optional: the path to a .tar.gz archive that holds the Controller tarball,
                                |           if not specified the Controller tarball is downloaded from the SOS web site
    --patch=<issue-key>         | optional: identifies a patch for an existing Controller installation
    --license-key=<key-file>    | optional: specifies the path to a license key file that should be installed
    --license-bin=<binary-file> | optional: specifies the path to the js7-license.jar binary file for licensed code to be installed
                                |           if not specified the file is downloaded from the SOS web site
    --backup-dir=<directory>    | optional: backup directory for existing Controller home directory
    --log-dir=<directory>       | optional: log directory for log output of this script
    --http-port=<http-port>     | optional: specifies the http port the Controller is operated for
    --exec-start=<command>      | optional: specifies the command to start the Controller, e.g. 'sudo systemctl start controller'
    --exec-stop=<command>       | optional: specifies the command to stop the Controller, e.g. 'sudo systemctl stop controller'
    --return-values=<file>      | optional: specifies a file that receives return values such as the path to a log file
  Switches:
    -h | --help                 | displays usage
    --show-logs                 | shows log output of the script
    --make-dirs                 | creates the specified directories if they do not exist
    --move-libs                 | moves an existing Controller's lib directory instead of removing the directory
    --remove-journal            | removes an existing Controller's state directory that holds the journal
    --restart                   | stops a running Controller and starts the Controller after installation
    --abort                     | aborts a running Controller if used with the -restart switch
    --kill                      | kills a running Controller if used with the -restart switch


Explanation:

  • Options
    • --home
      • Specifies the directory in which the Controller should be installed.
    • --data
      • Specifies the directory in which the Controller data such as configuration files should be stored.
      • By default the <home>/var directory is used, see option --home.
    • --release
      • Specifies a release number such as 2.3.1 for download from the SOS web site if the --tarball option is not used.
    • --tarball
      • Optionally specifies the path to a .tar.gz file that holds the Controller installation files. If this option is not used the installer tarball will be downloaded from the SOS web site for the release indicated with the --release option.
      • Download is performed with curl that considers http_proxy and https_proxy environment variables and settings from a .curlrc file.
    • --patch
      • A patch is identified by an issue key in the Change Management System, for example JS-1984.
      • Patches are downloaded from the SOS web site if the --tarball option is not used.
      • Patches are added to the Controller's JS7_CONTROLLER_HOME/lib/patches directory. Note that the patches sub-directory will be emptied when updating a Controller installation later on.
      • If a backup directory is specified then a Controller's existing installation directory will be added to a .tar.gz file in this directory.
    • --license-key
      • Optionally the path to a license key file is specified. Customers with a Commercial License receive the license key file from SOS in .pem or .crt format.
      • For details see JS7 - How to apply a JS7 License Key.
    • --license-bin
      • Optionally the path to the js7-license.jar binary file is specified that includes code that is available for use with a Commercial License only, see JS7 - How to apply a JS7 License Key.
      • Should this argument be omitted and a license key file be specified with the --license-key option then the binary file is downloaded from the SOS Web Site, see JS7 - Download.
    • --backup-dir
      • If a backup directory is specified then an Controller's existing installation directory will be added to a .tar.gz file in this directory.
      • File names are created according to the pattern: backup_js7_controller.<hostname>.<release>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz
      • For example: backup_js7_controller.centostest_primary.2.3.1.2022-03-19T20-50-45.tar.gz
    • --log-dir
      • If a log directory is specified then the installer script will log information about processing steps to a log file in this directory.
      • File names are created according to the pattern: install_js7_controller.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
      • For example: install_js7_controller.centostest_primary.2022-03-19T20-50-45.log
    • --http-port
      • Optionally specifies the HTTP port that the Controller is operated for. When used with the --restart switch the HTTP port is used to identify whether the Controller is running.
    • --exec-start
      • This option can be used if the Controller is to be started after installation from an individual command. For example, when using systemd then the option --exec-start="sudo systemctl start controller" will start the Controller provided that the controller.service file has been configured for systemd.
      • For systemd service files see the JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems article.
      • This option is an alternative to the use of the -restart switch which starts the Controller from its Instance Start Script. If specified this option will overrule the --restart switch.
    • --exec-stop
      • This option can be used if the Controller is to be stopped before installation from an individual command. For example, when using systemd then the option --exec-stop="sudo systemctl stop controller" will stop the Controller provided that the controller.service file has been configured for systemd.
      • For systemd service files see the JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems article.
      • This option is an alternative to the use of the -restart switch which stops the Controller from its Instance Start Script. If specified this option will overrule the --restart switch.
    • --return-values
      • Optionally specifies the path to a file to which return values will be added in the format <name>=<key>. For example:
        • log_file=install_js7_controller.centostest_primary.2022-03-20T04-54-31.log
        • backup_file=backup_js7_controller.centostest_primary.2.3.1.2022-03-20T04-54-31.tar.gz
      • Any existing file will be overwritten. It is recommended that a unique file name such as /tmp/return.$$.$RANDOM.properties. is used.
      • A value from the file can be retrieved like this:
        • backup=$(cat /tmp/return.$$.$RANDOM.properties | grep "backup_file" | cut -d'=' -f2)
  • Switches
    • -h | --help
      • Displays usage.
    • --show-logs
      • Displays the log output created by the script.
    • --make-dirs
      • If directories are missing that are indicated with the --home, --backup-dir or --log-dir options then they will be created.
    • --move-libs
      • For an existing Controller installation the lib sub-directory includes .jar files that carry the release number in their file names. If replaced by a newer version the lib directory has to be moved or removed. This switch tries to move the directory to a previous version number as indicated from the .version file in the Controller's home directory. For example, to rename lib to lib.2.3.1.
      • Files in the lib/user_lib sub-directory are preserved.
    • --remove-journal
      • If a Controller has been installed for the wrong operating mode (standalone, clustered) then the Controller's journal in the JS7_CONTROLLER_DATA/state directory can be removed. This operation removes any orders submitted to a Controller and Agents. It requires the Agents to be re-registered to the Controller.
    • --restart
      • Stops a running Controller before installation and starts the Controller after installation using the Controller's Instance Start Script. This switch can be used with the --abort and --kill switches to control the way how the Controller is terminated. This switch is ignored if the --exec-start and --exec-stop options are used.
    • --abort
      • Aborts a running Controller if used with the --restart switch. Aborting an Controller includes to terminate the Controller in an orderly manner that allows to close files consistently.
    • --kill
      • Kills a running Controller if used with the --restart switch. This includes killing child processes of running tasks.
  • Exit Codes
    • 1: argument errors
    • 2: non-recoverable errors
    • 3: this exit code is returned when used with the --restart switch and if it cannot be identified whether a Controller instance is running
    • 4: this exit code is returned if no --tarball option is used and download of the tarball reports errors
    • 5: this exit code is returned when used with the --restart switch and if the Controller instance cannot be started
    • 6: this exit code is returned when used with the --restart switch and if the Controller instance cannot be stopped

Examples

The following examples illustrate typical use cases. Users should consider to specify current releases, see JS7 - Download.

Install or Update from Download

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --release=2.3.1 \
    --make-dirs

# downloads the indicated Controller release and extracts the tarball to the specified Controller home directory
# the home directory is created if it does not exist

Install or Update from Download with Commercial License

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --release=2.3.1 \
    --license-key=/home/sos/example.pem \
    --make-dirs

# downloads the indicated Controller release and extracts the tarball to the specified Controller home directory
# installs the license key file and downloads the binary file for licensed code to enable cluster operations

Install or Update from Tarball

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --tarball=/mnt/releases/js7/js7_controller_unix.2.3.1.tar.gz

# extracts the indicated tarball to the specified Controller home directory

Install or Update from Tarball with Commercial License

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --tarball=/mnt/releases/js7/js7_controller_unix.2.3.1.tar.gz \
    --license-key=/home/sos/example.pem \
    --license-bin=/mnt/releases/js7/js7-license.jar

# extracts the indicated tarball to the specified Controller home directory
# installs the license key file and binary file for licensed code to enable cluster operations

Install or Update and Stop/Start using systemd

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --tarball=/mnt/releases/js7/js7_controller_unix.2.3.1.tar.gz \
    --exec-start="sudo systemctl start js7_controller" \
    --exec-stop="sudo systemctl stop js7_controller"

# extracts the indicated tarball to the specified Controller home directory
# the Controller is stopped and started by use of systemd commands

Install or Update and Restart

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --tarball=/mnt/releases/js7/js7_controller_unix.2.3.1.tar.gz \
    --restart

# extracts the indicated tarball to the specified Controller home directory
# the Controller is stopped and started from its instance start script

Install or Update with Return Values

Example for use of Controller Installer Script
retval=/tmp/js7_install_controller.$$.tmp

./js7_install_controller.sh \
    --home=/home/sos/controller \
    --tarball=/mnt/releases/js7/js7_controller_unix.2.3.1.tar.gz \
    --backup-dir=/tmp/backups \
    --log-dir=/tmp/logs \
    --return-values=$retval

log_file=$(cat $retval | grep "log_file" | cut -d'=' -f2)
backup_file=$(cat $retval | grep "backup_file" | cut -d'=' -f2)

# extracts the indicated tarball to the specified Controller home directory, creates a log file and a backup file
# return values include the path to the log file and to the backup file

Install or Update with Fallback

Example for use of Controller Installer Script
retval=/tmp/js7_install_controller.$$.tmp

./js7_install_controller.sh \
    --home=/home/sos/controller \
    --tarball=/mnt/releases/js7/js7_controller_unix.2.3.1.tar.gz \
    --backup-dir=/tmp/backups \
    --log-dir=/tmp/logs \
    --return-values=$retval \
    --restart \
    --show-logs \
    --make-dirs \
 || ( backup=$(cat $retval | grep "backup_file" | cut -d'=' -f2 ) \
      && ( test -e "$backup" ) && \
      ./js7_install_controller.sh \
          --home=/home/sos/controlller \
          --tarball=$backup \
          --log-dir=/tmp/logs \
          --restart \
          --show-logs )

log_file=$(cat $retval | grep "log_file" | cut -d'=' -f2)
backup_file=$(cat $retval | grep "backup_file" | cut -d'=' -f2)

# extracts the indicated tarball to the specified Controller home directory, creates a backup file and a log file and restarts the Controller
# should installation fail then it is reverted from the backup file

Patch from Download

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --release=2.3.1 \
    --patch=JS-1984

# downloads the indicated patch and extracts the tarball to the specified Controller home directory
# the patch is stored to the Controller's lib/patches sub-directory

Patch from Tarball

Example for use of Controller Installer Script
./js7_install_controller.sh \
    --home=/home/sos/controller \
    --tarball=/mnt/releases/js7/js7_controller_unix.2.3.1.JS-1984.tar.gz \
    --patch=JS-1984

# extracts the indicated patch tarball to the specified Controller home directory
# the patch is stored to the Controller's lib/patches sub-directory

Automation

The Controller Installer Script can be executed from a job for automated update and upgrade of JS7 Controllers.

The steps for automation are similar to update and upgrade of JS7 Agents. Find instructions how to setup workflow automation in the JS7 - Automated Update of Agent article.

Further Resources



  • No labels