Uploaded image for project: 'Couchbase Kubernetes'
  1. Couchbase Kubernetes
  2. K8S-2033

Improve Helm Documentation

    XMLWordPrintable

Details

    • Page
    • Resolution: Fixed
    • Major
    • 2.2.0
    • None
    • documentation, helm
    • None
    • 16: Autoscaling/PE/Docs, 18: PE/Tasks/Docs, 20: PE/Docs/Cleanup
    • 1

    Description

      This ticket tracks documentation work for various Helm fit and finish improvements. (See linked tickets.)

      Documentation Plan

      Manage. Helm. Helm Deployment

      • Update page with necessary fixes to address linked tickets.

      Manage. Helm. Helm Management

      • Update page with necessary fixes to address linked tickets.

      Reference. Helm. Couchbase Helm Chart Specification

      Draft Documentation

      Manage. Helm. Helm Deployment

      • Added note to Customize the Installation section reminding users about how overrides work in Helm and some examples of overriding default keys in the Operator chart. (K8S-1965)

      Reference. Helm. Couchbase Helm Chart Specification

      • Added auto-generated table that lists all of the fields that are currently in the Helm chart values file, as well as the descriptions of those fields from the various CRDs (K8S-1991)
      • Added note in the introduction that clarifies that the Helm chart should only be used with EE products (K8S-1363)
      • Updated Buckets section to add information describing the default bucket and how to override it (several linked tickets requesting this)

       

      Attachments

        Issue Links

          is duplicated by

          Page - A new page either standalone or within a series of pages must be added K8S-1933 Document Helm Better

          • Major - Major loss of function.
          • Resolved
          relates to

          Improvement - An improvement or enhancement to an existing feature or task. K8S-1547 Need Ability to override bucket name with Helm Charts Template with AO 2.0.1

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. K8S-1734 Add NodeSelector to DAC helm specification

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. K8S-1894 Add "couchbase-operator" service to Helm template

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Page - A new page either standalone or within a series of pages must be added K8S-1932 Ephemeral bucket is not supported with helm

          • Major - Major loss of function.
          • Resolved

          Page - A new page either standalone or within a series of pages must be added K8S-1933 Document Helm Better

          • Major - Major loss of function.
          • Resolved

          Page - A new page either standalone or within a series of pages must be added K8S-1363 Update Helm Compatibility Information

          • Major - Major loss of function.
          • Closed

          Page - A new page either standalone or within a series of pages must be added K8S-1915 Documentation for removing default bucket in Helm

          • Major - Major loss of function.
          • Closed

          Page - A new page either standalone or within a series of pages must be added K8S-1955 Document Helm 2.1 upgrade process with tls.generate=true

          • Major - Major loss of function.
          • Closed

          Page - A new page either standalone or within a series of pages must be added K8S-1965 set default config to null in Helm

          • Major - Major loss of function.
          • Closed

          Page - A new page either standalone or within a series of pages must be added K8S-2120 Document all optional attributes for Helm

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. K8S-1749 Couchbase Helm Chart specification should support all Operator functionalities

          • Critical - Crashes, loss of data, severe memory leak.
          • Closed

          Page - A new page either standalone or within a series of pages must be added K8S-1991 Helm Doc Auto-generation PART 1: The Beginning

          • Major - Major loss of function.
          • Closed
          mentioned in

          Page Loading...

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              arunkumar Arunkumar Senthilnathan (Inactive)
              eric.schneider Eric Schneider (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty