Skip to content

ROX-29040: Add info about devops and rhacs #95122

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.

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

Merged

Conversation

kcarmichael08
Copy link
Contributor

@kcarmichael08 kcarmichael08 commented Jun 23, 2025

Version(s):
4.8+

Issue

Link to docs preview:

QE review: ACS has no QE, approved by SME

  • QE has approved this change.

Additional information:

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 23, 2025

@kcarmichael08: This pull request references ROX-29040 which is a valid jira issue.

In response to this:

Version(s):
4.8+

Issue

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 23, 2025
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 23, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jun 23, 2025

🤖 Tue Jun 24 19:23:18 - Prow CI generated the docs preview:

https://95122--ocpdocs-pr.netlify.app/openshift-acs/latest/integration/integrate-with-ci-systems.html

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jun 23, 2025

@kcarmichael08: This pull request references ROX-29040 which is a valid jira issue.

In response to this:

Version(s):
4.8+

Issue

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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
Copy link

openshift-ci-robot commented Jun 24, 2025

@kcarmichael08: This pull request references ROX-29040 which is a valid jira issue.

In response to this:

Version(s):
4.8+

Issue

Link to docs preview:

QE review: ACS has no QE, approved by SME

  • QE has approved this change.

Additional information:

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.

@kcarmichael08 kcarmichael08 added RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.8 peer-review-needed Signifies that the peer review team needs to review this PR labels Jun 24, 2025
@kcarmichael08 kcarmichael08 added this to the Continuous Release milestone Jun 24, 2025
@michaelryanpeter michaelryanpeter added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Jun 24, 2025
Copy link
Contributor

@michaelryanpeter michaelryanpeter left a comment

Choose a reason for hiding this comment

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

I left a few micro-opinions. I'm not even sure they rise to the level of "nits".

Solid writing.

LGTM.
/label peer-review-done
/remove-label peer-review-needed
/remove-label peer-review-in-progress

[id="configuration-using-devops_{context}"]
= Configuration using DevOps

You can use {product-title-short} with your DevOps system to configure authentication and authorization resources, such as authentication providers, roles, permission sets, notifiers, and access scopes.
Copy link
Contributor

Choose a reason for hiding this comment

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

mild suggestion:
A list would be more scannable for the reader, but the lead-in sentence to the list gets tricky. 🤔

Suggested change
You can use {product-title-short} with your DevOps system to configure authentication and authorization resources, such as authentication providers, roles, permission sets, notifiers, and access scopes.
You can use {product-title-short} with your DevOps system to configure authentication and authorization resources, including the following examples:
* Authentication providers
* Roles...

I don't love that idea, but I hope it paints a picture.

I wish we had better guidance for how to introduce non-exhaustive lists. Anyhow, no need to follow me into the briar patch. Just a thought.


To use DevOps to configure these parameters, you create YAML files that contain configuration information. These files are used to create a config map that is added to {product-title-short} by using a mount point during installation of the {product-title-short} Central resource.

For more information, see "Using declarative configuration".
Copy link
Contributor

Choose a reason for hiding this comment

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

Think that this section is short, and the Additional resources section is pretty self-explanatory. You could cut this as fluff.


Additionally, you can use your DevOps system to configure and manage security policies by using the "policy as code" feature. You can author policies in YAML or JSON and save them as Kubernetes custom resources (CRs). Then, you use your DevOps system to track, manage, and apply policies to your clusters that are running {product-title-short}. A Kubernetes controller in {product-title-short} uses the API to receive information about new, updated, or deleted policies and reconciles the policy changes.

For more information, see "Managing policies as code".
Copy link
Contributor

@michaelryanpeter michaelryanpeter Jun 24, 2025

Choose a reason for hiding this comment

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

Same as above. I think the strength of your writing clearly leads the reader to the additional resources and that this sentence is not required here. That said, in both instances, feel free to do what you feel is best.

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jun 24, 2025
Copy link

openshift-ci bot commented Jun 24, 2025

@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 kcarmichael08 merged commit df30c7f into openshift:rhacs-docs-main Jun 24, 2025
2 checks passed
@kcarmichael08
Copy link
Contributor Author

/cherrypick rhacs-docs-4.8

@openshift-cherrypick-robot

@kcarmichael08: new pull request created: #95183

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.8 size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants