OpenShift Pipeline の可観測性

前提条件

• openssl コマンドラインユーティリティーがインストールされている。

• 外部 PostgreSQL サーバーを使用する必要がない場合は、次のコマンドを入力して、openshift-pipelines namespace に result という名前のデータベースユーザーと任意のパスワードを使用してシークレットを作成します。

  $ oc create secret generic tekton-results-postgres \
    --namespace=openshift-pipelines \
    --from-literal=POSTGRES_USER=result \
    --from-literal=POSTGRES_PASSWORD=$(openssl rand -base64 20)

  注記

  このコマンドおよび後続のコマンドで、OpenShift Pipelines のカスタムターゲット namespace を設定した場合は、openshift-pipelines の代わりにこの namespace の名前を使用します。

• 外部 PostgreSQL データベースサーバーを使用して Tekton Results データを保存する場合は、次のコマンドを入力して、このサーバーの認証情報を使用してシークレットを作成します。

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

  1

  
    --from-literal=POSTGRES_PASSWORD=<password> 

  2

  <user> は、Tekton Results が使用する必要がある PostgreSQL ユーザーのユーザー名に置き換えます。<password> は、同じアカウントのパスワードに置き換えます。

• Red Hat OpenShift Pipelines クラスター上の永続ボリューム要求
• Google Cloud Storage
• S3 バケットストレージ

• PVC を使用するには、次の手順を実行します。

  1. 次の定義を含む pvc.yaml という名前のファイルを PVC に作成します。

       apiVersion: v1
       kind: PersistentVolumeClaim
       metadata:
         name: tekton-logs
       spec:
         accessModes:
         - ReadWriteOnce
         resources:
           requests:
             storage: 1Gi

  2. 次のコマンドを入力して定義を適用します。

     $ oc apply -n openshift-pipelines -f pvc.yaml

• Google Cloud Storage を使用するには、次の手順を実行します。

  1. gcloud コマンドを使用して、アプリケーション認証情報ファイルを作成します。ファイルでアプリケーション認証情報を指定する手順は、Google Cloud ドキュメントの gcloud CLI を使用して提供されるユーザー認証情報 を参照してください。

  2. 次のコマンドを入力して、アプリケーション認証情報ファイルからシークレットを作成します。

     $ oc create secret generic gcs-credentials \
       --from-file=$HOME/.config/gcloud/application_default_credentials.json \
       -n openshift-pipelines

     必要に応じて、アプリケーション認証情報ファイルのパスとファイル名を調整します。

• S3 バケットストレージを使用するには、次の手順を実行します。

  1. 次の内容を含む s3_secret.yaml という名前のファイルを作成します。

       apiVersion: v1
       kind: Secret
       metadata:
         name: my_custom_secret
         namespace: tekton-pipelines
       type: Opaque
       stringData:
         S3_BUCKET_NAME: bucket1 

     1

     
         S3_ENDPOINT: https://example.localhost.com 

     2

     
         S3_HOSTNAME_IMMUTABLE: "false"
         S3_REGION: region-1 

     3

     
         S3_ACCESS_KEY_ID: "1234" 

     4

     
         S3_SECRET_ACCESS_KEY: secret_key 

     5

     
         S3_MULTI_PART_SIZE: "5242880"

     1 1

     S3 ストレージバケットの名前

     2 2

     S3 API エンドポイント URL

     3

     S3 リージョン

     4

     S3 アクセスキー ID

     5

     S3 シークレットアクセスキー

  2. 次のコマンドを入力して、ファイルからシークレットを作成します。

     $ oc create secret generic s3-credentials \
       --from-file=s3_secret.yaml -n openshift-pipelines

• LokiStack 転送を設定するには、次の手順を実行します。

  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:
             matchLabels:
               app.kubernetes.io/managed-by: tekton-pipelines
         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 を作成するには、クラスター管理者ユーザーとして OpenShift CLI (oc) を使用して OpenShift Container Platform クラスターにログインし、以下のコマンドを入力します。

     $ oc apply -n openshift-logging ClusterLogForwarder.yaml

前提条件

• Tekton Results がインストールされている。
• opc ユーティリティーがインストールされている。

前提条件

• Tekton Results がインストールされている。
• opc ユーティリティーをインストールし、Tekton Results をクエリーするための環境を準備している。
• jq パッケージをインストールしている。

前提条件

• Tekton Results がインストールされている。
• opc ユーティリティーをインストールし、Tekton Results をクエリーするための環境を準備している。

手順

• 次のコマンドを入力して、CEL クエリーを使用して結果を検索します。

  $ opc results list --addr ${RESULTS_API} --filter="<cel_query>" <namespace-name>

前提条件

• Tekton Results がインストールされている。
• opc ユーティリティーをインストールし、Tekton Results をクエリーするための環境を準備している。

手順

• 次のコマンドを入力して、CEL クエリーを使用してレコードを検索します。

  $ opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <namespace_name>/result/-

  <namespace_name> は、パイプラインの実行またはタスクの実行が作成された namespace に置き換えます。または、次のコマンドを入力して、単一の結果内のレコードを検索します。

  $ opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <result_name>

  <result_name> は、結果の完全名に置き換えます。

• UNKNOWN
• SUCCESS
• FAILURE
• TIMEOUT
• CANCELLED