-
Bug
-
Resolution: Unresolved
-
Undefined
-
None
-
OpenShift 4.17 Async, OpenShift 4.18 Async, OpenShift 4.20 Freeze, OpenShift 4.19 Async
-
False
-
-
False
-
-
-
Moderate
- A separate code block is required for commands in RHOL installation using CLI
- Here is the documentation link:
https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/logging/logging-6-1#log6x-installing-logging-operator_installing-logging-6-1
Here is the current look:
6. Assign the necessary permissions to the service account for the collector to be able to collect and forward logs. In this example, the collector is provided permissions to collect logs from both infrastructure and application logs.
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z logging-collector -n openshift-logging $ oc adm policy add-cluster-role-to-user collect-application-logs -z logging-collector -n openshift-logging $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z logging-collector -n openshift-logging
- As per the standard rule, using more than one command per code block is not recommended.
- Please check Standard rule [2] for reference: [2] https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#single-command-per-code-block
- When commands are bunched together, the copy to clipboard functionality might not break the lines up correctly. Using a single command per code block makes it copy-and-paste friendly.
- Hence, we need to mention 3 separate code blocks for above 3 commands.
- Here is the updated look of the documentation:
6. Assign the necessary permissions to the service account for the collector to be able to collect and forward logs. In this example, the collector is provided permissions to collect logs from both infrastructure and application logs.
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z logging-collector -n openshift-logging
$ oc adm policy add-cluster-role-to-user collect-application-logs -z logging-collector -n openshift-logging
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z logging-collector -n openshift-logging
I will raise a PR for this change and merge it.