Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need to add one step in quick start procedure of About Logging 6.0 documentation #86648

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

prithvipatil97
Copy link
Contributor

@prithvipatil97 prithvipatil97 commented Jan 2, 2025

  • 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:

  1. 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="<bucket_name>" \
  --from-literal=endpoint="<aws_bucket_endpoint>" \
  --from-literal=access_key_id="<aws_access_key_id>" \
  --from-literal=access_key_secret="<aws_access_key_secret>" \
  --from-literal=region="<aws_region_of_your_bucket>" \
  -n openshift-logging

Version(s):

RHOCP-4.18, RHOCP-4.17, RHOCP-4.16, RHOCP-4.15, RHOCP-4.14

Issue:

https://issues.redhat.com/browse/OBSDOCS-1346

Link to docs preview:

https://86648--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-about.html

QE review:

  • QE has approved this change.

Additional information:

…cumentation

- 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="<bucket_name>" \
  --from-literal=endpoint="<aws_bucket_endpoint>" \
  --from-literal=access_key_id="<aws_access_key_id>" \
  --from-literal=access_key_secret="<aws_access_key_secret>" \
  --from-literal=region="<aws_region_of_your_bucket>" \
  -n openshift-logging
~~~
------------------
@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 2, 2025
@ocpdocs-previewbot
Copy link

🤖 Thu Jan 02 16:58:16 - Prow CI generated the docs preview:

https://86648--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-about.html

Copy link

openshift-ci bot commented Jan 2, 2025

@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.

@prithvipatil97
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jan 2, 2025
@xenolinux xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jan 2, 2025
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A tiny nit; otherwise LGTM

Gentle reminder for QE review.

Comment on lines +46 to +47
. Create a secret with the details to access to an existing object storage bucket. AWS is used in the following example:
+
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. 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

@xenolinux xenolinux added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer-review-done Signifies that the peer review team has reviewed this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants