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

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

    XMLWordPrintable

Details

    • 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

    Description

      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

      Attachments

        Issue Links

          is blocked by

          Sub-task - The sub-task of the issue OBSDOCS-220 [SPIKE] Break RHDEVDOCS-4781 issue into smaller issues

          • Critical - To be worked on immediately following BLOCKER issues.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. RHDEVDOCS-2755 [5.7 prereq] Create Logging API reference docs

          • Normal - To be worked after urgent and high priorities are resolved. This term is chosen when the severity of an issue is relatively close to the level of effort to fix it. The existence of an easily implemented workaround can also lead to this priority level instead of a higher priority.
          • Closed
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. OBSDOCS-138 Add the CLI instructions for installing Loki logging subsystem

          • Blocker - To be worked above all other priorities. This term is chosen when the severity of the issue is very high, has no workaround, or the effort for the change is comparatively low. Issues that may be very publicly visible and could generate significant media attention may also drive a higher priority.
          • Closed

          Bug - A problem that impairs or prevents the functions of the product. OBSDOCS-169 Not documented how to use nodeSelector/tolerations for Loki and Vector

          • Critical - To be worked on immediately following BLOCKER issues.
          • Closed

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. OBSDOCS-84 Loki Operator for on-cluster deployment and management

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          split to

          Bug - A problem that impairs or prevents the functions of the product. OBSDOCS-92 Steps for Configure Loki for Cloud providers except AWS

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          links to

          GitHub openshift/openshift-docs#59285: RHDEVDOCS-4781 - Loki

          GitHub openshift/openshift-docs#64610: OBSDOCS-138 - Child PR of RHDEVDOCS-4781 - Loki CLI install

          GitHub openshift/openshift-docs#64621: OBSDOCS-92 - Child PR of RHDEVDOCS-4781 - Loki Storage

          GitHub openshift/openshift-docs#65234: OBSDOCS-219 - Child PR - Loki GUI Install.

          GitHub openshift/openshift-docs#65235: OBSDOCS-219 - Child PR - Loki Queries

          GitHub openshift/openshift-docs#65891: [enterprise-4.13] OBSDOCS-219 - Child PR - Loki GUI Install.

          GitHub openshift/openshift-docs#65892: [enterprise-4.12] OBSDOCS-219 - Child PR - Loki GUI Install.

          GitHub openshift/openshift-docs#66172: Manual CP of OBSDOCS-219 to 4.11

          GitHub openshift/openshift-docs#67215: [enterprise-4.13] OBSDOCS-138 - Child PR of RHDEVDOCS-4781 - Loki CLI install

          GitHub openshift/openshift-docs#67696: OBSDOCS-219 - Formatting fix

          GitHub openshift/openshift-docs#68013: [enterprise-4.13] OBSDOCS-219 - Formatting fix - draft

          GitHub openshift/openshift-docs#68131: [enterprise-4.13] OBSDOCS-92 - Child PR of RHDEVDOCS-4781 - Loki Storage

          GitHub openshift/openshift-docs#68191: [Enterprise-4.15] manual CP of #67696 - OBSDOCS-219

          GitHub openshift/openshift-docs#68192: [Enterprise-4.14] manual CP of #67696 - OBSDOCS-219

          GitHub openshift/openshift-docs#68193: [Enterprise-4.12] - Manual CP of #67696 - OBSDOCS-219

          GitHub openshift/openshift-docs#68196: [Enterprise-4.11] manual CP of #67696 - OBSDOCS-219

          GitHub openshift/openshift-docs#68588: [enterprise-4.13] OBSDOCS-92 - Child PR of RHDEVDOCS-4781 - Loki Storage

          mentioned in

          Page Loading...

          Activity

            People

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

              Dates

                Created:
                Updated:
                Resolved: