Introduction

The Packaging Script is used in the JS7 - Deployment process for on-premises installations on a JS7 - Deployment Area

• to install JS7 components such as JOC Cockpit, Controller, Agent in a temporary environment,
• to create .tar..gz tarball Deployment Packages of the JS7 components' installation and configuration directories created during installation,
• to create a Deployment Script per JS7 component. The script is later on used to deploy the packages to target hosts.

Packaging Script

The Packaging Script is provided for download and can be used to automate installation, updates, upgrades and patches of JS7 components such as JOC Cockpit, Controller and Agents.

• The script is available for Linux, MacOS® and AIX® using bash, dash, ksh and zsh POSIX-compatible shells. 
• The script expects a JS7 - Deployment Descriptor file in .json format that specifies the JS7 components, the installation options, configuration options and deployment options.
• The script creates
  • the run_install_agent.sh, run_install_controller.sh, run_install_joc.sh Installer Wrapper Scripts that parameterize installation of the JS7 components,
  • the run_deploy_agent.sh, run_deploy_controller.sh, run_deploy_joc.sh Deployment Scripts that are used to transfer tarball Deployment Packages to target machines.
• The script terminates with exit code 0 to signal success, with exit code 1 for command line argument errors and with other exit codes for non-recoverable errors.
• The script is intended as a baseline example for customization by JS7 users and by SOS within the scope of professional services.
  

Prerequisites

The Packaging Script requires the jq utility and OpenSSL to be installed and available from the operating system. 

Download

Find the Packaging Script for download from JS7 - Download.

...

• --deploy-desc
  • Specifies the path to the .json file that holds the JS7 - Deployment Descriptor.
  • Deployment Descriptors specify which JS7 components should be installed and which installation and configuration options should be used.
• --deploy-dir
  • Specifies the top-level directory holding configuration files that will be copied to an Agent, Controller or JOC Cockpit installation..
  • By default the ./config directory is used, see JS7 - Deployment Server.
• --work-dir
  • Specifies the directory that holds the working area to temporarily install JS7 components.
  • By default the ./work directory is used, see JS7 - Deployment Server.
• --archive-dir
  • Specifies the directory to which deployment packages are stored.
  • By default the ./archive directory is used, see JS7 - Deployment Server.
• --script-dir
  • Specifies the directory in which the Controller expects JS7 installer script files, see JS7 - Automated Installation and Update.
  • By default the ./bin directory is used, see JS7 - Deployment Server.
• --deploy-agent-id
  • Specifies the name of the Agent that should execute the Deployment Workflow.
  • This information will be added to the Deployment Workflow and can be changed later on in JOC Cockpit.
• --agent-id
  • Selects the name of an Agent available from the Deployment Descriptor file to which creation of Deployment Packages should be limited.
• --controller-id
  • Selects the Controller ID of a Controller available from the Deployment Descriptor file to which creation of Deployment Packages should be limited.
• --joc-id
  • Selects the JOC Cockpit ID available from the Deployment Descriptor file to which creation of Deployment Packages should be limited.
• --workflow-parallelism
  • Specifies the max. number of parallel deployments that should be executed by the Deployment Workflow.
  • By default up to 100 parallel deployments are performed.
• --workflow-timezone
  • Specifies the time zone that will be applied to the Deployment Workflow. The time zone is relevant should users wish to modify the included deployment job for consideration of JS7 - Admission Times for Jobs.
• --log-dir
  • If a log directory is specified then the Packaging Script will log information about processing steps to a log file in this directory.
  • File names are created according to the pattern: deployment_package.<deployment-descriptor>.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
  • For example: deployment_package.agent-http-20221204.centostest_primary.2022-12-19T20-50-45.log
  • The --log-dir option is forwarded to the installer scripts that will create individual log files in this directory.

...

• -h | --help
  • Displays usage.
• --dry-run
  • Performs a dry-run that will not create deployment packages Deployment Packages but will create Installer Wrapper Scripts for JS7 components only.
  • The wrapper scripts will make use of configuration items specified with the Deployment Descriptor and will parameterize execution of the Installer Scripts, see JS7 - Automated Installation and Update.
• --keep-script
  • This option is preferably used with the --dry-run option to retain copies of the wrapper scripts Wrapper Scripts for installation of jS7 components, see --dry-run.
• --keep-work
  • Specifies that temporary installations of JS7 components in the working area will not be removed but will remain in place to allow checking the installation and configuration options in place.
• --make-dirs
  • If directories are missing that are indicated with the --home, --backup-dir or --log-dir options then they will be created.
• --show-logs
  • Displays the log output created by the script if the --log-dir option is used.
  • The --show-logs option is forwarded to the installer scripts that will display individually created log files if the --log-dir option is used.

...