Red Hat Summit Red Hat Summit지원콘솔개발자평가판 시작연락처

OpenShift Pipelines의 가시성

Red Hat OpenShift Pipelines 1.17

OpenShift Pipelines의 관찰 기능

Red Hat OpenShift Documentation Team

초록

이 문서에서는 OpenShift Pipelines의 가시성 기능에 대한 정보를 제공합니다.

1장. OpenShift Pipelines 관찰 기능에 Tekton 결과 사용

Tekton Results는 모든 파이프라인 실행 및 작업 실행에 대한 전체 정보를 보관하는 서비스입니다. 필요에 따라 PipelineRun 및 TaskRun 리소스를 정리하고 Tekton Results API 또는 opc 명령줄 유틸리티를 사용하여 YAML 매니페스트 및 로깅 정보에 액세스할 수 있습니다.

중요

Tekton 결과는 기술 프리뷰 기능 전용입니다. 기술 프리뷰 기능은 Red Hat 프로덕션 서비스 수준 계약(SLA)에서 지원되지 않으며 기능적으로 완전하지 않을 수 있습니다. 따라서 프로덕션 환경에서 사용하는 것은 권장하지 않습니다. 이러한 기능을 사용하면 향후 제품 기능을 조기에 이용할 수 있어 개발 과정에서 고객이 기능을 테스트하고 피드백을 제공할 수 있습니다.

Red Hat 기술 프리뷰 기능의 지원 범위에 대한 자세한 내용은 기술 프리뷰 기능 지원 범위를 참조하십시오.

1.1. Tekton Results 개념

Tekton Results 아카이브는 파이프라인 실행 및 작업 실행 결과 및 레코드 형태로 실행됩니다.

실행을 완료하는 모든 PipelineRun 및 TaskRun CR(사용자 정의 리소스)에 대해 Tekton Results는 레코드를 생성합니다.

결과는 하나 또는 여러 레코드를 포함할 수 있습니다. 레코드는 항상 정확히 하나의 결과의 일부입니다.

결과적으로 파이프라인 실행에 해당하며 PipelineRun CR 자체 및 파이프라인 실행의 일부로 시작된 모든 TaskRun CR에 대한 레코드가 포함됩니다.

파이프라인 실행을 사용하지 않고 작업 실행이 직접 시작된 경우 이 작업 실행에 대한 결과가 생성됩니다. 이 결과에는 동일한 작업 실행에 대한 레코드가 포함됩니다.

각 결과에는 PipelineRun 또는 TaskRun CR이 생성된 네임스페이스와 CR의 UUID가 포함된 이름이 있습니다. 결과 이름의 형식은 < namespace_name>/results/<parent_run_uuid>입니다. 이 형식에서 < parent_run_uuid >는 파이프라인 실행 또는 직접 시작된 작업 실행의 UUUD 형식입니다.

결과 이름 예

results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed
Copy to clipboard

각 레코드에는 레코드가 포함된 결과의 이름과 레코드가 해당하는 PipelineRun 또는 TaskRun CR의 UUID가 포함됩니다. 결과 이름의 형식은 < namespace_name>/results/<parent_run_uuid>/results/<run_uuid > 입니다.

레코드 이름 예

results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/e9c736db-5665-441f-922f-7c1d65c9d621
Copy to clipboard

이 레코드에는 실행이 완료된 후 존재했던 TaskRun 또는 PipelineRun CR의 전체 YAML 매니페스트가 포함됩니다. 이 매니페스트에는 실행 사양, 실행에 지정된 주석, 실행 결과에 대한 특정 정보(예: 완료 시간 및 실행이 성공했는지 여부)가 포함되어 있습니다.

TaskRun 또는 PipelineRun CR이 있는 동안 다음 명령을 사용하여 YAML 매니페스트를 볼 수 있습니다. 

$ oc get pipelinerun <cr_name> -o yaml
Copy to clipboard

Tekton Results는 TaskRun 또는 PipelineRun CR이 삭제된 후 이 매니페스트를 유지하고 있으며 이를 보고 검색할 수 있도록 합니다.

완료 후 실행되는 파이프라인의 YAML 매니페스트 예

  kind: PipelineRun
  spec:
    params:
      - name: message
        value: five
    timeouts:
      pipeline: 1h0m0s
    pipelineRef:
      name: echo-pipeline
    taskRunTemplate:
      serviceAccountName: pipeline
  status:
    startTime: "2023-08-07T11:41:40Z"
    conditions:
      - type: Succeeded
        reason: Succeeded
        status: "True"
        message: 'Tasks Completed: 1 (Failed: 0, Cancelled 0), Skipped: 0'
        lastTransitionTime: "2023-08-07T11:41:49Z"
    pipelineSpec:
      tasks:
        - name: echo-task
          params:
            - name: message
              value: five
          taskRef:
            kind: Task
            name: echo-task-pipeline
      params:
        - name: message
          type: string
    completionTime: "2023-08-07T11:41:49Z"
    childReferences:
      - kind: TaskRun
        name: echo-pipeline-run-gmzrx-echo-task
        apiVersion: tekton.dev/v1
        pipelineTaskName: echo-task
  metadata:
    uid: 62c3b02e-f12b-416c-9771-c02af518f6d4
    name: echo-pipeline-run-gmzrx
    labels:
      tekton.dev/pipeline: echo-pipeline
    namespace: releasetest-js5tt
    finalizers:
      - chains.tekton.dev/pipelinerun
    generation: 2
    annotations:
      results.tekton.dev/log: releasetest-js5tt/results/62c3b02e-f12b-416c-9771-c02af518f6d4/logs/c1e49dd8-d641-383e-b708-e3a02b6a4378
      chains.tekton.dev/signed: "true"
      results.tekton.dev/record: releasetest-js5tt/results/62c3b02e-f12b-416c-9771-c02af518f6d4/records/62c3b02e-f12b-416c-9771-c02af518f6d4
      results.tekton.dev/result: releasetest-js5tt/results/62c3b02e-f12b-416c-9771-c02af518f6d4
    generateName: echo-pipeline-run-
    managedFields:
      - time: "2023-08-07T11:41:39Z"
        manager: kubectl-create
        fieldsV1:
          f:spec:
            .: {}
            f:params: {}
            f:pipelineRef:
              .: {}
              f:name: {}
          f:metadata:
            f:generateName: {}
        operation: Update
        apiVersion: tekton.dev/v1
        fieldsType: FieldsV1
      - time: "2023-08-07T11:41:40Z"
        manager: openshift-pipelines-controller
        fieldsV1:
          f:metadata:
            f:labels:
              .: {}
              f:tekton.dev/pipeline: {}
        operation: Update
        apiVersion: tekton.dev/v1
        fieldsType: FieldsV1
      - time: "2023-08-07T11:41:49Z"
        manager: openshift-pipelines-chains-controller
        fieldsV1:
          f:metadata:
            f:finalizers:
              .: {}
              v:"chains.tekton.dev/pipelinerun": {}
            f:annotations:
              .: {}
              f:chains.tekton.dev/signed: {}
        operation: Update
        apiVersion: tekton.dev/v1
        fieldsType: FieldsV1
      - time: "2023-08-07T11:41:49Z"
        manager: openshift-pipelines-controller
        fieldsV1:
          f:status:
            f:startTime: {}
            f:conditions: {}
            f:pipelineSpec:
              .: {}
              f:tasks: {}
              f:params: {}
            f:completionTime: {}
            f:childReferences: {}
        operation: Update
        apiVersion: tekton.dev/v1
        fieldsType: FieldsV1
        subresource: status
      - time: "2023-08-07T11:42:15Z"
        manager: openshift-pipelines-results-watcher
        fieldsV1:
          f:metadata:
            f:annotations:
              f:results.tekton.dev/log: {}
              f:results.tekton.dev/record: {}
              f:results.tekton.dev/result: {}
        operation: Update
        apiVersion: tekton.dev/v1
        fieldsType: FieldsV1
    resourceVersion: "126429"
    creationTimestamp: "2023-08-07T11:41:39Z"
    deletionTimestamp: "2023-08-07T11:42:23Z"
    deletionGracePeriodSeconds: 0
  apiVersion: tekton.dev/v1
Copy to clipboard

Tekton Results는 파이프라인 실행 또는 작업 실행의 일부로 실행된 모든 툴의 로깅 정보가 포함된 로그 레코드도 생성합니다.

모든 결과 및 레코드에 해당 이름으로 액세스할 수 있습니다. CEL(Common Expression Language) 쿼리를 사용하여 YAML 매니페스트를 포함하여 포함된 정보로 결과 및 레코드를 검색할 수도 있습니다.

