Skip to content

Commit ddee95f

Browse files
committed
Merge pull request #3842 from mboersma/minimum-three
docs(installing_deis): etcd doesn't require an odd # of nodes
2 parents 39f4873 + 5bcd02d commit ddee95f

5 files changed

Lines changed: 14 additions & 17 deletions

File tree

docs/installing_deis/aws.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,7 @@ By default, the script will provision 3 servers. You can override this by settin
7070
7171
$ export DEIS_NUM_INSTANCES=5
7272
73-
Note that for scheduling to work properly, clusters must consist of at least 3 nodes and always
74-
have an odd number of members. For more information, see `etcd disaster recovery`_.
75-
76-
Deis clusters of less than 3 nodes are unsupported.
73+
A Deis cluster must have 3 or more nodes. See :ref:`cluster-size` for more details.
7774

7875

7976
Generate a New Discovery URL

docs/installing_deis/azure.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,11 @@ With that, let's run the azure-coreos-cluster script which will create the CoreO
7676
--data-disk
7777
--custom-data azure-user-data
7878
79-
This script will by default provision a 3 node cluster but you can increase this with the
79+
This script will by default provision a 3-node cluster, but you can increase this with the
8080
``--num-nodes`` parameter. Likewise, you can increase the VM size using ``--vm-size``.
8181
It is not recommended that you use smaller than Large (A3) sized instances.
8282

83-
Note that for scheduling to work properly, clusters must consist of at least 3 nodes and always
84-
have an odd number of members. For more information, see `etcd disaster recovery`_.
83+
A Deis cluster must have 3 or more nodes. See :ref:`cluster-size` for more details.
8584

8685

8786
Configure DNS

docs/installing_deis/openstack.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,7 @@ Generate a New Discovery URL
9595
Choose number of instances
9696
--------------------------
9797

98-
For scheduling to work properly, clusters must consist of at least 3 nodes and always have an odd
99-
number of members. Please refer to :ref:`system-requirements` for more information about cluster
100-
size requirements.
98+
A Deis cluster must have 3 or more nodes. See :ref:`cluster-size` for more details.
10199

102100
Instruct the provision script to launch the desired number of nodes:
103101

docs/installing_deis/rackspace.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,8 @@ By default, the provision script will provision 3 servers. You can override this
7373
7474
$ DEIS_NUM_INSTANCES=5 ./provision-rackspace-cluster.sh deis-key
7575
76-
Note that for scheduling to work properly, clusters must consist of at least 3 nodes and always have an odd number of members.
77-
For more information, see `etcd disaster recovery`_.
76+
A Deis cluster must have 3 or more nodes. See :ref:`cluster-size` for more details.
7877

79-
Deis clusters of less than 3 nodes are unsupported.
8078

8179
Run the Provision Script
8280
------------------------

docs/installing_deis/system-requirements.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,17 @@ applications.
2828
Running smaller machines will likely result in increased system load and has been known to result
2929
in component failures, issues with etcd/fleet, and other problems.
3030

31+
.. _cluster-size:
32+
3133
Cluster size
3234
------------
3335

34-
For scheduling to work properly, clusters must consist of at least three nodes and always
35-
have an odd number of members. This is mostly because the underlying CoreOS cluster must always
36-
be able to obtain a quorum (see `etcd disaster recovery`_). Additionally, the :ref:`Store`
37-
component keeps three replicas of stored data, so it requires at least three nodes.
36+
For :ref:`scheduling <choosing_a_scheduler>` and the :ref:`deis-store <Store>` components
37+
to work properly, clusters must have at least three nodes. The ``etcd`` service must always
38+
be able to obtain a quorum, and the Ceph data store must maintain at least three replicas
39+
of persistent data.
40+
41+
See `optimal etcd cluster size`_ and `etcd disaster recovery`_ for further information.
3842

3943
.. important::
4044

@@ -50,5 +54,6 @@ Network
5054
.. include:: ../_includes/_private-network.rst
5155

5256
.. _`dokku`: https://github.com/progrium/dokku
57+
.. _`optimal etcd cluster size`: https://coreos.com/docs/cluster-management/scaling/etcd-optimal-cluster-size/
5358
.. _`etcd disaster recovery`: https://github.com/coreos/etcd/blob/master/Documentation/admin_guide.md#disaster-recovery
5459
.. _`sponsored`: http://deis.io/deis-sponsors-dokku/

0 commit comments

Comments
 (0)