Page History

...

• --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 If this option is omitted then the <home>/var directory is directory will be used, see option option --home.
• --config
  • Specifies the directory from which the Controller reads configuration files.
  • By default the <data>/config directory is used, see option --data.
• --logs
  • Specifies the directory to which the Controller stores log files.
  • By default the <data>/logs directory is used, see option --data.
• --user
  • Specifies the user account for the Controller daemon.
  • By default the account of the user running the Controller Installation Script is used.
• --controller-id
  • Specifies the Controller ID, a unique identifier of the Controller installation. If more than one Controller should be registered with JOC Cockpit then they have to use different Controller IDs.
  • If two Controller instances should work in a Cluster then they have to use the same Controller ID.
• --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 or patch files. If this option is not used the installation or patch 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 <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 backup file in this directory.
• --jar
  • Optionally specifies the path to a .jar file that holds the patch.
• --http-port
  
  • Specifies the HTTP port that the Controller is operated for. The default value is 4444. The HTTP port is used to specify the value of the JS7_CONTROLLER_HTTP_PORT environment variable in the Controller Instance Start Script.
  • The port can be prefixed by the network interface, for example localhost:4444.
  • When used with the --restart switch the HTTP port is used to identify if the Controller instance is running.
• --https-port
  • Specifies the HTTPS port that the Controller is operated for. The HTTPS port is specified in the Controller Instance Start Script typically available from ./bin/controller_instance.sh. with the environment variable JS7_CONTROLLER_HTTPS_PORT. Use of HTTPS requires a keystore and truststore to be present, see --keystore and --truststore options.
  • The port can be prefixed by the network interface, for example batch.example.com:4444.
• --pid-file-dir
  • Specifies the directory to which the Controller stores its PID file. By default the <data>/logs directory is used.
  • When using SELinux then it is recommended to specify the /var/run directory, see JS7 - How to install for SELinux.
• --pid-file-name
  • Specifies the name of the PID file. By default the file name controller.pid is used.
  • The PID file is created in the directory specified by the --pid-file-dir option.
• --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.
• --instance-script
  • Specifies the path to a script that acts as the Instance Start Script and that is copied to the bin directory. Typically the name controller_instance.sh. is used. Users are free to choose any name for the script. The script has to be executable for the Controller daemon, see --user. Permissions of the script are not changed by the Controller Installation Script.
  • The Controller Installation Script will perform replacements in the Instance Start Script template for known placeholders such as <JS7_CONTROLLER_USER>, for details see ./bin/controller_instance.sh-example.
• --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 Controller Installation 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
• --exec-start
  • This option can be used should the Controller be started after installation. For example, when using systemd then the option --exec-start="StartService" will start the Controller service provided that the related systemd service has been created manually or by use of the --make-service switch. Alternatively users can specify individual commands, for example --exec-start="sudo systemctl start js7_controller".
  • 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 should the Controller be stopped before installation. For example, when using systemd then the option --exec-stop="StopService" will stop the Controller service provided that the related systemd service has been created manually or by use of the --make-service switch. Alternatively users can specify individual commands, for example --exec-stop="sudo systemctl stop js7_controller".
  • 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)

...

curl 'https://download.sos-berlin.com/JobScheduler.2.5/js7_controller_unix.2.5.2.tar.gz' \
    -o /tmp/js7_controller_unix.2.5.2.tar.gz

./js7_install_controller.sh \
    --tarball=/tmp/js7_controller_unix.2.5.2.tar.gz \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --http-port=4444 \
    --exec-start="StartService" \
    --exec-stop="StopService" \
    --make-service \
    --make-dirs

# downloads the release tarball from the SOS Web Site using curl
# extracts the tarball to the Controller's home directory
# creates the Controller's systemd service
# stops and starts the Controller's systemd service
# operates the Controller for HTTP port 4444

...

curl 'https://download.sos-berlin.com/JobScheduler.2.5/js7_controller_unix.2.5.2.tar.gz' \
    -o /tmp/js7_controller_unix.2.5.2.tar.gz
retval=/tmp/js7_install_controller.$$.tmp

./js7_install_controller.sh \
    --tarball=/tmp/js7_controller_unix.2.5.2.tar.gz \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --http-port=4444 \
    --backup-dir=/tmp/backups \
    --log-dir=/tmp/logs \
    --return-values=$retval \
    --exec-start="StartService" \
    --exec-stop="StopService" \
    --make-service \
    --make-dirs
 
log_file=$(cat $retval | grep "log_file" | cut -d'=' -f2)
backup_file=$(cat $retval | grep "backup_file" | cut -d'=' -f2)

