OpenShift Pipelines 中的可观察性

先决条件

• 已安装 OpenShift CLI (oc)实用程序。
• 以集群管理员用户身份登录 OpenShift Container Platform 集群。

流程

• 使用以下命令编辑 TektonConfig 自定义资源(CR)：

  $ oc edit TektonConfig config

  在 结果 spec 中进行以下更改：

  apiVersion: operator.tekton.dev/v1alpha1
  kind: TektonConfig
  metadata:
    name: config
  spec:
    result:
      options:
        configMaps:
          config-results-retention-policy:
            data:
              runAt: "3 5 * * 0" 

  1

  
              maxRetention: "30" 

  2

  1

  以 cron 格式指定在数据库中运行修剪作业时。这个示例在每天的下午 5:03 AM 运行作业。

  2

  指定在数据库中保留数据的天数。这个示例保留 30 天的数据。

先决条件

• 已安装 opc 工具。
• 使用 OpenShift CLI (oc)登录到 OpenShift Container Platform 集群。

先决条件

• 已安装 opc 工具，并准备好其环境来查询 Tekton Results。
• 安装了 jq 软件包。
• 如果要查询日志信息，请将日志转发配置为 LokiStack。

先决条件

• 已安装 opc 工具，并准备好其环境来查询 Tekton Results。

流程

• 输入以下命令使用 CEL 查询来搜索结果：

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

先决条件

• 已安装 opc 工具，并准备好其环境来查询 Tekton Results。

流程

• 输入以下命令使用 CEL 查询搜索记录：

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

  将 &lt ;namespace_name > 替换为管道运行或任务运行的命名空间。或者，输入以下命令搜索单个结果中的记录：

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

  将 <result_name > 替换为结果的全名。

• UNKNOWN
• SUCCESS
• 失败
• TIMEOUT （超时）
• CANCELLED

先决条件

• 已安装 opc 工具。
• 使用 OpenShift CLI (oc)登录到 OpenShift Container Platform 集群。

验证

• 您可以输入以下命令来查看为 opc 工具设置的配置：

  $ opc results config view

  输出示例

  api-path: ""
  apiVersion: results.tekton.dev/v1alpha2
  host: https://tekton-results.openshiftapps.com
  insecure-skip-tls-verify: "true"
  kind: Client
  token: sha256~xyz

先决条件

• 已安装 opc 工具。
• 您已将 opc 工具配置为通过管道运行和任务运行名称查询 Tekton Results 的结果。

流程

• 使用以下命令查看管道运行：

  • 要查看指定命名空间中运行的所有管道，请输入以下命令：

    $ opc results pipelinerun list -n <namespace_name>

    （可选）指定 the- limit 命令行选项，如-- limit=10。使用这个设置时，op c 命令显示包含管道运行名称的指定行数，然后退出。如果您添加 -single-page=false 命令行选项，命令会显示指定的行数，然后提示您继续或退出。

    （可选）指定-- labels 命令行选项，如-- labels="app.kubernetes.io/name=test-app, app.kubernetes.io/component=database。使用这个设置时，列表只包含具有指定标签或注解的管道运行。

    opc results pipelinerun list 命令的输出示例

    NAME                                           UID                                    STARTED      DURATION   STATUS
    openshift-pipelines-main-release-tests-zscq8   78515e3a-8e20-43e8-a064-d2442c2ae845   1 week ago   5s         Failed(CouldntGetPipeline)
    openshift-pipelines-main-release-tests-zrgv6   14226144-2d08-440d-a600-d602ca46cdf6   1 week ago   26m13s     Failed
    openshift-pipelines-main-release-tests-jdc24   e34daea2-66fb-4c7d-9d4b-d9d82a07b6cd   1 week ago   5s         Failed(CouldntGetPipeline)
    openshift-pipelines-main-release-tests-6zj7f   9b3e5d68-70ab-4c23-8872-e7ad7121e60b   1 week ago   5s         Failed(CouldntGetPipeline)
    openshift-pipelines-main-release-tests-kkk9t   2fd28c48-388b-4e6a-9ec3-2bcd9dedebc3   1 week ago   5s         Failed(CouldntGetPipeline)

  • 要查看与指定管道相关的管道运行，请输入以下命令：

    $ opc results pipelinerun list <pipeline_name> -n <namespace_name>

    命令列出包含 < pipeline_name> 的管道的所有管道运行。例如，如果指定 build，命令显示所有与名为 build、 build _123 或 enhancedbuild 的管道相关的管道运行。

    （可选）指定 the- limit 命令行选项，如-- limit=10。使用这个设置时，op c 命令显示包含管道运行名称的指定行数，然后退出。如果您添加 -single-page=false 命令行选项，命令会显示指定的行数，然后提示您继续或退出。

先决条件

• 已安装 opc 工具。
• 您已将 opc 工具配置为通过管道运行和任务运行名称查询 Tekton Results 的结果。

流程

• 要查看命名空间中运行的所有任务的列表，请输入以下命令：

  $ opc results taskrun list -n <namespace_name>

  （可选）指定 the- limit 命令行选项，如-- limit=10。使用这个设置时，op c 命令显示包含管道运行名称的指定行数，然后退出。如果您添加 -single-page=false 命令行选项，命令会显示指定的行数，然后提示您继续或退出。

  （可选）指定-- labels 参数，如-- labels="app.kubernetes.io/name=test-app, app.kubernetes.io/component=database。使用这个设置时，列表只包含具有指定标签或注解的任务运行。

  命名空间的 opc results pipelinerun list 命令的输出示例

  NAME                                           UID                                    STARTED      DURATION   STATUS
  openshift-pipelines-main-release-tests-zrgv6-e2e-test             10d6952f-b926-4e4b-a976-519867969ce7   16d ago   12m41s     Failed
  openshift-pipelines-main-release-tests-zrgv6-deploy-operator      ab41b63b-16ec-4a32-8b95-f2678eb5c945   16d ago   22s        Succeeded
  openshift-pipelines-main-release-tests-zrgv6-provision-cluster    b374df00-5132-4633-91df-3259670756b3   16d ago   12m30s     Succeeded
  operator-main-index-4-18-on-pull-request-ml4ww-show-sbom          c5b77784-cd87-4be8-bc12-28957762f382   16d ago   16s        Succeeded
  openshift-c4ae3a5a28e19ffc930e7c2aa758d85c-provision-eaas-space   22535d8e-d360-4143-9c0c-4bd0414a22b0   16d ago   17s        Succeeded

• 要查看与管道运行关联的任务运行列表，请输入以下命令：

  $ opc results taskrun list --pipelinerun <pipelinerun_name> -n <namespace_name>

  （可选）指定 the- limit 命令行选项，如-- limit=10。使用这个设置时，op c 命令显示包含管道运行名称的指定行数，然后退出。如果您添加 -single-page=false 命令行选项，命令会显示指定的行数，然后提示您继续或退出。

先决条件

• 已安装 opc 工具。
• 您已将 opc 工具配置为通过管道运行和任务运行名称查询 Tekton Results 的结果。
• 您有管道运行的名称或 UUID。您可以使用 ocp results list pipelineruns 命令来查看可用结果的管道运行的名称和 UUID。

流程

• 使用以下命令查看管道运行的结果信息：

  • 要查看有关管道运行完成的时间和方式的描述，请输入以下命令：

    $ opc results pipelinerun describe -n <namespace_name> <pipelinerun_name>

    另外，您可以使用管道运行 UUID 而不是名称：

    $ opc results pipelinerun describe -n <namespace_name> --uid <pipelinerun_uuid>

    opc results pipelinerun describe 命令的输出示例

    Name: operator-main-index-4-18-on-pull-request-7kssl
    Namespace: tekton-ecosystem-tenant
    Service Account: appstudio-pipeline
    Labels:
     app.kubernetes.io/managed-by=pipelinesascode.tekton.dev
     app.kubernetes.io/version=v0.33.0
    Annotations:
     appstudio.openshift.io/snapshot=openshift-pipelines-main-b7jj6
     build.appstudio.openshift.io/repo=https://github.com/openshift-pipelines/operator?rev=ba5e62e51af0c88bc6c3fd4201e789bdfc093daa
    
    📌 Status
    STARTED          DURATION         STATUS
    27d ago          9m54s            Succeeded
    
    ⏱ Timeouts
    Pipeline:   2h0m0s
    
    ⚓ Params
      NAME                          VALUE
      • git-url                     https://github.com/pramodbindal/operator
      • revision                    ba5e62e51af0c88bc6c3fd4201e789bdfc093daa
    
    🗂  Workspaces
      NAME                SUB PATH            WORKSPACE BINDING
      • workspace          ---                VolumeClaimTemplate
      • git-auth           ---                Secret (secret=pac-gitauth-ceqzjt)
    
    📦 Taskruns
      NAME                                                                         TASK NAME
      • operator-main-index-4-18-on-pull-request-7kssl-init                        init
      • operator-main-index-4-18-on-pull-request-7kssl-clone-repository            clone-repository

• 要查看管道运行的完整 YAML 清单，请输入以下命令：

  $ opc results pipelinerun describe -n <namespace_name> --output yaml <pipelinerun_name>

  另外，您可以使用管道运行 UUID 而不是名称：

  $ opc results pipelinerun describe -n <namespace_name> --output yaml --uid <pipelinerun_uuid>

• 要查看与管道运行关联的日志，请输入以下命令：

  $ opc results pipelinerun logs -n <namespace_name> <pipelinerun_name>

  另外，您可以使用管道运行 UUID 而不是名称：

  $ opc results pipelinerun logs -n <namespace_name> --uid <pipelinerun_uuid>

先决条件

• 已安装 opc 工具。
• 您已将 opc 工具配置为通过管道运行和任务运行名称查询 Tekton Results 的结果。
• 您有任务运行的名称或 UUID。您可以使用 opc results taskrun list 命令查看可用结果的任务运行的名称或 UUID。
• 如果要检索日志，配置了将日志转发到 LokiStack。

流程

• 使用以下命令查看任务运行的结果信息：

  • 要查看有关任务运行完成的时间和方式的描述，请输入以下命令：

    $ opc results taskrun describe -n <namespace_name> <taskrun_name>

    另外，您可以使用任务运行 UUID 而不是名称：

    $ opc results taskrun describe -n <namespace_name> --uid <taskrun_uuid>

    opc 结果 taskrun describe 命令的输出示例

    Name: operator-main-index-4-18-on-push-gc699-build-images-0
    Namespace: tekton-ecosystem-tenant
    Service Account: appstudio-pipeline
    Labels:
     tekton.dev/pipelineTask=build-images
     tekton.dev/task=buildah-remote-oci-ta
    Annotations:
     pipelinesascode.tekton.dev/branch=main
     pipelinesascode.tekton.dev/check-run-id=40080193061
    
    📌 Status
    STARTED          DURATION         STATUS
    28d ago          3m22s            Failed
    
    ⚓ Params
      NAME                          VALUE
      • PLATFORM                    linux-m2xlarge/arm64
      • IMAGE                       quay.io/redhat-user-workloads/tekton-ecosystem

• 要查看任务运行的完整 YAML 清单，请输入以下命令：

  $ opc results taskrun describe -n <namespace_name> --output yaml <taskrun_name>

  另外，您可以使用任务运行 UUID 而不是名称：

  $ opc results taskrun describe -n <namespace_name> --output yaml --uid <taskrun_uuid>

• 要查看与任务运行关联的日志，请输入以下命令：

  $ opc results taskrun logs -n <namespace_name> <taskrun_name>

  另外，您可以使用任务运行 UUID 而不是名称：

  $ opc results taskrun logs -n <namespace_name> --uid <taskrun_uuid>