Page History

...

Code Block

language	text
title	Agent Installer Script: js7_install_agent.sh

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
    --controller-primary-subject=<id>   | optional: subject of Primary/Standalone Controller certificate
    --controller-secondary-subject=<id> | optional: subject of Secondary Controller certificate
    --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
    --director-primary-subject=<id>     | optional: subject of Primary Director Agent certificate
    --director-secondary-subject=<id>   | optional: subject of Secondary Director Agent certificate
    --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 including tasks and starts the Agent after installation
    --wait                              | waits for running tasks in Agent if used with the --restart switch
    --cancel                            | cancels a running Agent if used with the --restart switch

Installation Options

--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 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)

...

Space shortcuts

Page tree

Versions Compared

Old Version 80

New Version Current

Key

Installation Options