Быстрый старт

Содержание

Установка Tekton Results Предварительные требования Установка с использованием operator CRD Проверка работоспособности 1. Создайте ресурс TaskRun2. Дождитесь завершения выполнения task 3. Используйте CLI tkn-results для запроса результатов Ссылки

Установка Tekton Results

В этом документе описывается, как установить Tekton Results, используя существующую базу данных.

NOTE

В настоящее время встроенная база данных PostgreSQL не поддерживается, пожалуйста, используйте внешнюю базу данных.

Информацию о внешней базе данных см. в разделе Using PostgreSQL from Data Services

TIP

Tekton Results поддерживает хранение логов в различных backend-хранилищах. Совместимое с S3 object storage (например, AWS S3, Ceph, MinIO) сейчас является рекомендуемым подходом для масштабируемого и долговечного хранения логов. Подробную информацию о настройке S3 storage см. в S3 Storage Configuration Guide. Локальное хранилище PVC не рекомендуется для использования в production.

Предварительные требования

Tekton Pipelines должен быть установлен в кластере.

TIP
Следующие инструкции предполагают, что вы по умолчанию установили Results в namespace tekton-pipelines.
Если вы установили его в другой namespace, пожалуйста, замените tekton-pipelines на ваш namespace.
Создайте root-пароль базы данных.

Перед установкой пользователи должны сгенерировать root-пароль базы данных и сохранить его в Kubernetes Secret. По умолчанию Tekton Results ожидает, что этот Secret будет содержать следующие атрибуты:
- Namespace: tekton-pipelines
- Имя: tekton-results-postgres
- Следующие поля:
  - POSTGRES_USER=<your_username>
  - POSTGRES_PASSWORD=<your_password>
Вы можете быстро сгенерировать Secret с помощью следующей команды:
kubectl create secret generic tekton-results-postgres --namespace="tekton-pipelines" --from-literal=POSTGRES_USER={POSTGRES} --from-literal=POSTGRES_PASSWORD={PASSWORD}
Сгенерируйте пару сертификат/ключ. Примечание: для этого можно использовать любое ПО для управления сертификатами!

Tekton Results ожидает, что пара сертификат/ключ будет храниться в TLS Kubernetes Secret с именем tekton-results-tls.
- Сгенерируйте новый самоподписанный сертификат
  openssl req -x509 \ -newkey rsa:4096 \ -keyout key.pem \ -out cert.pem \ -days 365 \ -nodes \ -subj "/CN=tekton-results-api-service.tekton-pipelines.svc.cluster.local" \ -addext "subjectAltName = DNS:tekton-results-api-service.tekton-pipelines.svc.cluster.local"
  TIP
  Если ваша версия openssl слишком старая и не поддерживает некоторые параметры, пожалуйста, обновите openssl из openssl binaries .
- Создайте новый TLS Secret из сертификата.
  kubectl create secret tls -n tekton-pipelines tekton-results-tls \ --cert=cert.pem \ --key=key.pem
(Только для быстрого старта) Создайте PVC, если вы используете устаревший тип хранилища File (не рекомендуется для production).

WARNING
Локальное хранилище на основе PVC не рекомендуется для использования в production. Совместимое с S3 object storage является рекомендуемым подходом для масштабируемого и долговечного хранения логов. Для настройки S3 storage см. S3 Storage Configuration Guide.

Если вам все же нужно использовать PVC для тестирования:
cat <<EOF | kubectl create -f - apiVersion: v1 kind: PersistentVolumeClaim metadata: name: tekton-logs namespace: tekton-pipelines spec: accessModes: - ReadWriteOnce # The access mode indicating it can be read and written by a single node resources: requests: storage: 100Gi # The requested storage size EOF
- При необходимости скорректируйте размер PVC.
- Примечание: это требуется только при использовании устаревшего типа хранилища File.

Установка с использованием operator CRD

$ cat <<EOF | kubectl create -f -
apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  # Target namespace
  targetNamespace: tekton-pipelines
  result:
    # Update with database address
    db_host: <database_host>
    db_port: 5432
    db_name: <database_name>
    # Use external database
    is_external_db: true
    # secret containing database account information created earlier
    db_secret_name: tekton-results-postgres
    # Basic settings
    server_port: 8080
    # Disable authentication
    auth_disable: true
    db_enable_auto_migration: true
    log_level: debug
    # Use logs storage service
    logs_api: true
    logs_type: File
    logging_pvc_name: tekton-logs
    # logs_type: S3  # Recommended: S3-compatible storage for scalable log retention
    # secret_name: tekton-results-s3-credentials  # Secret containing S3 credentials
    logs_path: /logs
    logs_buffer_size: 92160
    # S3 storage does not require PVC, unlike legacy File storage
EOF

DETAILS

