-
Bug
-
Resolution: Unresolved
-
Normal
-
None
-
OpenShift 4.18 Async, OpenShift 4.19 Freeze, OpenShift 4.20 Async, OpenShift 4.21 Async
-
False
-
-
False
-
-
-
Moderate
- Amazon S3 with STS command structure needs to be corrected
- Here is the documentation link: https://docs.redhat.com/en/documentation/red_hat_openshift_cluster_observability_operator/1-latest/html/installing_red_hat_openshift_cluster_observability_operator/installing-end-to-end-observability-services#amazon-s3-with-secure-token-service-sts-short-lived
- Current documentation looks:
$ oc create secret generic storage-secret \ --from-literal=bucket="<BUCKET_NAME>" \ --from-literal=role_arn="<AWS_ROLE_ARN>" \ --from-literal=region="<AWS_REGION_YOUR_BUCKET_LIVES_IN>"
- In the above commands, the "- " signs are incorrectly placed below the "$" symbol.
- However, they should be aligned parallel to the "oc" command, where the command begins.
- Here is the updated look for all these commands:
$ oc create secret generic storage-secret \ --from-literal=bucket="<BUCKET_NAME>" \ --from-literal=role_arn="<AWS_ROLE_ARN>" \ --from-literal=region="<AWS_REGION_YOUR_BUCKET_LIVES_IN>"
- The commands will work as it is, but the structure is incorrect.
- It should be a standard format all over the documentation. Hence, it needs to be changed.
- I will raise a PR for this change and it get merged.
