Skip to content

OCPBUGS-48234: added an xref to PriorityClass creation #91045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OCPBUGS-48234: added an xref to PriorityClass creation #91045

wants to merge 1 commit into from

Conversation

sheriff-rh
Copy link
Contributor

@sheriff-rh sheriff-rh commented Mar 25, 2025 •
edited
Loading

Version(s):
4.12+

Issue:
https://issues.redhat.com/browse/OCPBUGS-48234

Link to docs preview:
Setting PriorityClass for ScanSetting scans

QE review:

  • QE has approved this change.

Additional information:
None

@sheriff-rh sheriff-rh added this to the Continuous Release milestone Mar 25, 2025
@sheriff-rh sheriff-rh self-assigned this Mar 25, 2025
@openshift-ci-robot openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Mar 25, 2025
@openshift-ci-robot
Copy link

@sheriff-rh: This pull request references Jira Issue OCPBUGS-48234, which is invalid:

  • expected the bug to target the "4.19.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Version(s):
4.12+

Issue:
https://issues.redhat.com/browse/OCPBUGS-48234

Link to docs preview:
In progress

QE review:

  • QE has approved this change.

Additional information:
None

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 openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 25, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Mar 25, 2025 •
edited
Loading

🤖 Tue Mar 25 15:02:20 - Prow CI generated the docs preview:

https://91045--ocpdocs-pr.netlify.app/openshift-enterprise/latest/security/compliance_operator/co-scans/compliance-operator-advanced.html

@openshift-ci openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 25, 2025
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Mar 25, 2025
View reviewed changes
security/compliance_operator/co-scans/compliance-operator-advanced.adoc
@@ -27,4 +32,4 @@ include::modules/compliance-custom-scc.adoc[leveloffset=+1]
[id="additional-resources_compliance-operator-advanced"]
[role="_additional-resources"]
== Additional resources
* xref:../../../authentication/managing-security-context-constraints.adoc[Managing security context constraints]
* xref:../../../authentication/managing-security-context-constraints.adoc[Managing security context constraints]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.XrefContainsAnchorID: The xref is missing an anchor ID.

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Mar 25, 2025

@sheriff-rh: 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.

@openshift-ci-robot
Copy link

@sheriff-rh: This pull request references Jira Issue OCPBUGS-48234, which is invalid:

  • expected the bug to target the "4.19.0" version, but no target version was set
  • expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is ON_QA instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

Version(s):
4.12+

Issue:
https://issues.redhat.com/browse/OCPBUGS-48234

Link to docs preview:
Setting PriorityClass for ScanSetting scans

QE review:

  • QE has approved this change.

Additional information:
None

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.

rhmdnd
rhmdnd reviewed Apr 17, 2025
View reviewed changes
modules/compliance-priorityclass.adoc
@@ -8,6 +8,10 @@

In large scale environments, the default `PriorityClass` object can be too low to guarantee Pods execute scans on time. For clusters that must maintain compliance or guarantee automated scanning, it is recommended to set the `PriorityClass` variable to ensure the Compliance Operator is always given priority in resource constrained situations.

.Prerequisites

* Optional: Create a `PriorityClass` object. See _Configuring priority and preemption_ in the _Additional Resources_ section for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels like a naive question, but is there a way to link directly? Or is that against convention?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sadly, that is against convention at this time. Long story short, linking from modules breaks the docs build or the webpage or both.

rhmdnd
rhmdnd approved these changes Apr 17, 2025
View reviewed changes
Copy link
Contributor

@rhmdnd rhmdnd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Just one question to satisfy my own curiosity.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 17, 2025
@sheriff-rh
Copy link
Contributor Author

Ready for your review @xiaojiey, thank you.

@xiaojiey
Copy link

/label qe-approved

@openshift-ci openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Apr 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments

@rhmdnd rhmdnd rhmdnd approved these changes

@xiaojiey xiaojiey Awaiting requested review from xiaojiey

@BhargaviGudi BhargaviGudi Awaiting requested review from BhargaviGudi

Assignees

@sheriff-rh sheriff-rh

@rhmdnd rhmdnd

Labels
branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 branch/enterprise-4.17 branch/enterprise-4.18 branch/enterprise-4.19 jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. qe-approved Signifies that QE has signed off on this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
Continuous Release
Development

Successfully merging this pull request may close these issues.
6 participants
@sheriff-rh @openshift-ci-robot @ocpdocs-previewbot @xiaojiey @rhmdnd @ocpdocs-vale-bot