快速开始
目录
安装 Tekton Results前提条件使用 operator CRD 安装验证功能1. 创建TaskRun 资源2. 等待任务执行完成3. 使用 tkn-results CLI 查询结果4. 重新启用身份验证参考安装 Tekton Results
本文档介绍如何使用现有数据库安装 Tekton Results。
目前不支持内置 PostgreSQL 数据库,请使用外部数据库。
有关外部数据库的信息,请参阅使用 Data Services 中的 PostgreSQL
Tekton Results 支持将日志存储在各种存储后端中。对于可扩展且持久的日志保留,目前建议使用 S3 兼容的对象存储(例如 AWS S3、Ceph、MinIO)。有关详细的 S3 存储配置,请参阅S3 存储配置指南。不建议在生产环境中使用本地 PVC 存储。
前提条件
-
必须在集群中安装 Tekton Pipelines。
TIP以下说明假设你已将 Results 安装到默认的
tekton-pipelines命名空间中。如果你将其安装到了其他命名空间,请将
tekton-pipelines替换为你的命名空间。 -
存储数据库账户。
Tekton Results 使用存储在 Kubernetes Secret 中的用户名和密码连接 PostgreSQL。在安装之前创建
Secret,其中包含 Tekton Results 用于连接数据库的用户,例如专用的result用户。默认情况下,Tekton Results 要求此Secret具有以下属性:- 命名空间:
tekton-pipelines - 名称:
tekton-results-postgres - 包含以下字段:
POSTGRES_USER=<your_username>POSTGRES_PASSWORD=<your_password>
你可以使用以下命令快速生成
Secret。单独运行read -rs行,输入数据库密码并按 Enter:read -rs不会显示密码,因此密码不会出现在屏幕上或 shell 历史记录中。在不支持括号粘贴的 shell 中(例如 5.1 之前的 bash),read会将粘贴块中的下一行作为密码。在 bash 或 zsh 中运行这些命令:在 POSIXsh中,例如dash,read -rs会失败并使变量保持为空:然后创建
Secret。创建Secret后,unset会从 shell 中移除密码: - 命名空间:
-
生成证书/密钥对。注意:可以使用任何证书管理软件完成此操作!
Tekton Results 要求将证书/密钥对存储在名为
tekton-results-tls的 TLS Kubernetes Secret 中。-
生成新的自签名证书
TIP如果你的
openssl版本过低,不支持某些参数,请从 openssl 二进制文件 升级你的openssl版本。 -
从证书创建新的 TLS Secret。
-
-
(仅用于快速开始)如果使用旧版
File存储类型,请创建一个PVC(不建议在生产环境中使用)。WARNING不建议在生产环境中使用基于 PVC 的本地存储。对于可扩展且持久的日志保留,建议使用 S3 兼容的对象存储。有关 S3 存储配置,请参阅S3 存储配置指南。
如果仍需使用 PVC 进行测试:
- 请根据需要调整 PVC 大小。
- 示例未设置
storageClassName,因此 PVC 使用集群的默认 StorageClass,该 StorageClass 由kubectl get storageclass标记为(default)。如果集群没有默认 StorageClass,请将storageClassName: <storage-class>添加到spec;没有 StorageClass 时,PVC 可能保持为Pending。 - 注意:仅当使用旧版 File 存储类型时才需要此项。
使用 operator CRD 安装
operator 已创建名为 config 的 TektonConfig。将以下 spec.result 字段合并到其中;disabled: false 会安装 Tekton Results。合并操作会保留其他 TektonConfig 字段,包括 spec.targetNamespace,即部署 Tekton Results 的命名空间。
DETAILS
以下 Tekton Results 配置字段嵌套在 TektonConfig 资源的 spec.result 下,但 targetNamespace 除外,它是 spec.targetNamespace。
disabled:是否禁用 Tekton Results。false:安装 Tekton Results。
db_host:数据库的主机。db_port:数据库的端口。db_name:数据库的名称。is_external_db:必须为true,因为不支持内置 PostgreSQL 数据库。true:使用外部数据库。
db_secret_name:包含数据库账户信息的 Secret 名称。- 这是上一步创建的 Secret。
server_port:服务器的端口。targetNamespace(spec.targetNamespace,不会由补丁更改):部署 Results 的命名空间。auth_disable:是否禁用身份验证。true:仅用于测试。Results API 会跳过 Kubernetes RBAC 检查并允许所有请求,因此任何能够访问该 API 的人都可以读取、更改和删除所有命名空间中的结果、记录和日志。这包括通过 Tekton Results 安装所创建的 Ingresstektoncd-results-api进行访问,该 Ingress 在路径/results下提供 API。请按照重新启用身份验证中的说明,在测试后重新启用身份验证。
db_enable_auto_migration:是否启用自动数据库迁移。log_level:日志级别。logs_api:是否启用日志 API。true:启用日志 API。
logs_type:日志的类型。File:将日志存储在文件中(不建议在生产环境中使用)。S3:将日志存储在 S3 兼容的对象存储中(例如 AWS S3、Ceph、MinIO)。这是实现可扩展且持久日志保留的推荐方式。有关详细配置,请参阅S3 存储配置指南。
secret_name:包含 S3 账户信息的 Secret 名称。有关详细配置,请参阅S3 存储配置指南。logs_path:日志的路径。logs_buffer_size:日志的缓冲区大小。logging_pvc_name:用于存储日志的 PVC 名称(仅在使用旧版 File 存储类型时需要)。- 这是上一步创建的 PVC(S3 存储不需要)。
有关更多数据库配置,请参阅PostgreSQL 配置
部署后,可以看到 results-api / results-retention-policy-agent / results-watcher 的状态为 Running。该命名空间还包含其他 Tekton 组件的 Pod;以下输出已缩减为 Tekton Results Pod:
验证功能
可以通过一个简单的 taskrun 验证功能。
1. 创建 TaskRun 资源
请将公开的 alpine 镜像替换为集群可以拉取的镜像,例如在隔离网络环境中使用内部 registry 中的镜像。
当集群设置 disable-inline-spec 包含 taskrun 时(请参阅使用 Kyverno 限制 Tekton Pipeline 执行),Tekton webhook 会拒绝带有内联 taskSpec 的 TaskRun;在此类集群中,请创建具有相同步骤的 Task,并改为使用 taskRef 引用它。
2. 等待任务执行完成
3. 使用 tkn-results CLI 查询结果
准备 CLI
tkn 是用于与 Tekton 交互的命令行工具。你可以从官方页面下载它。
你需要使用 golang 构建 tkn-results。至少使用所检出分支的
go.mod中go行指定的 Go 版本:Results v0.19.0 使用go 1.25.8,因此需要 Go 1.25.8 或更高版本。不要始终从
main构建。请使用与你环境中部署的 Tekton Results 版本匹配的 release 分支。 你可以在 Release Notes 中找到 Results 组件版本(Results列),然后检出相应的分支release-v<version>.x。
连接行为
未设置
--addr时,tkn-results会尝试自动将端口转发到 Results API 服务。在许多版本中(包括
release-v0.15.x),自动目标为tekton-pipelines/tekton-results-api-service。 如果你的 Results 部署使用不同的命名空间或服务名称,自动模式可能会失败。设置
--addr后,tkn-results会直接连接到该地址。 在这种情况下,通常需要自行运行kubectl port-forward。
查询执行记录列表
自动端口转发失败时的备用方法
在单独的终端中启动端口转发,并在运行 tkn results 命令时保持其运行;该命令会在前台运行,直到使用 Ctrl+C 停止:
然后,在第一个终端中运行:
查询单条执行记录
示例输出来自较早版本。在其 metadata.finalizers 中,chains.tekton.dev 是 TaskRun 的 Chains finalizer 旧名称;Chains 现在将其命名为 chains.tekton.dev/taskrun。
查询日志列表
查询单条日志
对于
logs_typeFile或S3(本页面设置的类型),Results API 仅提供 v1alpha2 Logs API。 因此,logs get需要使用--v1alpha2标志;没有该标志时,命令会失败并显示unknown service tekton.results.v1alpha3.Logs。logs get使用该标志调用 v1alpha2 Logs API,即使 CLI 将该标志标记为已弃用。
4. 重新启用身份验证
安装补丁设置了 auth_disable: true,该设置仅用于测试。测试完成后,将以下合并补丁保存为 results-auth-patch.yaml:
合并该补丁,然后重复运行第二条命令,直到其输出 AUTH_DISABLE=false。如果它持续输出 AUTH_DISABLE=true,请使用第三条命令读取 TektonConfig 条件。Operator 会先应用 Pipelines、基于事件的 Pruner、Triggers 和 Chains 组件,然后应用 Tekton Results,并在遇到无法应用的组件时停止;此时,ComponentsReady 条件为 False,其消息以 Components not in ready state: 开头,并包含该组件的名称:
Results API 仅在启动时读取此设置。删除其 Pod,使 Deployment 使用该设置启动新的 Pod,然后检查新 Pod 是否为 Running: