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

Explain reason for being multitenant the Lokistack CR for openshift-logging

XMLWordPrintable

    • 5
    • False
    • Hide

      None

      Show
      None
    • True
    • OBSDOCS (Mar 25 - Apr 15) #251
    • Moderate

      URL

      Creating a LokiStack custom resource by using the web console

      DESCRIPTION

      At the same that one of the points reported in bug OBSDOCS-787, it's not given any explanation for setting the Lokistack CR as `multitenant` and why is needed when setting the Lokistack CR for `openshift-logging` as per documentation example:

      apiVersion: loki.grafana.com/v1
      kind: LokiStack
      metadata:
        name: logging-loki 
        namespace: openshift-logging
      spec:
        size: 1x.small 
        storage:
          schemas:
          - version: v12
            effectiveDate: '2022-06-01'
          secret:
            name: logging-loki-s3 
            type: s3 
        storageClassName: <storage_class_name> 
        tenants:   <------------------------ setting the tenant
          mode: openshift-logging
      

      As a new user arriving to the Loki information trying to understand how the Red Hat configurations given are and the meaning of them, the Lokistack documentation for `openshift-logging` is not explaining "why" is needed to use multitenant and/or even if the name `openshift-logging` is or not mandatory to be like it.

      This kind of sort explanations helps from the end user/sysadmin to have a better experience when going through the product documentation to set up the environment with better configuration/changes and understand better the errors when they appear.

      Even when in the upstream documentation explain this, a short explanation could be added to the OpenShift Logging documentation avoiding to go to a different website to understand it.

              abrennan@redhat.com Ashleigh Brennan
              rhn-support-ocasalsa Oscar Casal Sanchez
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: