Skip to content

Conversation

@openshift-cherrypick-robot

This is an automated cherry-pick of #87028

/assign xenolinux

- Need to edit 2 steps in the Quick Start point of About Logging 6.0 documentation.
- Here is the documentation link: https://docs.openshift.com/container-platform/4.17/observability/logging/logging-6.0/log6x-about.html#quick-start
- This is the last and important change in the Quick start process.
- In step 5 and step 8 changes are required:
----
5. Bind the ClusterRole to the service account:
~~~
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector
~~~

8. Add additional roles to the collector service account:
~~~
$ oc project openshift-logging
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector
~~~
----

- In these steps, commands are properly mentioned.
- However, the project name is not mentioned in the commands.
- So we need to mention project name in the above commands.

Reason:
1. If for any reason the user has changed the namespace in the middle, then, it will create the resource in the wrong namespace.
2. If the credentials are shared, and two people using the same cluster at the same time, then, the second person could change to work in a different namespace.

- Hence we need to explicitly mention the `-n openshift-logging` in the above commands.
- Here are the new required changes:
----
5. Bind the ClusterRole to the service account:
~~~
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging
~~~

8. Add additional roles to the collector service account:
~~~
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector -n openshift-logging
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector -n openshift-logging
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging
~~~
----
@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 16, 2025
@openshift-ci
Copy link

openshift-ci bot commented Jan 16, 2025

@openshift-cherrypick-robot: 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.

@xenolinux xenolinux merged commit e21283c into openshift:enterprise-4.17 Jan 16, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants