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

[CEE.neXT] Adding sections and more clear documentation instructions for LokiStack

    • 13
    • False
    • False
    • Instructions
    • OBSDOCS (May 18-30) #236, OBSDOCS (May 30-June 20) #237, OBSDOCS (June 20-July 10) #238, OBSDOCS (July 10-31) #239, OBSDOCS (July 31-Aug 21) #240, OBSDOCS (Aug 21-Sep 11) #241, OBSDOCS (Sep 11 - Oct 2) #242, OBSDOCS (Oct 2 - Oct 23) #243, OBSDOCS (Oct 23 - Nov 13) #244, OBSDOCS (Nov 13 - Dev 4) #245, OBSDOCS (Dec 4 - Dev 25) #246, OBSDOCS (Jan 1 - Jan 22) #247, OBSDOCS (Jan 22 - Feb 12) #248, OBSDOCS (Feb 12 - Mar 4) #249, OBSDOCS (Mar 4 - Mar 25) #250

      Hello Team,

      I have a customer requesting the following to be added in the documentation.

      1) The steps should include Creation of ODF secret in the documentation as the product is native.
      2) Creating an object bucket claim hyperlink can also be added as a Prerequisite in the ODF section.
      3) Clear steps to encode the secret and add the values in the secret can be added.

      https://docs.openshift.com/container-platform/4.10//logging/cluster-logging-loki.html#logging-loki-deploy_cluster-logging-loki

      In Deploying the LokiStack we can add subsections for 5 supported storage types and add the clear instructions to complete the deployment.

      We can also add an output of what can be expected to be seen when we have Deployed LokiStack. An output oc get pods should help.

      The LokiStack provides a detailed Reason and Message we can add explanations of the messages and reason and solution in the documentation so that any issue during deployment can be SELF-SOLVED by the customer.

      https://github.com/openshift/loki/blob/main/operator/docs/operator/api.md

       

      Jamie's draft: https://github.com/jnewsome97/openshift-ops-workshops/blob/ocp4-dev/workshop/content/logging%202.0%20(with%20loki).adoc

          There are no Sub-Tasks for this issue.

            [OBSDOCS-219] [CEE.neXT] Adding sections and more clear documentation instructions for LokiStack

            landerso@redhat.com Can this be closed?

            Brian Dooley added a comment - landerso@redhat.com Can this be closed?

            PR for this is currently being broken into smaller parts.

            Brian Dooley added a comment - PR for this is currently being broken into smaller parts.

            Some QE feedback to be implemented. Hoping to close this soon.

            Brian Dooley added a comment - Some QE feedback to be implemented. Hoping to close this soon.

            landerso@redhat.com this one was in QE review in RHDEVDOCS but I didn't want to make assumptions re: your review sub tasks. If SME review is done, that task be closed. If QE review is still IP that task can be marked IP etc. LMK if you have questions. 

            Claire Bremble added a comment - landerso@redhat.com this one was in QE review in RHDEVDOCS but I didn't want to make assumptions re: your review sub tasks. If SME review is done, that task be closed. If QE review is still IP that task can be marked IP etc. LMK if you have questions. 

            Latha Sreenivasa Murthy added a comment - cbremble@redhat.com landerso@redhat.com Any update on this?

            When this issue is done, check to see if the requirements of RHDEVDOCS-4428 have also been met. 

            Claire Bremble added a comment - When this issue is done, check to see if the requirements of RHDEVDOCS-4428 have also been met. 

            Should be done after API ref docs are done. 

            Also, look into breaking this up into smaller issues. This should be looked into after API docs. landerso@redhat.com rkratky@redhat.com 

            Claire Bremble added a comment - Should be done after API ref docs are done.  Also, look into breaking this up into smaller issues. This should be looked into after API docs. landerso@redhat.com rkratky@redhat.com  

            Latha Sreenivasa Murthy added a comment - cbremble@redhat.com Thanks

            cbremble@redhat.com Assigning this back to you. Does this belongs to your team? 

            Latha Sreenivasa Murthy added a comment - cbremble@redhat.com Assigning this back to you. Does this belongs to your team? 

              landerso@redhat.com Libby Anderson
              rhn-support-ssadhale Saurabh Sadhale (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

                Created:
                Updated:
                Resolved: