Page History

...

- --setup-dir
  - Specifies the directory in to which the installer for the JOC Cockpit should be extracted. This is not the JOC Cockpit installation directory but a temporary directory used during installation. Users can remove the directory after installation.
  - Without this option the /tmp directory will be used to extract the installation tarball and to run the setup.sh installation script. The temporary directory that holds installer filesis removed after installation.
  - Consider that policies in user environments can deny execution of scripts in the /tmp directory. In this situation a different location has to be specified.
- --response-dir
  - Generally it is discouraged to use a response file for installation as it is preferable to make use the options offered by this script.
  - Specifies the directory that holds a copy of the JOC Cockpit installer joc_install.xml response file and optionally related files. This file is available after extraction of the installer tarball and specifies options for installation of the JOC Cockpit. Files in the response directory are copied to the working directory specified with the --setup-dir option. and are applied when invoking the installer by ./setup.sh -u joc_install.xml, see JS7 - JOC Cockpit - Headless Installation on Linux and Windows.
  - Users should keep their copy of the response file and specify the directory with this command line option. Response files can be re-used within the same minor release of the JOC Cockpit, for example when updating from release 2.2.1 to 2.2.4. When updating, for example, from release 2.2.x to 2.3.x it is recommended to check from the installer tarball if a newer version of the file is available.
  - Users should note that the response file can hold references to a license file and to a JDBC Driver .jar file. The JOC Cockpit setup installation is executed performed from the working setup directory specified with the --setup-dir option and otherwise from a temporary directory. Paths in the joc_install.xml response file can be used relative to the working setup directory, for example using sos.pem for a license file without specifying a directory if the license file is available in the response directory as it will be copied to the working setup directory.
- --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 JOC Cockpit 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 which takes account of http_proxy and https_proxy environment variables and the relevant settings from a .curlrc file.
- --home
  - Specifies the directory in which the JOC Cockpit should be installed.
  - This option overwrites the JOC Cockpit installation directory specified in the joc_install.xml response file with the <installpath> element.
- --data
  - Optionally specifies the directory in which the JOC Cockpit installs configuration files. If the option is omitted then the home directory will used.
  - If specified then the configuration directory is accessible from the jetty_base symlink in the JOC Cockpit home directory.
  - This option overwrites the JOC Cockpit configuration directory specified in the joc_install.xml response file with the <entry key="jettyBaseDir" value="..."/> element.
- --user
  - The JOC Cockpit joc_install.xml response file holds the runningUser setting that optionally specifies the user account of the JOC Cockpit daemon service. This setting allows to take precedence over the response file setting.
  - The user account specified will be used for the JOC Cockpit installation.
  - 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 JOC Cockpit 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 JOC Cockpit Installation Script.
- --patch
  - Specifies the Change Management issue key that is assigned the patch, for example JS-1984.
  - The patch is identified from its patch key that is specified with the --patch-key option.
  - The release number to which a patch is applicable is specified with the --release option.
  - Patches are downloaded from the SOS web site if the --tarball option is not used.
  - If a backup directory is specified then a backup of the JOC Cockpits installation directory will be created in this directory.
- --patch-key
  - A patch is identified by it's patch key which is specified from [API|GUI]-<sequence>, for example API-1, API-2, GUI-3:
    - API specifies a patch that is applicable to the JS7 - REST Web Service API.
    - GUI specifies a patch that is applicable to the user JS7 - Browser User Interface.
    - <sequence>: specifies the running number of a patch per API or GUI. Patches with higher running numbers include any patches with lower running numbers.
  - For details see JS7 - Patches for JOC Cockpit API and JS7 - Patches for JOC Cockpit GUI.
- --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 in .pem or .crt format.
  - For details see JS7 - How to apply a JS7 License Key.
  - This option is an alternative to specifying the license key file with the joc_install.xml response file, see --response-dir option.
- --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.
  - This option is an alternative to specifying the license key file with the joc_install.xml response file, see --respons-dir option. If the response files specifies a license key then the binary file for licensed code is automatically installed.
