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

            eric.schneider Eric Schneider (Inactive) created issue -
            eric.schneider Eric Schneider (Inactive) made changes -
            Field Original Value New Value
            Link This issue relates to K8S-1749 [ K8S-1749 ]
            simon.murray Simon Murray made changes -
            Rank Ranked higher
            eric.schneider Eric Schneider (Inactive) made changes -
            Labels candidate-for-cao-2.2
            lynn.straus Lynn Straus made changes -
            Remote Link This issue links to "Page (Couchbase, Inc. Wiki)" [ 21673 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Labels candidate-for-cao-2.2
            ingenthr Matt Ingenthron made changes -
            Sprint 16: Documentation [ 1503 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1991 [ K8S-1991 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1955 [ K8S-1955 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1965 [ K8S-1965 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1915 [ K8S-1915 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1734 [ K8S-1734 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1932 [ K8S-1932 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1933 [ K8S-1933 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Description This ticket tracks documentation work for various Helm fit and finish improvements. (See linked tickets.) This ticket tracks documentation work for various Helm fit and finish improvements. (See linked tickets.)
            h1. Draft Documentation

             
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1363 [ K8S-1363 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1991 [ K8S-1991 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Description This ticket tracks documentation work for various Helm fit and finish improvements. (See linked tickets.)
            h1. Draft Documentation

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

             
            eric.schneider Eric Schneider (Inactive) made changes -
            Description This ticket tracks documentation work for various Helm fit and finish improvements. (See linked tickets.)

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

             
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1547 [ K8S-1547 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1894 [ K8S-1894 ]
            ingenthr Matt Ingenthron made changes -
            Sprint 16: Autoscaling/PE/Docs [ 1503 ] 16: Autoscaling/PE/Docs, 18: PE/Tasks/Docs [ 1503, 1563 ]
            patrick.stephens Patrick Stephens (Inactive) made changes -
            Link This issue relates to K8S-2120 [ K8S-2120 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Description This ticket tracks documentation work for various Helm fit and finish improvements. (See linked tickets.)
            h1. Draft Documentation

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

            [*Manage. Helm.* *_Helm Deployment_*|https://docs-staging.couchbase.com/operator/current/helm-setup-guide.html]
             * Update page with necessary fixes to address linked tickets.

            [*Manage. Helm.* *_Helm Management_*|https://docs-staging.couchbase.com/operator/current/helm-managing-guide.html]
             * Update page with necessary fixes to address linked tickets.

            [*Reference. Helm.* *_Couchbase Helm Chart Specification_*|https://docs-staging.couchbase.com/operator/current/helm-couchbase-config.html]
             * Update Helm chart using new prototype auto-generated field descriptions: [https://gist.github.com/tahmmee/3c48001cec378e497a8bed216996a4bf]
             * Update page with necessary fixes to address linked tickets.

             
            ingenthr Matt Ingenthron made changes -
            Link This issue is duplicated by K8S-1933 [ K8S-1933 ]
            simon.murray Simon Murray made changes -
            Sprint 16: Autoscaling/PE/Docs, 18: PE/Tasks/Docs [ 1503, 1563 ] 16: Autoscaling/PE/Docs, 18: PE/Tasks/Docs, 20: PE/Docs/Cleanup [ 1503, 1563, 1595 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1991 [ K8S-1991 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Description This ticket tracks documentation work for various Helm fit and finish improvements. (See linked tickets.)
            h1. Documentation Plan

            [*Manage. Helm.* *_Helm Deployment_*|https://docs-staging.couchbase.com/operator/current/helm-setup-guide.html]
             * Update page with necessary fixes to address linked tickets.

            [*Manage. Helm.* *_Helm Management_*|https://docs-staging.couchbase.com/operator/current/helm-managing-guide.html]
             * Update page with necessary fixes to address linked tickets.

            [*Reference. Helm.* *_Couchbase Helm Chart Specification_*|https://docs-staging.couchbase.com/operator/current/helm-couchbase-config.html]
             * Update Helm chart using new prototype auto-generated field descriptions: [https://gist.github.com/tahmmee/3c48001cec378e497a8bed216996a4bf]
             * Update page with necessary fixes to address linked tickets.

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

            -[*Manage. Helm.* *_Helm Deployment_*|https://docs-staging.couchbase.com/operator/current/helm-setup-guide.html]-
             * -Update page with necessary fixes to address linked tickets.-

            -[*Manage. Helm.* *_Helm Management_*|https://docs-staging.couchbase.com/operator/current/helm-managing-guide.html]-
             * -Update page with necessary fixes to address linked tickets.-

            -[*Reference. Helm.* *_Couchbase Helm Chart Specification_*|https://docs-staging.couchbase.com/operator/current/helm-couchbase-config.html]-
             * -Update Helm chart using new prototype auto-generated field descriptions: [https://gist.github.com/tahmmee/3c48001cec378e497a8bed216996a4bf]-
             * -Update page with necessary fixes to address linked tickets.-

            h1. Draft Documentation

            [*Manage. Helm.* *_Helm Deployment_*|https://docs-staging.couchbase.com/operator/current/helm-setup-guide.html]
             * Added note to [Customize the Installation|https://docs-staging.couchbase.com/operator/current/helm-setup-guide.html#custom-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_*|https://docs-staging.couchbase.com/operator/current/helm-couchbase-config.html]
             * Added auto-generated [table|https://docs-staging.couchbase.com/operator/current/helm-couchbase-config.html#table-helm-chart-values] that lists all of the fields that are currently in the Helm chart [values file|https://github.com/couchbase-partners/helm-charts/blob/master/couchbase-operator/values.yaml], 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|https://docs-staging.couchbase.com/operator/current/helm-couchbase-config.html#buckets] section to add information describing the default bucket and how to override it (several linked tickets requesting this)

             
            eric.schneider Eric Schneider (Inactive) made changes -
            Assignee Eric Schneider [ eric.schneider ] Arunkumar Senthilnathan [ arunkumar ]
            Resolution Fixed [ 1 ]
            Status In Progress [ 3 ] Resolved [ 5 ]
            arunkumar Arunkumar Senthilnathan made changes -
            Status Resolved [ 5 ] Closed [ 6 ]
            lynn.straus Lynn Straus made changes -
            Remote Link This issue links to "Page (Couchbase, Inc. Wiki)" [ 22746 ]
            lynn.straus Lynn Straus made changes -
            Remote Link This issue links to "Page (Couchbase, Inc. Wiki)" [ 21673 ]

            People

              arunkumar Arunkumar Senthilnathan
              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