Skip to content

Conversation

@jc-berger
Copy link
Contributor

@jc-berger jc-berger commented Jan 12, 2026

Version(s):

4.20+

Issue:
https://issues.redhat.com/browse/OSDOCS-12691

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 12, 2026
@openshift-ci
Copy link

openshift-ci bot commented Jan 12, 2026

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

. 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]
Copy link
Contributor Author

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.
Copy link
Contributor Author

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

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.

@kalexand-rh
Copy link
Contributor

/ok-to-test

@openshift-ci openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 12, 2026
@jc-berger jc-berger force-pushed the jcberger-rosa-logforwarder-12691 branch from de429f0 to d374974 Compare January 13, 2026 17:21
@openshift-ci
Copy link

openshift-ci bot commented Jan 13, 2026

@jc-berger: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-asciidoc 72ba3ea link true /test validate-asciidoc
ci/prow/validate-portal 72ba3ea link true /test validate-portal

Full PR test history. Your PR dashboard.

Details

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.

@jc-berger
Copy link
Contributor Author

Hi please see this PR which includes the doc preview link: #104758

@jc-berger jc-berger closed this Jan 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants