Wizard Deployer

Overview

The Wizard Deployer is a utility that is designed to make deployment and execution of HERE Customizable Pipeline Templates easier. It does not require deep knowledge of the HERE platform or extensive development skills. The Wizard is a shell script that executes interactively by asking you a minimum set of questions required for a particular pipeline template, and then takes care of configuration, deployment, and execution.

Structure

This folder contains:

  • wizard.sh
  • deploy.sh
  • deployment_templates folder
  • README.md

Please do not change the structure of this folder or alter deployment templates or scripts. The only script that you will need to run is wizard.sh.

Prerequisites

System Requirements

This is a one time setup.

  • Java 1.8 - required by OLP CLI
  • Bash Execution environment (Cygwin for Windows)
  • OLP CLI
  • Jq - Utility to parse JSON file download page
  • Bc - Arbitrary precision calculator used to do mathematical calculations

You should have a general understanding of the HERE platform. Refer to the instructions provided in the System Requirements. The Wizard uses the OLP CLI for deployment, so you must have it installed and configured prior to using the Wizard. Otherwise, please follow the instructions below. While this setup doesn't require deep technical skills, it is expected that at a minimum you are able to use the bash execution environment, set up environment variables, and execute shell scripts.

Execution

After the variables above are set, the Wizard script is ready to be executed:

    ./wizard.sh
Environment Variables Setup (Optional)

While this step is not required, it is highly recommended that you set the environment variables listed below. If not set, you will be prompted to provide them during execution of the Wizard. Providing these environment variables saves time during subsequent deployment of the same pipeline template under the same bash session.

  • CLI_VERBOSE: Verbose option will enable debug logging to standard out.
    export CLI_VERBOSE=true
  • CLI_GROUP_ID: Group ID which is used to share resources (catalogs and pipelines) for pipeline templates. All resources created during pipeline template deployment will be shared with this Group.
    export CLI_GROUP_ID="GROUP-69xxxXxx-1111-X3xx-33ed-6XxxXXXxXXXf"
  • CLI_BILLING_TAG: Billing tag is used for grouping billing records together. It will be associated with catalogs, layers and pipeline resources created during pipeline template deployment. It must be between 4 - 16 characters and contain only alphanumeric ASCII characters [A-Za-z0-9].
    export CLI_BILLING_TAG="myBillingTag"
  • CLI_MANIFEST_FILE: Manifest is a file that describes the pipeline template's application and deployment parameters. It is unique per pipeline template and is packaged together with it. It is the main entry point for the Wizard. The user is not expected to alter the Manifest file, only provide an absolute path to it.
    export CLI_PROJECT_HRN="hrn:here:authorization::olp-cs:project/chitwant-test-1"
  • CLI_PROJECT_HRN: HRN of the project.
    export CLI_MANIFEST_FILE="/Users/xxxxx/repo/extension/config/manifest.json"
Execution With Options (Optional)

While this step is not required, you can provide the following listed options to the Wizard. If not set, you will be prompted to provide them during execution of the Wizard. Providing these options saves time during subsequent deployment of the same pipeline template under the same bash session.

verbose: If you want to see the values set for the configuration items during Wizard script execution, you can provide the "-v" option to Wizard script.

    ./wizard.sh --verbose=true

manifest-file: Manifest is a file that describes the pipeline template's application and deployment parameters. It is unique per pipeline template and is packaged together with it. It is the main entry point for the Wizard. You are not expected to alter the Manifest file, only provide an absolute path to it.

    ./wizard.sh --manifest-file="/Users/xxxxx/repo/extension/config/manifest.json"

billing-tag: Billing tag is used for grouping billing records together. It will be associated with catalogs, layers and pipeline resources created during pipeine template deployment. It must be between 4 - 16 characters and contain only alphanumeric ASCII characters [A-Za-z0-9].

    ./wizard.sh --billing-tag="myBillingTag"

group-id: Group ID is used to share resources (catalogs and pipelines) for pipeline templates. All resources created during pipeline template deployment will be shared with this Group.

    ./wizard.sh --group-id="GROUP-69xxxXxx-1111-X3xx-33ed-6XxxXXXxXXXf"

Since each pipeline template is different, the questions displayed during execution of the Wizard will vary.

Verification

Not Applicable

Cost Estimation

Not Applicable

Support

If you need support with the Wizard Deployer, please contact us.

results matching ""

    No results matching ""