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

Delivery Pipeline ツール統合を構成するときに、作成するパイプラインのタイプを選択できます。

1. ツールチェーンを持っていない場合は、テンプレートを選択して ツールチェーンを作成する。 使用するテンプレートに応じて、使用できるフィールドは異なります。 デフォルトのフィールド値を確認し、必要に応じてそれらの設定を変更します。

2. ツールチェーンがあり、そこにこのツール統合を追加する場合、 IBM Cloud コンソールから、 メニューアイコンの > Platform Automation > Toolchains をクリックします。 ツールチェイン・ページで、ツールチェインをクリックしてその概要ページを開く。 あるいは、アプリの「概要」ページの「継続的デリバリー」カードで、**「ツールチェーンの表示」をクリックします。 次に、「概要」**をクリックします。

3. デリバリー・パイプライン統合をツールチェーンに追加します。

   a. **「ツールの追加」**をクリックします。

   b. 「ツール統合」セクションで**「Delivery Pipeline」**をクリックします。

4. 新しいパイプラインの名前を指定します。

5. **「Tekton」**を選択して Tekton Delivery Pipeline を作成します。 パイプライン定義レポ、パイプライントリガー、パイプラインが実行される場所、簡単な秘密の設定をサポートし、定義された Kubernetes クラスタ上で実行されたTektonパイプラインの出力を表示することができます。

6. パイプラインを使用してユーザー・インターフェースをデプロイするよう計画している場合は、**「アプリケーションの表示メニューでアプリケーションを表示する (Show apps in the View app menu)」チェック・ボックスを選択します。 パイプラインが作成するすべてのアプリケーションが、ツールチェーンの「概要」ページの「アプリケーションの表示 (View App)」**リストに表示されます。

7. **「統合の作成」**をクリックして、Delivery Pipeline をツールチェーンに追加します。

   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'

フィルター

フィルターにより、ユーザーは特定の条件に基づいてプルリクエストを絞り込むことができます。 フィルターフィールドは現在、プルリクエストにラベルを指定することをサポートしており、それによってラベルの有無に基づいてパイプラインの実行を制御します。 しかし、ラベルが追加または削除されたときにパイプラインを起動するのではなく、パイプラインの実行を許可する前にPRのラベルを検証する。

実行方法:

• PRイベントが発生すると（新しいコミットが追加されるなど）、パイプラインはPRのラベルをチェックする。
• PRがラベルの条件を満たしている場合（例えば、「承認済み」ラベルを持つ場合）、パイプラインは実行される。
• PRがラベル条件を満たさない場合、パイプラインは実行されない。

構成の例

以下のスクリーンショットは、トリガーが "approved "と "reviewed "のラベルに設定されている例です。

• PRパイプラインは、両方のラベルが存在する場合にのみトリガーされる。
• どちらかのラベルがない場合、パイプラインは実行されない。

イベントペイロードのチェック

イベント・フィルタリングのために CEL 式を書くとき、式が評価されるウェブフック・ペイロードの構造と内容を理解する必要があります。 パイプラインランの詳細ページから、既存のランのペイロードを検査することができます。

イベントペイロードを表示するには、パイプライン実行の詳細ページでコンテキストを表示をクリックします。 パイプラインの実行をトリガーした生のウェブフック・ペイロードを表示し、CEL式の関連フィールドが希望する条件に一致することを確認できます。

API を使用した Tekton 用の Delivery Pipeline の作成

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

   export CD_TEKTON_PIPELINE_APIKEY={api_key}
   

2. Delivery Pipeline ツール統合の追加先となる ツールチェーンのリージョンと ID を決定します。

3. Delivery Pipeline ツール統合をツールチェーンに追加します。

   curl -X POST \
     https://api.{region}.devops.cloud.ibm.com/toolchain/v2/toolchains/{toolchain_id}/tools \
     -H 'Authorization: Bearer {iam_token}' \
     -H 'Accept: application/json` \
     -H 'Content-Type: application/json' \
     -d '{
       "tool_type_id": "pipeline",
       "parameters": {
         "name": "{tool_integration_name}",
         "type" : "tekton"
       }
     }'
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   ...
   (async () => {
      const toolchainService = CdToolchainV2.newInstance();
      const pipelinePrototypeModel = {
         toolchainId: {toolchain_id},
         toolTypeId: 'pipeline',
         name: {tool_integration_name},
         type: "tekton"
      };
      const pipelineTool = await toolchainService.createTool(pipelinePrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createPipelineToolOptions := toolchainClient.NewCreateToolOptions({toolchain_id}, "pipeline")
   createPipelineToolOptions.SetName({tool_integration_name})
   createPipelineToolOptions.SetType("tekton")
   pipelineTool, response, err := toolchainClient.CreateTool(createPipelineToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   pipeline_tool = toolchain_service.create_tool(
      name = {tool_integration_name},
      toolchain_id = {toolchain_id},
      tool_type_id = "pipeline",
      type = "tekton"
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   CreateToolOptions createPipelineToolOptions = new CreateToolOptions.Builder()
      .name({tool_integration_name})
      .toolchainId({toolchain_id})
      .toolTypeId("pipeline")
      .type("tekton")
      .build();
   Response<ToolchainToolPost> response = toolchainService.createTool(createPipelineToolOptions).execute();
   ToolchainToolPost pipelineTool = response.getResult();
   

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

   APIとのDelivery Pipelineツール統合を追加するための変数

   変数	説明
   {region}	ツールチェーンが存在するリージョン (例: us-south)。
   {tool_integration_name}	ツール統合の名前。例えば、 ci-pipeline など。
   {toolchain_id}	ツール統合の追加先となるツールチェーンの ID。
   {iam_token}	有効な IAM ベアラ・トークン。

4. 指定された地域内のパブリック管理対象ワーカーを使用するように Delivery Pipeline を構成します。

   curl -X POST \
      https://api.{region}.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines \
      -H 'Authorization: Bearer {iam_token}' \
      -H 'Accept: application/json` \
      -H 'Content-Type: application/json' \
      -d '{
         "id": "{pipeline_id}",
         "worker": { "id": "public" }
      }'
   

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

   import {
      "github.com/IBM/continuous-delivery-go-sdk/cdtektonpipelinev2"
   }
   ...
   cdTektonPipelineOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}
   pipelineSvc, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineOptions)
   createTektonPipelineOptions := pipelineSvc.NewCreateTektonPipelineOptions(
      {pipeline_id}
   )
   workerIdentityModel := &cdtektonpipelinev2.WorkerIdentity{
      ID: core.StringPtr("public"),
   }
   createTektonPipelineOptions.SetWorker(workerIdentityModel)
   tektonPipeline, response, err := pipelineSvc.CreateTektonPipeline(createTektonPipelineOptions)
   

   from ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2
   ...
   pipeline_service = CdTektonPipelineV2.new_instance()
   worker_identity_model = {
      'id': 'public',
   }
   response = pipeline_service.create_tekton_pipeline(
      id = {pipeline_id},
      worker = worker_identity_model
   )
   tekton_pipeline = response.get_result()
   

   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();
   WorkerIdentity workerIdentityModel = new WorkerIdentity.Builder()
      .id("public")
      .build();
   CreateTektonPipelineOptions createTektonPipelineOptions = new CreateTektonPipelineOptions.Builder()
      .id({pipeline_id})
      .worker(workerIdentityModel)
      .build();
   Response<TektonPipeline> response = pipelineSvc.createTektonPipeline(createTektonPipelineOptions).execute();
   TektonPipeline tektonPipeline = response.getResult();
   

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

   APIDelivery Pipelineで

   変数	説明
   {region}	ツールチェーンが存在するリージョン (例: us-south)。
   {pipeline_id}	パイプライン・ツール統合が作成された、前のステップから返されたパイプラインの ID。
   {iam_token}	有効な IAM ベアラ・トークン。

Delivery Pipeline APIについての詳細は、 API Docsを参照のこと。

Terraform を使用した Tekton 用の Delivery Pipeline の作成

1. Terraform CLI をインストールし、Terraform 用の IBM Cloud Provider プラグインを構成するために、Terraform on IBM Cloud® 入門のチュートリアルに従ってください。

2. main.tfという名前の Terraform 構成ファイルを作成します。 このファイルに、 HashiCorp Configuration Languageを使用してパイプラインを作成するための設定を追加します。 この構成言語の使用について詳しくは、 Terraform の資料を参照してください。

   パイプラインはツールチェーンに属している必要があります。 Terraform を使用して ツールチェーンを作成することもできます。

   以下の例では、指定された Terraform リソースを使用して、ツールチェーンとパイプラインを作成します。

   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
   }
   

   ibm_cd_toolchain_tool_pipeline および ibm_cd_tekton_pipeline リソースについて詳しくは、Terraform レジストリー資料で引数参照の詳細を参照してください。

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

   terraform init
   

4. Terraform 実行プランを作成します。 このプランは、ツールチェーンを作成するために実行する必要があるすべてのアクションを要約します。

   terraform plan
   

5. Terraformの実行計画を適用する。 Terraform は、ツールチェーンを作成するために必要なすべてのアクションを実行します。

   terraform apply
   

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
   

TaskRun ポッドの詳細の表示

特定の TaskRun の基礎となる Kubernetes ポッドに関する情報を表示するには、 Task 名をクリックし、［ ポッド］をクリックします。

ポッドの詳細と、ワーカーによって報告された関連イベントを表示できます。 この情報は、特定の障害をデバッグしたり、実行中にどこで時間がかかったかを判別したりするのに役立ちます。