Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • -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
    • Specifies 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
    • Specifies 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.
  • --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.

...

  • For details about certificates and HTTPS connections see JS7 - Agent HTTPS Connections.
  • The private.conf configuration file holds references to the Controller 's certificate instances' certificates and the Director Agent instances' certificates in order to verify the connection from the Controller incoming connections using HTTPS mutual authentication.
  • Users have a choice how to provide the required configuration:

...

Code Block
languagebash
titleExample for use of Agent Installation Script
curl 'https://download.sos-berlin.com/JobScheduler.2.6/js7_agent_unix.2.6.0.tar.gz' \
    -o /tmp/js7_agent_unix.2.6.0.tar.gz
curl 'https://download.sos-berlin.com/JobScheduler.2.6/js7-license.jar' \
    -o /tmp/js7-license.jar

./js7_install_agent.sh \
    --tarball=/tmp/js7_agent_unix.2.6.0.tar.gz \ 
    --home=/opt/sos-berlin.com/js7/agent \
    --data=/var/sos-berlin.com/js7/agent_4445 \
    --controller-id=controller \
    --agent-id=agent \
    --http-port=localhost:4445 \
    --https-port=batch.example.com:4445 \
    --license-key=/home/sos/agent-deployment/example.pem \
    --license-bin=/tmp/js7-license.jar \
    --private-conf=/home/sos/agent-deployment/private.conf-template-agent \
    --controller-primary-cert=/home/sos/agent-deployment/centostest-primary.crt \
    --controller-secondary-cert=/home/sos/agent-deployment/centostest-secondary.crt \ 
    --director-primary-cert=/home/sos/agent-deployment/centostest-primary.crt \
    --director-secondary-cert=/home/sos/agent-deployment/centostest-secondary.crt \
    --keystore=/home/sos/agent-deployment/https-keystore.p12 \
    --keystore-password="jobscheduler" \
    --truststore=/home/sos/agent-deployment/https-truststore.p12 \
    --truststore-password="jobscheduler" \
    --make-dirs

# downloads the release tarball from the SOS Web Site using curl
# downloads the binary file for licensed code to enable cluster operations
# extracts the release tarball to the Agent's home directory
# specifies the Controller ID of the Controller to which the Agent is dedicated
# specifies the Agent Cluster ID
# specifies HTTP port 4445 on the localhost network interface and the same HTTPS port on the server network interface
# specifies the paths to the Primary and Secondary Controller's server certificates if a Controller Cluster is used
#     for a Standalone Controller the --controller-secondary-cert option is omitted
# deploys the Agent private configuration file which holds references to keystore and truststore
# deploys keystore and truststore files
# stops and starts the Agent's systemd service
# operates the Agent for HTTP port 4445

Note:

  • For details about certificates and HTTPS connections see JS7 - Agent HTTPS Connections.
  • The private.conf configuration file holds references to the Controller 's certificate instances' certificates and the Director Agent instances' certificates in order to verify the connection from the Controller incoming connections using HTTPS mutual authentication.
  • Users have a choice how to provide the required configuration:

Install or Update Secondary Director

...

Agent and Apply Certificates for HTTPS Connections

Code Block
languagebash
titleExample for use of Agent Installation Script
curl 'https://download.sos-berlin.com/JobScheduler.2.6/js7_agent_unix.2.6.0.tar.gz' \
    -o /tmp/js7_agent_unix.2.6.0.tar.gz
curl 'https://download.sos-berlin.com/JobScheduler.2.6/js7-license.jar' \
    -o /tmp/js7-license.jar

./js7_install_agent.sh \
    --tarball=/tmp/js7_agent_unix.2.6.0.tar.gz \ 
    --home=/opt/sos-berlin.com/js7/agent \
    --data=/var/sos-berlin.com/js7/agent_4445 \
    --controller-id=controller \
    --agent-id=agent \
    --http-port=localhost:4445 \
    --https-port=batch.example.com:4445 \
    --license-key=/home/sos/agent-deployment/example.pem \
    --license-bin=/tmp/js7-license.jar \
    --private-conf=/home/sos/agent-deployment/private.conf-template-agent \
    --controller-primary-cert=/home/sos/agent-deployment/centostest-primary.crt \
    --controller-secondary-cert=/home/sos/agent-deployment/centostest-secondary.crt \ 
    --director-primary-cert=/home/sos/agent-deployment/centostest-primary.crt \
    --director-secondary-cert=/home/sos/agent-deployment/centostest-secondary.crt \
    --keystore=/home/sos/agent-deployment/https-keystore.p12 \
    --keystore-password="jobscheduler" \
    --truststore=/home/sos/agent-deployment/https-truststore.p12 \
    --truststore-password="jobscheduler" \
    --standby \
    --make-dirs

# parameterization is the same as from the previous example for a Primary Director Agent
# the one exception being use of the --standby switch

...

Start Agent

Code Block
languagebash
titleExample for use of Agent Installation Script
./js7_install_agent.sh \
    --home=/home/sos/agent \
    --http-port=4445 \
    --exec-start=StartService \
    --exec-stop=StopService \
    --no-install
 
# stops the Agent's systemd service if the Agent is running
# starts the Agent's systemd service

...