OpenShift Pipeline の可観測性

1. OpenShift Container Platform クラスターで、Loki Operator を使用して LokiStack をインストールし、さらに OpenShift Logging Operator もインストールします。

2. OpenShift Logging バージョン 6 またはバージョン 5 のどちらをインストールしたかに応じて、次のいずれかの YAML マニフェストを使用して、ClusterLogForwarder カスタムリソース (CR) の ClusterLogForwarder.yaml マニフェストファイルを作成します。

   OpenShift Logging バージョン 6 をインストールしている場合の ClusterLogForwarder CR の YAML マニフェスト

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
     name: collector
     namespace: openshift-logging
   spec:
     inputs:
     - application:
         selector:
           matchExpressions:
             - key: app.kubernetes.io/managed-by
               operator: In
               values: ["tekton-pipelines", "pipelinesascode.tekton.dev"]
       name: only-tekton
       type: application
     managementState: Managed
     outputs:
     - lokiStack:
         labelKeys:
           application:
             ignoreGlobal: true
             labelKeys:
             - log_type
             - kubernetes.namespace_name
             - openshift_cluster_id
         authentication:
           token:
             from: serviceAccount
         target:
           name: logging-loki
           namespace: openshift-logging
       name: default-lokistack
       tls:
         ca:
           configMapName: openshift-service-ca.crt
           key: service-ca.crt
       type: lokiStack
     pipelines:
     - inputRefs:
       - only-tekton
       name: default-logstore
       outputRefs:
       - default-lokistack
     serviceAccount:
       name: collector

   OpenShift Logging バージョン 5 をインストールしている場合の ClusterLogForwarder CR の YAML マニフェスト

   apiVersion: "logging.openshift.io/v1"
   kind: ClusterLogForwarder
   metadata:
     name: instance
     namespace: openshift-logging
   spec:
     inputs:
     - name: only-tekton
       application:
         selector:
           matchLabels:
             app.kubernetes.io/managed-by: tekton-pipelines
     pipelines:
       - name: enable-default-log-store
         inputRefs: [ only-tekton ]
         outputRefs: [ default ]

3. 次のコマンドを入力して、openshift-logging namespace に ClusterLogForwarder CR を作成します。

   $ oc apply -n openshift-logging ClusterLogForwarder.yaml

4. 次のコマンドを使用して、TektonConfig カスタムリソース (CR) を編集します。

   $ oc edit TektonConfig config

   result 仕様に次の変更を加えます。

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     result:
       loki_stack_name: logging-loki 1
       loki_stack_namespace: openshift-logging 2

   1

   LokiStack CR の名前。通常は logging-loki です。

   2

   LokiStack がデプロイされている namespace の名前。通常は openshift-logging です。

手順

1. 次のコマンドを入力して、PostgreSQL サーバーに接続するための認証情報を含むシークレットを作成します。

   $ oc create secret generic tekton-results-postgres \
     --namespace=openshift-pipelines \
     --from-literal=POSTGRES_USER=<user> \
     --from-literal=POSTGRES_PASSWORD=<password>

2. 次のコマンドを使用して、TektonConfig カスタムリソース (CR) を編集します。

   $ oc edit TektonConfig config

   result 仕様に次の変更を加えます。

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     result:
       is_external_db: true
       db_host: database.example.com 1
       db_port: 5342 2

   1

   PostgreSQL サーバーのホスト名を入力します。

   2

   PostgreSQL サーバーのポート番号を指定します。

手順

1. 次のコマンドを入力して、RESULTS_API 環境変数を Tekton Results API へのルートに設定します。

   $ export RESULTS_API=$(oc get route tekton-results-api-service -n openshift-pipelines --no-headers -o custom-columns=":spec.host"):443

2. 次のコマンドを入力して、Tekton Results API の認証トークンを作成します。

   $ oc create token <service_account>

   このコマンドが出力する文字列を保存します。

3. オプション: Tekton Results API による自動認証用に ~/.config/tkn/results.yaml ファイルを作成します。ファイルには次の内容が含まれている必要があります。

   address: <tekton_results_route> 1
   token: <authentication_token> 2
   ssl:
      roots_file_path: /home/example/cert.pem 3
      server_name_override: tekton-results-api-service.openshift-pipelines.svc.cluster.local 4
    service_account:
      namespace: service_acc_1 5
      name: service_acc_1 6

   1

   Tekton Results API へのルート。RESULTS_API に設定したものと同じ値を使用します。

   2

   oc create token コマンドによって作成された認証トークン。このトークンを指定すると、service_account 設定がオーバーライドされ、opc はこのトークンを使用して認証します。

   3

   API エンドポイント用に設定した SSL 証明書を含むファイルの場所。

   4

   OpenShift Pipelines のカスタムターゲット namespace を設定した場合は、openshift-pipelines をこの namespace の名前に置き換えます。

   5 6

   Tekton Results API で認証するためのサービスアカウントの名前。認証トークンを指定した場合は、service_account パラメーターを指定する必要はありません。

   あるいは、~/.config/tkn/results.yaml ファイルを作成しない場合は、--authtoken オプションを使用して各 opc コマンドにトークンを渡すことができます。

手順

1. namespace で作成されたパイプライン実行およびタスク実行に対応するすべての結果の名前をリストします。以下のコマンドを実行します。

   $ opc results list --addr ${RESULTS_API} <namespace_name>

   コマンドの例

   $ opc results list --addr ${RESULTS_API} results-testing

   出力例

   Name                                                          Start                                   Update
   results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed  2023-06-29 02:49:53 +0530 IST           2023-06-29 02:50:05 +0530 IST
   results-testing/results/ad7eb937-90cc-4510-8380-defe51ad793f  2023-06-29 02:49:38 +0530 IST           2023-06-29 02:50:06 +0530 IST
   results-testing/results/d064ce6e-d851-4b4e-8db4-7605a23671e4  2023-06-29 02:49:45 +0530 IST           2023-06-29 02:49:56 +0530 IST

2. 次のコマンドを入力して、結果内のすべてのレコードの名前をリスト表示します。

   $ opc results records list --addr ${RESULTS_API} <result_name>

   コマンドの例

   $ opc results records list --addr ${RESULTS_API} results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed

   出力例

   Name                                                                                                   Type                                    Start                                   Update
   results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/e9c736db-5665-441f-922f-7c1d65c9d621  tekton.dev/v1.TaskRun              2023-06-29 02:49:53 +0530 IST           2023-06-29 02:49:57 +0530 IST
   results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/5de23a76-a12b-3a72-8a6a-4f15a3110a3e  results.tekton.dev/v1alpha2.Log         2023-06-29 02:49:57 +0530 IST           2023-06-29 02:49:57 +0530 IST
   results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/57ce92f9-9bf8-3a0a-aefb-dc20c3e2862d  results.tekton.dev/v1alpha2.Log         2023-06-29 02:50:05 +0530 IST           2023-06-29 02:50:05 +0530 IST
   results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/e9a0c21a-f826-42ab-a9d7-a03bcefed4fd  tekton.dev/v1.TaskRun              2023-06-29 02:49:57 +0530 IST           2023-06-29 02:50:05 +0530 IST
   results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/04e2fbf2-8653-405f-bc42-a262bcf02bed  tekton.dev/v1.PipelineRun          2023-06-29 02:49:53 +0530 IST           2023-06-29 02:50:05 +0530 IST
   results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/e6eea2f9-ec80-388c-9982-74a018a548e4  results.tekton.dev/v1alpha2.Log         2023-06-29 02:50:05 +0530 IST           2023-06-29 02:50:05 +0530 IST

3. 次のコマンドを入力して、レコードからパイプライン実行またはタスク実行の YAML マニフェストを取得します。

   $ opc results records get --addr ${RESULTS_API} <record_name> \
     | jq -r .data.value | base64 -d | \
     xargs -0 python3 -c 'import sys, yaml, json; j=json.loads(sys.argv[1]); print(yaml.safe_dump(j))'

   コマンドの例

   $ opc results records get --addr ${RESULTS_API} \
     results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/e9c736db-5665-441f-922f-7c1d65c9d621 | \
     jq -r .data.value | base64 -d | \
     xargs -0 python3 -c 'import sys, yaml, json; j=json.loads(sys.argv[1]); print(yaml.safe_dump(j))'

4. オプション: ログレコード名を使用して、レコードから実行されたタスクのログ情報を取得します。ログレコード名を取得するには、レコード名の records は、logs に置き換えます。以下のコマンドを実行します。

   $ opc results logs get --addr ${RESULTS_API} <log_record_name> | jq -r .data | base64 -d

   コマンドの例

   $ opc results logs get --addr ${RESULTS_API} \
     results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/logs/e9c736db-5665-441f-922f-7c1d65c9d621 | \
     jq -r .data | base64 -d