Page History

...

Usage: js7_install_agent.sh [Options] [Switches]

  Installation Options:
    --home=<directory>                 | required: directory to which the Agent will be installed
    --data=<directory>                 | optional: directory for Agent data files, default: <home>/var_4445
    --config=<directory>               | optional: directory from which the Agent reads configuration files, default: <data>/config
    --logs=<directory>                 | optional: directory to which the Agent writes log files, default: <data>/logs
    --work=<directory>                 | optional: working directory of the Agent, default: <data>
    --user=<account>                   | optional: user account for Agent daemon, default: $USER
    --home-owner=<account[:group]>     | optional: account and optionally group owning the home directory, requires root or sudo permissions
    --data-owner=<account[:group]>     | optional: account and optionally group owning the data directory, requires root or sudo permissions
    --release=<release-number>         | optional: release number such as 2.5.0 for download if --tarball is not used
    --tarball=<tar-gz-archive>         | optional: the path to a .tar.gz archive that holds the Agent installation or patch tarball,
                                       |           if not specified the Agent tarball will be downloaded from the SOS web site
    --patch=<issue-key>                | optional: identifies a patch for a Change Management issue key
    --patch-jar=<jar-file>             | optional: the path to a .jar file that holds the patch
    --license-key=<key-file>           | optional: specifies the path to a license key file to 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 will be downloaded from the SOS web site
    --http-port=<port>                 | optional: specifies the http port the Agent will be operated for, default: 4445
                                                   port can be prefixed by network interface, e.g. localhost:4445
    --https-port=<port>                | optional: specifies the https port the Agent will be operated for
                                                   port can be prefixed by network interface, e.g. batch.example.com:4445
    --pid-file-dir=<directory>         | optional: directory to which the Agent writes its PID file, default: <data>/logs
    --pid-file-name=<file-name>        | optional: file name used by the Agent to write its PID file, default: agent.pid
    --instance-script=<file>           | optional: path to the Instance Start Script that will be copied to the Agent, default <home>/bin/<instance-script>
    --backup-dir=<directory>           | optional: backup directory for existing Agent home directory
    --log-dir=<directory>              | optional: log directory for log output of this script
    --exec-start=<command>             | optional: command to start the Agent, e.g. 'StartService'
    --exec-stop=<command>              | optional: command to stop the Agent, e.g. 'StopService'
    --return-values=<file>             | optional: path to a file that holds return values such as the path to a log file

  Configuration Options:
    --deploy-dir=<dir>[,<dir>]         | optional: deployment directory from which configuration files are copied to the Agent
    --agent-conf=<file>                | optional: path to a configuration file that will be copied to <config>/agent.conf
    --private-conf=<file>              | optional: path to a configuration file that will be copied to <config>/private/private.conf
    --controller-id=<identifier>       | optional: Controller ID, default: controller
    --controller-primary-cert=<file>   | optional: path to Primary/Standalone Controller certificate file
    --controller-secondary-cert=<file> | optional: path to Secondary Controller certificate file
    --agent-cluster-id=<identifier>    | optional: Agent Cluster ID
    --director-primary-cert=<file>     | optional: path to Primary/Standalone Director Agent certificate file
    --director-secondary-cert=<file>   | optional: path to Secondary Director Agent certificate file
    --keystore=<file>                  | optional: path to a PKCS12 keystore file that will be copied to <config>/private/
    --keystore-password=<password>     | optional: password for access to keystore
    --keystore-alias=<alias>           | optional: alias name for keystore entry
    --client-keystore=<file>           | optional: path to a PKCS12 client keystore file that will be copied to <config>/private/
    --client-keystore-password=<pass>  | optional: password for access to the client keystore
    --client-keystore-alias=<alias>    | optional: alias name for client keystore entry
    --truststore=<file>                | optional: path to a PKCS12 truststore file that will be copied to <config>/private/
    --truststore-password=<password>   | optional: password for access to truststore
    --java-home=<directory>            | optional: Java Home directory for use with the Instance Start Script
    --java-options=<options>           | optional: Java Options for use with the Instance Start Script
    --service-dir=<directory>          | optional: systemd service directory, default: /usr/lib/systemd/system
    --service-file=<file>              | optional: path to a systemd service file that will be copied to <home>/bin/
    --service-name=<identifier>        | optional: name of the systemd service to be created, default js7_agent_<http-port>

    Switches:
    -h | --help                        | displays usage
    --force-sudo                       | forces use of sudo for operations on directories
    --active                           | makes Director Agent instance the default active node in an Agent Cluster
    --standby                          | makes Director Agent instance the default standby node in an Agent Cluster 
    --no-yade                          | excludes YADE from Agent installation
    --no-install                       | skips Agent installation, performs configuration updates only
    --use-install                      | uses existing Agent installation, populates data directory and creates service
    --uninstall                        | uninstalls Agent and removes <home> and <data> directories
    --uninstall_home                   | uninstalls Agent and removes <home> directory only
    --uninstall_data                   | uninstalls Agent and removes <data> directory only
    --service-selinux                  | use SELinux version of systemd service file
    --show-logs                        | shows log output of the script
    --make-dirs                        | creates the specified directories if they do not exist
    --make-service                     | creates the systemd service for the Agent
    --move-libs                        | moves an existing Agent's lib directory instead of removing the directory
    --remove-journal                   | removes an existing Agent's state directory that holds the journal files
    --restart                          | stops a running Agent and starts the Agent after installation
    --abort                            | aborts a running Agent if used with the --restart switch
    --kill                             | kills a running Agent if used with the --restart switch 

