パイプライン

OLP CLI には、パイプラインを管理するためのツールがあります。 パイプライン ワークフローの例については、「パイプライン ワークフロー」を参照してください。

プラットフォームのパイプラインの詳細については 、『パイプライン API』を参照してください。

OLP CLI は、次のものをサポートしています。

  • 表示されているすべてのパイプラインを一覧表示
  • パイプラインを作成します
  • パイプラインを更新します
  • パイプラインを表示します
  • パイプラインを削除します
  • パイプラインを移動します

パイプラインリスト

アクセスできるすべてのパイプラインが一覧表示されます。

olp pipeline list [filter] [command options]

オプションのパラメータ :

  • [filter] パイプラインリストのフィルタリングに使用される freeform テキスト。 フィルタ filter は ' パイプラインの名前または説明に文字列が含まれているかどうかを確認します
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json コマンドの結果を JSON 形式で表示します。
  • --quiet 新しい行にパイプライン ID を表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

以下のコマンドを使用すると、 name または description パラメーターで、 spark という語でアクセス権を持つすべてのパイプラインが一覧表示されます。

olp pipeline list "spark" --json

出力 :

{
  "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"
    }
  ]
}

パイプラインが作成します

パイプラインを作成し、指定したグループまたはプロジェクトに関連付けます。

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

必須パラメータ :

  • <name> パイプラインの名前。 このパラメータの長さは 3 ～ 64 文字である必要があります。
  • 次のいずれかの操作を行います。
    • <group ID> メンバーがパイプラインへのアクセスを許可されているグループの ID 。
    • --scope <project HRN> メンバーがパイプラインへのアクセスを許可されているプロジェクトの HERE リソースネーム 。

オプションのパラメータ :

  • --description <pipeline description> パイプラインの説明。 このパラメータの長さは 0 ～ 512 文字である必要があります。
  • --email <address> パイプラインの単一の連絡先電子メールアドレス。 この電子メールは、予定されている停止やパイプラインの再起動などのさまざまなイベントをユーザーに通知するために使用され、ユーザーのパイプライン操作の中断を最小限に抑えるのに役立ちます。 個人の電子メールアドレスではなく、配布リストまたはグループの電子メールアドレスを使用することを強くお勧めします。
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json 作成されたパイプライン を JSON 形式で表示します。
  • --quiet パイプライン ID を表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドを実行すると、指定したグループの名前 My Example Pipeline と説明 This pipeline analyzes data を含むパイプラインが作成されます。

Linux
窓
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"

パイプラインの更新

パイプラインのバージョンに影響を与えることなく、指定したパイプラインのプロパティを名前、説明、および通知の電子メールアドレスとして更新します。

olp pipeline update <pipeline ID> [command option]

必須パラメータ :

  • <pipeline ID> 更新するパイプラインの ID 。

オプションのパラメータ :

  • --name <pipeline name> パイプラインの新しい名前。
  • --description <pipeline description> パイプラインの新しい説明。
  • --email <address> パイプラインの単一の連絡先メールアドレス。 この電子メールは、予定されている停止やパイプラインの再起動などのさまざまなイベントをユーザーに通知するために使用され、ユーザーのパイプライン操作の中断を最小限に抑えるのに役立ちます。 個人の電子メールアドレスではなく、配布リストまたはグループの電子メールアドレスを使用することを強くお勧めします。
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json パイプライン プロパティを JSON 形式で表示します。
  • --quiet パイプライン ID を表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

注

--name、 --description、、またはが --email 設定されていない場合、現在のパイプラインプロパティが保持されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドを実行すると、指定したパイプラインが新しい名前と説明で更新されます。

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

パイプラインショー

指定したパイプラインのプロパティを表示します。

olp pipeline show <pipeline ID> [command options]

必須パラメータ :

  • <pipeline ID> 表示するパイプラインの ID 。

オプションのパラメータ :

  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json パイプライン プロパティを JSON 形式で表示します。
  • --quiet パイプライン 名を表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

以下のコマンドは、指定したパイプラインのプロパティを表示します。

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

出力 :


{
    "contactEmail": "olp@cli.com",
    "created": "2018-03-01T15:21:11.39Z",
    "groupId": "GROUP-9479863e-a13b-4d35-9eb1-5a054669046e",
    "hrn": "hrn:here: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"
}

パイプラインが削除されます

指定したパイプラインと、そのパイプラインに関連付けられているすべてのバージョンを削除します。

olp pipeline delete <pipeline ID> [command options]

警告

このコマンドはパイプラインを完全に削除し、復元する方法はありません。

必須パラメータ :

  • <pipeline ID> 削除するパイプラインの ID 。

オプションのパラメータ :

  • --force パイプライン バージョンを削除する前に、指定したパイプライン のすべてのバージョンをキャンセルして非アクティブ化します。
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet 空の出力を追加情報なしで表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

olp pipeline delete example-pipeline-id

パイプラインが移動しました

指定した数のパイプラインの最新バージョンに関連付けられている、指定したパイプラインおよびパイプラインテンプレートを、指定したターゲットプロジェクトに移動します。

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

必須パラメータ :

  • <pipeline ID/pipeline HRN> 移動するパイプラインの ID/HRN 。

オプションのパラメータ :

  • --target-project <target project HRN> ターゲットプロジェクトの HERE リソースネーム 。
  • --number-of-versions <number of versions> 移動に含めるパイプラインの最新バージョンの数。 これらの最新バージョンのパイプラインに関連付けられているパイプラインテンプレートが、指定したターゲットプロジェクトに移動するためにシステムによって識別されます。 この番号は 1 ～ 5 の範囲である必要があります。
  • --report ソースグループ、ターゲットプロジェクト、その他の関連情報など、移行ステータスの詳細が利用可能な場合に表示されます。 それ以外の場合は、移行準備状況レポートが表示されます。 このオプション --target-project--number-of-versions を使用するには、およびが必要です。
  • --revert-to-group パイプライン およびテンプレート リソースをプロジェクトの元のグループに戻します。 このオプションは、移動が正常に完了した後にのみ適用されます。
  • --json コマンドの結果を JSON 形式で表示します。
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet 空の出力を追加情報なしで表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

警告

--report オプションを使用して、パイプラインがグループに含まれているか、またはプロジェクトに含まれていないかに応じて、プロジェクトまたはプロジェクト範囲外のトークンを使用します。 パイプラインがプロジェクト内にある場合、準備状況レポートセクションはスキップされ、最後のアクションの詳細のみが提供されます。

例 :

Linux
窓
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

出力 :

移行が完了すると、パイプライン移行の詳細が表示されます。 


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

それ以外の場合は、準備状況レポートが表示されます。 


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

「」に一致する結果は 件です

    「」に一致する結果はありません