Versions Compared

Key

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

...

  • 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 js7_import.tar.gz archive for import into the JS7 inventory by JOC Cockpit. The archive includes the JS7 - Deployment Workflow and schedules for automated rollout of Deployment Packages.
  • 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.

...

Code Block
titleDeployment Packaging Script js7_create_deployment_package.sh
Usage: js7_create_deployment_package.sh [Options] [Switches]

   Options:
    --deploy-desc=<file>               | required: path to a deployment descriptor file
    --config-dir=<directory>           | required: path to the deploymentconfiguration source directory, default: ./config
    --work-dir=<directory>             | required: path to the deployment working directory directory, default: ./work
    --archive-dir=<directory>          | required: path to the deployment archive directory directory, default: ./archive
    --script-dir=<directory>           | optional: path to the script directory directory, default: ./bin
    --deploy-agent-id=<identifier>     | required: Agent ID executing the deployment workflow, default: primaryAgent
    --agent-id=<identifier>            | optional: limits processing to a specific Agent ID
    --controller-id=<identifier>       | optional: limits processing to a specific Controller ID
    --joc-id=<identifier>              | optional: limits processing to a specific JOC Cockpit ID
     --workflow-parallelism=<number>    | optional: limits parallel processes in deployment workflow, default: 100
    --workflow-timezone=<number>       | optional: specifies time zone of deployment workflow, default: Etc/UTC
    --log-dir=<directory>              | optional: log directory for log output of this script

    SwitchesSwitches:
    -h | --help                        | displays usage
    --dry-run                          | create install script without running the script
    --keepmake-scriptdirs                        | keep install script in archive directory creates the specified directories if they do not exist
    --keep-work script                       | keep temporaryinstall installationscript in workarchive directory
    --makekeep-dirswork                        | createskeep thetemporary specifiedinstallation directoriesin if they do not exist
work directory
     --show-logs                        | shows log output of the script

...

  • --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.
  • --config-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
  • --deploy-agent-id
    • Specifies the name of the Agent that should execute jobs in 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.

...