1.2. Tekton 결과 설치 준비

Tekton 결과를 설치하기 전에 여러 준비 단계를 완료해야 합니다.

1.2.1. SSL 인증서를 사용하여 보안 준비

Tekton Results는 SSL 인증서가 필요한 HTTPS 프로토콜을 사용하여 REST API를 제공합니다. 이 인증서와 함께 보안을 제공합니다. CA(인증 기관)에서 제공하는 기존 인증서가 있는 경우 이 인증서를 사용하여 자체 서명된 인증서를 생성합니다.

사전 요구 사항

  • openssl 명령줄 유틸리티가 설치되어 있습니다.

프로세스

  1. CA에서 제공한 인증서가 없는 경우 다음 명령을 입력하여 자체 서명 인증서를 생성합니다. 

    $ openssl req -x509 \
-newkey rsa:4096 \
-keyout key.pem \
-out cert.pem \
-days 365 \
-nodes \
-subj "/CN=tekton-results-api-service.openshift-pipelines.svc.cluster.local" \
-addext "subjectAltName = DNS:tekton-results-api-service.openshift-pipelines.svc.cluster.local"
    Copy to clipboard

    tekton-results-api-service.openshift-pipelines.svc.cluster.local 을 Tekton Results API에 사용할 경로 끝점으로 교체합니다.

  2. 다음 명령을 입력하여 인증서에서 TLS(전송 보안 계층) 보안을 생성합니다. 

    $ oc create secret tls -n openshift-pipelines tekton-results-tls --cert=cert.pem --key=key.pem
    Copy to clipboard

    CA에서 제공하는 기존 인증서를 사용하려면 cert.pem 을 이 인증서가 포함된 파일 이름으로 교체합니다.

1.2.2. 데이터베이스 인증 정보를 사용하여 시크릿 준비

Tekton 결과는 PostgreSQL 데이터베이스를 사용하여 데이터를 저장합니다. Tekton Results와 함께 자동으로 설치된 PostgreSQL 서버 또는 배포에 이미 존재하는 외부 PostgreSQL 서버를 사용하도록 설치를 구성할 수 있습니다. 두 경우 모두 데이터베이스 인증 정보가 있는 시크릿을 제공합니다.

프로세스

다음 단계 중 하나를 완료합니다.

  • 외부 PostgreSQL 서버를 사용할 필요가 없는 경우 다음 명령을 입력하여 result 라는 데이터베이스 사용자로 시크릿을 생성하고 openshift-pipelines 네임스페이스에 임의의 암호를 생성합니다. 

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

    이 명령과 후속 쉼표에서 OpenShift Pipelines의 사용자 정의 대상 네임스페이스를 구성한 경우 openshift-pipelines 대신 이 네임스페이스의 이름을 사용합니다.

  • 외부 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
    Copy to clipboard

    & lt;user >를 Tekton 결과에서 사용해야 하는 PostgreSQL 사용자의 사용자 이름으로 바꿉니다. & lt;password& gt;를 동일한 계정의 암호로 바꿉니다.

1.2.3. 로깅 정보를 위한 스토리지 또는 LokiStack 전달 준비

Tekton Results는 파이프라인 실행 및 작업 실행과 관련된 정보를 로깅하기 위해 별도의 스토리지를 사용합니다. 다음 스토리지 유형 중 하나를 구성할 수 있습니다.

  • Red Hat OpenShift Pipelines 클러스터의 PVC(영구 볼륨 클레임)
  • Google Cloud Storage
  • S3 버킷 스토리지

또는 OpenShift Container Platform 클러스터에 LokiStack 및 OpenShift Logging을 설치하고 LokiStack으로 로깅 정보 전달을 구성할 수 있습니다. 이 옵션은 더 높은 로드를 위해 더 나은 확장성을 제공합니다.

참고

OpenShift Pipelines 1.16에서는 PVC, Google Cloud Storage 및 S3 버킷 스토리지에서 로깅 정보를 기본적으로 저장할 수 있는 Tekton 결과는 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다.

로깅 정보는 구성하는 로깅 정보 스토리지 유형 또는 LokiStack 전달 유형에 관계없이 Tekton Results 명령줄 인터페이스 및 API를 사용하여 확인할 수 있습니다.

프로세스

다음 절차 중 하나를 완료합니다.

  • PVC를 사용하려면 다음 단계를 완료합니다.

    1. PVC에 대해 다음 정의를 사용하여 pvc.yaml 이라는 파일을 생성합니다. 

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

    2. 다음 명령을 입력하여 정의를 적용합니다. 

      $ oc apply -n openshift-pipelines -f pvc.yaml
      Copy to clipboard

  • 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
      Copy to clipboard

      필요에 따라 애플리케이션 자격 증명 파일의 경로와 파일 이름을 조정합니다.

  • 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"
      Copy to clipboard
      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
      Copy to clipboard

  • 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
      Copy to clipboard

      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 ]
      Copy to clipboard

    3. openshift-logging 네임스페이스에서 ClusterLogForwarder CR을 생성하려면 클러스터 관리자로 OpenShift CLI(oc)를 사용하여 OpenShift Container Platform 클러스터에 로그인한 다음 다음 명령을 입력합니다. 

      $ oc apply -n openshift-logging ClusterLogForwarder.yaml
      Copy to clipboard

1.3. Tekton 결과 설치

Tekton Results를 설치하려면 필요한 리소스를 제공한 다음 TektonResult CR(사용자 정의 리소스)을 생성하고 적용해야 합니다. OpenShift Pipelines Operator는 TektonResult 사용자 정의 리소스를 적용할 때 Results 서비스를 설치합니다.

사전 요구 사항

  • Operator를 사용하여 OpenShift Pipelines를 설치했습니다.
  • SSL 인증서를 사용하여 보안을 준비합니다.
  • 로깅 정보를 위한 스토리지를 준비합니다.
  • 데이터베이스 인증 정보를 사용하여 시크릿을 준비합니다.

프로세스

  1. 다음 예제를 기반으로 result.yaml 이라는 리소스 정의 파일을 생성합니다. 필요에 따라 설정을 조정할 수 있습니다. 

      apiVersion: operator.tekton.dev/v1alpha1
  kind: TektonResult
  metadata:
    name: result
  spec:
    targetNamespace: openshift-pipelines
    logs_api: true
    log_level: debug
    db_port: 5432
    db_host: tekton-results-postgres-service.openshift-pipelines.svc.cluster.local
    logs_path: /logs
    logs_type: File
    logs_buffer_size: 32768
    auth_disable: true
    tls_hostname_override: tekton-results-api-service.openshift-pipelines.svc.cluster.local
    db_enable_auto_migration: true
    server_port: 8080
    prometheus_port: 9090
    Copy to clipboard

  2. 이 파일에 로깅 정보를 위해 스토리지 또는 전달 구성을 추가합니다.

    • PVC(영구 볼륨 클레임)를 구성한 경우 다음 행을 추가하여 PVC 이름을 제공합니다. 

          logging_pvc_name: tekton-logs
      Copy to clipboard

    • Google Cloud Storage를 구성한 경우 다음 행을 추가하여 시크릿 이름, 인증 정보 파일 이름, Google Cloud Storage 버킷의 이름을 제공합니다. 

          gcs_creds_secret_name: gcs-credentials
    gcs_creds_secret_key: application_default_credentials.json 1
    gcs_bucket_name: bucket-name 2
      Copy to clipboard
      1
      시크릿을 생성할 때 사용한 애플리케이션 인증 정보 파일의 경로 없이 이름을 제공합니다.
      2
      Google Cloud Storage에 버킷 이름을 입력합니다. Tekton 체인은 이 버킷을 사용하여 파이프라인 실행 및 작업 실행에 대한 로깅 정보를 저장합니다.

    • S3 버킷 스토리지를 구성한 경우 다음 행을 추가하여 S3 시크릿 이름을 제공합니다. 

          secret_name: s3-credentials
      Copy to clipboard

    • LokiStack 전달을 구성한 경우 다음 행을 추가하여 LokiStack으로 로깅 정보를 전달할 수 있습니다. 

          loki_stack_name: logging-loki 1
    loki_stack_namespace: openshift-logging 2
      Copy to clipboard
      1
      LokiStack CR의 이름, 일반적으로 logging-loki.
      2
      LokiStack이 배포된 네임스페이스의 이름(일반적으로 openshift-logging ).

  3. 선택 사항: 외부 PostgreSQL 데이터베이스 서버를 사용하여 Tekton Results 정보를 저장하려면 다음 행을 파일에 추가합니다. 

        db_host: postgres.internal.example.com 1
    db_port: 5432 2
    is_external_db: true
    Copy to clipboard
    1
    PostgreSQL 서버의 호스트 이름입니다.
    2
    PostgreSQL 서버의 포트입니다.

  4. 다음 명령을 입력하여 리소스 정의를 적용합니다. 

    $ oc apply -n openshift-pipelines -f result.yaml
    Copy to clipboard

  5. 다음 명령을 입력하여 Tekton Results 서비스 API의 경로를 노출합니다. 

    $ oc create route -n openshift-pipelines \
  passthrough tekton-results-api-service \
  --service=tekton-results-api-service --port=8080
    Copy to clipboard

1.4. Tekton 결과에 대한 보존 정책 구성

기본적으로 Tekton Results는 파이프라인 실행, 작업 실행, 이벤트 및 로그를 무기한 저장합니다. 이로 인해 스토리지 리소스를 불필요하게 사용하지 않고 데이터베이스 성능에 영향을 미칠 수 있습니다.

클러스터 수준에서 Tekton 결과에 대한 보존 정책을 구성하여 이전 결과 및 관련 레코드 및 로그를 제거할 수 있습니다. TektonResult CR(사용자 정의 리소스)을 편집하여 이 작업을 수행할 수 있습니다.

사전 요구 사항

  • Tekton 결과가 설치되어 있어야 합니다.

프로세스

  • TektonResult CR에서 다음 예와 같이 Tekton Results에 대한 보존 정책을 구성합니다.

    Tekton 결과 보존 정책의 예

    apiVersion: operator.tekton.dev/v1alpha1
kind: TektonResult
metadata:
  name: result
spec:
  options:
    configMaps:
      config-results-retention-policy:
        data:
          runAt: "3 5 * * 0" 1
          maxRetention: "30" 2
    Copy to clipboard

    1
    데이터베이스에서 정리 작업을 실행할 때 cron 형식으로 지정합니다. 이 예제에서는 매주 일요일 오전 5:03에 작업을 실행합니다.
    2
    데이터베이스에 데이터를 보관할 일 수를 지정합니다. 이 예에서는 30일 동안 데이터를 유지합니다.

1.5. opc 명령줄 유틸리티를 사용하여 Tekton 결과 쿼리

opc 명령줄 유틸리티를 사용하여 결과 및 레코드에 대한 Tekton 결과를 쿼리할 수 있습니다. opc 명령줄 유틸리티를 설치하려면 tkn 명령줄 유틸리티에 대한 패키지를 설치합니다. 이 패키지 설치에 대한 자세한 내용은 tkn 설치를 참조하십시오.

레코드 이름과 결과를 사용하여 해당 레코드에서 데이터를 검색할 수 있습니다.

CEL(Common Expression Language) 쿼리를 사용하여 결과 및 레코드를 검색할 수 있습니다. 이러한 검색에는 결과 또는 레코드의 UUID가 표시됩니다. 제공된 예제를 사용하여 공통 검색 유형에 대한 쿼리를 생성할 수 있습니다. 참조 정보를 사용하여 다른 쿼리를 생성할 수도 있습니다.

1.5.1. Tekton 결과 쿼리를 위한 opc 유틸리티 환경 준비

Tekton Results를 쿼리하려면 먼저 opc 유틸리티에 대한 환경을 준비해야 합니다.

사전 요구 사항

  • Tekton 결과가 설치되어 있어야 합니다.
  • opc 유틸리티를 설치했습니다.

프로세스

  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
    Copy to clipboard

  2. 다음 명령을 입력하여 Tekton Results API에 대한 인증 토큰을 생성합니다. 

    $ oc create token <service_account>
    Copy to clipboard

    이 명령이 출력하는 문자열을 저장합니다.

  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
    Copy to clipboard
    1
    Tekton Results API의 경로입니다. RESULTS_API 에 설정한 것과 동일한 값을 사용합니다.
    2
    oc create token 명령으로 생성된 인증 토큰입니다. 이 토큰을 제공하는 경우 service_account 설정을 재정의하고 opc 는 이 토큰을 사용하여 인증합니다.
    3
    API 엔드포인트에 대해 구성한 SSL 인증서가 있는 파일의 위치입니다.
    4
    OpenShift Pipelines에 대한 사용자 정의 대상 네임스페이스를 구성한 경우 openshift-pipelines 를 이 네임스페이스의 이름으로 교체합니다.
    5 6
    Tekton Results API를 사용하여 인증하는 서비스 계정의 이름입니다. 인증 토큰을 제공한 경우 service_account 매개변수를 제공할 필요가 없습니다.

    또는 ~/.config/tkn/results.yaml 파일을 생성하지 않으면 --authtoken 옵션을 사용하여 각 opc 명령에 토큰을 전달할 수 있습니다.

