Skip to content

Commit 0e234ff

Browse files
committed
Update README
1 parent ce7d765 commit 0e234ff

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
# couchdb-statefulset-assembler
2-
Helper to automatically join members of a StatefulSet into a CouchDB cluster
1+
# CouchDB StatefulSet Assembler
2+
3+
This code is intended to be deployed as a sidecar container in a Pod alongside
4+
the official CouchDB container when running CouchDB as a Kubernetes StatefulSet.
5+
It will resolve the DNS records maintained by Kubernetes to discover the other
6+
peers in the cluster, then automatically populate the Pod's _nodes DB with the
7+
names of the other nodes. The end result is that the cluster is automically
8+
joined up.
9+
10+
If the deployment is scaled *up* after the initial creation those new Pods will
11+
be automatically added. Scaling *down* does not automatically remove the Pods
12+
from the membership database at this time.

0 commit comments

Comments
 (0)