[OBSDOCS-2678] Clarify prerequisites Quick start with OpenTelemetry #101389
Conversation
We need to perform the changes in Procedures 1, 4, and 5
1. Prerequisites section is incomplete.
2. Operators names are not highlighted in Procedure 1.
3. Project name has not been added to the command mentioned in Procedure 4.
4. Remove the command `$ oc project openshift-logging` from Procedure 5 and add the project name in the remaining command.
Below is the updated look of the documentation:
Prerequisites
You have access to an {ocp-product-title} cluster with cluster-admin permissions.
You installed the {oc-first}.
You have access to a supported object store. For example, AWS S3, Google Cloud Storage, {azure-short}, Swift, Minio, or {rh-storage}.
1. Install the `Red Hat OpenShift Logging Operator`, `Loki Operator`, and `Cluster Observability Operator (COO)` from OperatorHub.
4. Allow the collector's service account to write data to the LokiStack CR:
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging
5. Allow the collector's service account to collect logs:
$ 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
bot
added
the
size/S
|
🤖 Wed Oct 29 22:08:05 - Prow CI generated the docs preview: https://101389--ocpdocs-pr.netlify.app/openshift-logging/latest/about/quick-start.html |
|
@prithvipatil97: 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. |
|
Hello Team, All checks have passed, and I have reviewed the PR with the peer review checklist. @anpingli , @QiaolingTang , it would be really helpful if someone could please take a look and provide QE approval for this change. Thanks in advance. Regards, |
| . Install the {clo}, {loki-op}, and {coo-first} from OperatorHub. | ||
| . Install the `{clo}`, `{loki-op}`, and `{coo-first}` from OperatorHub. | ||
|
|
||
| . Create a `LokiStack` custom resource (CR) in the `openshift-logging` namespace: |
There was a problem hiding this comment.
Can we see "here is an example using AWS s3 object store"?
There was a problem hiding this comment.
the storage.schemas.verison must be v13.
| $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector | ||
| $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging | ||
| ---- | ||
| + |
There was a problem hiding this comment.
How about move (Create a UIPlugin CR to enable the Log section in the Observe tab) after line 45.
The UIPlugin display logs from lokistack, it doesn't care about if ClusterLogForwarder is running or not.
3 participants
https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/about_openshift_logging/quick-start#quick-start-opentelemetry_quick-start
We need to perform the changes in Procedures 1, 4, and 5
$ oc project openshift-loggingfrom Procedure 5 and add the project name in the remaining command.Below is the updated look of the documentation:
Prerequisites
Install the
Red Hat OpenShift Logging Operator,Loki Operator, andCluster Observability Operator (COO)from OperatorHub.Allow the collector's service account to write data to the LokiStack CR:
Version(s):
Logging 6.4, Logging 6.3, Logging 6.2, Logging 6.1, Logging 6.0
Issue:
https://issues.redhat.com/browse/OBSDOCS-2678
Link to docs preview:
https://101389--ocpdocs-pr.netlify.app/openshift-logging/latest/about/quick-start.html
QE review:
Additional information: