第3章 サービスプロバイダーをホストする Git リポジトリーでの Pipelines as Code の使用

手順

1. 管理者パースペクティブで、ナビゲーションペインを使用して Pipelines に移動します。
2. Pipelines ページで GitHub アプリのセットアップ をクリックします。
3. GitHub のアプリケーション名を入力します。例: pipelines-ci-clustername-testui
4. Setup をクリックします。
5. ブラウザーでプロンプトが表示されたら、Git パスワードを入力します。
6. Create GitHub App for <username> をクリックします。ここで、<username> は GitHub ユーザー名です。

手順

1. GitHub アカウントにサインインします。
2. GitHub メニューで、Settings Developer settings GitHub Apps を選択し、New GitHub App をクリックします。

3. GitHub App フォームに以下の情報を入力します。

   • GitHub Application Name: OpenShift Pipelines
   • Homepage URL: OpenShift Console の URL

   • Webhook URL: Pipelines as Code ルートまたは受信 URL次のコマンドを実行すると、これを見つけることができます。

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

     あるいは、追加の Pipelines as Code コントローラー用に GitHub アプリケーションを設定するには、次の例のように、pipelines-as-code-controller を、設定したコントローラーの名前に置き換えます。

     コマンドの例

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

   • Webhook secret: 任意のシークレット。次のコマンドを実行してシークレットを生成できます。

     $ openssl rand -hex 20

4. Repository permissions セクションで次の項目を選択します。

   • Checks: Read & Write
   • Contents: Read & Write
   • Issues: Read & Write
   • Metadata: Read-only
   • Pull request: Read & Write

5. Organization permissions セクションで次の項目を選択します。

   • Members: Read-only
   • Plan: Read-only

6. 次のイベントにサブスクライブします。

   • Check run
   • Check suite
   • Commit comment
   • Issue comment
   • Pull request
   • プッシュ
7. Create GitHub App をクリックします。
8. 新たに作成された GitHub App の Details ページで、上部に表示される App ID を書き留めます。
9. Private keys セクションで、Generate Private key をクリックして GitHub アプリケーションの秘密鍵を自動的に生成およびダウンロードします。今後の参照や使用のために秘密鍵を安全に保管します。
10. 作成したアプリを Pipelines as Code で使用するリポジトリーにインストールします。

11. 次のコマンドを入力して、新しく作成された GitHub アプリケーションにアクセスできるように Pipelines as Code を設定します。

    $ oc -n openshift-pipelines create secret generic pipelines-as-code-secret \ 1
            --from-literal github-private-key="$(cat <PATH_PRIVATE_KEY>)" \ 2
            --from-literal github-application-id="<APP_ID>" \ 3
            --from-literal webhook.secret="<WEBHOOK_SECRET>" 4

    1

    追加の GitHub アプリケーションをサポートするために追加の Pipelines as Code コントローラーを作成し、追加のコントローラー用にアプリケーションを設定する場合は、pipelines-as-code-secret を、コントローラーの secretName パラメーターで設定した名前に置き換えます。

    2

    GitHub アプリケーションの設定時にダウンロードした秘密鍵へのパス。

    3

    GitHub アプリケーションの App ID。

    4

    GitHub アプリケーションの作成時に提供された Webhook シークレット。

手順

1. TektonConfig カスタムリソース (CR) の pipelinesAsCode.settings 仕様で、secret-github-app-token-scoped パラメーターを false に設定します。この設定により、GitHub トークンのスコープを、グローバルおよびリポジトリーレベルの設定にリストされているプライベートおよびパブリックリポジトリーに設定できるようになります。

2. GitHub トークンのスコープを指定するためのグローバル設定を設定するには、TektonConfig CR の pipelinesAsCode.settings 仕様で、次の例のように secret-github-app-scope-extra-repos パラメーターで追加のリポジトリーを指定します。

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     platforms:
       openshift:
         pipelinesAsCode:
           enable: true
           settings:
             secret-github-app-token-scoped: false
             secret-github-app-scope-extra-repos: "owner2/project2, owner3/project3"

3. GitHub トークンのスコープを設定するためのリポジトリーレベルの設定を設定するには、次の例のように、Repository CR の github_app_token_scope_repos パラメーターで追加のリポジトリーを指定します。

   apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
   kind: Repository
   metadata:
     name: test
     namespace: test-repo
   spec:
     url: "https://github.com/linda/project"
     settings:
       github_app_token_scope_repos:
       - "owner/project"
       - "owner1/project1"

   この例では、Repository カスタムリソースは test-repo namespace の linda/project リポジトリーに関連付けられています。生成された GitHub トークンのスコープは linda/project リポジトリーだけでなく、owner/project および owner1/project1 リポジトリーにも拡張されます。これらのリポジトリーは、test-repo namespace の下に存在する必要があります。

   注記

   追加のリポジトリーはパブリックまたはプライベートにすることができますが、Repository リソースが関連付けられているリポジトリーと同じ namespace に存在する必要があります。

   いずれかのリポジトリーが namespace に存在しない場合、GitHub トークンのスコープ設定は失敗し、次のエラーメッセージが表示されます。

   failed to scope GitHub token as repo owner1/project1 does not exist in namespace test-repo