Introduction

For JS7 - Automated Deployment use of a Deployment Area is recommended.

The Deployment Area is used for the following purposes:

to hold the script environment for JS7 - Automated Installation and Update and the JS7 - Deployment Packaging,
to hold the configuration files and certificates for deployment of JS7 components,
to hold the JS7 installations per JS7 release and component such as JOC Cockpit, Controller, Agent,
to hold the archive of deployment packages per JS7 releases and target machine,
to operate a JS7 Agent that is used to perform the JS7 - Deployment Workflow.

Directory Layout

The suggested directory layout for the Deployment Area includes the following directories and files:

archive (holds Deployment Packages)
- <deployment-descriptor> (specifies the Deployment Descriptor)
  - agents (holds Agent Deployment Packages)
    - <agent-id> (specifies the Agent ID)
      - js7_deploy_agent_unix.<agent-id>.<release>.config.tar.gz (Deployment Package for the Agent's configuration directory)
      - js7_deploy_agent_unix.<agent-id>.<release>.install.tar.gz (Deployment Package for the Agent's installation directory)
      - run_deploy_agent.sh (deployment script)
      - run_install_agent.sh (wrapper script for the parameterized call to js7_install_agent.sh)
    - <agent-id> (specifies the Agent ID)
    - ...
  - controllers (holds Controller Deployment Packages)
    - <controller-id> (specifies the Controller ID)
      - <instance-type> (specifies the type of the Controller instance which is primary or secondary)
        js7_deploy_controller_unix.<controller-id>.<instance-type>.<release>.config.tar.gz (Deployment Package for the Controller instance's configuration directory)
        js7_deploy_controller_unix.<controller-id>.<instance-type>.<release>.install.tar.gz (Deployment Package for the Controller instance's installation directory)
        run_deploy_controller.sh (Deployment Script)
        run_install_controller.sh (Wrapper Script for the parameterized call to the js7_install_controller.sh Installer Script)
      - <instance-type> (specifies the type of the Controller instance which is primary or secondary)
    - <controller-id> (specifies the Controller ID)
    - ...
  - joc (holds JOC Cockpit Deployment Packages)
    - <joc-id> (specifies the JOC Cockpit ID)
      - <instance-type> (specifies the type of the JOC Cockpit instance which is primary or secondary)
        js7_deploy_joc_linux.<joc-id>.<instance-type>.<release>.config.tar.gz (Deployment Package for the JOC Cockpit instance's configuration directory)
        js7_deploy_joc_linux.<joc-id>.<instance-type>.<release>.install.tar.gz (Deployment Package for the JOC Cockpit instance's installation directory)
        run_deploy_joc.sh (Deployment Script)
        run_install_joc.sh (Wrapper Script for the parameterized call to the js7_install_joc.sh Installer Script.
      - <instance-type> (specifies the type of the JOC Cockpit instance which is primary or secondary)
    - <joc-id> (specifies the JOC Cockpit ID)
    - ...
  - js7_import_tar.gz (holds the Deployment Workflow for import to JS7 JOC Cockpit)
  - run_deploy.sh (Wrapper Script to run all run_deploy_*.sh Deployment Scripts for Agent, Controller and JOC Cockpit instances)
- <deployment-descriptor> (specifies the Deployment Descriptor)
- ...
bin (holds executable files, preferably individual scripts, Deployment Scripts and Installer Scripts available from JS7 - Download)
- js7_create_certificate_store.sh (used to add certificates to keystores and truststores, see JS7 - How to add SSL TLS Certificates to Keystore and Truststore)
- js7_create_deployment_package.sh (used to create Deployment Packages, see JS7 - Deployment Packaging)
- js7_install_agent.sh (used to install Agents, see JS7 - Automated Installation and Update of Agent)
- js7_install_controller.sh (used to install Controller instances, see JS7 - Automated Installation and Update of Controller)
- js7_install_joc.sh (used to install JOC Cockpit instances, see JS7 - Automated Installation and Update of JOC Cockpit)
ca (holds the Certificate Authority as explained from JS7 - How to create self-signed Certificates, not used if an external Certificate Authority is in place)
- certs (holds CA-signed Certificates)
- csr (holds Certificate Signing Requests)
- private (holds Private Keys)
config (holds configuration files)
- agents (holds Agent configuration files)
  - instances (holds configuration files specific for an Agent)
    - <agent-id> (specifies the Agent ID for directories and files that are specific to an Agent)
      - config (general configuration)
        private (specific configuration)
        trusted-pgp-keys (optionally holds PGP public key files and keyring files used for signing, see JS7 - Deployment of Scheduling Objects)
        <pgp-public-key> (public key file or keyring file)
        <pgp-public-key> (public key file or keyring file)
        ...
        trusted-x509-keys (optionally holds X.509 certificate files used for signing, see JS7 - Deployment of Scheduling Objects)
        <x509-certificate> (X.509 certificate file)
        <x509-certificate> (X.509 certificate file)
        ...
        https-keystore.p12 (optional default location and file name of a PKCS12 keystore)
        https-truststore.p12 (optional default location and file name of a PKCS12 truststore)
        private.conf (optional configuration file, for example to specify keystore, truststore and Distinguished Names of Controller certificate, see JS7 - Agent Configuration Items)
        log4j2.xml (optional log configuration file, see JS7 - Log Levels and Debug Options)
        agent.conf (optional configuration file, see JS7 - Agent Configuration Items)
    - <agent-id> (specifies the Agent ID for directories and files that are specific to an Agent)
    - ...
  - templates (holds configuration files that act as templates for a number of Agents)
    - <template-name> (an arbitrary directory name for templates can be used)
      - config (general configuration)
        private (specific configuration)
        trusted-pgp-keys (optionally holds PGP public key files and keyring files used for signing, see JS7 - Deployment of Scheduling Objects)
        ...
        trusted-x509-keys (optionally holds X.509 certificate files used for signing, see JS7 - Deployment of Scheduling Objects)
        ...
    - <template-name> (an arbitrary directory name for templates can be used)
    - ...
- certs (holds certificate files for deployment with Agents and Controllers)
  - ca (optional Root Certificate Authority used for self-signed certificates)
    - <root-ca-certificate> (the Root CA Certificate file, frequently available with a .pem, .crt extension)
  - server (Server Authentication Certificates)
    - <server-certificate>(Server Certificate file, frequently available with a .pem, .crt extension)
    - <server-certificate>(Server Certificate file, frequently available with a .pem, .crt extension)
    - ^...
  - client (Client Authentication Certificates)
    - <client-certificate>(Client Certificate file, frequently available with a .pem, .crt extension)
    - <client-certificate>(Client Certificate file, frequently available with a .pem, .crt extension)
    - ...
- controllers (holds Controller configuration files)
  - instances (holds configuration files specific for a Controller instance)
    - <controller-id>.<controller-type> (specifies the Controller ID for directories and files that are specific to a Controller instance with the instance type being primary or secondary)
      - config (general configuration)
        private (specific configuration)
        trusted-pgp-keys (optionally holds PGP public key files and keyring files used for signing, see JS7 - Deployment of Scheduling Objects)
        <pgp-public-key> (public key file or keyring file)
        <pgp-public-key> (public key file or keyring file)
        ...
        trusted-x509-keys (optionally holds X.509 certificate files used for signing, see JS7 - Deployment of Scheduling Objects)
        <x509-certificate> (X.509 certificate file)
        <x509-certificate> (X.509 certificate file)
        ...
        https-keystore.p12 (optional default location and file name of a PKCS12 keystore)
        https-truststore.p12 (optional default location and file name of a PKCS12 truststore)
        private.conf (optional configuration file, for example to specify keystore, truststore and Distinguished Names of JOC Cockpit certificate, see JS7 - Controller Configuration Items)
        log4j2.xml (optional log configuration file, see JS7 - Log Levels and Debug Options)
        controller.conf (optional configuration file, see JS7 - Controller Configuration Items)
    - <controller-id>.<controller-type> (specifies the Controller ID for directories and files that are specific to a Controller)
    - ...
  - templates (holds configuration files that act as templates for a number of Controllers)
    - <template-name> (an arbitrary directory name for templates can be used)
      - config (general configuration)
        private (specific configuration)
        trusted-pgp-keys (optionally holds PGP public key files and keyring files used for signing, see JS7 - Deployment of Scheduling Objects)
        ...
        trusted-x509-keys (optionally holds X.509 certificate files used for signing, see JS7 - Deployment of Scheduling Objects)
        ...
    - <template-name> (an arbitrary directory name for templates can be used)
    - ...
- joc (holds JOC Cockpit configuration files)
  - instances (holds configuration files that are specific for a JOC Cockpit instance)
    - <server>.<instance-type> (holds configuration files for a JOC Cockpit instance running on a specific server with the instance type being primary or secondary)
      - resources (optionally holds configuration files such as the joc.properties file, keystore, truststore files etc.)
      - response (holds response files, mainly the joc_install.xml response file, that are copied to the JOC Cockpit's setup directory)
    - <server>.<instance-type> (holds configuration files for a JOC Cockpit instance running on a specific server with the instance type being primary or secondary)
    - ...
  - templates (holds configuration files that act as templates for a number of JOC Cockpit instances)
    - <template-name> (an arbitrary directory name for templates can be used)
      - resources (optionally holds configuration files such as the joc.properties file, keystore, truststore files etc.)
      - response (holds response files, mainly the joc_install.xml response file, that are copied to the JOC Cockpit's setup directory)
    - <template-name> (an arbitrary directory name for templates can be used)
    - ...
desc (holds Deployment Descriptors)
- <deployment-descriptor>.json (Deployment Descriptor .json file)
- <deployment-descriptor>.json (Deployment Descriptor .json file)
- ...
logs (holds log files)
- deployment_package.<deployment-descriptor>.<host>.<timestamp>.log (Packaging Script log files)
- install_js7_agent.<host>.<timestamp>.log (Agent Installer log files)
- install_js7_controller.<host>.<timestamp>.log (Controller Installer log files)
- install_js7_joc.<host>.<timestamp>.log (JOC Cockpit Installer log files)
release (holds the installation tarballs for JS7 releases)
- ... (users can apply an arbitrary directory hierarchy at this level)
  - js7_agent_unix.<release>.tar.gz (JS7 Agent installation tarball as download from the SOS Web Site)
  - js7_controller_unix.<release>.tar.gz (JS7 Controller installation tarball as download from the SOS Web Site)
  - js7_joc_linux.<release>.tar.gz (JS7 JOC Cockpit installation tarball as download from the SOS Web Site)
work (the working area is preferably used to perform installation of JS7 components during packaging)
- agents (directory for Agent installation during packaging)
  - <agent-id> (specifies the Agent ID for directories and files that are specific to an Agent)
    - ... (sub-directories used for Agent installation)
  - <agent-id> (specifies the Agent ID for directories and files that are specific to an Agent)
  - ...
- controllers (directory for Controller installation during packaging)
  - <controller-id> (specifies the Controller ID for directories and files that are specific to a Controller)
    - ... (sub-directories used for Controller installation)
  - <controller-id> (specifies the Controller ID for directories and files that are specific to a Controller)
  - ...
- tmp (temporary files are written to this directory, if the --keep-work switch is used when invoking the JS7 - Deployment Packaging then files will remain in this directory which suggests cleanup by the user)
env.sh (Environment Script, see next chapter)

Explanation on Individual Files

Environment Script: env.sh

The Environment Script initializes a number of environment variables that map to directories as explained above.

The script has to be invoked before running any script to install, to package or to deploy packages to target hosts.

Example for Environment File env.sh

#!/bin/sh

SCRIPT_HOME=$HOME/js7.deploy

DEP_ARCHIVE="${DEP_ARCHIVE:-$SCRIPT_HOME/archive}"
DEP_BIN="${DEP_BIN:-$SCRIPT_HOME/bin}"
DEP_CONFIG="${DEP_CONFIG:-$SCRIPT_HOME/config}"
DEP_DESC="${DEP_DESC:-$SCRIPT_HOME/desc}"
DEP_LOGS="${DEP_LOGS:-$SCRIPT_HOME/logs}"
DEP_RELEASE=/mnt/releases/scheduler_setups
DEP_TARGET="/home/sos/js7.target"
DEP_WORK="${DEP_WORK:-$SCRIPT_HOME/work}"

JAVA_HOME="${SCRIPT_HOME}"/jdk-11.0.2
PATH=${JAVA_HOME}/bin:${PATH}

export JAVA_HOME PATH DEP_ARCHIVE DEP_BIN DEP_CONFIG DEP_DESC DEP_LOGS DEP_RELEASE DEP_TARGET DEP_WORK

Explanation:

Any environment variable makes use of a fallback if not otherwise specified.
- By default the env.sh script's directory is assumed to hold the directory layout of the Deployment Area.
Each environment variable in the script points to a directory with a specific purpose that can be located outside of the suggested directory layout.
- In the above example the DEP_RELEASE environment variable specifies a location of JS7 installation files from a mount point.
- The DEP_ARCHIVE, DEP_BIN, DEP_CONFIG, DEP_DESC, DEP_LOGS, DEP_WORK environment variables point to directories explained with the directory layout.
- The DEP_TARGET environment variable points to a location on the same server to simulate deployments to target hosts.
The JAVA_HOME environment variable is specified to enforce use of a specific Java version for temporary installation of JS7 components during packaging.
Consider that environment variables have to be exported in order to be applied by subsequent calls to deployment scripts.

The Environment Script has to be sourced to make environment variables available to shell scripts in the Deployment Area:

Example for Environment Script env.sh

. ./env.sh

Installer Wrapper Scripts: run_install_agent.sh, run_install_controller.sh, run_install_joc.sh

The Installer Wrapper Scripts parameterize calls to the Installer Scripts. The scripts are generated by the Packaging Script.

Example for Installer Wrapper Script run_install_agent.sh

#!/bin/sh

set -e

JS7_DEP_CONFIG="/home/sos/js7.deploy/config"
JS7_DEP_SCRIPT="/home/sos/js7.deploy/bin"
JS7_DEP_WORK="/home/sos/js7.deploy/work/agents/agent_001"

mkdir -p "/home/sos/js7.deploy/work/agents/agent_001"

${JS7_DEP_SCRIPT}/js7_install_agent.sh \
    --real-path-prefix="${JS7_DEP_WORK}" \
    --release="2.5.0" \
    --tarball="/mnt/releases/scheduler_setups/2.5.0/js7_agent_unix.2.5.0.tar.gz" \
    --home="${JS7_DEP_WORK}/opt/sos-berlin.com/js7/agent-primary" \
    --data="${JS7_DEP_WORK}/var/sos-berlin.com/js7/agent-primary" \
    --http-port="localhost:31443" \
    --https-port="centostest-primary.sos:31443" \
    --controller-id="testsuite" \
    --controller-primary-cert="${JS7_DEP_DEPLOY}/certs/server/centostest-primary.crt" \
    --controller-secondary-cert="${JS7_DEP_DEPLOY}/certs/server/centostest-secondary.crt" \
    --keystore="${JS7_DEP_DEPLOY}/agents/instances/agent_001/config/private/https-keystore.p12" \
    --keystore-password="jobscheduler" \
    --truststore="${JS7_DEP_DEPLOY}/agents/instances/agent_001/config/private/https-truststore.p12" \
    --truststore-password="jobscheduler" \
    --deploy-dir="${JS7_DEP_DEPLOY}/agents/templates/https/config" \
    --make-dirs

Explanation:

The parameterization is used from the Deployment Descriptor.
The --home and --data directories are prefixed with the directory of the work area.
- The --real-path-prefix holds the work area directory. The Installer Script makes use of this information to conclude the effective directories as used for the target host.
Wrapper Scripts for Controllers and JOC Cockpit are similarly parameterized.

Deployment Scripts: run_deploy_agent.sh, run_deploy_controller.sh, run_deploy_joc.sh

The Deployment Scripts perform transfer of deployment tarballs to target machines and extract the respective tarballs. The parameterization is used from the Deployment Descriptor.

Example for Deployment Script run_deploy_agent.sh

#!/bin/sh

set -e

scp -i "/home/sos/.ssh/sos_rsa" -P 22 "/home/sos/js7.deploy/archive/agent-https-2022-12-04/agents/agent_001/js7_deploy_agent_unix.agent_001.2.5.0.install.tar.gz" sos@centostest-primary:"/tmp"
ssh -i "/home/sos/.ssh/sos_rsa" -p 22 -t -t -o LogLevel=QUIET sos@centostest-primary << 'EOF'
systemctl stop js7.agent_001
cd "/opt/sos-berlin.com/js7" > /dev/null
test -e "/tmp/js7_deploy_agent_unix.agent_001.2.5.0.install.tar.gz" && gzip -c -d < "/tmp/js7_deploy_agent_unix.agent_001.2.5.0.install.tar.gz" | tar -xf -
cd - > /dev/null
rc=$?
systemctl start js7.agent_001
exit $rc
EOF

scp -i "/home/sos/.ssh/sos_rsa" -P 22 "/home/sos/js7.deploy/archive/agent-https-2022-12-04/agents/agent_001/js7_deploy_agent_unix.agent_001.2.5.0.config.tar.gz" sos@centostest-primary:"/tmp"
ssh -i "/home/sos/.ssh/sos_rsa" -p 22 -t -t -o LogLevel=QUIET sos@centostest-primary << 'EOF'
systemctl stop js7.agent_001
cd "/var/sos-berlin.com/js7" > /dev/null
test -e "/tmp/js7_deploy_agent_unix.agent_001.2.5.0.config.tar.gz" && gzip -c -d < "/tmp/js7_deploy_agent_unix.agent_001.2.5.0.config.tar.gz" | tar -xf -
cd - > /dev/null
rc=$?
systemctl start js7.agent_001
exit $rc
EOF

Explanation:

Authentication is performed by use of private/public keys.
For each deployed tarball transfer and extraction are individually applied.
The example includes commands for pre- and post-processing to stop and to start an Agent from iJS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems.

Alternative Directory Layout

The directory layout of the Deployment Area is not carved in stone. Instead, users can modify the env.sh Environment Script to point to different directories.

Use of the env.sh Environment Script brings benefits when adding your own scripts to the ./bin folder, for example to create individual deployment packages like this:

Example for use of an individual script to create deployment packages

#!/bin/sh

set -e

SCRIPT_HOME=$(cd "$(dirname "$0")" >/dev/null && pwd)

DEP_ARCHIVE=${DEP_ARCHIVE:-$(dirname "${SCRIPT_HOME}")/archive}
DEP_BIN=${DEP_BIN:-$(dirname "${SCRIPT_HOME}")/bin}
DEP_CONFIG=${DEP_CONFIG:-$(dirname "${SCRIPT_HOME}")/config}
DEP_DESC=${DEP_DESC:-$(dirname "${SCRIPT_HOME}")/desc}
DEP_WORK=${DEP_WORK:-$(dirname "${SCRIPT_HOME}")/work}


${DEP_BIN}/js7_create_deployment_package.sh \
    --deploy-desc=${DEP_DESC}/agent-https-2022-12-04.json \
    --config-dir=${DEP_CONFIG} \
    --archive-dir=${DEP_ARCHIVE} \
    --script-dir=${DEP_BIN} \
    --work-dir=${DEP_WORK} \
    --deploy-agent-id=deploymentAgent \
    --keep-script \
    --keep-work

Explanation:

The example of an individual script to create Deployment Packages makes use of existing environment variables to apply individual directories or to fall back to the default directory layout.
Use of set -e is recommended in order not to proceed execution of scripts in case of errors.
Use of environment variables from the above example allows to execute the script from any working directory.

Space shortcuts

Page tree

Introduction

Directory Layout

Explanation on Individual Files

Environment Script: env.sh

Installer Wrapper Scripts: run_install_agent.sh, run_install_controller.sh, run_install_joc.sh

Deployment Scripts: run_deploy_agent.sh, run_deploy_controller.sh, run_deploy_joc.sh

Alternative Directory Layout

Resources

Space shortcuts

Page tree

JS7 - Deployment Area - Directory Layout

Introduction

Directory Layout

Explanation on Individual Files

Environment Script: env.sh

Installer Wrapper Scripts: run_install_agent.sh, run_install_controller.sh, run_install_joc.sh

Deployment Scripts: run_deploy_agent.sh, run_deploy_controller.sh, run_deploy_joc.sh

Alternative Directory Layout

Resources