# downloads the release tarball from the SOS Web Site using curl
# creates a backup archive and log file
# extracts the tarball to the Controller's home directory
# provides return values from a temporary file which includes the path to the log file and to the backup archive
# stops and starts the Controller from its systemd service
# operates the Controller for HTTP port 4444

...

curl 'https://download.sos-berlin.com/JobScheduler.2.5/js7_controller_unix.2.5.2.tar.gz' \
    -o /tmp/js7_controller_unix.2.5.2.tar.gz

./js7_install_controller.sh \
    --tarball=/tmp/js7_controller_unix.2.5.2.tar.gz \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --http-port=localhost:4444 \
    --https-port=batch.example.com:4444 \
    --private-conf=/home/sos/controller-deployment/private.conf \
    --controller-secondary-cert=/home/sos/controller-deployment/centostest-secondary.crt \
    --joc-primary-cert=/home/sos/controller-deployment/centostest-primary.crt \
    --joc-secondary-cert=/home/sos/controller-deployment/centostest-secondary.crt \ 
    --keystore=/home/sos/controller-deployment/https-keystore.p12 \
    --keystore-password="jobscheduler" \
    --truststore=/home/sos/controller-deployment/https-truststore.p12 \
    --truststore-password="jobscheduler" \ 
    --exec-start=StartService \
    --exec-stop=StopService \
    --make-service \
    --make-dirs

# downloads the release tarball from the SOS Web Site using curl
# extracts the tarball to the Controller's home directory
# specifies HTTP port 4444 on the localhost network interface and the same HTTPS port on the server network interface
# specifies the path to the Secondary Controller's server certificate used by the Primary Controller instance if a Controller Cluster is used
#    a Primary Controller instance requires the server certificate of the Secondary Controller instance
#    a Secondary Controller instance requires the server certificate of the Primary Controller instance
#    for a Standalone Controller both --controller-primary-cert and --controller-secondary-cert argumentsoptions are omitted
# specifies the paths to the Primary and Secondary JOC Cockpit's server certificates if a JOC Cockpit Cluster is used
#     for a Standalone JOC Cockpit the --joc-secondary-cert argumentoption is omitted
# deploys the Controller private configuration file which holds references to keystore and truststore
# deploys keystore and truststore files
# stops and starts the Controller's systemd service

...

./js7_install_controller.sh \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --exec-start="StartService" \
    --exec-stop="StopService" \
    --no-install

# stops the Controller's systemd service if the Controller is running
# starts the Controller's systemd service

...

./js7_install_controller.sh \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --exec-stop="StopService" \
    --no-install

# stops the Controller's systemd service if the Controller is running

...

./js7_install_controller.sh \
    --release=2.2.3 \
    --patch=JS-1984 \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --exec-start="StartService" \
    --exec-stop="StopService"

# downloads the patch tarball from the SOS Web Site
# extracts the patch tarball to the Controller's home directory
# stores the patch files to the Controller's <home>/lib/patches sub-directory
# stops and starts the Controller's systemd service

...

curl 'https://download.sos-berlin.com/JobScheduler.2.2/js7_controller_unix.2.2.3.JS-1984.tar.gz' \
    -o /tmp/js7_controller_unix.2.2.3.JS-1984.tar.gz

./js7_install_controller.sh \
    --tarball=/tmp/js7_controller_unix.2.2.3.JS-1984.tar.gz \
    --patch=JS-1984 \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --exec-start="StartService" \
    --exec-stop="StopService"

# downloads the patch tarball from the SOS Web Site using curl
# extracts the patch tarball to the Controller's home directory
# stores the patch files to the Controller's <home>/lib/patches sub-directory
# stops and starts the Controller's systemd service

...

curl 'https://download.sos-berlin.com/JobScheduler.2.2/patch-20220331-JS-1984-2.2.3.jar' \
    -o /tmp/patch-20220331-JS-1984-2.2.3.jar

./js7_install_controller.sh \
    --jar=/tmp/patch-20220331-JS-1984-2.2.3.jar \
    --patch=JS-1984 \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --exec-start="StartService" \
    --exec-stop="StopService"

# downloads the patch .jar file from the SOS Web Site using curl
# stores the patch .jar file to the Controller's <home>/lib/patches sub-directory
# stops and starts the Controller's systemd service

...

./js7_install_controller.sh \
    --home=/home/sos/controller \
    --controller-id="controller" \
    --exec-stop="StopService" \
    --uninstall

# stops the Controller's systemd service
# uninstalls the Controller and removes the home and data directories

...