Skip to content

Commit e0eee03

Browse files
committed
Merge pull request #2472 from carmstrong/clarify_resouce_requirements
docs(installing_docs): add cluster size to system requirements
2 parents 1a99fab + 1940eaa commit e0eee03

1 file changed

Lines changed: 24 additions & 3 deletions

File tree

docs/installing_deis/system-requirements.rst

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,38 @@ will move around the cluster onto healthy hosts as hosts leave the cluster for v
1212
(failures, reboots, autoscalers, etc.). Because of this, you should have ample spare resources on
1313
any machine in your cluster to withstand the additional load of running services for failed machines.
1414

15-
Machines must have:
15+
Resources
16+
---------
1617

17-
* At least 4GB of RAM (Deis uses 2 - 2.5GB, plus room for failover and deployed applications)
18+
Deis components consume approximately 2 - 2.5GB of memory across the cluster, and approximately
19+
30GB of hard disk space. Because each machine should be able to absorb additional load should a
20+
machine fail, each machine must have:
21+
22+
* At least 4GB of RAM (more is better)
1823
* At least 40GB of hard disk space
1924

25+
Note that these estimates are for Deis and CoreOS only, and there should be ample room for deployed
26+
applications.
27+
2028
Running smaller machines will likely result in increased system load and has been known to result
2129
in component failures, issues with etcd/fleet, and other problems.
2230

23-
If running multiple (at least 3) machines of an adequate size is unreasonable, it is recommended to
31+
Cluster size
32+
------------
33+
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 `optimal etcd cluster size`_). Additionally, the :ref:`Store`
37+
component keeps three replicas of stored data, so it requires at least three nodes.
38+
39+
.. important::
40+
41+
Deis clusters of less than three nodes are unsupported.
42+
43+
If running multiple (at least three) machines of an adequate size is unreasonable, it is recommended to
2444
investigate the `Dokku`_ project instead. Dokku is `sponsored`_ by Deis and is ideal for environments
2545
where a highly-available distributed system is not necessary (i.e. local development, testing, etc.).
2646

2747
.. _`dokku`: https://github.com/progrium/dokku
48+
.. _`optimal etcd cluster size`: https://github.com/coreos/etcd/blob/master/Documentation/optimal-cluster-size.md
2849
.. _`sponsored`: http://deis.io/deis-sponsors-dokku/

0 commit comments

Comments
 (0)