Skip to content

Commit 4f3f0c9

Browse files
prithvipatil97xenolinux
authored andcommitted
Prerequisites are missing and editing steps from Update log6x-about.adoc
- Here is the link: https://docs.openshift.com/container-platform/4.16/observability/logging/logging-6.0/log6x-about.html#quick-start - Problems: - Quick Start indentation is wrong. - Prerequisites are missing. - Need to remove Step 6 and add it in Step 1 - Need to remove step 9 - We are performing the following changes through this PR: - Corrected Quick Start indentation, it should be in line with Validation. - Added required Prerequisites. - Removed Step 6 (Install the Cluster Observability Operator.) and added it under Step 1. - Removed Step 9, as it is a verification, not a Step. So, added it a Verification point. Prerequisites (1) are missing and editing steps from Update log6x-about.adoc Committing the suggested changes. - * Verify that logs are visible in the *Log* section of the *Observe* tab in the OpenShift web console. + * Verify that logs are visible in the *Log* section of the *Observe* tab in the {product-title} web console. Co-authored-by: Servesha Dudhgaonkar <49194531+xenolinux@users.noreply.github.com> (2) Prerequisites are missing and editing steps from Update log6x-about.adoc Committing the suggested changes in Peer Review - * You have administrator permissions. + * You have access to an {product-title} cluster with `cluster-admin` permissions. Co-authored-by: Servesha Dudhgaonkar <49194531+xenolinux@users.noreply.github.com>
1 parent 0c3c76e commit 4f3f0c9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

observability/logging/logging-6.0/log6x-about.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ The Cluster Logging Operator manages the deployment and configuration of the col
3434
== Validation
3535
Logging includes extensive validation rules and default values to ensure a smooth and error-free configuration experience. The `ClusterLogForwarder` resource enforces validation checks on required fields, dependencies between fields, and the format of input values. Default values are provided for certain fields, reducing the need for explicit configuration in common scenarios.
3636

37-
=== Quick Start
37+
== Quick Start
3838

3939
.Prerequisites
40-
* Cluster administrator permissions
40+
* You have access to an {product-title} cluster with `cluster-admin` permissions.
41+
* You installed the {oc-first}.
42+
* You have access to a supported object store. For example, AWS S3, Google Cloud Storage, {azure-short}, Swift, Minio, or {rh-storage}.
4143

4244
.Procedure
4345

44-
. Install the `OpenShift Logging` and `Loki` Operators from OperatorHub.
46+
. Install the `{clo}`, `{loki-op}`, and `{coo-first}` from OperatorHub.
4547

4648
. Create a secret to access an existing object storage bucket:
4749
+
@@ -95,8 +97,6 @@ $ oc create sa collector -n openshift-logging
9597
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging
9698
----
9799

98-
. Install the Cluster Observability Operator.
99-
100100
. Create a `UIPlugin` to enable the Log section in the Observe tab:
101101
+
102102
[source,yaml]
@@ -156,4 +156,5 @@ spec:
156156
- default-lokistack
157157
----
158158

159-
. Verify that logs are visible in the Log section of the Observe tab in the OpenShift web console.
159+
.Verification
160+
* Verify that logs are visible in the *Log* section of the *Observe* tab in the {product-title} web console.

0 commit comments

Comments
 (0)