1.5.2. 이름으로 결과 및 레코드 쿼리

해당 이름을 사용하여 결과 및 레코드를 나열하고 쿼리할 수 있습니다.

사전 요구 사항

  • Tekton 결과가 설치되어 있어야 합니다.
  • opc 유틸리티를 설치하고 Tekton 결과를 쿼리할 수 있는 환경을 준비합니다.
  • jq CLI를 설치하셨습니다.

프로세스

  1. 네임스페이스에서 생성된 파이프라인 실행 및 작업 실행에 해당하는 모든 결과의 이름을 나열합니다. 다음 명령을 실행합니다. 

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

    명령 예

    $ opc results list --addr ${RESULTS_API} results-testing
    Copy to clipboard

    출력 예

    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
    Copy to clipboard

  2. 다음 명령을 입력하여 결과에서 모든 레코드 이름을 나열합니다. 

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

    명령 예

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

    출력 예

    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
    Copy to clipboard

  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))'
    Copy to clipboard

    명령 예

    $ 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))'
    Copy to clipboard

  4. 선택 사항: 로그 레코드 이름을 사용하여 레코드에서 실행되는 작업의 로깅 정보를 검색합니다. 로그 레코드 이름을 가져오려면 레코드를 레코드 이름에 로그 로 바꿉니다. 다음 명령을 실행합니다. 

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

    명령 예

    $ 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
    Copy to clipboard

1.5.3. 결과 검색

CEL(Common Expression Language) 쿼리를 사용하여 결과를 검색할 수 있습니다. 예를 들어 성공하지 못한 파이프라인 실행에 대한 결과를 찾을 수 있습니다. 그러나 관련 정보의 대부분은 결과 개체에 포함되지 않습니다; 이름, 완료 시간 및 기타 데이터로 검색하고 레코드를 검색합니다.

사전 요구 사항

  • Tekton 결과가 설치되어 있어야 합니다.
  • opc 유틸리티를 설치하고 Tekton 결과를 쿼리할 수 있는 환경을 준비합니다.

프로세스

  • 다음 명령을 입력하여 CEL 쿼리를 사용하여 결과를 검색합니다. 

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

& lt;namespace_name >을 파이프라인 실행 또는 작업 실행이 생성된 네임스페이스로 바꿉니다.

표 1.1. 결과에 대한 CEL 쿼리 예
목적CEL 쿼리

실패한 모든 실행의 결과

!(summary.status == SUCCESS)

모든 파이프라인이 주석 ann1 및 ann2가 포함된 결과

summary.annotations.contains('ann1') && summary.annotations.contains('ann2') && summary.type=='PIPELINE_RUN'

1.5.4. 레코드 검색

CEL(Common Expression Language) 쿼리를 사용하여 레코드를 검색할 수 있습니다. 각 레코드에는 파이프라인 실행 또는 작업 실행에 대한 전체 YAML 정보가 포함되어 있으므로 다양한 기준으로 레코드를 찾을 수 있습니다.

사전 요구 사항

  • Tekton 결과가 설치되어 있어야 합니다.
  • opc 유틸리티를 설치하고 Tekton 결과를 쿼리할 수 있는 환경을 준비합니다.

프로세스

  • 다음 명령을 입력하여 CEL 쿼리를 사용하여 레코드를 검색합니다. 

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

    & lt;namespace_name >을 파이프라인 실행 또는 작업 실행이 생성된 네임스페이스로 바꿉니다. 또는 다음 명령을 입력하여 단일 결과 내에서 레코드를 검색합니다. 

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

    & lt;result_name >을 결과의 전체 이름으로 바꿉니다.

표 1.2. 레코드에 대한 CEL 쿼리의 예
목적CEL 쿼리

실패한 모든 작업 실행 또는 파이프라인 실행 기록

!(data.status.conditions[0].status == 'True')

TaskRun 또는 PipelineRun CR(사용자 정의 리소스)의 이름이 run1인 레코드

data.metadata.name == 'run1'

run1이라는 PipelineRun CR에 의해 시작된 모든 작업 실행에 대한 레코드

data_type == 'TASK_RUN' && data.metadata.labels['tekton.dev/pipelineRun'] == 'run1'

pipeline1이라는 Pipeline CR에서 생성된 모든 파이프라인 실행 및 작업 실행 기록

data.metadata.labels['tekton.dev/pipeline'] == 'pipeline1'

pipeline1이라는 Pipeline CR에서 생성된 모든 파이프라인 실행 레코드

data.metadata.labels['tekton.dev/pipeline'] == 'pipeline1' && data_type == 'PIPELINE_RUN'

TaskRun CR 이름이 hello로 표시된 모든 작업 실행 레코드

data.metadata.name.startsWith('hello') && data_type=='TASK_RUN'

완료하는 데 5분 이상 걸리는 모든 파이프라인 실행 레코드

data.status.completionTime - data.status.startTime > duration('5m') && data_type == 'PIPELINE_RUN'

2023년 10월 7일에 완료된 모든 파이프라인 실행 및 작업 실행 기록

data.status.completionTime.getDate() == 7 && data.status.completionTime.getMonth() == 10 && data.status.completionTime.getFullYear() == 2023

세 개 이상의 작업을 포함하는 모든 파이프라인 실행 레코드

size(data.status.pipelineSpec.tasks) >= 3 && data_type == 'PIPELINE_RUN'

ann1이 포함된 주석이 있는 모든 파이프라인 실행 레코드

data.metadata.annotations.contains('ann1') && data_type == 'PIPELINE_RUN'

ann1 이 포함된 주석과 PipelineRun CR의 이름이 hello로 시작된 모든 파이프라인 실행 레코드

data.metadata.annotations.contains('ann1') && data.metadata.name.startsWith('hello') && data_type == 'PIPELINE_RUN'

1.5.5. 결과 검색에 대한 참조 정보

결과를 위해 CEL(Common Expression Language) 쿼리에서 다음 필드를 사용할 수 있습니다.

표 1.3. 결과에 대해 CEL 쿼리에서 사용할 수 있는 필드
EL 필드설명

상위

PipelineRun 또는 TaskRun CR(사용자 정의 리소스)이 생성된 네임스페이스입니다.

uid

결과에 대한 고유 식별자입니다.

annotations

PipelineRun 또는 TaskRun CR에 추가된 주석입니다.

summary

결과에 대한 요약입니다.

create_time

결과 생성 시간입니다.

update_time

결과 마지막 업데이트 시간입니다.

summary.status 필드를 사용하여 파이프라인 실행이 성공했는지 확인할 수 있습니다. 이 필드에는 다음과 같은 값이 있을 수 있습니다.

  • 알 수 없음
  • SUCCESS
  • 실패
  • TIMEOUT
  • CANCELLED
참고

이 필드의 값을 제공하기 위해 " 또는 ' 와 같은 인용 문자를 사용하지 마십시오.

1.5.6. 레코드 검색에 대한 참조 정보

CEL(Common Expression Language) 쿼리에서 다음 필드를 사용할 수 있습니다.

표 1.4. CEL 쿼리에서 레코드에 사용할 수 있는 필드
EL 필드설명값

name

레코드 이름

 

data_type

레코드 유형 식별자

Tekton .dev/v1.TaskRun 또는 TASK_RUNtekton.dev/v1.PipelineRun 또는 PIPELINE_RUNresults.tekton.dev/v1alpha2.Log

data

작업 실행 또는 파이프라인 실행에 대한 YAML 데이터입니다. 로그 레코드에서 이 필드에는 로깅 출력이 포함됩니다.

 

data 필드에 작업 실행 또는 파이프라인 실행에 대한 전체 YAML 데이터가 포함되어 있으므로 CEL 쿼리에서 이 데이터의 모든 요소를 사용할 수 있습니다. 예를 들어 data.status.completionTime 에는 작업 실행 또는 파이프라인 실행의 완료 시간이 포함됩니다.

1.6. 추가 리소스

2장. OpenShift Logging Operator를 사용하여 파이프라인 로그 보기

파이프라인 실행, 작업 실행 및 이벤트 리스너로 생성된 로그는 해당 Pod에 저장됩니다. 문제 해결 및 감사의 로그를 검토하고 분석하는 것이 유용합니다.

그러나 Pod를 무기한 유지하면 불필요한 리소스 소비와 누락된 네임스페이스가 발생합니다.

