From 21b8be63bd87a41d7d4d0990a2a9f8177e181d26 Mon Sep 17 00:00:00 2001 From: Prithviraj Patil <116709298+prithvipatil97@users.noreply.github.com> Date: Thu, 2 Jan 2025 22:12:32 +0530 Subject: [PATCH 1/2] Need to add one step in quick start procedure of About Logging 6.0 documentation - Need to add one step 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 - Before creating `LokiStack` custom resource (CR) in the openshift-logging namespace, it is necessary to create an object storage secret. - Without creating a secret we can not create `Lokistack` customer resource. - So it is required to add this step in our documentation. - Hence adding Step 2 in the documentation: ----------------- 2. Create a secret with the details to access to an existing object storage bucket. AWS is used in the following example: ~~~ $ oc create secret generic logging-loki-s3 \ --from-literal=bucketnames="" \ --from-literal=endpoint="" \ --from-literal=access_key_id="" \ --from-literal=access_key_secret="" \ --from-literal=region="" \ -n openshift-logging ~~~ ------------------ --- observability/logging/logging-6.0/log6x-about.adoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/observability/logging/logging-6.0/log6x-about.adoc b/observability/logging/logging-6.0/log6x-about.adoc index 50b0adb26a87..bacfd2e9d737 100644 --- a/observability/logging/logging-6.0/log6x-about.adoc +++ b/observability/logging/logging-6.0/log6x-about.adoc @@ -43,6 +43,19 @@ Logging includes extensive validation rules and default values to ensure a smoot . Install the `OpenShift Logging` and `Loki` Operators from OperatorHub. +. Create a secret with the details to access to an existing object storage bucket. AWS is used in the following example: ++ +[source,terminal,subs="+quotes"] +---- +$ oc create secret generic logging-loki-s3 \ + --from-literal=bucketnames="" \ + --from-literal=endpoint="" \ + --from-literal=access_key_id="" \ + --from-literal=access_key_secret="" \ + --from-literal=region="" \ + -n openshift-logging +---- + . Create a `LokiStack` custom resource (CR) in the `openshift-logging` namespace: + [source,yaml] From 4ace402ceaf8c12c35e9d0d0600fbef958ef5d6b Mon Sep 17 00:00:00 2001 From: Prithviraj Patil <116709298+prithvipatil97@users.noreply.github.com> Date: Tue, 7 Jan 2025 01:21:38 +0530 Subject: [PATCH 2/2] Update observability/logging/logging-6.0/log6x-about.adoc - Need to add one step 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 - Here Step 2 is mentioned as "Create a LokiStack custom resource (CR) in the openshift-logging namespace:" - But before creating `LokiStack` custom resource (CR), it is necessary to create an `object storage secret`. - Without creating a secret we can not create `Lokistack` customer resource. - We need to mention that `object storage secret` name in the `LokiStack custom resource (CR)` under `spec.storage.secret.name` section. - So it is required to add this step in our documentation. - Hence adding Step 2 in the documentation: ----------------- 2. Create a secret to access an existing object storage bucket: Example command for AWS ~~~ $ oc create secret generic logging-loki-s3 \ --from-literal=bucketnames="" \ --from-literal=endpoint="" \ --from-literal=access_key_id="" \ --from-literal=access_key_secret="" \ --from-literal=region="" \ -n openshift-logging ~~~ ------------------ Co-authored-by: Servesha Dudhgaonkar <49194531+xenolinux@users.noreply.github.com> --- observability/logging/logging-6.0/log6x-about.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/observability/logging/logging-6.0/log6x-about.adoc b/observability/logging/logging-6.0/log6x-about.adoc index bacfd2e9d737..ed0697721f19 100644 --- a/observability/logging/logging-6.0/log6x-about.adoc +++ b/observability/logging/logging-6.0/log6x-about.adoc @@ -43,8 +43,9 @@ Logging includes extensive validation rules and default values to ensure a smoot . Install the `OpenShift Logging` and `Loki` Operators from OperatorHub. -. Create a secret with the details to access to an existing object storage bucket. AWS is used in the following example: +. Create a secret to access an existing object storage bucket: + +.Example command for AWS [source,terminal,subs="+quotes"] ---- $ oc create secret generic logging-loki-s3 \