4.7. OpenShift Pipeline での Tekton Hub の使用

手順

1. Tekton Hub リポジトリーのフォークを作成します。
2. フォークされたリポジトリーのクローンを作成します。

3. config.yaml ファイルを更新して、次のスコープを持つ少なくとも 1 人のユーザーを含めます。

   • agent:create スコープを持つユーザーで、カタログに変更があった場合に、一定間隔後に Tekton Hub データベースを更新する cron ジョブを設定できます。
   • Tekton Hub のデータベース内のカタログとすべてのリソースを更新できる catalog:refresh スコープを持つユーザー。

   • 追加のスコープを取得できる config:refresh スコープを持つユーザー。

     ...
     scopes:
     - name: agent:create
       users: <username_registered_with_the_Git_repository_hosting_service_provider>
     - name: catalog:refresh
       users: <username_registered_with_the_Git_repository_hosting_service_provider>
     - name: config:refresh
       users: <username_registered_with_the_Git_repository_hosting_service_provider>
     ...

     サポートされているサービスプロバイダーは、GitHub、GitLab、および BitBucket です。

4. Git リポジトリーホスティングプロバイダーを使用して OAuth アプリケーションを作成し、クライアント ID とクライアントシークレットをメモします。

   • GitHub OAuth アプリケーションの場合、Homepage URL と Authorization callback URL を <auth-route> として設定します。
   • GitLab OAuth アプリケーションの場合、REDIRECT_URI を <auth-route>/auth/gitlab/callback として設定します。
   • BitBucket OAuth アプリケーションの場合、Callback URL を <auth-route> として設定します。

5. Tekton Hub API シークレットの <tekton_hub_repository>/config/02-api/20-api-secret.yaml ファイルの次のフィールドを編集します。

   • GH_CLIENT_ID: Git リポジトリーホスティングサービスプロバイダーで作成された OAuth アプリケーションのクライアント ID。
   • GH_CLIENT_SECRET: Git リポジトリーホスティングサービスプロバイダーで作成された OAuth アプリケーションのクライアントシークレット。
   • GHE_URL: GitHub Enterprise を使用して認証している場合は、GitHub Enterprise URL。このフィールドの値としてカタログへの URL を指定しないでください。
   • GL_CLIENT_ID: GitLab OAuth アプリケーションからのクライアント ID。
   • GL_CLIENT_SECRET: GitLab OAuth アプリケーションからのクライアントシークレット。
   • GLE_URL: GitLab Enterprise を使用して認証している場合は、GitLab Enterprise URL。このフィールドの値としてカタログへの URL を指定しないでください。
   • BB_CLIENT_ID: BitBucket OAuth アプリケーションからのクライアント ID。
   • BB_CLIENT_SECRET: BitBucket OAuth アプリケーションからのクライアントシークレット。
   • JWT_SIGNING_KEY: ユーザー用に作成された JSON Web Token (JWT) に署名するために使用される長いランダムな文字列。
   • ACCESS_JWT_EXPIRES_IN: アクセストークンの有効期限が切れるまでの制限時間を追加します。たとえば、1m、ここで m は分を示します。サポートされている時間の単位は、秒 (s)、分 (m)、時間 (h)、日 (d)、および週 (w) です。
   • REFRESH_JWT_EXPIRES_IN: 更新トークンの有効期限が切れるまでの制限時間を追加します。たとえば、1m、ここで m は分を示します。サポートされている時間の単位は、秒 (s)、分 (m)、時間 (h)、日 (d)、および週 (w) です。トークンの更新に設定された有効期限が、トークンアクセスに設定された有効期限よりも長いことを確認してください。

   • AUTH_BASE_URL: OAuth アプリケーションのルート URL。

     注記
     • サポートされている Git リポジトリーホスティングサービスプロバイダーのいずれかについて、クライアント ID とクライアントシークレットに関連するフィールドを使用します。
     • Git リポジトリーホスティングサービスプロバイダーに登録されたアカウントクレデンシャルにより、catalog: refresh スコープを使用するユーザーは、すべてのカタログリソースを認証してデータベースにロードできます。
6. 変更をコミットして、フォークされたリポジトリーにプッシュします。

7. TektonHub CR が次の例のようになっていることを確認します。

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonHub
   metadata:
     name: hub
   spec:
     targetNamespace: openshift-pipelines 1
     api:
       hubConfigUrl: https://raw.githubusercontent.com/tektoncd/hub/main/config.yaml 2

   1

   Tekton Hub をインストールする必要がある namespace。デフォルトは openshift-pipelines です。

   2

   フォークされたリポジトリーの config.yaml ファイルの URL に置き換えます。

8. Tekton Hub をインストールします。

   $ oc apply -f TektonHub.yaml 1

   1

   TektonConfig CR のファイル名またはパス。

9. インストールのステータスを確認します。

   $ oc get tektonhub.operator.tekton.dev
   NAME   VERSION   READY   REASON   APIURL                    UIURL
   hub    v1.7.2    True             https://api.route.url/    https://ui.route.url/