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

Document Helm Better

    XMLWordPrintable

Details

    • Page
    • Status: Resolved
    • Major
    • Resolution: Duplicate
    • None
    • 2.2.0
    • documentation
    • None
    • 18: PE/Tasks/Docs
    • 1

    Description

      We need to document the values.yaml file better, people get confused about what does what and formats.

      We should point to the CouchbaseCluster CRD reference docs
      https://docs.couchbase.com/operator/current/reference-couchbasecluster.html

      wherever we can as it defines the types and also deep links into Kubernetes.
      It would be better if we have specific examples for Helm as we do for each K8s resources, if they are the same format and syntax, we should document so. For example, we should have documentation on how a customer would do backup on helm, or xdcr.

      Related to: k8s-1718

      Attachments

        Issue Links

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

          Activity

            It's true that this was opened first, but K8S-1991 has a more complete description of what's planned here.

            ingenthr Matt Ingenthron added a comment - It's true that this was opened first, but K8S-1991 has a more complete description of what's planned here.

            Matt Ingenthron Tommie McAfee since K8S-1991 has been pushed out of the 2.2 release, I'm re-opening this ticket to track the manual updates to the Helm chart documentation.

            eric.schneider Eric Schneider (Inactive) added a comment - Matt Ingenthron Tommie McAfee since K8S-1991 has been pushed out of the 2.2 release, I'm re-opening this ticket to track the manual updates to the Helm chart documentation.

            Reviewed in team meeting, everything in the description here is covered elsewhere and rolled up to K8S-2033

            ingenthr Matt Ingenthron added a comment - Reviewed in team meeting, everything in the description here is covered elsewhere and rolled up to K8S-2033

            People

              tommie Tommie McAfee
              tin.tran Tin Tran
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty