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

Improve Helm Documentation

    XMLWordPrintable

Details

    • Page
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 2.2.0
    • 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

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

          Activity

            No work has yet been logged on this issue.

            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