コンソールを使用した Tekton 用の Delivery Pipeline の構成

1. ツールチェーンの「概要」ページにある「 デリバリーパイプライン 」カードで、 Delivery Pipeline をクリックして、Tektonの「 Delivery Pipeline 」概要ページを開きます。

2. 「設定」 をクリックします。 **「定義」**セクションで、以下のタスクを実行します。

   a. Tekton パイプライン定義および関連する成果物が含まれている Git リポジトリーおよび URL を指定します。 リポジトリーが使用できない場合は、ツールチェーンの「概要」ページに戻り、リポジトリーを追加します。

   b. 使用する Git リポジトリー内のブランチを選択するか、タグを入力します。

   c. Git リポジトリー内のパイプライン定義のパスを指定します。 同じリポジトリー内にある特定の定義を参照できます。 ツールチェーンと統合されている場合は、複数の定義リポジトリーを追加することもできます。

   d. 変更内容を保存します。

   パイプライン定義は自動的に更新されます。

   計算されたパイプライン定義のサイズ制限は 1 MB です。 パイプラインを保存または実行するときにエラーが発生した場合は、パイプライン定義のサイズを小さくするか、複数のパイプラインに分割する必要があります。

3. **「ワーカー (Worker)」**セクションで、Tekton パイプラインを実行するために使用する IBM 管理の共有ワーカーまたはプライベート・ワーカーを選択します。 プライベート・ワーカーについて詳しくは、Delivery Pipeline プライベート・ワーカーの操作を参照してください。

   プライベート・ワーカーは、Tekton パイプラインと同じツールチェーンに定義されていなければなりません。

4. 「環境プロパティー」 セクションで、「追加」 をクリックし、独自の環境プロパティーを定義するプロパティー・タイプを選択します。 例えば、API_KEY プロパティーを定義して、パイプライン内のすべてのスクリプトで IBM Cloud リソースにアクセスするときに使用する API キーを渡すことができます。 以下のタイプのプロパティーを追加できます。

   • 列挙 (Enumeration): ユーザー定義のオプションのリストから選択できる値を持つプロパティー・キー。
   • セキュア値 (Secure value): AES-128 暗号化で保護された単一行の値を持つプロパティー・キー。 この値は、アスタリスク文字を使用して表示されます。 あるいは、鍵アイコンをクリックして、ボールト統合 (IBM Key Protectなど) からシークレットを選択することもできます (そのようなツールがツールチェーンで使用可能な場合)。
   • テキスト値 (Text value): 単一行または複数行のテキスト値を持つプロパティー・キー。 以前は、複数行の値は別のテキスト域 (Text area) プロパティー・タイプでサポートされていました。
   • ツール統合 (Tool integration): 実行時にツールチェーンのツール統合から解決される値を持つプロパティー・キー。 デフォルトでは、値はツール統合の JSON ストリング表現です。 オブジェクトの特定のフィールドまたはサブセットは、オプションの JSON フィルターに値を指定して取得できます。 例えば、GitHub 統合が選択されていて、JSON フィルター parameters.repo_url が指定されている場合、値は、PipelineRun リソースの実行時にツール統合で構成される Git リポジトリーの URL を表します。

   Tekton パイプラインのリソースの中で、これらのプロパティーにアクセスすることができます。 これらのプロパティーの詳細については、Tekton の環境とリソースを参照してください。

   プロパティーをロックして、オーバーライドされないようにすることができます。 ロックされたプロパティーを実行時にオーバーライドしようとすると、実行要求が拒否されます。 ロックされたプロパティーは、デフォルトでは実行サイド・パネルに表示されませんが、「すべてのプロパティーを表示」オプションを有効にすることで読み取り専用で表示できます。

5. 保存 をクリックします。

6. 「パイプラインの概要」ページで、「 追加 」をクリックしてトリガーを作成し、追加するトリガーの種類を選択して、そのトリガーをイベントリスナーに関連付けます。 使用可能なイベント・リスナーのリストには、パイプライン・コード・リポジトリーで定義されているリスナーが含まれています。

   トリガーは、 Tektonのトリガー定義に基づいています。 Git repoトリガーは、自身にマッピングされたイベントリスナーを使用して、受信したイベントのペイロードから情報を抽出し、 Kubernetes リソースを作成します。 これらのリソースは、Tekton PipelineRun リソースに適用されます。

   トリガーされたパイプライン実行は、Limit concurrent runs オプションを使用して実行をシリアライズするようにトリガーを構成しない限り、並行して実行されます。 このオプションを有効にすると、このトリガーによって開始できる同時実行の数を制限できます。 たとえば、上限が 1 に設定されている場合、このトリガーに対するパイプラインの実行は一度に 1 つだけ行われ、それ以外のものは「待機中」の状態としてキューに入れられます。 最大20件の実行（ IBM のマネージドワーカーを使用している場合は5件）が待機状態でキューに入れられた後、それ以降のリクエストは自動的にキャンセルされます。 IBM のマネージドワーカーを使用する場合、デフォルトでは、すべての「タイムド」トリガーの同時実行数は1つに制限されます。

   トリガーが同時実行の制限を超えると、キャパシティが利用可能になるまで、新しいパイプラインの実行は "Waiting "状態に置かれる。 必要であれば、この動作を変更し、直近のランだけを "Waiting "状態にし、他のランは自動的にキャンセルされるようにすることもできる。 例えば、短時間に複数回トリガーされた場合に最新のコミットのみをビルドしたい場合 Git などに、この機能は有用です。 この機能を有効にするために、"Limit to one waiting run "トグルがトリガー設定パネルで利用可能であり、 limit_waiting_runs プロパティを使用してAPI経由で設定することもできます （APIドキュメントを参照 ）。 この設定は「待機中」のランにのみ適用され、アクティブなランには影響しないことに注意してください。

   手動トリガーは、**「実行」**パイプライン・ボタンをクリックしてトリガーを選択した場合に実行されます。

   Git リポジトリー・トリガーは、指定した Git リポジトリーおよびブランチで、指定した Git イベント・タイプが発生した場合に実行されます。

   Tekton パイプライン・リソースから Git トリガーに送達された Web フック・ペイロードにアクセスできます。 正確なフィールドはリポジトリーによって異なりますが、Web フック・ペイロードの一般的な構文は $(event.payloadFieldName) です。 Web フックを作成する前に、対応する Git 統合に対する Git 管理アクセスを許可する必要があります。 Git 管理アクセスを許可するには、再度 Git 統合を構成して保存します。

   時間指定トリガーは、 CRON 値で定義されたスケジュールされた時刻に実行されます。 時間指定によるトリガー用の CRON式は、 UNIXのcrontab構文に基づいており、 minute、 hour、 day of the month、 month、 day of the week という5つの日時フィールドの組み合わせで構成されています。 これらのフィールドは、 X X X X X の形式でスペースで区切られます。 時限トリガーの最大頻度は、5 分に 1 回です。 以下の例は、さまざまな時間指定の頻度を使用する文字列を示しています。

   • */5 * * * * - 5 分毎にトリガーを実行します。
   • 0 * * * * - 毎時 0 分にトリガーを実行します。
   • 0 9 * 1 MON-FRI - 1 月の毎週月曜から金曜まで午前 9:00 にトリガーを実行します。
   • 0 * * NOV,DEC 1 - 11 月と 12 月の月曜に毎時トリガーを実行します。

汎用 Web フック・トリガーは、シークレットの設定で構成された POST 要求が汎用 Web フック URL に送信されると実行されます。 汎用 Web フック・トリガーは、POST 要求に対して固有の Web フック URL を提供します。

PipelineRun UI は、イベント・ペイロード・セクションの汎用 Web フック・ペイロード値を非表示にしないため、ペイロードには機密データを含めないでください。 代わりに、パスワードまたは API キー・シークレットなどのトリガー・プロパティーを使用して、汎用 Web フックに必要なデータを保護してください。

次のいずれかのメソッドを使用して、Git、Slack Outgoing Web フック、Artifactory Web フックなどと連携する、汎用 Web フック・トリガーを保護できます。

• 保存されたトークンと POST 要求内で渡されるトークンを比較する、トークンの突き合わせ。 サポートされるトークン・ソースには、ヘッダー、クエリー、またはペイロードが含まれます。 トークンの突き合わせは、GitLab Web フックおよび Slack Outgoing Web フックで使用されます。
• HMAC 16 進数ダイジェストを保存されたトークンと一緒に使用して、ダイジェストされたペイロードから生成されたハッシュと署名とを比較する、ペイロード・ダイジェストの突き合わせ。 サポートされる署名ソースには、ヘッダー、クエリー、またはペイロードが含まれることがあります。 ユーザーはダイジェスト・アルゴリズムを指定する必要があります。 ペイロード・ダイジェストの突き合わせは、GitHub Web フックで使用されます。
• Tekton タスク検証では、ユーザーがその Tekton タスク内の Web フック要求を検証する必要があります。

汎用 Web フック・トリガーを GitHub Web フックで使用するには、以下の値を指定します。

• 保護: Payload Digest Matches
• 署名ソース: Header
• ヘッダー・キー名: X-Hub-Signature
• ダイジェスト・アルゴリズム: sha1。

汎用 Web フック・トリガーを GitLab Web フックで使用するには、以下の値を指定します。

• 保護: Token Matches
• トークン・ソース: Header
• ヘッダー・キー名: X-Gitlab-Token

汎用 Web フック・トリガーを Slack Outgoing Web フックで使用するには、以下の値を指定します。

• 保護: Token Matches
• トークン・ソース: Payload
• JSON プロパティー名 / フォーム・キー: token

次の例は、Token Matches ルールで保護されている汎用 Web フックで curl コマンドを使用する方法を示しています。

  ![一般的なWebhookの例*一般](images/pipeline_tekton_generic_webhook.png){: caption="なWebhookの例" caption-side="bottom"}

curl -X POST \
https://devops-api.us-south.devops.cloud.ibm.com/v1/tekton-webhook/588236be-749b-4c67-ae57-a561abbbc9a8/run/7e82880e-4223-4c98-8ca9-ef6df36bb6dc \
-H 'Content-Type: application/json' \
-H 'token: 48a0f92c0932890048596906a22ae189c48c5619fbcf9600' \
-d '{
"somekey": "somevalue"
}'

パイプライン定義でペイロード値を取得するには、イベントから派生した値で Triggerbinding パラメーターを指定します。

apiVersion: tekton.dev/v1beta1
kind: TriggerBinding
metadata:
name: binding
spec:
params:
- name: somekey
value: $(event.somekey)

変更内容を保存します。

さらに、一般的な Webhook トリガーは、Webhook リクエストのボディにプロパティを渡すことができます。 これにより、ウェブフックによってトリガーされる PipelineRun に対してプロパティをオーバーライドしたり、 PipelineRun で使用されるパイプライン/トリガーのプロパティを補足する追加のプロパティを渡したりすることができます。

パスワードやAPIキーの秘密など、機密データをペイロードプロパティに渡す必要がある場合、UIにプレーンテキストで表示されないように、そのようなプロパティにはプロパティタイプ SECURE を使用する必要があります。

さらに、トリガーされた PipelineRun、ブラウザで PipelineRun の詳細を見るときにUIに表示される を説明するオプションの説明をリクエストボディに渡すことができる。

次の例は、text プロパティ、secure プロパティ、および description を渡しながら、一般的な Webhook で curl コマンドを使用する方法を示しています：

curl -X POST \
https://devops-api.us-south.devops.cloud.ibm.com/v1/tekton-webhook/588236be-749b-4c67-ae57-a561abbbc9a8/run/7e82880e-4223-4c98-8ca9-ef6df36bb6dc \
-H 'Content-Type: application/json' \
-H 'token: 48a0f92c0932890048596906a22ae189c48c5619fbcf9600' \
-d '{
  "description":"This text can be used to describe the PipelineRun that will be triggered by this request.",
  "properties":[
    {"name":"mytextprop","type":"TEXT","value":"my text value"},
    {"name":"mysecureprop","type":"SECURE","value":"mysecret"}
  ]
}'

Tekton パイプライン用の Delivery Pipeline トリガーの設定

Git リポジトリ内のさまざまなイベントに基づいて、Tekton パイプラインのトリガーを設定できます。 以下のオプションを使用して、Gitトリガーをフィルタリングします：

• ブランチ：指定したイベントが発生すると、選択したレポの特定のブランチのパイプラインをトリガーします。
• パターン：指定したイベントが発生したときに、選択したレポのタグとブランチ名のグロブマッチに基づいてパイプラインをトリガーします。
• CELフィルター：イベントが指定された CEL (Common Expression Language) フィルタに一致すると、パイプラインをトリガーします。

commit push、'pull request opened、'updated、'closed などのイベントを指定するには、**ブランチ・オプションとパターン・**オプションを使用する。 また、'プルリクエストのドラフトイベントを含めるオプションを切り替えることで、プルリクエストのイベントを指定し、ドラフトプルリクエストのパイプライントリガーを許可またはスキップすることができます。 同様に、フォークしたリポジトリからのプルリクエストに対してパイプライントリガーを許可するかどうかを、フォークからのプルリクエストイベントを含めるトグルを使って指定できます。 さらに、Label filters オプションを選択すると、フィルターテーブルのユーザー定義基準に従って、プルリクエストラベルに基づくフィルタリングを有効にすることができます。

CELフィルターオプションは、イベントペイロードの他のフィールドとのマッチングのような、より高度なユースケースをサポートする。 このオプションは、プッシュイベント、すべてのプルリクエストイベント、課題イベント、課題コメントイベント、リリースイベント、および GitHub マージキューイベントをサポートします。 このオプションは、Webhook ペイロードに基づくイベントフィルタリングを提供するために、Generic Webhook トリガーのオプション機能としても利用可能です。

   header['x-github-event'] == 'pull_request' &&
      (body.action == 'opened' || body.action == 'synchronize') &&
      body.pull_request.base.ref == 'main'

   header['x-github-event'] == 'push' && body.ref == 'refs/heads/main'

   header['x-github-event'] == 'push' &&
      body.ref == 'refs/heads/main' &&
      !body.head_commit.message.contains("skip run")

   header['x-github-event'] == 'issue_comment' &&
      body.action == 'created' && has(body.issue.pull_request) &&
      body.comment.body.contains('/lgtm')

   header['x-github-event'] == 'issues' &&
      body.action == 'opened' &&
      body.issue.labels.exists(label, label.name == 'urgent')

   header['x-gitlab-event'] == 'Merge Request Hook' &&
      (body.object_attributes.action == 'open' || body.object_attributes.action == 'update') &&
      body.object_attributes.target_branch == 'main'

   header['x-gitlab-event'] == 'Push Hook' && body.ref == 'refs/heads/main'

   header['x-gitlab-event'] == 'Push Hook' &&
      body.ref == 'refs/heads/main' &&
      !body.object_attributes.last_commit.message("skip run")

   header['x-gitlab-event'] == 'Note Hook' &&
      body.object_attributes.noteable_type == 'MergeRequest' &&
      body.object_attributes.action == 'create' &&
      body.object_attributes.note.contains('/lgtm')

   header['x-gitlab-event'] == 'Issue Hook' &&
      (body.object_attributes.action == 'open') &&
      body.object_attributes.labels.exists(label, label.name == 'urgent')

   (header['x-event-key'] == 'pullrequest:created' || header['x-event-key'] == 'pullrequest:updated') &&
       body.pullrequest.destination.branch.name == 'main'

   header['x-event-key'] == 'repo:push' && body.push.changes[0].new.name == 'main'

   header['x-event-key'] == 'repo:push' &&
      body.push.changes[0].new.name == 'main' &&
      !body.push.changes[0].commits[0].message("skip run")

   header['x-event-key'] == 'pullrequest:comment_created' &&
      body.comment.content.raw.contains('/lgtm')

   header['x-event-key'] == 'issue:created' &&
      body.issue.kind == 'bug'

コンソールUIを使用してツールチェーンを削除する

1. IBM Cloud コンソールから、 メニューアイコンの > Platform Automation > Toolchains をクリックします。
2. 「ツールチェーン」ページで、ツールチェーンをクリックしてその「概要」ページを開きます。 代わりに、アプリの「アプリの詳細」ページで、ツールチェーン名をクリックすることもできます。
3. デリバリーパイプライン」セクションで、削除したいパイプラインを見つけます。
4. パイプラインのメニューアイコンをクリックし、 削除オプションをクリックします。
5. ダイアログの「 削除 」をクリックして、削除を確認してください。

API を使用して「 Delivery Pipeline 」を削除する

1. IAM ベアラー・トークンを取得します。 あるいは、SDK を使用している場合は、 IAM API キーを取得 し、環境変数を使用してクライアント・オプションを設定します。

   export CD_TEKTON_PIPELINE_APIKEY={api_key}
   

2. DevOps Insights ツール統合の追加先となる ツールチェーンの地域と ID を決定します。

3. パイプラインを削除します。

   curl -X DELETE \
     https://api.{region}.devops.cloud.ibm.com/toolchain/v2/toolchains/{toolchain_id}/tools/{pipeline_id} \
     -H 'Authorization: Bearer {iam_token}'
   

   const CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');
   ...
   (async () => {
      const pipelineSvc = CdTektonPipelineV2.newInstance();
      const params = {
         id: {pipeline_id},
      };
      const res = await pipelineSvc.deleteTektonPipeline(params);
   })();
   

   import {
      "github.com/IBM/continuous-delivery-go-sdk/cdtektonpipelinev2"
   }
   ...
   cdTektonPipelineOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}
   pipelineSvc, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineOptions)
   deleteTektonPipelineOptions := pipelineSvc.NewDeleteTektonPipelineOptions(
      {pipeline_id}
   )
   response, err := pipelineSvc.DeleteTektonPipeline(deleteTektonPipelineOptions)
   

   from ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2
   ...
   pipeline_service = CdTektonPipelineV2.new_instance()
   response = pipeline_service.delete_tekton_pipeline(
      id={pipeline_id}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.CdTektonPipeline;
   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.model.*;
   ...
   CdTektonPipeline pipelineSvc = CdTektonPipeline.newInstance();
   DeleteTektonPipelineOptions deleteTektonPipelineOptions = new DeleteTektonPipelineOptions.Builder()
      .id({pipeline_id})
      .build();
   Response<Void> response = pipelineSvc.deleteTektonPipeline(deleteTektonPipelineOptions).execute();
   

以下の表に、前のステップで使用された各変数をリストして説明します。

Terraform を使用した Delivery Pipeline の削除

1. 既存のパイプラインの resource ブロックを含む Terraform ファイル (例えば、 main.tf) を見つけます。

   以下の例の resource は、既存のパイプラインを記述しています。

   data "ibm_resource_group" "group" {
     name = "default"
   }
   resource "ibm_cd_toolchain" "my_toolchain" {
     name              = "terraform_toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   resource "ibm_cd_toolchain_tool_pipeline" "my_pipeline_tool" {
     parameters {
        name = "terraform-pipeline-integration"
     }
     toolchain_id = ibm_cd_toolchain.my_toolchain.id
   }
   resource "ibm_cd_tekton_pipeline" "my_tekton_pipeline" {
    worker {
        id = "public"
    }
    pipeline_id = ibm_cd_toolchain_tool_pipeline.my_pipeline_tool.tool_id
   }
   

2. Terraform ファイルから ibm_cd_toolchain_tool_pipeline ブロックと ibm_cd_tekton_pipeline resource ブロックを削除します。

3. 必要な場合は、Terraform CLI を初期化します。

   terraform init
   

4. Terraform 実行プランを作成します。 この計画は、パイプラインを削除するために実行する必要があるすべてのアクションを要約します。

   terraform plan
   

5. Terraformの実行プランを適用します。 Terraform は、パイプラインを削除するために必要なすべてのアクションを実行します。

   terraform apply
   

コマンドラインまたはAPI経由でパイプラインを起動する

IBM Cloud CLIを使用してコマンドラインからパイプラインをトリガーすることも、 curl を使用してAPIを直接コールすることもできます。