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

Several mistakes in the quick start steps in the Logging 6.0 documentation

XMLWordPrintable

    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • OBSDOCS (Oct 21 - Nov 11) #258, OBSDOCS (Sep 30 - Oct 21) #261, OBSDOCS (Nov 11 - Dec 02) #259
    • Important

      https://docs.openshift.com/container-platform/4.16/observability/logging/logging-6.0/log6x-about.html#quick-start

       

      In the above documentation, several mistakes need to be fixed:

      1. In step 2, the indent of the `storageClassName` parameter should be on the same level as the `storage` parameter instead of under the `storage` parameter.

      2. In step 5, the command `$ oc project openshift-logging` should be run first in case the current namespace is not the `openshift-logging`.
      (Although it can also be done by adding the `-n openshift-logging` option, I suggest adding the command `$ oc project openshift-logging` so it is consistent between step 5 and step 8).

      3. In step 9, the indent of the `authentication` parameter should be under the `lokiStack` parameter instead of on the same level as the `lokiStack` parameter. (Note all parameters under the `authentication` parameter need to move backward together)

      And the following points are not mistakes, but suggestions to improve:

      4. In step 2, it might be better to add the instruction of creating the necessary secret too as this secret is mandatory for creating LokiStack CR.
      Refer to: https://docs.openshift.com/container-platform/4.16/observability/logging/log_storage/installing-log-storage.html#loki-create-object-storage-secret-console_installing-log-storage

      apiVersion: v1
      kind: Secret
      metadata:
        name: logging-loki-s3
        namespace: openshift-logging
      stringData:
        access_key_id: AKIAIOSFODNN7EXAMPLE
        access_key_secret: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
        bucketnames: s3-bucket-name
        endpoint: https://s3.eu-central-1.amazonaws.com
        region: eu-central-1

      5. In step 4, in my test environment, the `logging-collector-logs-writer` ClusterRole already exist and no need to create it manually, so it might be better to change the instruction to something like: `If the logging-collector-logs-writer ClusterRole does not exist, create the ClusterRole for the collector.` 

       

       

              Unassigned Unassigned
              rhn-support-yhe Yiyong He
              Votes:
              3 Vote for this issue
              Watchers:
              8 Start watching this issue

                Created:
                Updated: