Pipelines as Code

手順

1. TektonConfig カスタムリソースで、次の例のように、platforms.openshift.pipelinesAsCode 仕様に additionalPACControllers セクションを追加します。

   例: additionalPACControllers セクション

   apiVersion: operator.tekton.dev/v1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     platforms:
       openshift:
         pipelinesAsCode:
           additionalPACControllers:
             pac_controller_2:  

   1

   
               enable: true    

   2

   
               secretName: pac_secret_2  

   3

   
               settings: #  

   4

   
   # ...

   1

   コントローラーの名前。この名前は一意であり、長さが 25 文字を超えてはなりません。

   2

   このパラメーターは任意です。追加のコントローラーを有効にするにはこのパラメーターを true に設定し、追加のコントローラーを無効にするには false に設定します。デフォルト値は true です。

   3

   このパラメーターを、GitHub アプリケーション用に作成する必要があるシークレットの名前に設定します。

   4

   このセクションはオプションです。このセクションでは、メインの Pipelines as Code コントローラーとは異なる設定が必要な場合に、このコントローラーの Pipelines as Code 設定を指定できます。

2. オプション: 2 つ以上の GitHub アプリケーションを使用する場合は、pipelinesAsCode.additionalPACControllers 仕様の下に追加のセクションを作成し、すべての GitHub インスタンスに対して Pipelines as Code コントローラーを設定します。各コントローラーに一意の名前を使用します。

手順

1. Webhook を設定し、リポジトリー カスタムリソース (CR) を作成します。

   • tkn pac CLI ツールを使用して webhook を設定し、リポジトリー CR を 自動的に 作成するには、次のコマンドを使用します。

     $ tkn pac create repo

     対話型出力の例

     ? Enter the Git repository url (default: https://github.com/owner/repo):
     ? Please enter the namespace where the pipeline should run (default: repo-pipelines):
     ! Namespace repo-pipelines is not found
     ? Would you like me to create the namespace repo-pipelines? Yes
     ✓ Repository owner-repo has been created in repo-pipelines namespace
     ✓ Setting up GitHub Webhook for Repository https://github.com/owner/repo
     👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
     ? Do you want me to use it? Yes
     ? Please enter the secret to configure the webhook for payload validation (default: sJNwdmTifHTs):  sJNwdmTifHTs
     ℹ ️You now need to create a GitHub personal access token, please checkout the docs at https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token for the required scopes
     ? Please enter the GitHub access token:  ****************************************
     ✓ Webhook has been created on repository owner/repo
     🔑 Webhook Secret owner-repo has been created in the repo-pipelines namespace.
     🔑 Repository CR owner-repo has been updated with webhook secret in the repo-pipelines namespace
     ℹ Directory .tekton has been created.
     ✓ We have detected your repository using the programming language Go.
     ✓ A basic template has been created in /home/Go/src/github.com/owner/repo/.tekton/pipelinerun.yaml, feel free to customize it.

   • Webhook を設定して Repository CR を 手動 で作成するには、以下の手順を実行します。

     1. OpenShift クラスターで、Pipelines as Code コントローラーの公開 URL を抽出します。

        $ echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')

     2. GitHub リポジトリーまたは組織で、以下の手順を実行します。

        1. Settings -> Webhooks に移動し、Add webhook をクリックします。
        2. Payload URL を Pipelines as Code コントローラーのパブリック URL に設定します。
        3. コンテンツタイプを application/json として選択します。

        4. Webhook シークレットを追加し、別の場所に書き留めます。openssl がローカルマシンにインストールされた状態で、ランダムなシークレットを生成します。

           $ openssl rand -hex 20

        5. Let me select individual events をクリックし、Commit comments、Issue comments、Pull request、および Pushes のイベントを選択します。
        6. Add webhook をクリックします。

     3. OpenShift クラスターで、個人アクセストークンおよび Webhook シークレットを使用して Secret オブジェクトを作成します。

        $ oc -n target-namespace create secret generic github-webhook-config \
          --from-literal provider.token="<GITHUB_PERSONAL_ACCESS_TOKEN>" \
          --from-literal webhook.secret="<WEBHOOK_SECRET>"

     4. Repository CR を作成します。

        例: Repository CR

        apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
        kind: Repository
        metadata:
          name: my-repo
          namespace: target-namespace
        spec:
          url: "https://github.com/owner/repo"
          git_provider:
            secret:
              name: "github-webhook-config"
              key: "provider.token" # Set this if you have a different key in your secret
            webhook_secret:
              name: "github-webhook-config"
              key: "webhook.secret" # Set this if you have a different key for your secret

        注記

        Pipelines as Code は、OpenShift Secret オブジェクトと Repository CR が同じ namespace にあることを前提としています。

2. オプション: 既存の Repository CR の場合、複数の GitHub Webhook シークレットを追加するか、削除されたシークレットの代わりを提供します。

   1. tkn pac CLI ツールを使用して Webhook を追加します。

      例: tkn pac CLI を使用した追加の Webhook

      $ tkn pac webhook add -n repo-pipelines

      対話型出力の例

      ✓ Setting up GitHub Webhook for Repository https://github.com/owner/repo
      👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
      ? Do you want me to use it? Yes
      ? Please enter the secret to configure the webhook for payload validation (default: AeHdHTJVfAeH):  AeHdHTJVfAeH
      ✓ Webhook has been created on repository owner/repo
      🔑 Secret owner-repo has been updated with webhook secert in the repo-pipelines namespace.

   2. 既存の OpenShift Secret オブジェクトの webhook.secret キーを更新します。

3. オプション: 既存の Repository CR の場合は、Personal Access Token を更新します。

   • tkn pac CLI ツールを使用して Personal Access Token を更新します。

     例: tkn pac CLI を使用した Personal Access Token の更新

     $ tkn pac webhook update-token -n repo-pipelines

     対話型出力の例

     ? Please enter your personal access token:  ****************************************
     🔑 Secret owner-repo has been updated with new personal access token in the repo-pipelines namespace.

   • または、Repository CR を変更して Personal Access Token を更新します。

     1. Repository CR でシークレットの名前を見つけます。

        apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
        kind: Repository
        metadata:
          name: my-repo
          namespace: target-namespace
        spec:
        # ...
          git_provider:
            secret:
              name: "github-webhook-config"
        # ...

     2. oc patch コマンドを使用して、$target_namespace namespace の $NEW_TOKEN の値を更新します。

        $ oc -n $target_namespace patch secret github-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}"

手順

1. Webhook を設定し、リポジトリー カスタムリソース (CR) を作成します。

   • tkn pac CLI ツールを使用して webhook を設定し、リポジトリー CR を 自動的に 作成するには、次のコマンドを使用します。

     $ tkn pac create repo

     対話型出力の例

     ? Enter the Git repository url (default: https://gitlab.com/owner/repo):
     ? Please enter the namespace where the pipeline should run (default: repo-pipelines):
     ! Namespace repo-pipelines is not found
     ? Would you like me to create the namespace repo-pipelines? Yes
     ✓ Repository repositories-project has been created in repo-pipelines namespace
     ✓ Setting up GitLab Webhook for Repository https://gitlab.com/owner/repo
     ? Please enter the project ID for the repository you want to be configured,
       project ID refers to an unique ID (e.g. 34405323) shown at the top of your GitLab project : 17103
     👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
     ? Do you want me to use it? Yes
     ? Please enter the secret to configure the webhook for payload validation (default: lFjHIEcaGFlF):  lFjHIEcaGFlF
     ℹ ️You now need to create a GitLab personal access token with `api` scope
     ℹ ️Go to this URL to generate one https://gitlab.com/-/profile/personal_access_tokens, see https://is.gd/rOEo9B for documentation
     ? Please enter the GitLab access token:  **************************
     ? Please enter your GitLab API URL::  https://gitlab.com
     ✓ Webhook has been created on your repository
     🔑 Webhook Secret repositories-project has been created in the repo-pipelines namespace.
     🔑 Repository CR repositories-project has been updated with webhook secret in the repo-pipelines namespace
     ℹ Directory .tekton has been created.
     ✓ A basic template has been created in /home/Go/src/gitlab.com/repositories/project/.tekton/pipelinerun.yaml, feel free to customize it.

   • Webhook を設定して Repository CR を 手動 で作成するには、以下の手順を実行します。

     1. OpenShift クラスターで、Pipelines as Code コントローラーの公開 URL を抽出します。

        $ echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')

     2. GitLab プロジェクトで、以下の手順を実行します。

        1. 左側のサイドバーを使用して Settings -> Webhooks に移動します。
        2. URL を Pipelines as Code コントローラーのパブリック URL に設定します。

        3. Webhook シークレットを追加し、別の場所に書き留めます。openssl がローカルマシンにインストールされた状態で、ランダムなシークレットを生成します。

           $ openssl rand -hex 20

        4. Let me select individual events をクリックし、Commit comments、Issue comments、Pull request、および Pushes のイベントを選択します。
        5. Save changes をクリックします。

     3. OpenShift クラスターで、個人アクセストークンおよび Webhook シークレットを使用して Secret オブジェクトを作成します。

        $ oc -n target-namespace create secret generic gitlab-webhook-config \
          --from-literal provider.token="<GITLAB_PERSONAL_ACCESS_TOKEN>" \
          --from-literal webhook.secret="<WEBHOOK_SECRET>"

     4. Repository CR を作成します。

        例: Repository CR

        apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
        kind: Repository
        metadata:
          name: my-repo
          namespace: target-namespace
        spec:
          url: "https://gitlab.com/owner/repo" # The repository URL
          git_provider:
            #url: "https://gitlab.example.com/" 

        1

        
            secret:
              name: "gitlab-webhook-config"
              key: "provider.token" # Set this if you have a different key in your secret
            webhook_secret:
              name: "gitlab-webhook-config"
              key: "webhook.secret" # Set this if you have a different key for your secret

        1

        GitLab.com ではなく GitLab のプライベートインスタンスを使用している場合は、このフィールドのコメントを解除して、GitLab API の URL に設定します。GitLab API はリポジトリーと同じホストです。たとえば、リポジトリーが https://gitlab.example.com/owner/repo の場合、API URL は https://gitlab.example.com/ です。

   注記
   • Pipelines as Code は、OpenShift Secret オブジェクトと Repository CR が同じ namespace にあることを前提としています。

2. オプション: 既存の Repository CR の場合、複数の GitLab Webhook シークレットを追加するか、削除されたシークレットの代わりを提供します。

   1. tkn pac CLI ツールを使用して Webhook を追加します。

      例: tkn pac CLI を使用した Webhook の追加

      $ tkn pac webhook add -n repo-pipelines

      対話型出力の例

      ✓ Setting up GitLab Webhook for Repository https://gitlab.com/owner/repo
      👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
      ? Do you want me to use it? Yes
      ? Please enter the secret to configure the webhook for payload validation (default: AeHdHTJVfAeH):  AeHdHTJVfAeH
      ✓ Webhook has been created on repository owner/repo
      🔑 Secret owner-repo has been updated with webhook secert in the repo-pipelines namespace.

   2. 既存の OpenShift Secret オブジェクトの webhook.secret キーを更新します。

3. オプション: 既存の Repository CR の場合は、Personal Access Token を更新します。

   • tkn pac CLI ツールを使用して Personal Access Token を更新します。

     例: tkn pac CLI を使用した Personal Access Token の更新

     $ tkn pac webhook update-token -n repo-pipelines

     対話型出力の例

     ? Please enter your personal access token:  ****************************************
     🔑 Secret owner-repo has been updated with new personal access token in the repo-pipelines namespace.

   • または、Repository CR を変更して Personal Access Token を更新します。

     1. Repository CR でシークレットの名前を見つけます。

        ...
        spec:
          git_provider:
            secret:
              name: "gitlab-webhook-config"
        ...

     2. oc patch コマンドを使用して、$target_namespace namespace の $NEW_TOKEN の値を更新します。

        $ oc -n $target_namespace patch secret gitlab-webhook-config -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}"

手順

1. Webhook を設定し、Repository CR を作成します。

   • tkn pac CLI ツールを使用して webhook を設定し、リポジトリー CR を 自動的に 作成するには、次のコマンドを使用します。

     $ tkn pac create repo

     対話型出力の例

     ? Enter the Git repository url (default: https://bitbucket.org/workspace/repo):
     ? Please enter the namespace where the pipeline should run (default: repo-pipelines):
     ! Namespace repo-pipelines is not found
     ? Would you like me to create the namespace repo-pipelines? Yes
     ✓ Repository workspace-repo has been created in repo-pipelines namespace
     ✓ Setting up Bitbucket Webhook for Repository https://bitbucket.org/workspace/repo
     ? Please enter your bitbucket cloud username:  <username>
     ℹ ️You now need to create a Bitbucket Cloud app password, please checkout the docs at https://is.gd/fqMHiJ for the required permissions
     ? Please enter the Bitbucket Cloud app password:  ************************************
     👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
     ? Do you want me to use it? Yes
     ✓ Webhook has been created on repository workspace/repo
     🔑 Webhook Secret workspace-repo has been created in the repo-pipelines namespace.
     🔑 Repository CR workspace-repo has been updated with webhook secret in the repo-pipelines namespace
     ℹ Directory .tekton has been created.
     ✓ A basic template has been created in /home/Go/src/bitbucket/repo/.tekton/pipelinerun.yaml, feel free to customize it.

   • Webhook を設定して Repository CR を 手動 で作成するには、以下の手順を実行します。

     1. OpenShift クラスターで、Pipelines as Code コントローラーの公開 URL を抽出します。

        $ echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')

     2. Bitbucket Cloud で、以下の手順を実行します。

        1. Bitbucket Cloud リポジトリーの左側のナビゲーションペインを使用して Repository settings -> Webhooks に移動し、Add webhook をクリックします。
        2. Title を設定します。たとえば、"Pipelines as Code" です。
        3. URL を Pipelines as Code コントローラーのパブリック URL に設定します。
        4. Repository: Push、Pull Request: Created、Pull Request: Updated、および Pull Request: Comment created のイベントを選択します。
        5. Save をクリックします。

     3. OpenShift クラスターで、ターゲット namespace に app パスワードを使用して Secret オブジェクトを作成します。

        $ oc -n target-namespace create secret generic bitbucket-cloud-token \
          --from-literal provider.token="<BITBUCKET_APP_PASSWORD>"

     4. Repository CR を作成します。

        例: Repository CR

        apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
        kind: Repository
        metadata:
          name: my-repo
          namespace: target-namespace
        spec:
          url: "https://bitbucket.com/workspace/repo"
          branch: "main"
          git_provider:
            user: "<BITBUCKET_USERNAME>" 

        1

        
            secret:
              name: "bitbucket-cloud-token" 

        2

        
              key: "provider.token" # Set this if you have a different key in your secret

        1

        所有者ファイルの ACCOUNT_ID からしかユーザーの参照はできません。

        2

        Pipelines as Code は、git_provider.secret 仕様で参照され、Repository CR が同じ namespace にあることを前提としています。

   注記
   • tkn pac create および tkn pac bootstrap コマンドは Bitbucket Cloud ではサポートされていません。

   • Bitbucket Cloud では Webhook シークレットはサポートされません。ペイロードを保護し、CI のハイジャックを防止するために、Pipelines as Code は Bitbucket Cloud IP アドレスのリストをフェッチし、Webhook の受信がそれらの IP アドレスからのみ行われるようにします。

     • デフォルトの動作を無効にするには、pipelinesAsCode.settings 仕様の TektonConfig カスタムリソースで bitbucket-cloud-check-source-ip パラメーターを false に設定します。
     • 追加の安全な IP アドレスまたはネットワークを許可するには、pipelinesAsCode.settings 仕様の TektonConfig カスタムリソースの bitbucket-cloud-Additional-source-ip パラメーターにコンマ区切りの値として追加します。

2. オプション: 既存の Repository CR の場合は、複数の Bitbucket Cloud Webhook シークレットを追加するか、削除されたシークレットの代わりに指定します。

   1. tkn pac CLI ツールを使用して Webhook を追加します。

      例: tkn pac CLI を使用した Webhook の追加

      $ tkn pac webhook add -n repo-pipelines

      対話型出力の例

      ✓ Setting up Bitbucket Webhook for Repository https://bitbucket.org/workspace/repo
      ? Please enter your bitbucket cloud username:  <username>
      👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.example.com
      ? Do you want me to use it? Yes
      ✓ Webhook has been created on repository workspace/repo
      🔑 Secret workspace-repo has been updated with webhook secret in the repo-pipelines namespace.

      注記

      [-n <namespace>] オプションを tkn pac webhook add コマンドで使用するのは、Repository CR がデフォルト以外の namespace に存在する場合のみです。

   2. 既存の OpenShift Secret オブジェクトの webhook.secret キーを更新します。

3. オプション: 既存の Repository CR の場合は、Personal Access Token を更新します。

   • tkn pac CLI ツールを使用して Personal Access Token を更新します。

     例: tkn pac CLI を使用した Personal Access Token の更新

     $ tkn pac webhook update-token -n repo-pipelines

     対話型出力の例

     ? Please enter your personal access token:  ****************************************
     🔑 Secret owner-repo has been updated with new personal access token in the repo-pipelines namespace.

     注記

     [-n <namespace>] オプションを tkn pac webhook update-token コマンドで使用するのは、Repository CR がデフォルト以外の namespace に存在する場合のみです。

   • または、Repository CR を変更して Personal Access Token を更新します。

     1. Repository CR でシークレットの名前を見つけます。

        ...
        spec:
          git_provider:
            user: "<BITBUCKET_USERNAME>"
            secret:
              name: "bitbucket-cloud-token"
              key: "provider.token"
        ...

     2. oc patch コマンドを使用して、$target_namespace namespace の $password の値を更新します。

        $ oc -n $target_namespace patch secret bitbucket-cloud-token -p "{\"data\": {\"provider.token\": \"$(echo -n $NEW_TOKEN|base64 -w0)\"}}"

手順

1. OpenShift クラスターで、Pipelines as Code コントローラーの公開 URL を抽出します。

   $ echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')

2. Bitbucket Data Center で、以下の手順を実行します。

   1. Bitbucket Data Center リポジトリーの左側のナビゲーションペインを使用して Repository settings -> Webhooks に移動し、Add webhook をクリックします。
   2. Title を設定します。たとえば、"Pipelines as Code" です。
   3. URL を Pipelines as Code コントローラーのパブリック URL に設定します。

   4. Webhook シークレットを追加し、そのコピーを別の場所に保存します。openssl をローカルマシンにインストールしている場合は、以下のコマンドを使用してランダムなシークレットを生成します。

      $ openssl rand -hex 20

   5. 以下のイベントを選択します。

      • Repository: Push
      • Repository: Modified
      • Pull Request: Opened
      • Pull Request: Source branch updated
      • Pull Request: Comment added
   6. Save をクリックします。

3. OpenShift クラスターで、ターゲット namespace に app パスワードを使用して Secret オブジェクトを作成します。

   $ oc -n target-namespace create secret generic bitbucket-datacenter-webhook-config \
     --from-literal provider.token="<PERSONAL_TOKEN>" \
     --from-literal webhook.secret="<WEBHOOK_SECRET>"

4. Repository CR を作成します。

   例: Repository CR

   apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
   kind: Repository
   metadata:
     name: my-repo
     namespace: target-namespace
   spec:
     url: "https://bitbucket.com/workspace/repo"
     git_provider:
       url: "https://bitbucket.datacenter.api.url/rest" 

   1

   
       user: "<BITBUCKET_USERNAME>" 

   2

   
       secret: 

   3

   
         name: "bitbucket-datacenter-webhook-config"
         key: "provider.token" # Set this if you have a different key in your secret
       webhook_secret:
         name: "bitbucket-datacenter-webhook-config"
         key: "webhook.secret" # Set this if you have a different key for your secret

   1

   /api/v1.0 の接尾辞のない正しい Bitbucket Data Center API URL があることを確認します。通常、デフォルトのインストールには /rest 接尾辞があります。

   2

   所有者ファイルの ACCOUNT_ID からしかユーザーの参照はできません。

   3

   Pipelines as Code は、git_provider.secret 仕様で参照され、Repository CR が同じ namespace にあることを前提としています。

   注記

   tkn pac create および tkn pac bootstrap コマンドは Bitbucket Data Center ではサポートされません。

手順

1. .tekton ディレクトリーに .yaml または .yml 拡張子を含むファイルを作成します。
2. 作成したファイルで、PipelineRun CR の YAML 仕様を作成します。この仕様は、OpenShift Pipeline のすべての機能を使用できます。

3. パイプライン実行定義の要件に応じて、次のいずれかの手順を実行します。

   • .yaml または .yml 拡張子を持つ他のファイルを .tekton ディレクトリーに作成します。これらのファイルに、Pipeline、Task、StepAction CR など、パイプライン実行定義が参照するリソースの定義を指定します。Pipelines as Code リゾルバーは、これらのリソースを自動的に解決し、定義に基づく PipelineRun CR に含めます。

   • パイプライン実行仕様で 動的変数 を使用します。コードとしてのパイプラインは、これらの変数を現在のコンテキストを表す値に置き換えます。たとえば、{{ repo_url }} はリポジトリーの現在の URL で、{{ revision }} はパイプライン実行が開始されたコミット SHA です。

     動的変数の詳細については、パイプライン実行仕様の動的変数のセクションを参照してください。

   • 1 つ以上の Pipelines as Code リゾルバーアノテーションをパイプライン実行定義に追加します。コードとしてのパイプラインリゾルバーアノテーションは、Tekton Hub のパイプラインまたはタスク、HTTP の場所、または .tekton ディレクトリー外のリポジトリー内の場所を参照します。リソースを参照するために Pipelines as Code リゾルバーアノテーションを作成する場合、パイプライン実行定義でこのリソースを名前で使用できます。Pipelines as Code リゾルバーは、これらのリソースを自動的に解決し、定義に基づく PipelineRun CR に含めます。

     これらのアノテーションの詳細については、Pipelines as Code リゾルバーアノテーションセクションを参照してください。

4. 以下のアノテーションをパイプライン実行定義に追加して、パイプライン実行をイベントに一致します。定義されたイベントが発生すると、コードとしてのパイプラインはパイプラインの実行を開始します。パイプライン実行とイベントへのマッチングについて、詳しくは「パイプライン実行とのイベントのマッチング」のセクションを参照してください。

   • プルリクエストまたはプッシュイベントを定義する pipelinesascode.tekton.dev/on-event アノテーションと、プルリクエスト または プッシュ イベントがターゲットとする必要のあるブランチを定義する pipelinesascode.tekton.dev/on-target-branch アノテーションの組み合わせ。パイプラインの実行をプルリクエストまたはプッシュイベントに一致させると、イベントの作成時にパイプライン実行が開始されます。プルリクエストの場合は、ソースブランチイベントが更新されるたびに再度開始されます。

     注記

     Git リポジトリープロバイダーがプル要求ではなくマージ要求を使用する場合、pull_request イベント定義はマージ要求に一致します。

   • pipelinesascode.tekton.dev/on-comment アノテーション。これは、パイプライン実行と正規表現によるプルリクエストのコメントに一致します。パイプラインの実行をコメントに一致させると、プルリクエストにコメントが追加されたときに開始されます。パイプラインの実行を再度開始するには、コメントを再度追加します。
   • pipelinesascode.tekton.dev/on-cel-expression アノテーション。これは、指定された Common Expression Language (CEL)式がプルリクエストまたはプッシュイベントに対して true と評価される場合にパイプライン実行に一致します。

5. オプション：一致するイベントをフィルタリングする 1 つ以上のアノテーションを追加します。これらのアノテーションを使用すると、定義された一致するイベント（プルリクエスト、プッシュイベント、またはコメントなど）が発生すると、コードとしてのパイプラインは、これらのアノテーションも一致するかどうかを確認します。パイプライン実行は、追加したすべてのアノテーションが一致する場合にのみ起動します。一致するイベントのフィルターに関する詳細は、イベントをフィルタリングするためのアノテーションセクションを参照してください。

   • プルリクエストまたはプッシュイベントが指定されたパス内のファイルに影響を与える場合、pipelinesascode.tekton.dev/on-path-changed アノテーションは照合されます。
   • pipelinesascode.tekton.dev/on-path-changed-ignore アノテーションは、イベントが指定されたパスのファイル のみ を変更し、リポジトリーの他のファイルを変更しない場合は、一致するイベントを除外します。
   • プルリクエストまたはプッシュイベントに指定されたラベルのいずれかがある場合、pipelinesascode.tekton.dev/on-label アノテーションが一致します。
6. オプション： pipelinesascode.tekton.dev/cancel-in-progress: "true" アノテーションを追加して、特定のケースでパイプライン実行の自動キャンセルを有効にします。たとえば、プルリクエストによってパイプラインの実行がトリガーされ、ユーザーが新しいコミットをプル要求ソースブランチにプッシュする場合、それぞれのプッシュはパイプライン実行の新しいコピーをトリガーします。自動キャンセルを有効にすると、パイプライン実行の新しいコピーが開始されると、Pipelines as Code は古い実行をキャンセルして、パイプライン実行の多くのコピーを同時に実行しないようにします。このアノテーションの詳細については、パイプライン実行の自動キャンセルを指定するアノテーションを参照してください。

手順

1. Web コンソールの Administrator パースペクティブで、Administration → CustomResourceDefinitions に移動します。
2. Search by name ボックスを使用して、tektonconfigs.operator.tekton.dev カスタムリソース定義 (CRD) を検索し、TektonConfig をクリックして CRD Details ページを表示します。
3. Instances タブをクリックします。
4. config インスタンスをクリックして、TektonConfig CR の詳細を表示します。
5. YAML タブをクリックします。

6. 要件に応じて、.options.configMaps.pac-config-logging.data の loglevel. フォールドを編集します。

   Pipelines as Code のログレベルフィールドが warn に設定されている TektonConfig CR の例

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     platforms:
       openshift:
         pipelinesAsCode:
           options:
             configMaps:
               pac-config-logging:
                 data:
                   loglevel.pac-watcher: warn 

   1

   
                   loglevel.pipelines-as-code-webhook: warn 

   2

   
                   loglevel.pipelinesascode: warn 

   3

   
                   zap-logger-config: |
                     {
                       "level": "info",
                       "development": false,
                       "sampling": {
                         "initial": 100,
                         "thereafter": 100
                       },
                       "outputPaths": ["stdout"],
                       "errorOutputPaths": ["stderr"],
                       "encoding": "json",
                       "encoderConfig": {
                         "timeKey": "ts",
                         "levelKey": "level",
                         "nameKey": "logger",
                         "callerKey": "caller",
                         "messageKey": "msg",
                         "stacktraceKey": "stacktrace",
                         "lineEnding": "",
                         "levelEncoder": "",
                         "timeEncoder": "iso8601",
                         "durationEncoder": "",
                         "callerEncoder": ""
                       }
                     }

   1

   pipelines-as-code-watcher コンポーネントのログレベル。

   2

   pipelines-as-code-webhook コンポーネントのログレベル。

   3

   pipelines-as-code-controller コンポーネントのログレベル。

7. オプション: .options.deployments フィールドで各コンポーネントの .env.value を変更して、Pipelines as Code コンポーネントのカスタムロギング config map を作成します。以下の例は custom-pac-config-logging というカスタム config map を使用した設定を示しています。

   Pipelines as Code カスタムロギング config map を使用した TektonConfig CR の例

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     platforms:
       openshift:
         pipelinesAsCode:
           enable: true
           options:
             configMaps:
               custom-pac-config-logging:
                 data:
                   loglevel.pac-watcher: warn
                   loglevel.pipelines-as-code-webhook: warn
                   loglevel.pipelinesascode: warn
                   zap-logger-config: |
                     {
                       "level": "info",
                       "development": false,
                       "sampling": {
                         "initial": 100,
                         "thereafter": 100
                       },
                       "outputPaths": ["stdout"],
                       "errorOutputPaths": ["stderr"],
                       "encoding": "json",
                       "encoderConfig": {
                         "timeKey": "ts",
                         "levelKey": "level",
                         "nameKey": "logger",
                         "callerKey": "caller",
                         "messageKey": "msg",
                         "stacktraceKey": "stacktrace",
                         "lineEnding": "",
                         "levelEncoder": "",
                         "timeEncoder": "iso8601",
                         "durationEncoder": "",
                         "callerEncoder": ""
                       }
                     }
             deployments:
               pipelines-as-code-controller:
                 spec:
                   template:
                     spec:
                       containers:
                       - name: pac-controller
                         env:
                         - name: CONFIG_LOGGING_NAME
                           value: custom-pac-config-logging
               pipelines-as-code-watcher:
                 spec:
                   template:
                     spec:
                       containers:
                       - name: pac-watcher
                         env:
                         - name: CONFIG_LOGGING_NAME
                           value: custom-pac-config-logging
               pipelines-as-code-webhook:
                 spec:
                   template:
                     spec:
                       containers:
                       - name: pac-webhook
                         env:
                         - name: CONFIG_LOGGING_NAME
                           value: custom-pac-config-logging