This is an automated email from the ASF dual-hosted git repository.
willholley pushed a commit to branch placement-zone-join
in repository https://gitbox.apache.org/repos/asf/couchdb.git
The following commit(s) were added to refs/heads/placement-zone-join by this
push:
new 0524d96c1 update docs
0524d96c1 is described below
commit 0524d96c16be619590c85746363ff283d185ace7
Author: Will Holley <[email protected]>
AuthorDate: Mon Jul 7 09:56:11 2025 +0000
update docs
---
src/docs/src/cluster/databases.rst | 4 ++++
src/docs/src/cluster/sharding.rst | 5 ++++-
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/src/docs/src/cluster/databases.rst
b/src/docs/src/cluster/databases.rst
index 1dcbc2ba8..5a56ae064 100644
--- a/src/docs/src/cluster/databases.rst
+++ b/src/docs/src/cluster/databases.rst
@@ -66,6 +66,10 @@ Add a key value pair of the form:
"zone": "metro-dc-a"
+
+Alternatively, you can set the ``COUCHDB_ZONE`` environment variable
+on each node and CouchDB will configure this document for you on startup.
+
Do this for all of the nodes in your cluster.
In your config file (``local.ini`` or ``default.ini``) on each node, define a
diff --git a/src/docs/src/cluster/sharding.rst
b/src/docs/src/cluster/sharding.rst
index 7b8ca52ff..e98df513d 100644
--- a/src/docs/src/cluster/sharding.rst
+++ b/src/docs/src/cluster/sharding.rst
@@ -650,6 +650,9 @@ Do this for all of the nodes in your cluster. For example:
"zone": "{zone-name}"
}'
+Alternatively, you can set the ``COUCHDB_ZONE`` environment variable
+on each node and CouchDB will configure this document for you on startup.
+
In the local config file (``local.ini``) of each node, define a
consistent cluster-wide setting like:
@@ -669,7 +672,7 @@ when the database is created, using the same syntax as the
ini file:
.. code-block:: bash
- curl -X PUT $COUCH_URL:5984/{db}?zone={zone}
+ curl -X PUT $COUCH_URL:5984/{db}?placement={zone}
The ``placement`` argument may also be specified. Note that this *will*
override the logic that determines the number of created replicas!