Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-3166

Amazon S3 / MinIO command code block structure issue

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • Moderate

      Current documentation looks:

      Use the following command to create the secret containing the access key:

      $ oc create secret generic minio-secret \
      --from-literal=access_key_secret="supersecret" 

      2.2.2.1. Secret supported by Tempo and Loki operators

      $ oc create secret generic storage-secret \
          --from-literal=bucket="<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_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: 
        Use the following command to create the secret containing the access key:
        $ oc create secret generic minio-secret \
          --from-literal=access_key_secret="supersecret"

        2.2.2.1. Secret supported by Tempo and Loki operators

        $ oc create secret generic storage-secret \
          --from-literal=bucket="<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_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.

              Unassigned Unassigned
              rhn-support-pripatil Prithviraj Patil
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: