You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by fl...@apache.org on 2020/09/21 13:34:44 UTC

[couchdb-helm] 03/03: Update documentation

This is an automated email from the ASF dual-hosted git repository.

flimzy pushed a commit to branch clusterSetup
in repository https://gitbox.apache.org/repos/asf/couchdb-helm.git

commit ed30b9f403c61fabb5f1dd39271866d913816b3b
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Mon Sep 21 15:34:23 2020 +0200

    Update documentation
---
 couchdb/README.md           | 1 +
 couchdb/templates/NOTES.txt | 6 ++++--
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/couchdb/README.md b/couchdb/README.md
index ca3716b..fab0a85 100644
--- a/couchdb/README.md
+++ b/couchdb/README.md
@@ -142,6 +142,7 @@ CouchDB chart and their default values:
 | `couchdbConfig`                 | Map allowing override elements of server .ini config  | *See below*                            |
 | `allowAdminParty`               | If enabled, start cluster without admin account       | false (requires creating a Secret)     |
 | `createAdminSecret`             | If enabled, create an admin account and cookie secret | true                                   |
+| `clusterSetup`                  | Finalize cluster configuration by calling /_cluster_setup endpoint after installation | false  |
 | `schedulerName`                 | Name of the k8s scheduler (other than default)        | `nil`                                  |
 | `erlangFlags`                   | Map of flags supplied to the underlying Erlang VM     | name: couchdb, setcookie: monster
 | `persistentVolume.enabled`      | Boolean determining whether to attach a PV to each node | false
diff --git a/couchdb/templates/NOTES.txt b/couchdb/templates/NOTES.txt
index a3658bd..483b73c 100644
--- a/couchdb/templates/NOTES.txt
+++ b/couchdb/templates/NOTES.txt
@@ -2,13 +2,12 @@ Apache CouchDB is starting. Check the status of the Pods using:
 
   kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "couchdb.name" . }},release={{ .Release.Name }}"
 
-Once all of the Pods are fully Ready, execute the following command to create
+Once all of the pods are fully ready, execute the following command to create
 some required system databases:
 
   kubectl exec --namespace {{ .Release.Namespace }} {{ if not .Values.allowAdminParty }}-it {{ end }}{{ template "couchdb.fullname" . }}-0 -c couchdb -- \
     curl -s \
     http://127.0.0.1:5984/_cluster_setup \
-    -X POST \
     -H "Content-Type: application/json" \
 {{- if .Values.allowAdminParty }}
     -d '{"action": "finish_cluster"}'
@@ -18,3 +17,6 @@ some required system databases:
 {{- end }}
 
 Then it's time to relax.
+
+As of chart version 3.4.0, the helm chart will attempt automatically to complete
+cluster setup after installation if the `clusterSetup` value is set to true.
\ No newline at end of file