- --backup-dir
  - If a backup directory is specified then existing JOC Cockpit's home and data directories will be added to two .tar.gz files in this directory.
  - File names are created according to the pattern: backup_js7_joc.<hostname>.<release>.[home|data].<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz
    - For example: backup_js7_joc.centostest_primary.2.3.1.home.2022-03-19T20-50-45.tar.gz
  - A backup is intended to restore files in the JOC Cockpit's installation and data directories. The purpose of a backup is to restore files that are replaced by the JOC Cockpit Installation Script, its purpose is not to restore a JOC Cockpit 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 JOC Cockpit Installation Script will write information about processing steps to a log file in this directory.
  - File names are created like this: install_js7_joc.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
  - For example: install_js7_joc.centostest_primary.2022-03-19T20-50-45.log
- --exec-start
  - This option can be used should JOC Cockpit be started after installation. For example, when using systemd then the option --exec-start="StartService" will start the JOC Cockpit 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_joc".
  - For systemd service files see the JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems article.
  - This option is an alternative for use of the -restart switch that starts the JOC Cockpit from its Start Script. If specified this option overrules the --restart switch.
- --exec-stop
  - This option can be used should JOC Cockpit be stopped before installation. For example, when using systemd then the option --exec-stop="StopService" will stop the JOC Cockpit 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_joc".
  - 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 use of the -restart switch that stops the JOC Cockpit from its Start Script. If specified this option overrules the --restart switch.
- --return-values
  - Optionally specifies the path to a file which return values will be added to in the format <name>=<key>. For example:
    - log_file=install_js7_joc.centostest_primary.2022-03-20T04-54-31.log
    - backup_file=backup_js7_joc.centostest_primary.2.3.1.2022-03-20T04-54-31.tar.gz
  - An 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)

...

--deploy-dir
- Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the <config> folder. A deployment directory allows to manage central copies of configuration files such as hibernate.cfg.xml, log4j2.xml etc.
- Use of a deployment directory has lower precedence as files can be overwritten by individual options such as --properties etc.
--properties
- Specifies the path to a joc.properties file that will be copied to the <data>/resources/joc directory. While any file name can be used for the source file the target file name will be joc.properties.
--ini
- Specifies one or more *.ini files that include settings for the Jetty Servlet Container, for example http.ini, https.ini, ssl.ini. The files will be copied to the JOC Cockpit <data>/start.d directory. For use with HTTPS connections the following settings in the ssl.ini file have to be adjusted:
  - jetty.sslContext.keyStorePath
  - jetty.sslContext.keyStorePassword
  - jetty.sslContext.keyManagerPassword
  - jetty.sslContext.trustStorePath
  - jetty.sslContext.trustStorePassword
- The option takes a number of files as arguments that are separated by comma, for example: --ini="/js7-deployment/ssl.ini,/js7-deployement/https.ini".
--title
- The title of the JOC Cockpit instance is displayed with its dashboard. It serves to distinguish JOC Cockpit instances operated as a cluster.
- This option has precedence over the respective setting specified in the joc_install.xml response file with the <entry key="jocTitle" value="..."/> element.
--security-level
- The JOC Cockpit is operated in one of the security levels low, medium, high, see JS7 - Security Architecture. By default the low security level is used.
- This option has precedence over the respective setting specified in the joc_install.xml response file with the <entry key="securityLevel" value="..."/> element.
--dbms-config
- Optionally specifies the path to a Hibernate configuration file that includes settings to access the JS7 - Database.
- This option has precedence over the respective setting specified in the joc_install.xml response file with the <entry key="hibernateConfFile" value="..."/> element.
- For use with an H2 database users should specify the value H2 for this option instead of the path to a Hibernate configuration file.
--dbms-driver
- Optionally specifies the path to a JDBC Driver .jar file that is used for access to the DBMS. See JS7 - Database to identify JDBC Drivers that ship with JS7.
- This option has precedence over the respective setting specified in the joc_install.xml response file with the <entry key="connector" value="..."/> element.
--dbms-init
- Optionally specifies the point in time when database objects will be created:
  - byInstaller: Database objects will be created during installation of JOC Cockpit.
  - byJoc: Database objects will be created on start-up of JOC Cockpit, for example when used for Containers.
  - off: Database objects will not be created. This assumes that users create database objects on their own before running JOC Cockpit. The JOC Cockpit installation tarball includes the db sub-directory that holds *.sql files for the respective DBMS that can be used to populate the JS7 - Database independently from installing JOC Cockpit.
--http-port
- Specifies the HTTP port that the JOC Cockpit is operated for. This option takes precedence over the port setting in the joc_install.xml response file.
- Users are discouraged to enable both HTTP and HTTPS protocols as it undermines security to operate JOC Cockpit for both protocols.
- The port can be prefixed by the network interface, for example joc.example.com:4446.
- When used with the --restart switch, the HTTP port is used to determine if JOC Cockpit is running.
--https-port
- Specifies the HTTPS port that the JOC Cockpit is operated for. This option takes precedence over the port setting in the joc_install.xml response file.
- Users are discouraged to enable both HTTP and HTTPS protocols as it undermines security to operate JOC Cockpit for both protocols.
- The port can be prefixed by the network interface, for example joc.example.com:4448.
- Use of HTTPS connections requires additional settings, see --ini , --keystore and --truststore options.
- When used with the --restart switch, the HTTPS port is used to determine if JOC Cockpit is running.
--keystore
- Specifies the path to a PKCS12 keystore file that holds the private key and certificate for HTTPS connections to JOC Cockpit.
- Users are free to specify any file name, typically the name https-keystore.p12 is used. The keystore file will be copied to the <data>/resources/joc directory.
- If a keystore file is made available then the JOC Cockpit's <data>/start.d/ssl.ini file has to hold a reference to the keystore location and optionally the keystore password. Users can deploy an individual ssl.ini file using the --ini option. The following settings are automatically updated in the ssl.ini file:
  - jetty.ssl.host: optionally specifies the network interface that is available from the --https-port option provided that the port is prefixed with the network interface, for example joc.example.com:4446.
  - jetty.ssl.port: specifies the HTTPS port that is automatically updated from the --https-port option.
  - jetty.sslContext.keyStorePath: specifies the path to the keystore relative to the <data>/resources/joc directory.
- The path to the keystore file and related settings as specified with the --keystore-password and --keystore-alias options are similarly added to the joc.properties file in the <data>/resources/joc directory. If the --client-keystore, --client-keystore-password, --client-keystore-alias options are used then they will be applied by precedence to the joc.properties file, however, they will not be applied to the ssl.ini configuration file.
- Assigning a keystore for HTTPS connections requires to use the --https-port option and suggests not to use the --http-port option in order to disable HTTP access and to enable HTTPS access only to JOC Cockpit.
- 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 argument.
--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 argument.
--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 argument.
--truststore
- Specifies the path to a PKCS12 truststore file that holds the certificate(s) for HTTPS connections from JOC Cockpit to a Controller instance, LDAP server etc.
- Users are free to specify any file name, typically the name https-truststore.p12 is used. The truststore file will be copied to the <home>/jetty_base/resources/joc directory.
- If a truststore file is made available then the JOC Cockpit's <data>/start.d/ssl.ini file has to hold a reference to the truststore location and optionally the truststore password. It is therefore recommended to use the --ini option to deploy an individual ssl.ini file. The following settings are automatically updated in the ssl.ini file:
  - jetty.sslContext.trustStorePath: specifies the path to the truststore relative to the <data>/resources/joc directory.
- Further settings in the ssl.ini file such as the truststore password have to be deployed from a copy of the file using the --ini option.
- 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 JOC Cockpit from the JAVA_HOME environment variable.
--java-options
- Specifies the Java options that will be made available to JOC Cockpit from the JAVA_OPTIONS environment variable.
- Java options can be used for example to specify Java heap space settings for JOC Cockpit, see JS7 - FAQ - Which Java Options are recommended.
- 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 JOC Cockpit'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 is copied to the JOC Cockpit's <home>/jetty/bin directory.
- Users are free to choose any file name as a template for the service file. The resulting service file name will be joc.service.
- The JOC Cockpit Installation Script will perform replacements in the service file to update paths to be used.
--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_joc will be used.

...

Space shortcuts

Page tree

Versions Compared

Old Version 48

New Version Current

Key