OSDOCS-19632: Document propagation of Annotations and Labels from Rules to ComplianceCheckResults#111334
OSDOCS-19632: Document propagation of Annotations and Labels from Rules to ComplianceCheckResults#111334GroceryBoyJr wants to merge 3 commits intoopenshift:mainfrom
Conversation
Add assembly and modules describing propagation of custom labels and annotations from Rule and CustomRule objects to ComplianceCheckResult resources, based on the compliance-operator enhancement and CMP-3974. Register the new topic under Compliance Operator scan management. Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify that operator versions are not aligned with OCP and link to the Compliance Operator lifecycle section on the support page. Co-authored-by: Cursor <cursoragent@cursor.com>
Operator release cadence is covered in OpenShift release notes; keep only the 1.9.0 prerequisite here. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@GroceryBoyJr: This pull request references OSDOCS-19632 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set. DetailsIn 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-robot
added
the
jira/valid-reference
openshift-ci
Bot
added
the
size/L
|
🤖 Wed May 06 21:54:45 - Prow CI generated the docs preview: |
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="compliance-operator-checkresult-custom-metadata-configure-customrules_{context}"] | ||
| = Adding custom labels and annotations to a CustomRule object for CEL scans |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="compliance-operator-checkresult-custom-metadata-configure-rules_{context}"] | ||
| = Adding custom labels and annotations to a Rule object |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id="compliance-operator-checkresult-custom-metadata-overview_{context}"] | ||
| = Understanding custom metadata on rules and check results |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
|
|
||
| Failure behavior:: If the operator cannot build its in-memory index of `Rule` objects during aggregation, it logs a warning and still creates scan results without your custom metadata. If a label value violates Kubernetes length or syntax rules, creation of that specific `ComplianceCheckResult` can fail while other results continue. | ||
|
|
||
| For more background on the enhancement, see link:https://github.com/ComplianceAsCode/compliance-operator/blob/master/enhancements/custom-metadata-propagation.md[Custom metadata propagation from rules to ComplianceCheckResults] and link:https://redhat.atlassian.net/browse/CMP-3974[CMP-3974]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
|
|
||
| Failure behavior:: If the operator cannot build its in-memory index of `Rule` objects during aggregation, it logs a warning and still creates scan results without your custom metadata. If a label value violates Kubernetes length or syntax rules, creation of that specific `ComplianceCheckResult` can fail while other results continue. | ||
|
|
||
| For more background on the enhancement, see link:https://github.com/ComplianceAsCode/compliance-operator/blob/master/enhancements/custom-metadata-propagation.md[Custom metadata propagation from rules to ComplianceCheckResults] and link:https://redhat.atlassian.net/browse/CMP-3974[CMP-3974]. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
| @@ -0,0 +1,23 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
| [id="compliance-operator-checkresult-custom-metadata"] | |||
| = Propagating custom metadata to ComplianceCheckResult objects | |||
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
|
@GroceryBoyJr: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
4 participants
Version(s):
Issue: https://redhat.atlassian.net/browse/OSDOCS-19632
Link to docs preview: https://111334--ocpdocs-pr.netlify.app/openshift-enterprise/latest/security/compliance_operator/co-scans/compliance-operator-checkresult-custom-metadata.html
QE review:
Additional information: