You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by wo...@apache.org on 2017/10/12 19:30:07 UTC
[couchdb-documentation] branch db-put-q updated (75b781e -> f819c5e)
This is an automated email from the ASF dual-hosted git repository.
wohali pushed a change to branch db-put-q
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git.
omit 75b781e Document cluster config settings
add 35a4f9f Improve docs on bumping fd limits
new f819c5e Document cluster config settings
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (75b781e)
\
N -- N -- N refs/heads/db-put-q (f819c5e)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/maintenance/performance.rst | 20 +++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].
[couchdb-documentation] 01/01: Document cluster config settings
Posted by wo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
wohali pushed a commit to branch db-put-q
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit f819c5e7d966dda578bffffa52bad10a1d698ddd
Author: Joan Touzet <jo...@atypical.net>
AuthorDate: Wed Oct 11 18:46:44 2017 -0400
Document cluster config settings
---
src/api/database/common.rst | 2 ++
src/cluster/databases.rst | 2 ++
src/config/cluster.rst | 71 +++++++++++++++++++++++++++++++++++++++++++++
src/config/index.rst | 1 +
4 files changed, 76 insertions(+)
diff --git a/src/api/database/common.rst b/src/api/database/common.rst
index 4c9f655..5f696ab 100644
--- a/src/api/database/common.rst
+++ b/src/api/database/common.rst
@@ -152,6 +152,8 @@
written as ``^[a-z][a-z0-9_$()+/-]*$``.
:param db: Database name
+ :query integer q: Shards, aka the number of range partitions. Default is
+ 8, unless overridden in the :config:option:`cluster config <cluster/q>`.
:<header Accept: - :mimetype:`application/json`
- :mimetype:`text/plain`
:>header Content-Type: - :mimetype:`application/json`
diff --git a/src/cluster/databases.rst b/src/cluster/databases.rst
index 819228f..62edd3a 100644
--- a/src/cluster/databases.rst
+++ b/src/cluster/databases.rst
@@ -42,6 +42,8 @@ Deleteing a database
curl -X DELETE "http://xxx.xxx.xxx.xxx:5984/database-name --user admin-user
+.. _cluster/databases/placement:
+
Placing a database on specific nodes
====================================
diff --git a/src/config/cluster.rst b/src/config/cluster.rst
new file mode 100644
index 0000000..51c007f
--- /dev/null
+++ b/src/config/cluster.rst
@@ -0,0 +1,71 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
+.. use this file except in compliance with the License. You may obtain a copy of
+.. the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations under
+.. the License.
+
+.. default-domain:: config
+.. highlight:: ini
+
+======================
+Configuring Clustering
+======================
+
+.. _config/cluster:
+
+Cluster Options
+===============
+
+.. config:section:: cluster :: cluster Options
+
+ .. config:option:: q
+
+ Sets the default number of shards for newly created databases. The
+ default value, ``8``, splits a database into 8 separate partitions. ::
+
+ [cluster]
+ q = 8
+
+ For systems with lots of small, infrequently accessed databases, or
+ for servers with fewer CPU cores, consider reducing this value to
+ ``1`` or ``2``.
+
+ The value of ``q`` can also be overridden on a per-DB basis, at DB
+ creation time.
+
+ .. seealso::
+ httpdomain:put:`PUT /{db} </{db}>`
+
+ .. config:option:: n
+
+ Sets the number of replicas of each document in a cluster. CouchDB will
+ only place one replica per node in a cluster. When set up through the
+ :ref:`Cluster Setup Wizard <cluster/setup/wizard>`, a standalone single
+ node will have ``n = 1``, a two node cluster will have ``n = 2``, and
+ any larger cluster will have ``n = 3``. It is recommended not to set
+ ``n`` greater than ``3``. ::
+
+ [cluster]
+ n = 3
+
+ .. config:option:: placement
+
+ Sets the cluster-wide replica placement policy when creating new
+ databases. The value must be a comma-delimited list of strings of the
+ format ``zone_name:#``, where ``zone_name`` is a zone as specified in
+ the ``nodes`` database and ``#`` is an integer indicating the number of
+ replicas to place on nodes with a matching ``zone_name``.
+
+ This parameter is not specified by default. ::
+
+ [cluster]
+ placement = metro-dc-a:2,metro-dc-b:1
+
+ .. seealso::
+ :ref:`cluster/databases/placement`
diff --git a/src/config/index.rst b/src/config/index.rst
index a906c5b..93dca8b 100644
--- a/src/config/index.rst
+++ b/src/config/index.rst
@@ -21,6 +21,7 @@ Configuring CouchDB
intro
couchdb
+ cluster
couch-peruser
http
auth
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.