3.7. OpenShift Pipeline での Tekton Hub の使用

手順

1. 次の例のような TektonHub CR を作成します。

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonHub
   metadata:
     name: hub
   spec:
     targetNamespace: openshift-pipelines 1
     db:                      # Optional: If you want to use custom database
       secret: tekton-hub-db  # Name of db secret should be `tekton-hub-db`
   
     categories:              # Optional: If you want to use custom categories
       - Automation
       - Build Tools
       - CLI
       - Cloud
       - Code Quality
       - ...
   
     catalogs:                # Optional: If you want to use custom catalogs
       - name: tekton
         org: tektoncd
         type: community
         provider: github
         url: https://github.com/tektoncd/catalog
         revision: main
   
     scopes:                   # Optional: If you want to add new users
       - name: agent:create
         users: [abc, qwe, pqr]
       - name: catalog:refresh
         users: [abc, qwe, pqr]
       - name: config:refresh
         users: [abc, qwe, pqr]
   
     default:                   # Optional: If you want to add custom default scopes
       scopes:
         - rating:read
         - rating:write
   
     api:
       catalogRefreshInterval: 30m 2

   1

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

   2

   カタログが自動的に更新されるまでの時間間隔。サポートされている時間の単位は、秒 (s)、分 (m)、時間 (h)、日 (d)、および週 (w) です。デフォルトの間隔は 30 分です。

   注記

   TektonHub CR のオプションフィールドにカスタム値を指定しない場合は、Tekton Hub API config map で設定されたデフォルト値が使用されます。

2. TektonHub CR を適用します。

   $ oc apply -f <tekton-hub-cr>.yaml

3. インストールのステータスを確認します。TektonHub CR が安定状態になるまでに時間がかかる場合があります。

   $ oc get tektonhub.operator.tekton.dev

   出力例

   NAME   VERSION   READY   REASON   APIURL                    UIURL
   hub    v1.9.0    True             https://api.route.url/    https://ui.route.url/

手順

1. Git リポジトリーホスティングプロバイダーを使用して OAuth アプリケーションを作成し、クライアント ID とクライアントシークレットをメモします。サポートされているプロバイダーは、GitHub、GitLab、および BitBucket です。

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

2. <tekton_hub_root>/config/02-api/20-api-secret.yaml ファイルを編集して、Tekton Hub API シークレットを含めます。以下に例を示します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: tekton-hub-api
     namespace: openshift-pipelines
   type: Opaque
   stringData:
     GH_CLIENT_ID: 1
     GH_CLIENT_SECRET: 2
     GL_CLIENT_ID: 3
     GL_CLIENT_SECRET: 4
     BB_CLIENT_ID: 5
     BB_CLIENT_SECRET: 6
     JWT_SIGNING_KEY: 7
     ACCESS_JWT_EXPIRES_IN: 8
     REFRESH_JWT_EXPIRES_IN: 9
     AUTH_BASE_URL: 10
     GHE_URL: 11
     GLE_URL: 12

   1

   GitHub OAuth アプリケーションからのクライアント ID。

   2

   GitHub OAuth アプリケーションからのクライアントシークレット。

   3

   GitLab OAuth アプリケーションからのクライアント ID。

   4

   GitLab OAuth アプリケーションからのクライアントシークレット。

   5

   BitBucket OAuth アプリケーションからのクライアント ID。

   6

   BitBucket OAuth アプリケーションからのクライアントシークレット。

   7

   ユーザー用に作成された JSON Web トークン (JWT) に署名するために使用される長いランダムな文字列。

   8

   アクセストークンの有効期限が切れるまでの時間制限を追加します。たとえば、1m、ここで m は分を示します。サポートされている時間の単位は、秒 (s)、分 (m)、時間 (h)、日 (d)、および週 (w) です。

   9

   更新トークンの有効期限が切れるまでの時間制限を追加します。たとえば、1m、ここで m は分を示します。サポートされている時間の単位は、秒 (s)、分 (m)、時間 (h)、日 (d)、および週 (w) です。トークンの更新に設定された有効期限が、トークンアクセスに設定された有効期限よりも長いことを確認してください。

   10

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

   11

   GitHub Enterprise を使用して認証している場合は、GitHub Enterprise URL。このフィールドの値としてカタログへの URL を指定しないでください。

   12

   GitLab Enterprise を使用して認証している場合は、GitLab Enterprise URL。このフィールドの値としてカタログへの URL を指定しないでください。

   注記

   デプロイに関係のない Git リポジトリーホスティングサービスプロバイダーの未使用のフィールドを削除できます。

3. 次の例のような TektonHub CR を作成します。

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonHub
   metadata:
     name: hub
   spec:
     targetNamespace: openshift-pipelines 1
     db: 2
       secret: tekton-hub-db 3
   
     categories: 4
       - Automation
       - Build Tools
       - CLI
       - Cloud
       - Code Quality
         ...
   
     catalogs: 5
       - name: tekton
         org: tektoncd
         type: community
         provider: github
         url: https://github.com/tektoncd/catalog
         revision: main
   
     scopes: 6
       - name: agent:create
         users: [<username>]
       - name: catalog:refresh
         users: [<username>]
       - name: config:refresh
         users: [<username>]
   
     default: 7
       scopes:
         - rating:read
         - rating:write
   
     api:
       catalogRefreshInterval: 30m 8

   1

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

   2

   オプション: Crunchy Postgres データベースなどのカスタムデータベース。

   3

   データベースシークレットの名前は tekton-hub-db である必要があります。

   4

   オプション: Tekton Hub のタスクとパイプラインのカスタマイズされたカテゴリー。

   5

   オプション: Tekton Hub 用にカスタマイズされたカタログ。

   6

   オプション: 追加のユーザー。[<username_1>, <username_2>, <username_3>] のように、複数のユーザーをメンションできます。

   7

   オプション: カスタマイズされたデフォルトスコープ。

   8

   カタログが自動的に更新されるまでの時間間隔。サポートされている時間の単位は、秒 (s)、分 (m)、時間 (h)、日 (d)、および週 (w) です。デフォルトの間隔は 30 分です。

   注記

   TektonHub CR のオプションフィールドにカスタム値を指定しない場合は、Tekton Hub API config map で設定されたデフォルト値が使用されます。

4. TektonHub CR を適用します。

   $ oc apply -f <tekton-hub-cr>.yaml

5. インストールのステータスを確認します。TektonHub CR が安定状態になるまでに時間がかかる場合があります。

   $ oc get tektonhub.operator.tekton.dev

   出力例

   NAME   VERSION   READY   REASON   APIURL                    UIURL
   hub    v1.9.0    True             https://api.route.url/    https://ui.route.url/

手順

1. Crunchy Postgres Pod に入ります。

   例: test-instance1-m7hh-0 Pod に入る

   $ oc exec -it -n openshift-operators test-instance1-m7hh-0 -- /bin/sh
   
   Defaulting container name to database.
   Use 'oc describe pod/test-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod.
   sh-4.4$ psql -U postgres
   psql (14.4)
   Type "help" for help.

2. pg_hba.conf ファイルを見つけます。

   postgres=# SHOW hba_file;
            hba_file
   --------------------------
    /pgdata/pg14/pg_hba.conf
   (1 row)
   
   postgres=#

3. データベースを終了します。

4. pg_hba.conf ファイルに、すべての受信接続にアクセスするために必要なエントリー host all all 0.0.0.0/0 md5 があるかどうかを確認します。さらに、pg_hba.conf ファイルの末尾にエントリーを追加します。

   例: pg_hba.conf ファイル

   sh-4.4$ cat /pgdata/pg14/pg_hba.conf
   
   # Do not edit this file manually!
   # It will be overwritten by Patroni!
   local all "postgres" peer
   hostssl replication "_crunchyrepl" all cert
   hostssl "postgres" "_crunchyrepl" all cert
   host all "_crunchyrepl" all reject
   hostssl all all all md5
   host  all  all 0.0.0.0/0 md5

5. pg_hba.conf ファイルを保存し、データベースをリロードします。

   sh-4.4$ psql -U postgres
   psql (14.4)
   Type "help" for help.
   
   postgres=# SHOW hba_file;
            hba_file
   --------------------------
    /pgdata/pg14/pg_hba.conf
   (1 row)
   
   postgres=# SELECT pg_reload_conf();
    pg_reload_conf
   ----------------
    t
   (1 row)

6. データベースを終了します。

7. Crunchy Postgres ホストのシークレット値をデコードします。

   例: Crunchy Postgres ホストのシークレット値をデコードする

   $ echo 'aGlwcG8tcHJpbWFyeS5vcGVuc2hpZnQtb3BlcmF0b3JzLnN2YyA=' | base64 --decode
   test-primary.openshift-operators.svc

8. 次のキーを使用して、ターゲット namespace に tekton-hub-db という名前のシークレットを作成します。

   • POSTGRES_HOST
   • POSTGRES_DB
   • POSTGRES_USER
   • POSTGRES_PASSWORD

   • POSTGRES_PORT

     例: カスタムデータベースシークレット

     apiVersion: v1
     kind: Secret
     metadata:
       name: tekton-hub-db
       labels:
         app: tekton-hub-db
     type: Opaque
     stringData:
       POSTGRES_HOST: test-primary.openshift-operators.svc
       POSTGRES_DB: test
       POSTGRES_USER: test
       POSTGRES_PASSWORD: woXOisU5>ocJiTF7y{{;1[Q(
       POSTGRES_PORT: '5432'
     ...

   注記

   デフォルトのターゲット namespace は openshift-pipelines です。

9. TektonHub CR で、データベースのシークレット属性の値を tekton-hub-db に設定します。

   例: カスタムデータベースシークレットの追加

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonHub
   metadata:
     name: hub
   spec:
     targetNamespace: openshift-pipelines
     db:
       secret: tekton-hub-db
   ...

10. 更新された TektonHub CR を使用して、カスタムデータベースを Tekton Hub に関連付けます。

    $ oc apply -f <tekton-hub-cr>.yaml

11. インストールのステータスを確認します。TektonHub CR が安定状態になるまでは、時間がかかる場合があります。

    $ oc get tektonhub.operator.tekton.dev

    出力例

    NAME   VERSION   READY   REASON   APIURL                    UIURL
    hub    v1.9.0    True             https://api.route.url/    https://ui.route.url/

手順

1. 内部またはデフォルトのデータベースから Pod 内のファイルに既存のデータをダンプします。

   例: データのダンプ

   $ pg_dump -Ft -h localhost -U postgres hub -f /tmp/hub.dump

2. データダンプを含むファイルをローカルシステムにコピーします。

   コマンドの形式

   $ oc cp -n <namespace> <podName>:<path-to-hub.dump> <path-to-local-system>

1. データダンプを含むファイルをローカルシステムから外部の Crunchy Postgres データベースを実行している Pod にコピーします。

   コマンドの形式

   $ oc cp -n <namespace> <path-to-local-system> <podName>:<path-to-hub.dump>

1. Crunchy Postgres データベースのデータを復元します。

1. Crunchy Postgres Pod に入ります。例: test-instance1-m7hh-0 Pod に入る

   $ oc exec -it -n openshift-operators test-instance1-m7hh-0 -- /bin/sh
   
   Defaulting container name to database.
   Use 'oc describe pod/test-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod.
   sh-4.4$ psql -U postgres
   psql (14.4)
   Type "help" for help.

2. pg_hba.conf ファイルを見つけます。

   postgres=# SHOW hba_file;
            hba_file
   --------------------------
    /pgdata/pg14/pg_hba.conf
   (1 row)
   
   postgres=#

3. データベースを終了します。

4. pg_hba.conf ファイルに、すべての受信接続にアクセスするために必要なエントリー host all all 0.0.0.0/0 md5 があるかどうかを確認します。必要に応じて、pg_hba.conf ファイルの末尾にエントリーを追加します。

   例: pg_hba.conf ファイル

   sh-4.4$ cat /pgdata/pg14/pg_hba.conf
   
   # Do not edit this file manually!
   # It will be overwritten by Patroni!
   local all "postgres" peer
   hostssl replication "_crunchyrepl" all cert
   hostssl "postgres" "_crunchyrepl" all cert
   host all "_crunchyrepl" all reject
   hostssl all all all md5
   host  all  all 0.0.0.0/0 md5

5. pg_hba.conf ファイルを保存し、データベースをリロードします。

   sh-4.4$ psql -U postgres
   psql (14.4)
   Type "help" for help.
   
   postgres=# SHOW hba_file;
            hba_file
   --------------------------
    /pgdata/pg14/pg_hba.conf
   (1 row)
   
   postgres=# SELECT pg_reload_conf();
    pg_reload_conf
   ----------------
    t
   (1 row)

6. データベースを終了します。

7. ターゲット namespace の tekton-hub-db という名前のシークレットに次のキーがあることを確認します。

   • POSTGRES_HOST
   • POSTGRES_DB
   • POSTGRES_USER
   • POSTGRES_PASSWORD

   • POSTGRES_PORT

     例: カスタムデータベースシークレット

     apiVersion: v1
     kind: Secret
     metadata:
       name: tekton-hub-db
       labels:
         app: tekton-hub-db
     type: Opaque
     stringData:
       POSTGRES_HOST: test-primary.openshift-operators.svc
       POSTGRES_DB: test
       POSTGRES_USER: test
       POSTGRES_PASSWORD: woXOisU5>ocJiTF7y{{;1[Q(
       POSTGRES_PORT: '5432'
     ...

     注記

     POSTGRES_HOST フィールドの値はシークレットとしてエンコードされます。次の例を使用して、Crunchy Postgres ホストの値をデコードできます。

     例: Crunchy Postgres ホストのシークレット値をデコードする

     $ echo 'aGlwcG8tcHJpbWFyeS5vcGVuc2hpZnQtb3BlcmF0b3JzLnN2YyA=' | base64 --decode
     test-primary.openshift-operators.svc

8. TektonHub CR で、データベースのシークレット属性の値が tekton-hub-db であることを確認します。

   例: データベースシークレットの名前を含む TektonHub CR

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonHub
   metadata:
     name: hub
   spec:
     targetNamespace: openshift-pipelines
     db:
       secret: tekton-hub-db
   ...

9. 外部の Crunchy Postgres データベースを Tekton Hub に関連付けるには、既存の TektonHub CR を更新された TektonHub CR に置き換えます。

   $ oc replace -f <updated-tekton-hub-cr>.yaml

10. Tekton Hub のステータスを確認します。更新された TektonHub CR が安定状態になるまでは、時間がかかる場合があります。

    $ oc get tektonhub.operator.tekton.dev

    出力例

    NAME   VERSION   READY   REASON   APIURL                    UIURL
    hub    v1.9.0    True             https://api.route.url/    https://ui.route.url/