Все поля конфигурации Tekton Results вложены в spec.result в ресурсе TektonConfig.

db_host: Хост базы данных.
db_port: Порт базы данных.
db_name: Имя базы данных.
is_external_db: Указывает, использовать ли внешнюю базу данных.
- true: Использовать внешнюю базу данных.
db_secret_name: Имя secret, содержащего информацию об учетной записи базы данных.
- Это secret, созданный на предыдущем шаге.
server_port: Порт сервера.
targetNamespace: Namespace, в котором развернут Results.
auth_disable: Указывает, отключать ли аутентификацию.
db_enable_auto_migration: Указывает, включать ли автоматическую миграцию базы данных.
log_level: Уровень логирования.
logs_api: Указывает, включать ли Logs API.
- true: Включить Logs API.
logs_type: Тип логов.
- File: Сохранять логи в файл (не рекомендуется для использования в production).
- S3: Сохранять логи в совместимое с S3 object storage (например, AWS S3, Ceph, MinIO). Это рекомендуемый подход для масштабируемого и долговечного хранения логов. Подробную информацию о настройке см. в S3 Storage Configuration Guide.
secret_name: Имя secret, содержащего информацию об учетной записи S3. Подробную информацию о настройке см. в S3 Storage Configuration Guide.
logs_path: Путь к логам.
logs_buffer_size: Размер буфера логов.
logging_pvc_name: Имя PVC для хранения логов (требуется только при использовании устаревшего типа хранилища File).
- Это PVC, созданный на предыдущем шаге (не требуется для хранения в S3).

TIP

Дополнительную информацию о настройке базы данных см. в PostgreSQL Configuration

После развертывания вы можете увидеть, что статус results-api / results-retention-policy-agent / results-watcher равен Running

$ kubectl get pods -n tekton-pipelines

NAME                                                    READY   STATUS    RESTARTS   AGE
tekton-results-api-68bb657996-bb487                     1/1     Running   0          14s
tekton-results-retention-policy-agent-c6ff5575b-prczg   1/1     Running   0          14s
tekton-results-watcher-6d7c68f576-p2gbl                 1/1     Running   0          14s

Проверка работоспособности

Функциональность можно проверить с помощью простого taskrun.

1. Создайте ресурс `TaskRun`

$ cat <<'EOF' | kubectl create -f -
apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
  name: hello
spec:
  taskSpec:
    steps:
      - name: hello
        image: alpine
        command: ["echo", "hello"]
EOF

NOTE

Для изолированных от сети сред измените адрес образа alpine на другой, доступный в сети

2. Дождитесь завершения выполнения task

$ kubectl get taskruns.tekton.dev -n default -w

hello                                        Unknown     Pending     3s
hello                                        True        Succeeded   11s         0s

3. Используйте CLI tkn-results для запроса результатов

Подготовка CLI

tkn — это командная строка для взаимодействия с Tekton. Вы можете загрузить ее с официальной страницы.

Вам нужно собрать tkn-results, используя golang.

Не собирайте всегда из main. Используйте release-branch, соответствующий версии Tekton Results, развернутой в вашей среде. Версию компонента Results можно найти в Release Notes (столбец Results), а затем перейти на соответствующую ветку release-v<version>.x.

# 1. Clone the repository
git clone https://github.com/tektoncd/results.git

# 2. Change to the project directory
cd results

# 3. Checkout the matching release branch (example: Results 0.15.x -> release-v0.15.x)
git checkout release-v<version>.x

# 4. Build the binary
go build -o tkn-results ./cmd/tkn-results/main.go

# 5. Copy the binary to a directory in your PATH

Поведение подключения

Когда --addr не задан, tkn-results пытается автоматически выполнить port-forward к сервису Results API.

Во многих версиях (включая release-v0.15.x) целевой адрес по умолчанию — tekton-pipelines/tekton-results-api-service. Если ваш deployment Results использует другой namespace или имя сервиса, автоматический режим может не сработать.

Когда --addr задан, tkn-results подключается к этому адресу напрямую. В этом случае вам обычно нужно самостоятельно запускать kubectl port-forward.

Запрос списка записей выполнения

$ tkn results --insecure records list default/results/-

default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/records/209dcb81-e3c0-47cd-b082-d910e15702ae  tekton.dev/v1.TaskRun                   2025-02-19 16:17:11 +0800 CST           2025-02-19 16:17:21 +0800 CST
default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/records/a750035d-0479-34a1-9db2-9a256b53243f  results.tekton.dev/v1alpha3.Log         2025-02-19 16:17:21 +0800 CST           2025-02-19 16:17:21 +0800 CST

Резервный вариант при сбое автоматического port-forward

$ kubectl port-forward -n <results-namespace> service/tekton-results-api-service 8080

$ tkn results --insecure --addr localhost:8080 records list default/results/-
$ tkn results --insecure --addr localhost:8080 records get -o textproto default/results/<result-uid>/records/<record-uid>
$ tkn results --insecure --addr localhost:8080 logs list default/results/-
$ tkn results --insecure --addr localhost:8080 logs get -o textproto default/results/<result-uid>/logs/<log-uid>
# If logs get returns "unknown service tekton.results.v1alpha3.Logs", retry with:
$ tkn results --insecure --addr localhost:8080 --v1alpha2 logs get -o textproto default/results/<result-uid>/logs/<log-uid>

Запрос одной записи выполнения

$ tkn results --insecure records get -o textproto default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/records/209dcb81-e3c0-47cd-b082-d910e15702ae

name: "default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/records/209dcb81-e3c0-47cd-b082-d910e15702ae"
id: "0805bbd0-e390-40dc-a1ea-f65ae9401930"
uid: "0805bbd0-e390-40dc-a1ea-f65ae9401930"
data: {
  type: "tekton.dev/v1.TaskRun"
  value: "{\"kind\": \"TaskRun\", \"spec\": {\"timeout\": \"1h0m0s\", \"taskSpec\": {\"steps\": [{\"name\": \"hello\", \"image\": \"152-231-registry.alauda.cn:60070/ops/ubuntu:latest\", \"command\": [\"echo\", \"hello\"], \"computeResources\": {}}]}, \"serviceAccountName\": \"default\"}, \"status\": {\"steps\": [{\"name\": \"hello\", \"imageID\": \"alpine\", \"container\": \"step-hello\", \"terminated\": {\"reason\": \"Completed\", \"exitCode\": 0, \"startedAt\": \"2025-02-19T08:17:20Z\", \"finishedAt\": \"2025-02-19T08:17:20Z\", \"containerID\": \"containerd://5e2cb72ca758fc976744b06b5ee97564bcc0958ca9cee2a54fdaab64323a1bf9\"}, \"terminationReason\": \"Completed\"}], \"podName\": \"hello-pod\", \"taskSpec\": {\"steps\": [{\"name\": \"hello\", \"image\": \"152-231-registry.alauda.cn:60070/ops/ubuntu:latest\", \"command\": [\"echo\", \"hello\"], \"computeResources\": {}}]}, \"startTime\": \"2025-02-19T08:17:10Z\", \"conditions\": [{\"type\": \"Succeeded\", \"reason\": \"Succeeded\", \"status\": \"True\", \"message\": \"All Steps have completed executing\", \"lastTransitionTime\": \"2025-02-19T08:17:21Z\"}], \"provenance\": {\"featureFlags\": {\"Coschedule\": \"workspaces\", \"MaxResultSize\": 4096, \"EnableAPIFields\": \"beta\", \"EnableArtifacts\": false, \"EnableParamEnum\": false, \"DisableCredsInit\": false, \"EnableStepActions\": true, \"SetSecurityContext\": false, \"AwaitSidecarReadiness\": true, \"EnableKeepPodOnCancel\": false, \"EnableTektonOCIBundles\": false, \"ResultExtractionMethod\": \"termination-message\", \"SendCloudEventsForRuns\": false, \"DisableAffinityAssistant\": false, \"EnableProvenanceInStatus\": true, \"EnforceNonfalsifiability\": \"none\", \"EnableCELInWhenExpression\": false, \"VerificationNoMatchPolicy\": \"ignore\", \"ScopeWhenExpressionsToTask\": false, \"RequireGitSSHSecretKnownHosts\": false, \"RunningInEnvWithInjectedSidecars\": true}}, \"completionTime\": \"2025-02-19T08:17:21Z\"}, \"metadata\": {\"uid\": \"209dcb81-e3c0-47cd-b082-d910e15702ae\", \"name\": \"hello\", \"labels\": {\"app.kubernetes.io/managed-by\": \"tekton-pipelines\"}, \"namespace\": \"default\", \"finalizers\": [\"results.tekton.dev/taskrun\", \"chains.tekton.dev\"], \"generation\": 1, \"annotations\": {\"results.tekton.dev/log\": \"default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/logs/a750035d-0479-34a1-9db2-9a256b53243f\", \"chains.tekton.dev/signed\": \"true\", \"results.tekton.dev/record\": \"default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/records/209dcb81-e3c0-47cd-b082-d910e15702ae\", \"results.tekton.dev/result\": \"default/results/209dcb81-e3c0-47cd-b082-d910e15702ae\", \"pipeline.tekton.dev/release\": \"8bfd3273cbe7776847884d7fa5004481e6be8f4a\"}, \"managedFields\": [{\"time\": \"2025-02-19T08:17:10Z\", \"manager\": \"kubectl-create\", \"fieldsV1\": {\"f:spec\": {\".\": {}, \"f:taskSpec\": {\".\": {}, \"f:steps\": {}}}}, \"operation\": \"Update\", \"apiVersion\": \"tekton.dev/v1\", \"fieldsType\": \"FieldsV1\"}, {\"time\": \"2025-02-19T08:17:21Z\", \"manager\": \"controller\", \"fieldsV1\": {\"f:metadata\": {\"f:finalizers\": {\"v:\\\"chains.tekton.dev\\\"\": {}}, \"f:annotations\": {\"f:chains.tekton.dev/signed\": {}, \"f:pipeline.tekton.dev/release\": {}}}}, \"operation\": \"Update\", \"apiVersion\": \"tekton.dev/v1\", \"fieldsType\": \"FieldsV1\"}, {\"time\": \"2025-02-19T08:17:21Z\", \"manager\": \"controller\", \"fieldsV1\": {\"f:status\": {\".\": {}, \"f:steps\": {}, \"f:podName\": {}, \"f:taskSpec\": {\".\": {}, \"f:steps\": {}}, \"f:artifacts\": {}, \"f:startTime\": {}, \"f:conditions\": {}, \"f:provenance\": {\".\": {}, \"f:featureFlags\": {\".\": {}, \"f:Coschedule\": {}, \"f:MaxResultSize\": {}, \"f:EnableAPIFields\": {}, \"f:EnableArtifacts\": {}, \"f:EnableParamEnum\": {}, \"f:DisableCredsInit\": {}, \"f:DisableInlineSpec\": {}, \"f:EnableStepActions\": {}, \"f:SetSecurityContext\": {}, \"f:AwaitSidecarReadiness\": {}, \"f:EnableKeepPodOnCancel\": {}, \"f:ResultExtractionMethod\": {}, \"f:SendCloudEventsForRuns\": {}, \"f:EnableKubernetesSidecar\": {}, \"f:DisableAffinityAssistant\": {}, \"f:EnableProvenanceInStatus\": {}, \"f:EnforceNonfalsifiability\": {}, \"f:EnableCELInWhenExpression\": {}, \"f:VerificationNoMatchPolicy\": {}, \"f:EnableConciseResolverSyntax\": {}, \"f:RequireGitSSHSecretKnownHosts\": {}, \"f:RunningInEnvWithInjectedSidecars\": {}}}, \"f:completionTime\": {}}}, \"operation\": \"Update\", \"apiVersion\": \"tekton.dev/v1\", \"fieldsType\": \"FieldsV1\", \"subresource\": \"status\"}, {\"time\": \"2025-02-19T08:17:21Z\", \"manager\": \"watcher\", \"fieldsV1\": {\"f:metadata\": {\"f:finalizers\": {\".\": {}, \"v:\\\"results.tekton.dev/taskrun\\\"\": {}}, \"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\": \"1592422\", \"creationTimestamp\": \"2025-02-19T08:17:10Z\"}, \"apiVersion\": \"tekton.dev/v1\"}"
}
etag: "0805bbd0-e390-40dc-a1ea-f65ae9401930-1739953041309658421"
created_time: {
  seconds: 1739953031
  nanos: 16922000
}
create_time: {
  seconds: 1739953031
  nanos: 16922000
}
updated_time: {
  seconds: 1739953041
  nanos: 309658000
}
update_time: {
  seconds: 1739953041
  nanos: 309658000
}

Запрос списка логов

$ tkn results --insecure logs list default/results/-

default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/logs/a750035d-0479-34a1-9db2-9a256b53243f  results.tekton.dev/v1alpha3.Log         2025-02-19 16:17:21 +0800 CST           2025-02-19 16:17:21 +0800 CST

Запрос одного лога

Версия Logs API может отличаться в зависимости от deployment. Если вы столкнетесь с unknown service tekton.results.v1alpha3.Logs, повторите команду с флагом --v1alpha2.

$ tkn results --insecure logs get -o textproto default/results/209dcb81-e3c0-47cd-b082-d910e15702ae/logs/a750035d-0479-34a1-9db2-9a256b53243f

content_type: "text/plain"
data: "[prepare] 2025/02/19 08:17:12 Entrypoint initialization\n\n[hello] hello\n\n"

#Быстрый старт

#Содержание

#Установка Tekton Results

#Предварительные требования

#Установка с использованием operator CRD

#Проверка работоспособности

#1. Создайте ресурс TaskRun

#2. Дождитесь завершения выполнения task

#3. Используйте CLI tkn-results для запроса результатов

#Подготовка CLI

#Поведение подключения

#Запрос списка записей выполнения

#Резервный вариант при сбое автоматического port-forward

#Запрос одной записи выполнения

#Запрос списка логов

#Запрос одного лога

#Ссылки