파이프라인 로그를 보기 위해 Pod에 대한 종속성을 제거하기 위해 OpenShift Elasticsearch Operator 및 OpenShift Logging Operator를 사용할 수 있습니다. 이러한 Operator를 사용하면 로그가 포함된 Pod를 삭제한 후에도 Elasticsearch Kibana 스택을 사용하여 파이프라인 로그를 볼 수 있습니다.

2.1. 사전 요구 사항

Kibana 대시보드에서 파이프라인 로그를 보기 전에 다음을 확인하십시오.

  • 단계는 클러스터 관리자가 수행합니다.
  • 파이프라인 실행 및 작업 실행에 대한 로그를 사용할 수 있습니다.
  • OpenShift Elasticsearch Operator 및 OpenShift Logging Operator가 설치되어 있습니다.

2.2. Kibana에서 파이프라인 로그 보기

Kibana 웹 콘솔에서 파이프라인 로그를 보려면 다음을 수행합니다.

프로세스

  1. OpenShift Container Platform 웹 콘솔에 클러스터 관리자로 로그인합니다.
  2. 메뉴 모음 오른쪽 상단에서 그리드 아이콘 → Observability → 로깅 을 클릭합니다. Kibana 웹 콘솔이 표시됩니다.

  3. 인덱스 패턴을 생성합니다.

    1. Kibana 웹 콘솔의 왼쪽 탐색 패널에서 Management 를 클릭합니다.
    2. 인덱스 패턴 생성 을 클릭합니다.
    3. 2 단계 중 2 단계 아래에서 인덱스 패턴 → 인덱스 패턴을 정의하고 * 패턴을 입력하고 다음 단계를 클릭합니다.
    4. 2단계: 설정 구성 → 시간 필터 필드 이름에서 드롭다운 메뉴에서 @timestamp 를 선택한 다음 인덱스 패턴 생성 을 클릭합니다.

  4. 필터를 추가합니다.

    1. Kibana 웹 콘솔의 왼쪽 탐색 패널에서 검색을 클릭합니다.

    2. 필터 추가 + → 쿼리 DSL 편집을 클릭합니다.

      참고
      • 다음 예제 필터 각각에 대해 쿼리를 편집하고 저장을 클릭합니다.
      • 필터가 차례로 적용됩니다.

      1. 파이프라인과 관련된 컨테이너를 필터링합니다.

        파이프라인 컨테이너를 필터링하는 쿼리의 예

        {
  "query": {
	"match": {
  	"kubernetes.flat_labels": {
    	"query": "app_kubernetes_io/managed-by=tekton-pipelines",
    	"type": "phrase"
  	}
	}
  }
}
        Copy to clipboard

      2. place-tools 컨테이너가 아닌 모든 컨테이너를 필터링합니다. 쿼리 DSL을 편집하는 대신 그래픽 드롭다운 메뉴를 사용하는 방법을 보여 줍니다.As an illustration of using the graphical drop-down menus instead of editing the query DSL, consider the following approach:

        그림 2.1. 드롭다운 필드를 사용하여 필터링의 예

        place-tools

      3. 강조 표시를 위해 라벨에서 pipelinerun 을 필터링합니다.

        강조 표시를 위해 라벨에서 pipelinerun 을 필터링하는 쿼리의 예

        {
  "query": {
	"match": {
  	"kubernetes.flat_labels": {
    	"query": "tekton_dev/pipelineRun=",
    	"type": "phrase"
  	}
	}
  }
}
        Copy to clipboard

      4. 강조 표시를 위해 라벨에서 파이프라인 을 필터링합니다.

        강조 표시를 위해 라벨에서 파이프라인 을 필터링하는 쿼리의 예

        {
  "query": {
	"match": {
  	"kubernetes.flat_labels": {
    	"query": "tekton_dev/pipeline=",
    	"type": "phrase"
  	}
	}
  }
}
        Copy to clipboard

    3. 사용 가능한 필드 목록에서 다음 필드를 선택합니다.

      • kubernetes.flat_labels

      • message

        선택한 필드 목록에 선택한 필드가 표시되는지 확인합니다.

    4. 로그는 message 필드에 표시됩니다.

      그림 2.2. 필터링된 메시지

      필터링된 메시지

법적 공지

Copyright © 2025 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
맨 위로 이동
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

Theme

© 2025 Red Hat, Inc.