Red Hat Summitこのコンテンツは選択した言語では利用できません。
Chapter 2. Understanding the Tekton Results retention policy
The Tekton Results Retention Policy Agent manages how long the database retains Tekton Results and Records before pruning them. You can configure the retention behavior by using the tekton-results-config-results-retention-policy config map in the tekton-pipelines namespace.
The retention policy determines when and how old Tekton Results and Records are automatically deleted from the database. You can define global defaults and fine-grained rules based on namespaces, labels, annotations, or run statuses.
Use the following sample YAML configuration to define Tekton Results settings, including log retention policies, namespaces, and runtime options:
apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
labels:
openshift-pipelines.tekton.dev/sa-created: "true"
operator.tekton.dev/release-version: 1.21.0
name: config
spec:
...
result:
disabled: false
is_external_db: false
log_level: debug
loki_stack_name: logging-loki
loki_stack_namespace: openshift-logging
options:
configMaps:
tekton-results-config-results-retention-policy:
data:
defaultRetention: 30m
policies: |
- name: "prod-failed-retention"
selector:
matchNamespaces:
- "prod-1"
- "prod-west"
matchStatuses:
- "Failed"
matchLabels:
"env": ["prod"]
retention: "10m"
- name: "all-prod-retention"
selector:
matchNamespaces:
- "prod-1"
- "prod-west"
retention: "3m"
runAt: '*/1 * * * *'
metadata:
creationTimestamp: nullThe following fields in the config map define the retention configuration:
| Field | Description | Default |
|---|---|---|
|
| Specifies when the pruning job runs. The value must use a cron schedule format. |
|
|
|
Specifies the fallback retention period for Results and Records when no specific policy matches. The value can be a number (in days) or a duration string such as |
|
|
|
(Deprecated). Used for backward compatibility if | N/A |
|
|
Defines a list of fine-grained retention policies for more specific control, in order of precedence. Each policy includes a name, selector, and retention period. For Records and Results matched by a policy’s selector, the policy’s retention period overrides the | None |
2.1. Fine-grained retention policies
You can use the policies field to define rules that apply to specific Results. Tekton Results evaluates the policies in order, and applies the first matching policy. If no policies match, Tekton Results uses the defaultRetention value.
Each policy includes the following fields:
| Field | Description |
|---|---|
|
| A descriptive name for the policy. |
|
|
Defines criteria for matching Results. All selector types use |
|
| A list of namespaces. The policy matches Results in any of the listed namespaces. |
|
| A map of label keys and possible values. A Result must have all listed label keys, and each value must match one of the values in the list. |
|
|
A map of annotation keys and possible values. Works similarly to |
|
|
A list of final statuses such as |
|
|
The retention period for matching Results. The value can be a number (days) or a duration string such as |
The following example shows a config map that defines many retention policies:
apiVersion: v1
kind: ConfigMap
metadata:
name: tekton-results-config-results-retention-policy
namespace: openshift-pipelines
data:
runAt: "0 2 * * *"
defaultRetention: "30d"
policies: |
- name: "retain-critical-failures-long-term"
selector:
matchNamespaces:
- "production"
- "prod-east"
matchLabels:
"criticality": ["high"]
matchStatuses:
- "Failed"
retention: "180d"
- name: "retain-annotated-for-debug"
selector:
matchAnnotations:
"debug/retain": ["true"]
retention: "14d"
- name: "default-production-policy"
selector:
matchNamespaces:
- "production"
- "prod-east"
retention: "60d"
- name: "short-term-ci-retention"
selector:
matchNamespaces:
- "ci"
retention: "7d"The following examples describe how Tekton Results applies the defined retention policies to different Results based on their namespaces, labels, annotations, and statuses.
-
Tekton Results retains a failed Result in the
productionorprod-eastnamespace with the labelcriticality: highfor 180 days. -
Tekton Results retains any Result with the annotation
debug/retain: "true"for 14 days. -
Tekton Results retains Results in the
productionorprod-eastnamespaces for 60 days. -
Tekton Results retains Results in the
cinamespace for 7 days. - Tekton Results retains all other Results that do not match any policy for the default 30 days.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}