-
Notifications
You must be signed in to change notification settings - Fork 1.9k
add new rosa cli log forwarder assembly #104653
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
add new rosa cli log forwarder assembly #104653
Conversation
|
Hi @jc-berger. Thanks for your PR. I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
| . Enable the log forwarder to send logs to your ROSA cluster. | ||
| .. To create a new ROSA cluster for the log forwarder, run the following command: | ||
| + | ||
| [source,terminal] |
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.
@bhardesty I'm used to writing commands as [oc, bash]
Looking at the other modules in the ROSA security assemblies, I see they follow the [source, terminal] structure. Maybe because we're using ROSA CLI commands?
Anyway, please let me know what you think is the best way to document command for consistency.
| $ rosa create log-forwarder -c <cluster> --log-fwd-config="path/to/file.yaml" | ||
| ---- | ||
| + | ||
| . Configure your ROSA cluster to access logs from your chosen bucket. |
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.
@bhardesty I was looking at the attributes and saw the {rosa-short} was rendered as "Rosa with HCP"
Looking at other ROSA docs, I see that we'll sometimes simply write out the acronym, ROSA, so for a command, I thought to be more concise. let me know if we're adamant about always using a prod-name a certain way.
| // * security/rosa-configuring-the-log-forwarder.adoc | ||
| :_mod-docs-content-type: REFERENCE | ||
| [id="rosa-reference-cli-commands.adoc_{context}"] | ||
| = ROSA reference CLI commands |
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.
@bhardesty as a standard practice, does ROSA keep IDs to match the title perfectly?
Since this is a reference doc, I thought of naming it simply, ROSA CLI commands but isntead made it match the ID and made the ID match the naming conventions of other ROSA modules.
|
/ok-to-test |
de429f0 to
d374974
Compare
Co-authored-by: Sean Malloy <[email protected]>
Co-authored-by: Sean Malloy <[email protected]>
Co-authored-by: Sean Malloy <[email protected]>
Co-authored-by: Sean Malloy <[email protected]>
Co-authored-by: Sean Malloy <[email protected]>
|
@jc-berger: The following tests failed, say
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. |
|
Hi please see this PR which includes the doc preview link: #104758 |
Version(s):
4.20+Issue:
https://issues.redhat.com/browse/OSDOCS-12691
Link to docs preview:
QE review:
Additional information: