OpenShift Pipelines 中的可观察性
OpenShift Pipelines 的可观察性功能
摘要
第 1 章 为 OpenShift Pipelines 可观察性使用 Tekton 结果 复制链接链接已复制到粘贴板!
Tekton Results 是一个记录每个管道运行和任务运行的完整信息的服务。您可以根据需要修剪 PipelineRun 和 TaskRun 资源,并使用 Tekton Results API 或 opc 命令行工具访问其 YAML 清单以及日志信息。
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 > 是管道运行的 UUD,或其他任务运行已直接启动的。
结果名称示例
results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed
results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed
每个记录都有一个名称,其中包含记录的结果名称,以及 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
results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed/records/e9c736db-5665-441f-922f-7c1d65c9d621
记录包括 TaskRun 或 PipelineRun CR 的完整 YAML 清单,因为它会在完成运行后存在。此清单包含运行规格、为运行指定的任何注解,以及有关运行结果的特定信息,如完成时间和运行是否成功。
当 TaskRun 或 PipelineRun CR 存在时,您可以使用以下命令查看 YAML 清单:
oc get pipelinerun <cr_name> -o yaml
$ oc get pipelinerun <cr_name> -o yaml
Tekton Results 在 TaskRun 或 PipelineRun CR 被删除后保留此清单,并使其可用于查看和搜索。
管道的 YAML 清单在完成后运行
您可以通过其名称访问每个结果并记录。您还可以使用通用表达式语言(CEL)查询来根据其包含的信息(包括 YAML 清单)搜索结果和记录。
您还可以将 Tekton Results 配置为促进将作为管道或任务一部分运行的所有工具的日志信息转发到 LokiStack。然后,您可以查询与 Tekton Results 记录关联的任务运行的 Tekton Results 信息。
1.2. 配置 Tekton 结果 复制链接链接已复制到粘贴板!
安装 OpenShift Pipelines 后,Tekton Results 会被默认启用。
但是,如果要存储和访问管道运行的日志信息和任务运行,您必须配置此信息转发到 LokiStack。
您可以选择为 Tekton Results 完成额外的配置。
1.2.1. 为日志信息配置 LokiStack 转发 复制链接链接已复制到粘贴板!
如果要使用 Tekton Results 查询任务运行的日志信息,您必须在 OpenShift Container Platform 集群上安装 LokiStack 和 OpenShift Logging,并将日志信息转发到 LokiStack。
如果没有为日志信息配置 LokiStack 转发,Tekton Results 不会存储此信息,或者从命令行界面或 API 提供它。
先决条件
-
已安装 OpenShift CLI (
oc)实用程序。 - 以集群管理员用户身份登录 OpenShift Container Platform 集群。
流程
要配置 LokiStack 转发,请完成以下步骤:
- 在 OpenShift Container Platform 集群中,使用 Loki Operator 安装 LokiStack,同时安装 OpenShift Logging Operator。
根据您安装的 OpenShift Logging 版本 6 或版本 5,为
ClusterLogForwarder自定义资源(CR)创建一个ClusterLogForwarder.yaml清单文件,包含以下 YAML 清单之一:如果安装了 OpenShift Logging 版本 6,
ClusterLogForwarderCR 的 YAML 清单Copy to Clipboard Copied! Toggle word wrap Toggle overflow 如果安装了 OpenShift Logging 版本 5,
ClusterLogForwarderCR 的 YAML 清单Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输入以下命令在
openshift-logging命名空间中创建ClusterLogForwarderCR:oc apply -n openshift-logging ClusterLogForwarder.yaml
$ oc apply -n openshift-logging ClusterLogForwarder.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 使用以下命令编辑
TektonConfig自定义资源(CR):oc edit TektonConfig config
$ oc edit TektonConfig configCopy to Clipboard Copied! Toggle word wrap Toggle overflow 在
结果spec 中进行以下更改:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.2.2. 配置外部数据库服务器 复制链接链接已复制到粘贴板!
Tekton Results 使用 PostgreSQL 数据库来存储数据。默认情况下,安装包含一个内部 PostgreSQL 实例。您可以将安装配置为使用部署中已存在的外部 PostgreSQL 服务器。
流程
输入以下命令,使用凭证创建 secret 以连接到 PostgreSQL 服务器:
oc create secret generic tekton-results-postgres \ --namespace=openshift-pipelines \ --from-literal=POSTGRES_USER=<user> \ --from-literal=POSTGRES_PASSWORD=<password>
$ oc create secret generic tekton-results-postgres \ --namespace=openshift-pipelines \ --from-literal=POSTGRES_USER=<user> \ --from-literal=POSTGRES_PASSWORD=<password>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使用以下命令编辑
TektonConfig自定义资源(CR):oc edit TektonConfig config
$ oc edit TektonConfig configCopy to Clipboard Copied! Toggle word wrap Toggle overflow 在
结果spec 中进行以下更改:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.2.3. 为 Tekton 结果配置保留策略 复制链接链接已复制到粘贴板!
默认情况下,Tekton Results 存储管道运行、任务运行、事件和日志无限期存储。这会导致存储资源的不必要的使用,并可能会影响您的数据库性能。
您可以在集群级别为 Tekton Results 配置保留策略,以删除旧的结果及其关联的记录和日志。
流程
使用以下命令编辑
TektonConfig自定义资源(CR):oc edit TektonConfig config
$ oc edit TektonConfig configCopy to Clipboard Copied! Toggle word wrap Toggle overflow 在
结果spec 中进行以下更改:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.3. 使用 opc 命令行工具查询 Tekton Results 复制链接链接已复制到粘贴板!
您可以使用 opc 命令行工具查询 Tekton 结果以获取结果和记录。要安装 opc 命令行工具,请为 tkn 命令行工具安装软件包。有关安装此软件包的步骤,请参阅安装 tkn。
您可以使用记录的名称和结果来检索其中的数据。
您可以使用通用表达式语言(CEL)查询搜索结果和记录。这些搜索显示结果或记录的 UUID。您可以使用提供的示例来创建对常见搜索类型的查询。您还可以使用参考信息来创建其他查询。
1.3.1. 准备 opc 工具环境以查询 Tekton Results 复制链接链接已复制到粘贴板!
在查询 Tekton 结果前,您必须为 opc 工具准备环境。
先决条件
-
已安装
opc工具。
流程
输入以下命令将
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
$ export RESULTS_API=$(oc get route tekton-results-api-service -n openshift-pipelines --no-headers -o custom-columns=":spec.host"):443Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输入以下命令为 Tekton Results API 创建身份验证令牌:
oc create token <service_account>
$ oc create token <service_account>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 保存此命令输出的字符串。
可选:创建
~/.config/tkn/results.yaml文件以使用 Tekton Results API 自动身份验证。该文件必须具有以下内容:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 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.3.2. 根据名称查询结果和记录 复制链接链接已复制到粘贴板!
您可以使用其名称列出和查询结果和记录。
先决条件
-
已安装
opc工具,并准备好其环境来查询 Tekton Results。 -
安装了
jq软件包。 - 如果要查询日志信息,请将日志转发配置为 LokiStack。
流程
列出与管道运行和在命名空间中创建的任务对应的结果的名称。输入以下命令:
opc results list --addr ${RESULTS_API} <namespace_name>$ opc results list --addr ${RESULTS_API} <namespace_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 示例命令
opc results list --addr ${RESULTS_API} results-testing$ opc results list --addr ${RESULTS_API} results-testingCopy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
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
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 ISTCopy to Clipboard Copied! Toggle word wrap Toggle overflow 输入以下命令列出结果中所有记录的名称:
opc results records list --addr ${RESULTS_API} <result_name>$ opc results records list --addr ${RESULTS_API} <result_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 示例命令
opc results records list --addr ${RESULTS_API} results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bed$ opc results records list --addr ${RESULTS_API} results-testing/results/04e2fbf2-8653-405f-bc42-a262bcf02bedCopy to Clipboard Copied! Toggle word wrap Toggle overflow 输出示例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 输入以下命令从记录中检索管道运行或任务的 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} <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 Copied! Toggle word wrap Toggle overflow 示例命令
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))'$ 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 Copied! Toggle word wrap Toggle overflow 可选:使用日志记录名称从记录中检索任务运行的日志信息。要获取日志记录名称,请将
记录替换为记录名称中的日志。输入以下命令:opc results logs get --addr ${RESULTS_API} <log_record_name> | jq -r .data | base64 -d$ opc results logs get --addr ${RESULTS_API} <log_record_name> | jq -r .data | base64 -dCopy to Clipboard Copied! Toggle word wrap Toggle overflow 示例命令
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$ 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 -dCopy to Clipboard Copied! Toggle word wrap Toggle overflow
1.3.3. 搜索结果 复制链接链接已复制到粘贴板!
您可以使用通用表达式语言(CEL)查询来搜索结果。例如,您可以找到管道运行的结果,这些结果没有成功。但是,大多数相关信息都不包含在结果对象中;若要根据名称、完成时间和其他数据搜索,请搜索记录。
先决条件
-
已安装
opc工具,并准备好其环境来查询 Tekton Results。
流程
输入以下命令使用 CEL 查询来搜索结果:
opc results list --addr ${RESULTS_API} --filter="<cel_query>" <namespace-name>$ opc results list --addr ${RESULTS_API} --filter="<cel_query>" <namespace-name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
将 < ;namespace_name > 替换为管道运行或任务运行的命名空间。
| 用途 | CEL 查询 |
|---|---|
| 所有失败的结果 |
|
|
结果所有管道运行包含注解 |
|
1.3.4. 搜索记录 复制链接链接已复制到粘贴板!
您可以使用通用表达式语言(CEL)查询搜索记录。因为每个记录包含管道运行或任务运行的完整 YAML 信息,您可以根据许多不同的条件查找记录。
先决条件
-
已安装
opc工具,并准备好其环境来查询 Tekton Results。
流程
输入以下命令使用 CEL 查询搜索记录:
opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <namespace_name>/result/-$ opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <namespace_name>/result/-Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将 <
;namespace_name> 替换为管道运行或任务运行的命名空间。或者,输入以下命令搜索单个结果中的记录:opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <result_name>$ opc results records list --addr ${RESULTS_API} --filter="<cel_query>" <result_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将
<result_name> 替换为结果的全名。
| 用途 | CEL 查询 |
|---|---|
| 所有任务运行或管道运行的记录 |
|
|
|
|
|
所有由名为 |
|
|
所有管道运行和任务运行的记录从名为 |
|
|
所有管道运行的记录都从名为 |
|
|
所有任务的记录,其中 |
|
| 完成所有管道运行的记录时间超过五分钟 |
|
| 所有管道运行和任务运行的记录在 2023 年 10 月 7 日完成 |
|
| 所有管道运行的记录包括三个或更多任务 |
|
|
具有 |
|
|
所有管道运行的记录,其中包含 |
|
1.3.5. 搜索结果的参考信息 复制链接链接已复制到粘贴板!
您可以使用通用表达式语言(CEL)查询中的以下字段进行结果:
| CEL 字段 | 描述 |
|---|---|
|
|
创建 |
|
| 结果的唯一标识符。 |
|
|
添加到 |
|
| 结果摘要。 |
|
| 结果的创建时间。 |
|
| 结果的最后更新时间。 |
您可以使用 summary.status 字段来确定管道运行是否成功。此字段可以有以下值:
-
UNKNOWN -
SUCCESS -
失败 -
TIMEOUT (超时) -
CANCELLED
不要使用引号字符,如 " 或 ' 来为此字段提供值。
1.3.6. 搜索记录的参考信息 复制链接链接已复制到粘贴板!
您可以使用 Common Expression Language (CEL)查询记录中的以下字段:
| CEL 字段 | 描述 | 值 |
|---|---|---|
|
| 记录名称 | |
|
| 记录类型标识符 |
|
|
| 任务运行或管道运行的 YAML 数据。在日志记录中,此字段包含日志输出。 |
因为 data 字段包含任务运行或管道运行的整个 YAML 数据,所以您可以在 CEL 查询中使用此数据的所有元素。例如,data.status.completionTime 包含任务运行或管道运行的完成时间。