Versions Compared

Key

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

...

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

...

Code Block
titlePackaging 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
    --deploy-dir=<directory>           | required: path to the deployment source directory, default: ./deployconfig
    --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
    --agent-id=<identifier>            | optional: limits processing to a specific Agent ID
    --controller-id=<identifier>       | optional: limits processing to a specific Controller 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

  Switches:
    -h | --help                        | displays usage
    --dry-run                          | create install script without running the script
    --keep-script                      | keep install script in archive directory
    --keep-work                        | keep temporary installation in work directory
    --show-logs                        | shows log output of the script

...

Packaging Options

  • --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 the directory in which the Controller should be installed.
  • --deploy-dir
    • Specifies the top-level directory in from which the Controller data such as configuration files should be storedconfiguration files copied to an Agent or Controller installation..
    • By default the <home>./var directory config directory is used, see option --homesee JS7 - Deployment Server.
  • --work-dir
    • Specifies the directory from which the Controller reads configuration filesthat holds the working area to temporarily install JS7 components.
    • By default the <data>./configwork directory is used, see option --data see JS7 - Deployment Server.
  • --archive-dir
    • Specifies the directory from which the Controller reads configuration filesto which deployment packages are written.
    • By default the ./archive directory is used, see JS7 - Deployment Server.
  • --script-dir
  • ----deploy-agent-id
    • Specifies the directory from which the Controller reads configuration filesthe name of the Agent that should execute the Deployment Workflow.
    • This information is added to the Deployment Workflow and can be changed later on in JOC Cockpit.
  • --agent-id
    • Specifies the directory from which the Controller reads configuration filesSelects the name of an Agent available from the Deployment Descriptor file to which creation of deployment packages should be limited.
  • --controller-id
    • Specifies the directory from which the Controller reads configuration filesSelects the Controller ID of a Controller available from the Deployment Descriptor file to which creation of deployment packages should be limited.
  • --workflow-parallelism
    • Specifies the directory from which the Controller reads configuration filesmax. 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 directory from which the Controller reads configuration files.time zone that is 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

Switches

  • -h | --help
    • Displays usage.
  • --dry-run
    • Performs a dry-run that will not create deployment packages but will create wrapper scripts for installation of 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
    • Displays the log output created by the script.
  • --keep-script
    • Displays the log output created by the scriptThis option is preferably used with the --dry-run option to retain copies of the wrapper scripts for installation of jS7 components, see --dry-run.
  • --keep-work
    • Displays the log output created by the scriptSpecifies 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.
  • --show-logs
    • Displays the log output created by the script.

...