パイプライン テンプレート

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

• パイプラインテンプレートを一覧表示します
• パイプラインテンプレートを作成します
• パイプラインテンプレートを表示します
• パイプラインテンプレートを削除します

パイプライン テンプレートリスト

アクセス権を持つすべてのパイプラインテンプレートが一覧表示されます。

olp pipeline template list [filter] [command options]

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

• [filter] パイプライン テンプレートリストをフィルタリングするための freeform テキスト。フィルタは name 、または description フィールドに filter 文字列が含まれているかどうかを確認します。
• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --json コマンドの結果を JSON 形式で表示します。
• --quiet 新しい行にパイプライン テンプレート ID を表示します。
• --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

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

例 :

以下のコマンドは、アクセス権を持っているすべてのパイプラインテンプレートを一覧表示します。 name OR description フィールドには spark という語が含まれています。

olp pipeline template list "spark" --json

出力 :

{
    "pipelineTemplates": [
        {
            "created": "2018-03-01T15:16:53.796Z",
            "groupId": "GROUP-9479863e-a13b-4d35-9eb1-5a054669046e",
            "defaultClusterConfiguration": {
                "workerResourceProfileId": "HS1B",
                "supervisorResourceProfileId": "HS1B",
                "supervisorUnits": 1,
                "workerUnits": 1,
                "workers": 1
            },
            "name": "sparktestcompiler",
            "packageId": "68d723f6-2ae7-40e4-8c24-61512d511852",
            "entryPointClassName": "com.example.Main",
            "description": "",
            "id": "5c0660a3-0fb4-4f35-bcd0-be6ce25075f6",
            "state": "created",
            "defaultRuntimeConfiguration": "",
            "updated": "2018-03-01T15:16:53.796Z",
            "runtimeEnvironment": "batch-3.0"
        }
    ]
}

パイプライン テンプレートが作成します

パイプライン テンプレートを作成します。

olp pipeline template create <name> <cluster type> <JAR file> \
 <class name> <group ID> --input-catalog-ids catalogExample1 [command options]

olp pipeline template create <name> <cluster type> <JAR file> ^
<class name> <group ID> --input-catalog-ids catalogExample1 [command options]

必須パラメータ :

• <name> パイプライン テンプレートの名前。 このパラメータの長さは 3 ～ 64 文字である必要があります。
• <cluster type> ランタイム環境 ID を使用してパイプライン テンプレートを実行するために使用される分散処理フレームワーク。現在有効になっているすべてのランタイム環境を一覧表示するに olp pipeline environment list は、コマンドを入力します。
• <JAR file> ローカルファイルシステムのパスを含む、アップロードする FAT JAR ファイル 。
• <class name> パイプライン テンプレートメインクラスの名前。
• 次のいずれかの操作を行います。
  • <group ID> メンバーがパイプラインへのアクセスを許可されているグループの ID 。
  • --scope <project HRN> メンバーがパイプラインへのアクセスを許可されているプロジェクトの HERE リソースネーム 。

• --input-catalog-ids <fixed catalog identifiers...> パイプラインによって要求された入力カタログの固定 ID （スペースで区切ります）。 この一覧表は pipeline-config.conf 、ファイルで使用されているカタログ識別子と一致する必要があります。

  注

  --input-catalog-ids pipeline-config.conf カタログの固定 ID を含む構成ファイルへのパスを受け入れることもできます。 このファイルは、パイプラインバージョンが作成されたときに使用されます。

  pipeline-config.confの詳細 について は、「パイプラインの設定」を参照してください。

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

• --description <template description> パイプライン テンプレートの説明。 このパラメータの長さは 0 ～ 512 文字である必要があります。
• --supervisor-units <size in units> スーパーバイザノードのサイズ（ 1 ～ 15 単位）。 指定しない場合、デフォルト値はです 1。
• --supervisor-units-profile <resource profile ID> スーパーバイザユニットに要求されたリソースプロファイルの ID 。 指定しない Default 場合、プロファイルが使用されます。 現在使用可能なすべてのリソースプロファイルを一覧表示するに olp pipeline profile list は、コマンドを入力します。
• --workers <number of workers> 既定の作業者数。 指定しない場合、デフォルト値はです 1。
• --worker-units <size in units> ワーカーノードのデフォルトのサイズ (1 ～ 15 単位 ) 。 指定しない場合、デフォルト値はです 1。
• --worker-units-profile <resource profile ID> 作業者ユニットに要求されたリソースプロファイルの ID 。 指定しない Default 場合、プロファイルが使用されます。 現在使用可能なすべてのリソースプロファイルを一覧表示するに olp pipeline profile list は、コマンドを入力します。

• --default-runtime-config <key1=value1 key2=value2 ...> パイプラインアプリケーションのデフォルト設定値のマップ。 key 名前の最大サイズは 256 で、最大 value サイズは 1024 です。 パイプラインバージョンの作成中に、ランタイム設定を上書きできます。 パイプラインバージョンに独自のランタイム設定値がある場合、これらの値は親パイプライン テンプレートから利用できる任意のデフォルトに追加されます。

  注

  --default-runtime-config パラメーターの値は、のよう "key1=value1 key2=value2"に二重引用符で囲む必要があります。 値にスペースが含まれている場合 "key1='some value1' key2=value2"は、のように一重引用符で囲む必要があります。 \n スプリッタのパラメータ値も許容範囲内であることを考慮してください。 例 : "key1='some value1'\nkey2=value2\n"

• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。

• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --json 作成されたパイプライン テンプレート の内容を JSON 形式で表示します。
• --quiet パイプライン テンプレート ID を表示します。

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

パイプライン設定の詳細について は、「パイプライン設定」を参照してください。

パイプライン テンプレートショー

指定したパイプライン テンプレートに関するすべての情報を表示します。

olp pipeline template show <pipeline template ID> [command option]

必須パラメータ :

• <pipeline template ID> 表示するパイプライン テンプレートの ID 。

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

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

例 :

olp pipeline template show 5c0660a3-0fb4-4f35-bcd0-be6ce25075f6 --json

出力 :

次の例では、指定したパイプライン テンプレートに関するすべての情報を取得します。

{
    "created": "2018-03-01T15:16:53.796Z",
    "groupId": "GROUP-9479863e-a13b-4d35-9eb1-5a054669046e",
    "hrn": "hrn:here:pipeline-template::org:5c0660a3-0fb4-4f35-bcd0-be6ce25075f6",
    "defaultClusterConfiguration": {
        "workerResourceProfileId": "HS1B",
        "supervisorResourceProfileId": "HS1B",
        "supervisorUnits": 1,
        "workerUnits": 1,
        "workers": 1
    },
    "name": "sparktestcompiler",
    "packageId": "68d723f6-2ae7-40e4-8c24-61512d511852",
    "entryPointClassName": "com.example.Main",
    "description": "",
    "id": "5c0660a3-0fb4-4f35-bcd0-be6ce25075f6",
    "state": "created",
    "defaultRuntimeConfiguration": "",
    "updated": "2018-03-01T15:16:53.796Z",
    "runtimeEnvironment": "batch-3.0"
}

パイプライン テンプレートが削除されます

指定したパイプライン テンプレートを削除します。 削除するパイプライン テンプレートは使用できません。 これは、そのパイプライン テンプレートで定義されているパイプラインバージョンがないことを意味します。

olp pipeline template delete <pipeline template ID> [command option]

必須パラメータ :

• <pipeline template ID> 削除するパイプライン テンプレートの ID 。

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

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

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

例 :

次のコマンドを実行すると、指定したパイプライン テンプレートが削除されます

olp pipeline template delete example-pipeline-template-id