Skip to content

Commit dbb1dfa

Browse files
prithvipatil97agantony
authored andcommitted
Update log6x-quickstart-opentelemetry.adoc
- Here is the link: https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/logging/logging-6-1#quick-start-opentelemetry_logging-6x-6.1 - Problems: - Prerequisites are missing. - Operators names are not highlighted. - Step 4, namespace name is missing from the command - Step 5, namespace name is missing from the command - We are performing the following changes through this PR: - Added required Prerequisites. - Highlighted the Operator's names in Step 1. - Namespace name is added in the Step 4 - Removed $ oc project openshift-logging, and added namespace in the remaining 3 commands. 1-Update modules/log6x-quickstart-opentelemetry.adoc 16 - * You installed the {oc-first}. 16 + * You have installed the {oc-first}. Co-authored-by: Agil Antony <61876435+agantony@users.noreply.github.com> 2- Update modules/log6x-quickstart-opentelemetry.adoc - * Verify that OTLP is functioning correctly by going to *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes* in the OpenShift web console, and checking *Distributor - Structured Metadata*. + * To verify that OTLP is functioning correctly, complete the following steps: + .. In the OpenShift web console, click *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes*. + .. Check the *Distributor - Structured Metadata* section. Co-authored-by: Agil Antony <61876435+agantony@users.noreply.github.com>
1 parent f20e451 commit dbb1dfa

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

modules/log6x-quickstart-opentelemetry.adoc

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ include::snippets/technology-preview.adoc[]
1212
To configure OTLP ingestion and enable the OpenTelemetry data model, follow these steps:
1313

1414
.Prerequisites
15-
* Cluster administrator permissions
15+
* You have access to an {product-title} cluster with `cluster-admin` permissions.
16+
* You have installed the {oc-first}.
17+
* You have access to a supported object store. For example, AWS S3, Google Cloud Storage, {azure-short}, Swift, Minio, or {rh-storage}.
1618
1719
.Procedure
1820

19-
. Install the {clo}, {loki-op}, and {coo-first} from OperatorHub.
21+
. Install the `{clo}`, `{loki-op}`, and `{coo-first}` from OperatorHub.
2022

2123
. Create a `LokiStack` custom resource (CR) in the `openshift-logging` namespace:
2224
+
@@ -58,34 +60,29 @@ $ oc create sa collector -n openshift-logging
5860
+
5961
[source,terminal]
6062
----
61-
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector
63+
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging
6264
----
6365
+
6466
[NOTE]
6567
====
6668
The `ClusterRole` resource is created automatically during the Cluster Logging Operator installation and does not need to be created manually.
6769
====
6870

69-
. Allow the collector's service account to collect logs:
71+
. To collect logs, use the service account of the collector by running the following commands:
7072
+
7173
[source,terminal]
7274
----
73-
$ oc project openshift-logging
75+
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector -n openshift-logging
7476
----
7577
+
7678
[source,terminal]
7779
----
78-
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector
80+
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector -n openshift-logging
7981
----
8082
+
8183
[source,terminal]
8284
----
83-
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector
84-
----
85-
+
86-
[source,terminal]
87-
----
88-
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector
85+
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging
8986
----
9087
+
9188
[NOTE]
@@ -155,4 +152,6 @@ You cannot use `lokiStack.labelKeys` when `dataModel` is `Otel`. To achieve simi
155152
====
156153

157154
.Verification
158-
* Verify that OTLP is functioning correctly by going to *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes* in the OpenShift web console, and checking *Distributor - Structured Metadata*.
155+
* To verify that OTLP is functioning correctly, complete the following steps:
156+
.. In the OpenShift web console, click *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes*.
157+
.. Check the *Distributor - Structured Metadata* section.

0 commit comments

Comments
 (0)