RHDEVDOCS-6943: Content creation for Tekton results retention policy #102107
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6943 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/L
|
🤖 Mon Nov 10 15:20:48 - Prow CI generated the docs preview: |
|
@Dhruv-Soni11: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6943 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6943 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6943 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
aThorp96
left a comment
aThorp96
left a comment
There was a problem hiding this comment.
A couple minor change requests. Also, at the moment the Using Tekton Results Pipelines observability section has the subsection Configuring Tekton Results which is currently where all the documentation for Tekton Results configuration lives. Should these updates be part of that same page or does the Configuring Tekton Results subsection just need to link to this new page?
|
|
||
| [role="_abstract"] | ||
|
|
||
| The {tekton-results} Retention Policy Agent manages how long {tekton-results} and Records are retained in the database before they are pruned. You can configure the retention behavior by using the `tekton-results-config-results-retention-policy` config map in the `tekton-pipelines` namespace. |
There was a problem hiding this comment.
IIUC we do not reccomend modifying any of these configmaps directly. @khrm @savitaashture can these settings be configured via the TektonConfig?
| |`policies` | ||
| |Defines a list of fine-grained retention policies for more specific control. Each policy includes a name, selector, and retention period. | ||
| |None | ||
| |=== |
There was a problem hiding this comment.
Can this link to the fine-grained-retention-policies module/section? Since these are next to eachother right now it's easy to jump from "what can I put in this field" to "oh it's in this other section". But if the section gets moved or something is in between this table and the section it becomes less obvious. Can this also specify that the field type is a string containing json or yaml following the schema described in the other section.
| |`30d` | ||
|
|
||
| |`maxRetention` | ||
| |(Deprecated). Used for backward compatibility if `defaultRetention` is not set. This field will be removed in a future release. |
There was a problem hiding this comment.
IMO we should specify the allowed values here even if it's deprecated. Also, we should clarify that this field behaves the same way as defaultRetention so the config name is misleading.
IIUC it must be a number in a string (e.g. "32" or "5").
@khrm does maxRetention support the same values as defaultRetention, meaning it supports unit suffixes like "32h" or "5d"?
| |N/A | ||
|
|
||
| |`policies` | ||
| |Defines a list of fine-grained retention policies for more specific control. Each policy includes a name, selector, and retention period. |
There was a problem hiding this comment.
| |Defines a list of fine-grained retention policies for more specific control. Each policy includes a name, selector, and retention period. | |
| |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 `defaultRetention`. |
4 participants
Version(s):
pipelines-docs-1.21, pipelines-docs-1.20
Issue:
https://issues.redhat.com/browse/RHDEVDOCS-6943
Link to docs preview:
Understanding the Tekton Results retention policy
QE review:
SME review: athorp@redhat.com
QE review:
Peer review:
Additional information: