Update violations page info #91288

kcarmichael08 · 2025-03-28T20:28:21Z

Version(s):
4.7+

Issue

Link to docs preview

QE review: ACS has no QE, approved by SME

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2025-03-28T20:38:21Z

🤖 Thu Apr 03 14:32:34 - Prow CI generated the docs preview:

https://91288--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/respond-to-violations.html

clickboo · 2025-04-02T15:52:49Z

modules/analyzing-all-violations.adoc

+*** Violations in the build and deploy stages for workloads that were removed or modified to be compliant
+*** Manually resolved runtime violations
+*** Violations in all stages that were generated before a policy exclusion was added
+** *Attempted*: Displays violations for deployment actions that were attempted but blocked by a pre-check of {product-title-short} policies by the {product-title-short} admission controller. For example, the deployment action that was attempted would have triggered a violation if it had been allowed to succeed, but the policy enforcement behavior did not allow it to succeed.


blocked by evaluation of enforced policies

... but the admission controller enforcement did not allow the operation to be admitted to the cluster.

fduthilleul · 2025-04-02T16:12:27Z

LGTM

clickboo

One minor comment/change for your consideration, good to go. Thank you for fixing this!

sr1kar99 · 2025-04-03T07:28:13Z

/label peer-review-in-progress
/remove-label peer-review-needed

sr1kar99

Left a few suggestions.

Requesting @snarayan-redhat for another round of peer review.
Thanks!

sr1kar99 · 2025-04-03T07:36:53Z

modules/analyzing-all-violations.adoc

-** To display the findings for platform components in {ocp}, select *Platform view*.
-** To display the findings for application workloads and platform components simultaneously, select *Full view*.
-. Optional: Choose the appropriate method to re-organize the information in the *Violations* page:
+. Click the tab to view violations for the following categories:


Suggested change

. Click the tab to view violations for the following categories:

. Click one of the following tabs to view violations by category:

To maintain consistency with other parts of the doc.

sr1kar99 · 2025-04-03T07:43:23Z

modules/analyzing-all-violations.adoc

+. Click the tab to view violations for the following categories:
+** *User Workloads*: Displays violations for user-managed workloads.
+** *Platform*: Displays violations for workloads used by {ocp} and layered services.
+** *All violations*: Displays violations for user workload and platform components, and audit log violations for cluster resources.


Suggested change

** *All violations*: Displays violations for user workload and platform components, and audit log violations for cluster resources.

** *All violations*: Displays violations for user workloads and the platform component. It also displays audit log violations for cluster resources.

sr1kar99 · 2025-04-03T07:51:39Z

modules/analyzing-all-violations.adoc

+** *User Workloads*: Displays violations for user-managed workloads.
+** *Platform*: Displays violations for workloads used by {ocp} and layered services.
+** *All violations*: Displays violations for user workload and platform components, and audit log violations for cluster resources.
+. To view different types of violations, click one of the following tabs:


Suggested change

. To view different types of violations, click one of the following tabs:

. Click one of the following tabs to view violations by type:

@sr1kar99 The original sentence adheres to ISG.

sr1kar99 · 2025-04-03T07:55:00Z

modules/analyzing-all-violations.adoc

+** *Resolved*: Displays the following violations:
+*** Violations in the build and deploy stages for workloads that were removed or modified to be compliant
+*** Manually resolved runtime violations
+*** Violations in all stages that were generated before a policy exclusion was added


Suggested change

*** Violations in all stages that were generated before a policy exclusion was added

*** Violations that were generated before a policy exclusion was added

I think "in all stages" is redundant.

sr1kar99 · 2025-04-03T11:15:04Z

modules/analyzing-all-violations.adoc

+*** Manually resolved runtime violations
+*** Violations in all stages that were generated before a policy exclusion was added
+** *Attempted*: Displays violations for deployment actions that were attempted but blocked by the evaluation of enforced policies. For example, the admission controller found that the attempted deployment action, such as a deployment create, update, or scale, would have triggered a violation. The admission controller enforcement then did not allow the operation to be admitted to the cluster.
+. Optional: Choose the appropriate method to reorganize or filter information in the *Violations* page:


Suggested change

. Optional: Choose the appropriate method to reorganize or filter information in the *Violations* page:

. Optional: Choose a method to reorganize or filter information on the *Violations* page:

sr1kar99 · 2025-04-03T11:35:06Z

modules/analyzing-all-violations.adoc

+*** Violations in the build and deploy stages for workloads that were removed or modified to be compliant
+*** Manually resolved runtime violations
+*** Violations in all stages that were generated before a policy exclusion was added
+** *Attempted*: Displays violations for deployment actions that were attempted but blocked by the evaluation of enforced policies. For example, the admission controller found that the attempted deployment action, such as a deployment create, update, or scale, would have triggered a violation. The admission controller enforcement then did not allow the operation to be admitted to the cluster.


Suggested change

** *Attempted*: Displays violations for deployment actions that were attempted but blocked by the evaluation of enforced policies. For example, the admission controller found that the attempted deployment action, such as a deployment create, update, or scale, would have triggered a violation. The admission controller enforcement then did not allow the operation to be admitted to the cluster.

** *Attempted*: Displays violations for deployment actions that were attempted but blocked by enforced policies. For example, if the admission controller detected that creating, updating, or scaling a deployment would trigger a violation, it prevents the operation from running in the cluster.

Feel free to disagree. :)

Good suggestion - am keeping the examples because I think there could be other actions that might trigger a violation other than these?

Agreed! I was thinking that all the actions were mentioned. If there are more actions then the examples can be kept.

openshift-ci · 2025-04-03T14:33:15Z

@kcarmichael08: 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.

kcarmichael08 · 2025-04-03T15:20:04Z

/cherrypick rhacs-docs-4.7

kcarmichael08 · 2025-04-03T15:20:14Z

/cherrypick rhacs-docs-4.8

openshift-cherrypick-robot · 2025-04-03T15:20:53Z

@kcarmichael08: new pull request created: #91591

In response to this:

/cherrypick rhacs-docs-4.7

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.

openshift-cherrypick-robot · 2025-04-03T15:21:00Z

@kcarmichael08: new pull request created: #91592

In response to this:

/cherrypick rhacs-docs-4.8

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.

openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 28, 2025

kcarmichael08 force-pushed the ROX-27693-violations-page-updates branch from c49fa08 to bfb37dc Compare April 2, 2025 13:42

clickboo reviewed Apr 2, 2025

View reviewed changes

clickboo approved these changes Apr 2, 2025

View reviewed changes

kcarmichael08 force-pushed the ROX-27693-violations-page-updates branch from bfb37dc to 1dc0457 Compare April 2, 2025 20:09

kcarmichael08 added RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.5 rhacs-docs-4.6 rhacs-docs-4.7 rhacs-docs-4.8 labels Apr 2, 2025

kcarmichael08 added this to the Continuous Release milestone Apr 2, 2025

kcarmichael08 added peer-review-needed Signifies that the peer review team needs to review this PR and removed rhacs-docs-4.5 rhacs-docs-4.6 labels Apr 2, 2025

openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 3, 2025

sr1kar99 reviewed Apr 3, 2025

View reviewed changes

snarayan-redhat added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Apr 3, 2025

Update violations page info

65b76d2

kcarmichael08 force-pushed the ROX-27693-violations-page-updates branch from 1dc0457 to 65b76d2 Compare April 3, 2025 14:26

kcarmichael08 merged commit aac19e7 into openshift:rhacs-docs-main Apr 3, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request Apr 3, 2025

[rhacs-docs-4.7] Update violations page info #91591

Merged

openshift-cherrypick-robot mentioned this pull request Apr 3, 2025

[rhacs-docs-4.8] Update violations page info #91592

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update violations page info #91288

Update violations page info #91288

kcarmichael08 commented Mar 28, 2025 •

edited

Loading

ocpdocs-previewbot commented Mar 28, 2025 •

edited

Loading

clickboo Apr 2, 2025

fduthilleul commented Apr 2, 2025

clickboo left a comment

sr1kar99 commented Apr 3, 2025

sr1kar99 left a comment

sr1kar99 Apr 3, 2025

sr1kar99 Apr 3, 2025

sr1kar99 Apr 3, 2025

snarayan-redhat Apr 3, 2025

sr1kar99 Apr 3, 2025

sr1kar99 Apr 3, 2025

sr1kar99 Apr 3, 2025

kcarmichael08 Apr 3, 2025

sr1kar99 Apr 3, 2025

openshift-ci bot commented Apr 3, 2025

kcarmichael08 commented Apr 3, 2025

kcarmichael08 commented Apr 3, 2025

openshift-cherrypick-robot commented Apr 3, 2025

openshift-cherrypick-robot commented Apr 3, 2025

	. Click the tab to view violations for the following categories:
	. Click one of the following tabs to view violations by category:

	** All violations: Displays violations for user workload and platform components, and audit log violations for cluster resources.
	** All violations: Displays violations for user workloads and the platform component. It also displays audit log violations for cluster resources.

	. To view different types of violations, click one of the following tabs:
	. Click one of the following tabs to view violations by type:

	*** Violations in all stages that were generated before a policy exclusion was added
	*** Violations that were generated before a policy exclusion was added

	. Optional: Choose the appropriate method to reorganize or filter information in the Violations page:
	. Optional: Choose a method to reorganize or filter information on the Violations page:

	** Attempted: Displays violations for deployment actions that were attempted but blocked by the evaluation of enforced policies. For example, the admission controller found that the attempted deployment action, such as a deployment create, update, or scale, would have triggered a violation. The admission controller enforcement then did not allow the operation to be admitted to the cluster.
	** Attempted: Displays violations for deployment actions that were attempted but blocked by enforced policies. For example, if the admission controller detected that creating, updating, or scaling a deployment would trigger a violation, it prevents the operation from running in the cluster.

Update violations page info #91288

Update violations page info #91288

Conversation

kcarmichael08 commented Mar 28, 2025 • edited Loading

ocpdocs-previewbot commented Mar 28, 2025 • edited Loading

Choose a reason for hiding this comment

fduthilleul commented Apr 2, 2025

clickboo left a comment

Choose a reason for hiding this comment

sr1kar99 commented Apr 3, 2025

sr1kar99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openshift-ci bot commented Apr 3, 2025

kcarmichael08 commented Apr 3, 2025

kcarmichael08 commented Apr 3, 2025

openshift-cherrypick-robot commented Apr 3, 2025

openshift-cherrypick-robot commented Apr 3, 2025

kcarmichael08 commented Mar 28, 2025 •

edited

Loading

ocpdocs-previewbot commented Mar 28, 2025 •

edited

Loading