...

• --home
  • Specifies the directory in which the Agent should be installed.
• --data
  • Specifies the directory in which Agent data such as configuration files should be stored.
  • By default the <home>/var_<http-port> directory is used, see options --home and --http-port.
• --config
  • Specifies the directory from which the Agent reads configuration files.
  • By default the <data>/config directory is used, see option --data.
• --logs
  • Specifies the directory to which the Agent stores log files.
  • By default the <data>/logs directory is used, see option --data.
• --work
  • Specifies the working directory of the Agent.
  • By default the <data> directory is used, see option --data.
• --user
  • Specifies the user account for the Agent daemon running as a systemd service.
  • By default the account of the user running the Agent Installation Script is used.
  • Should the the home or data directory be owned by an account that is different from the one running the Agent Installation Script then consider use of the --home-owner and --data-owner options.
• --home-owner
  • Optionally specifies the user account and group that should own the home directory. By default the home directory is created and owned by the current user account.
  • Syntactically a user account and optionally a group can be specified, for example --home-owner=sos or --home-owner=sos:sos. If the group is not specified then a group with the name of the user account is assumed.
  • Use of this option requires sudo permissions for the user account that runs the Agent Installation Script.
• --data-owner
  • Optionally specifies the user account and group that should own the data directory. By default the data directory is created and owned by the current user account.
  • Syntactically a user account and optionally a group can be specified, for example --data-owner=sos or --data-owner=sos:sos. If the group is not specified then a group with the name of the user account is assumed.
  • Use of this option requires sudo permissions for the user account that runs the Agent Installation Script.
• --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 Agent 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 respective 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 Agent's <home>/lib/patches directory. Note that the patches sub-directory will be emptied when updating an Agent installation later on.
  • If a backup directory is specified then an Agent's existing installation directory will be added to a .tar.gz backup file in this directory.
• --patch-jar
  • Optionally specifies the path to a .jar file that holds the patch if a patch is provided in this format.
• --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 option 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.
• --http-port
  • Specifies the HTTP port that the Agent is operated for. The default value is 4445. The Agent by default makes use of a data directory <home>/var_<http-port> that will be excluded from a backup taken with the --backup-dir option. In addition the HTTP port is used to identify the Agent Instance Start Script typically available from the <home>/bin/agent_<http-port>.sh script and to specify the value of the JS7_AGENT_HTTP_PORT environment variable in the script.
  • The port can be prefixed by the network interface, for example localhost:4445.
  • When used with the --restart switch the HTTP port is used to identify if the Agent is running.
• --https-port
  • Specifies the HTTPS port that the Agent is operated for. The HTTPS port is specified in the Agent Instance Start Script typically available from the <home>/bin/agent_<http-port>.sh script with the environment variable JS7_AGENT_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:4445.
• --pid-file-dir
  • Specifies the directory to which the Agent stores its PID file. By default the <data>/logs directory is used.
  • When using SELinux then it is recommended to specify and to create the /var/run/js7 directory, see see JS7 - How to install for SELinux.
• --pid-file-name
  • Specifies the name of the PID file. By default the file name agent.pid is used.
  • The PID file is created in the directory specified by the --pid-file-dir option.
• --instance-script
  • Specifies the path to an Instance Start Script that acts as a template and that is copied to the <home>/bin directory. Typically the name agent_<http-port>.sh. is used. Users are free to choose any name for the Instance Start Script. The script has to be executable for the Agent daemon, see --user option. Permissions of the script are not changed by the Agent Installation Script.
  • The Agent Installation Script will perform replacements in the Instance Start Script template for known placeholders such as <JS7_AGENT_USER>, for details see <home>/bin/agent_instance.sh-example.
• --backup-dir
  • If a backup directory is specified then an Agent's existing installation directory will be added to a .tar.gz file in this directory before applying changes to the Agent installation.
  • File names are created according to the pattern: backup_js7_agent.<hostname>.<release>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz
    • For example: backup_js7_agent.centostest_primary.2.3.1.2022-03-19T20-50-45.tar.gz
  • A backup is intended to restore files in the Agent's installation directory, not in its data directory, see --data. The purpose of a backup is to restore files that are replaced by the Agent Installation Script, its purpose is not to restore an Agent installation that otherwise is corrupted or removed. No backup will be taken if one of the --uninstall options is used.
• --log-dir
  • If a log directory is specified then the Agent Installation Script will write information about processing steps to a log file in this directory.
  • File names are created according to the pattern: install_js7_agent.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
  • For example: install_js7_agent.centostest_primary.2022-03-19T20-50-45.log
• --exec-start
  • This option can be used should the Agent be started after installation. For example, when using systemd then the option --exec-start="StartService" will start the Agent 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_agent_4445".
  • 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 will start the Agent from its Instance Start Script. If specified this option overrules the --restart switch.
• --exec-stop
  • This option can be used should the Agent be stopped before installation. For example, when using systemd then the option --exec-stop="StopService" will stop the Agent 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_agent_4445".
  • 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 Agent from its Instance Start Script. If specified this option overrules 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_agent.centostest_primary.2022-03-20T04-54-31.log
    • backup_file=backup_js7_agent.centostest_primary.2.3.1.2022-03-20T04-54-31.tar.gz
  • An existing file will be overwritten. It is recommended to use a unique file name such as /tmp/return.$$.$RANDOM.properties.
  • A value from the file can be retrieved like this:
    • backup=$(cat /tmp/return.$$.$RANDOM.properties | grep "backup_file" | cut -d'=' -f2)

...

• --deploy-dir
  • Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the <config> directory. A deployment directory allows to manage central copies of configuration files such as agent.conf, private.conf, log4j2.xml etc.
  • Use of a deployment directory has lower precedence as files can be overwritten by individual options such as --agent-conf, --private-conf etc.
• --agent-conf
  • Specifies the path to a configuration file for global JS7 - Agent Configuration Items. The file will be copied to the <config>/agent.conf file.
  • Any path to a file can be used as a value of this option, however, the target file name agent.conf will be used.
• --private-conf
  • Specifies the path to a configuration file for private JS7 - Agent Configuration Items. The file will be copied to the <config>/private/private.conf file.
  • Any path to a file can be used as a value of this option, however, the target file name private.conf will be used.
  • Users have a choice how to provide the required configuration:
    • Download the private.conf-template-agent template, the Agent Installation Script performs replacements of placeholders in the template file from option values, for details see chapter Replacements.
    • Users can manually adjust configuration items in the private.conf file that they specify for the Agent Installation Script, see JS7 - Agent Configuration Items.
• --controller-id
  • Specifies the Controller ID, a unique identifier of the Controller installation. Agents will be dedicated to the Controller with the given Controller ID.
  • The Controller ID is used in the Agent's private.conf file to specify which Controller can access a given Agent.
• --controller-primary-cert
  • Specifies the path to the SSL/TLS certificate of the Primary Controller instance. The Agent Installation Script extracts the distinguished name from the given certificate and adds it to the Agent's private.conf file to allow HTTPS connections from the given Controller using mutual authentication without the need for passwords.
• --controller-secondary-cert
  • Corresponds to the --controller-primary-cert option and is used for the Secondary Controller instance.
• --agent-cluster-id
  • Specifies the Agent Cluster ID, a unique identifier of the Agent Cluster. This is not the Primary/Secondary Director Agent ID.
  • Subagents will be dedicated to the Agent Cluster with the given Agent Cluster ID.
  • The Agent Cluster ID is used in the Agent's private.conf file to specify which pairing Director Agent instance can access the given Director Agent instance.
• --directorydirector-primary-cert
  • Specifies the path to the SSL/TLS certificate of the Primary Director Agent instance. The Agent Installation Script extracts the distinguished name from the given certificate and adds it to the Agent's private.conf file to allow HTTPS connections from the given Director Agent instance using mutual authentication without the need for passwords.
• --director-secondary-cert
  • Corresponds to the --director-primary-cert option and is used for the Secondary Director Agent instance.
• --keystore
  • Specifies the path to a PKCS12 keystore file that holds the private key and certificate for HTTPS connections to the Agent.
  • Users are free to specify any file name, typically the name https-keystore.p12 is used. The keystore file will be copied to the <config>/private directory.
  • If a keystore file is made available then the Agent's <config>/private/private.conf file has to hold a reference to the keystore location and optionally the keystore password. It is therefore recommended to use the --private-conf option to deploy an individual private.conf file that holds settings related to a keystore.
  • For automating the creation of keystores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.
• --keystore-password
  • Specifies the password for access to the keystore. Use of a keystore password is required.
  • Consider use of quotes when specifying the password.
• --keystore-alias
  • If a keystore holds more than one private key, for example if separate pairs of private keys/certificates for server authentication and client authentication exist, then it is not determined which private key/certificate will be used. The alias name of a given private key/certificate is specified when the entry is added to the keystore. The alias name allows to indicate a specific private key/certificate to be used.
• --client-keystore
  • Use of this setting is optional. It can be used if separate certificates for Server Authentication and Client Authentication are used.
  • The Client Authentication private key and certificate can be added to a client keystore. The location and configuration of a client keystore correspond to the--keystore option.
• --client-keystore-password
  • Specifies the password for access to the client keystore. Use of a client keystore password is required if a client keystore is used.
  • Consider explanations for the --keystore-password option.
• --client-keystore-alias
  • If a client keystore holds more than one private key, for example if a number of private keys/certificates for client authentication exist, then it is not determined which private key/certificate will be used.
  • Consider explanations for the --keystore-alias option.
• --truststore
  • Specifies the path to a PKCS12 truststore file that holds the certificate(s) for HTTPS connections to the Agent using mutual authentication .
  • Users are free to specify any file name, typically the name https-truststore.p12 is used. The truststore file will be copied to the <config>/private directory.
  • If a truststore file is made available then the Agent's <config>/private/private.conf file has to hold a reference to the truststore location and optionally the truststore password. It is therefore recommended to use the --private-conf option to deploy an individual private.conf file that holds settings related to a truststore.
  • For automating the creation of truststores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.
• --truststore-password
  • Specifies the password for access to the truststore. Use of a password is recommended as it is not primarily intended to protect access to the truststore. The password is intended to allow verification that truststore entries have been added using the same password.
  • Consider use of quotes when specifying the password.
• --java-home
  • Specifies the Java home directory that will be made available to the Agent from the JAVA_HOME environment variable specified with the Agent Instance Start Script typically available from the ./bin/agent_<http-port>.sh script.
• --java-options
  • Specifies the Java options that will be made available to the Agent from the JAVA_OPTIONS environment variable specified with the Agent Instance Start Script typically available from the ./bin/agent_<http-port>.sh script.
  • Java options can be used for example to specify Java heap space settings for the Agent.
  • If more than one Java option is used then the value has to be quoted, for example --java-options="-Xms256m -Xmx512m".
• --service-dir
  
  • Specifies the systemd service directory to which the Agent's service file will be copied if the --make-service switch is used.
  • By default the /usr/lib/systemd/system directory will be used. Users can specify an alternative location.
• --service-file
  
  • Specifies the path to a systemd service file that acts as a template and that will be copied to the Agent's <home>/bin directory. Users are free to choose any file name as a template for the service file. The resulting service file name will be agent_<http-port>.service.
  • The Agent Installation Script will not perform replacements in the service file to update paths and the port to be used, for etc., for details see ./bin/agent.service-example.
• --service-name
  
  • Specifies the name of the systemd service that will be created if the --make-service switch is used.
  • By default the service name js7_agent_<http-port> will be used.

...

• -h | --help
  • Displays usage.
• --force-sudo
  • Specifies that sudo is used when performing operations on directories. This switch is required if the home or data directory is not owned by the user account running the Agent Installation Script.
• --active
  • This setting is used for Director Agents only. It specifies that the Director Agent instance should act as the active node in a Director Agent Cluster during initial operation.
  • This setting is not required for installation of a Primary Director Agent in an Agent Cluster. It can be used to revert a Secondary Director Agent to a Primary Director Agent.
• --standby
  • This setting is used for Director Agents only. It specifies that the Director Agent instance should act as the standby node in a Director Agent Cluster during initial operation.
  • This setting is required when installing a Secondary Director Agent instance in an Agent Cluster.
• --no-yade
  • Excludes the YADE file transfer utility from the Agent installation.
  • YADE is available from the yade sub-directory of the Agent's <home> directory. If this switch is used then an existing yade sub-directory will be removed and YADE will not be copied from the installation tarball to the Agent's <home> directory.
• --no-install
  • Specifies if the Installation Script should be used to update configuration items without changes to the binary files of the installation.
    In fact no installation is performed but configuration changes as for example specified with the --keystore option will be applied.
• -use-install

  • Resuses an existing Agent installation. No installation files are specified as with the --release or --tarball parameters. Instead, the new Agent's data directory and the respective service will be created.

• --uninstall
  • Uninstalls the Agent including the steps to stop and to remove a running Agent service and to remove the <home> and <data> directories.
• --uninstall-home
  • Uninstalls the Agent including the steps to stop and to remove a running Agent service and removes the <home> directory only.
• --uninstall-data
  • Uninstalls the Agent including the steps to stop and to remove a running Agent service and preserves the <data> directory only.

• --service-selinux
  • Updates the systemd service file for compliance with SELinux, see JS7 - How to install for SELinux.
• --show-logs
  • Displays the log output created by the script if the --log-dir option is used.
• --make-dirs
  • If directories are missing that are indicated with the --home, --backup-dir or --log-dir options then they will be created.
• --make-service
  • Specifies that a systemd service should be created for the Agent. The service will be created from the --service-name option or its default value.
• --move-libs
  • For an existing Agent 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 Agent'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 Agents have been installed for the wrong operating mode (standalone, clustered) then the Agent's journal in the JS7_AGENT_DATA/state directory can be removed. This operation removes any orders submitted to an Agent and requires the Agent to be re-registered to a Controller.
• --restart
  • Stops a running Agent before installation and starts the Agent after installation using the Agent's Instance Start Script. This switch can be used with the --abort and --kill switches to control the way how the Agent is terminated. This switch is ignored if the --exec-start or --exec-stop options are used.
• --abort
  • Aborts a running Agent and kills any running tasks including child processes if used with the --restart switch. Aborting an Agent includes to terminate the Agent in an orderly manner that allows to close files consistently.
• --kill
  • Kills a running Agent and any running tasks if used with the --restart switch. This includes killing child processes of running tasks.

...

The Agent Installation Script performs replacements of placeholders in installation files and configuration files by option values, for details see chapter Replacements.

Examples

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

Common Options for Agent Clusters

In an Agent Cluster users find the following roles:

• Primary Director Agent: first Director Agent that orchestrates Subagents. By default this is the active instance in a Director Agent Cluster.
• Secondary Director Agent: second Director Agent that orchestrates Subagents. By default this is the standby instance in a Director Agent Cluster.
• Subagent: a worker node in an Agent Cluster that executes jobs.

The following matrix shows applicable and required options for roles in an Agent Cluster as opposed to use of Standalone Agents:

Explanation:

• n/a: the setting is not applicable and must not be used
• not used: the setting is ignored
• required: the setting must be specified

Examples

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

Install or Update from Download

...

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

./js7_install_agent.sh \
    --tarball=/tmp/js7_agent_unix.2.5.2.tar.gz \
    --home=/home/sos/agent \
    --http-port=4445 \
    --java-home=/opt/java/jdk-1117.0.2+9 \
    --java-options="-Xmx512m -Xms256m" \
    --restart \
    --make-dirs

# downloads the release tarball from the SOS Web Site using curl
# extracts the tarball to the Agent's home directory
# specifies the Java version and Java options to be used
# stops and starts the Agent from its instance start script <home>/bin/agent_4445.sh
# operates the Agent for HTTP port 4445

...