-
Notifications
You must be signed in to change notification settings - Fork 1.8k
[OBSDOCS-2680] Fix formatting in AWS logging configuration documentation #101346
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
base: standalone-logging-docs-main
Are you sure you want to change the base?
[OBSDOCS-2680] Fix formatting in AWS logging configuration documentation #101346
Conversation
backslash () is missing from AWS object storage secret creation command Here is the documentation link: https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/configuring_logging/configuring-lokistack-storage#logging-loki-storage-aws_configuring-the-log-store The backslash () must be set at the end of a line, as it is a line continuation character. Here is the current look: - Create an object storage secret with the name logging-loki-aws by running the following command: $ oc create secret generic logging-loki-aws \ 1 --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>" --from-literal=forcepathstyle="true" The backslash () is missing from line no. 6 As backslash is a line continuation character, so we need to add it to the command. So it will complete the command. Here is the updated look: - Create an object storage secret with the name logging-loki-aws by running the following command: ~~~ $ oc create secret generic logging-loki-aws \ 1 --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>" \ --from-literal=forcepathstyle="true" ~~~
|
🤖 Wed Oct 29 18:55:34 - Prow CI generated the docs preview: https://101346--ocpdocs-pr.netlify.app/ |
|
@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, |
|
/lgtm |
|
Hello QiaolingTang, Regards, |
|
/label merge-review-needed |
backslash () is missing from AWS object storage secret creation command
Here is the documentation link:
https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/configuring_logging/configuring-lokistack-storage#logging-loki-storage-aws_configuring-the-log-store
The backslash () must be set at the end of a line, as it is a line continuation character.
Here is the current look:
Here is the updated look:
Version(s):
Logging 6.4, Logging 6.3, Logging 6.2, Logging 6.1, Logging 6.0
Issue:
https://issues.redhat.com/browse/OBSDOCS-2680
Link to docs preview:
https://101346--ocpdocs-pr.netlify.app/
https://101346--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html
QE review:
Additional information: