-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
ROX-29040: Add info about devops and rhacs #95122
Conversation
@kcarmichael08: This pull request references ROX-29040 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. |
3b00419
to
4064416
Compare
🤖 Tue Jun 24 19:23:18 - Prow CI generated the docs preview: |
4064416
to
4361792
Compare
@kcarmichael08: This pull request references ROX-29040 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. |
4361792
to
dab87d9
Compare
@kcarmichael08: This pull request references ROX-29040 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. |
dab87d9
to
10a66d1
Compare
There was a problem hiding this 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. |
There was a problem hiding this comment.
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. 🤔
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". |
There was a problem hiding this comment.
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". |
There was a problem hiding this comment.
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.
10a66d1
to
9cb05c4
Compare
@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. |
/cherrypick rhacs-docs-4.8 |
@kcarmichael08: new pull request created: #95183 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 kubernetes-sigs/prow repository. |
Version(s):
4.8+
Issue
Link to docs preview:
QE review: ACS has no QE, approved by SME
Additional information: