pipeline

The OLP CLI provides tools for managing pipelines. For examples of pipeline workflows, see Pipeline workflows.

For more information on pipelines in the platform, see the Pipeline API.

The OLP CLI supports the following:

pipeline list

Lists all pipelines that you can access.

olp pipeline list [filter] [command options]

Optional parameters:

  • [filter] Freeform text used to filter the pipeline list. The filter checks if the pipeline's name or description contains the filter string.
  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the command result in JSON format.
  • --quiet Displays pipeline IDs, each on a new line.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below lists all the pipelines to which you have access with the word spark in the name or in the description parameters.

olp pipeline list "spark" --json

Output:

{
  "pipelines": [
    {
      "created": "2018-03-01T15:21:11.39Z",
      "groupId": "GROUP-9479863e-a13b-4d35-9eb1-5a054669046e",
      "name": "sparktestpipeline",
      "description": "",
      "realm": "org",
      "id": "f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96",
      "updated": "2018-03-01T15:21:11.39Z"
    }
  ]
}

pipeline create

Creates a pipeline and associates it with the specified group or project.

olp pipeline create <name> <group ID> [command options]

Required parameters:

  • <name> The name of the pipeline. The length of this parameter must be between 3 and 64 characters.
  • Either of the following:
    • <group ID> The ID of the group whose members are allowed to access the pipeline.
    • --scope <project HRN> The HRN of the project whose members are allowed to access the pipeline.

Optional parameters:

  • --description <pipeline description> The description of the pipeline. The length of this parameter must be between 0 and 512 characters.
  • --email <address> A single contact e-mail address for the pipeline. This email may be used to notify users about various events, such as planned outages or pipeline restarts, and can help minimize interruption to users' pipeline operations. We strongly recommend using a distribution list or group e-mail address rather than a personal email address.
  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the created pipeline in JSON format.
  • --quiet Displays the pipeline ID.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below creates a pipeline with the name My Example Pipeline and the description This pipeline analyzes data for the specified group.

Linux
Windows
olp pipeline create "My Example Pipeline" example-group-id \
   --description "This pipeline analyzes data"
olp pipeline create "My Example Pipeline" example-group-id ^
   --description "This pipeline analyzes data"

pipeline update

Updates such properties of the specified pipeline as its name, description, and an email address for notifications without affecting the pipeline's version.

olp pipeline update <pipeline ID> [command option]

Required parameters:

  • <pipeline ID> The ID of the pipeline to update.

Optional parameters:

  • --name <pipeline name> A new name for the pipeline.
  • --description <pipeline description> A new description for the pipeline.
  • --email <address> A single contact email address for the pipeline. This email may be used to notify users about various events, such as planned outages or pipeline restarts, and can help minimize interruption to users' pipeline operations. We strongly recommend using a distribution list or group e-mail address rather than a personal email address.
  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the pipeline properties in JSON format.
  • --quiet Displays the pipeline ID.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

Note

If no --name, --description, or --email is set, then the current pipeline properties are kept.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below updates the specified pipeline with a new name and description.

olp pipeline update example-pipeline-id --name new-name --description new-description

pipeline show

Shows the properties of the specified pipeline.

olp pipeline show <pipeline ID> [command options]

Required parameters:

  • <pipeline ID> The ID of the pipeline to show.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the pipeline properties in JSON format.
  • --quiet Displays the pipeline name.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below displays the properties of the specified pipeline.

olp pipeline show f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 --json

Output:


{
    "contactEmail": "olp@cli.com",
    "created": "2018-03-01T15:21:11.39Z",
    "groupId": "GROUP-9479863e-a13b-4d35-9eb1-5a054669046e",
    "hrn": "hrn:here-cn:pipeline::org:f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96",
    "name": "sparktestpipeline",
    "description": "",
    "realm": "org",
    "id": "f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96",
    "updated": "2018-03-01T15:21:11.39Z"
}

pipeline delete

Deletes the specified pipeline along with all the versions associated with that pipeline.

olp pipeline delete <pipeline ID> [command options]

Warning

This command removes the pipeline completely, and there is no way to restore it.

Required parameters:

  • <pipeline ID> The ID of the pipeline to delete.

Optional parameters:

  • --force Cancels and deactivates all versions of the specified pipeline before deleting the pipeline versions.
  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --quiet Displays empty output with no additional information.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials setup.

Example:

olp pipeline delete example-pipeline-id

pipeline move

Move the specified pipeline and the pipeline templates associated with the specified number of the most recent versions of the pipeline to the specified target project.

olp pipeline move <pipeline ID / pipeline HRN> [command options]

Required parameters:

  • <pipeline ID/pipeline HRN> The ID/HRN of the pipeline to move.

Optional parameters:

  • --target-project <target project HRN> The HRN of the target project.
  • --number-of-versions <number of versions> The number of the most recent versions of the pipeline to include in the move. The system identifies the pipeline templates associated with these most recent versions of the pipeline for moving to the specified target project. This number must be between 1 and 5.
  • --report Displays migration status details such as source group, target project and other relevant information in case they are available. Otherwise, displays the migration readiness report. Please note that this option requires --target-project and --number-of-versions to be provided.
  • --revert-to-group Reverts pipeline and template resources to the original group from the project. This option only applies after a move has successfully completed.
  • --json Displays the command result in JSON format.
  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --quiet Displays empty output with no additional information.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

Warning

With the --report option, use a project or a non-project scoped token depending on whether the pipeline is in a group or in a project. If the pipeline is in a project, the readiness report section is skipped and only last action details are provided.

Example:

Linux
Windows
olp pipeline move example-pipeline-id \
  --target-project hrn:here:authorization::org:project/00000000-0000-0000-0000-000000000000 \
  --number-of-versions 2
  --quiet
olp pipeline move example-pipeline-id ^
  --target-project hrn:here:authorization::org:project/00000000-0000-0000-0000-000000000000 ^
  --number-of-versions 2
  --quiet

Output:

If the migration is done the pipeline migration details are displayed: 


Details of the pipeline migration:
Source GROUP:            GROUP-00000000-0000-0000-0000-000000000000
Target Project:          hrn:here:authorization::org:project/00000000-0000-0000-0000-000000000000
Migration status:        inProgress
last updated:            2021-06-02T12:05:00+02:00
Pipeline HRN:            hrn:here:pipeline::org:00000000-0000-0000-0000-00000000000
Pipeline versions:       example-pipeline-template-version-id

Otherwise, the readiness report is displayed: 


Readiness report:
remaining resource slots in project:    4
pipeline contact email:                 user@site.domain
version readiness reports:
  Report of version example-pipeline-version-id:
  pipeline template HRN:                example-template(in project)
  input catalogs:
    HRN: example-hrn(in project)
  output catalog HRN: example-hrn(in project)
  runAsId HRN: example-hrn(in project)
warnings:
    severity:     info
    message:      example warning message
    pipeline ID:  33333333-3333-3333-3333-33333333333
    pipeline HRN: hrn:here:pipeline::org:00000000-0000-0000-0000-000000000000
    template HRN: hrn:here:pipeline-template::org:00000000-0000-0000-0000-00000000000
    additionalDetails:
      message:             example message.
      pipeline ID:         11111111-1111-1111-1111-111111111111
      pipeline HRN:        hrn:here:pipeline::org:11111111-1111-1111-1111-111111111111
      pipeline version ID: 99999999-9999-9999-9999-999999999999
      template HRN:        hrn:here:pipeline-template::org:00000000-0000-0000-0000-000000000000

results matching ""

    No results matching ""