Skip to content

Commit 8956d83

Browse files
committed
chore(requirements): bit of polish
1 parent 3bad467 commit 8956d83

1 file changed

Lines changed: 26 additions & 15 deletions

File tree

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,45 @@
1-
# Resource Requirements
1+
# Requirements
22

3-
When deploying Deis, it's important to provision machines with adequate resources. Deis is a highly-available distributed system, which means that Deis components and your deployed applications will move around the cluster onto healthy hosts as hosts leave the cluster for various reasons (failures, reboots, autoscalers, etc.). Because of this, you should have ample spare resources on any machine in your cluster to withstand the additional load of running services for failed machines.
3+
If you are planning to run Deis Workflow on your own Kubernetes cluster there are a few requirements that you should be
4+
aware of when creating your environment.
45

5-
## Resources
6+
## Resource Requirements
67

7-
Deis components consume approximately 2 - 2.5GB of memory across the cluster, and approximately 30GB of hard disk space. Because each machine should be able to absorb additional load should a machine fail, each machine must have:
8+
When deploying Deis Workflow, it's important to provision machines with adequate resources. Deis is a highly-available
9+
distributed system, which means that Deis components and your deployed applications will move around the cluster onto
10+
healthy hosts as hosts leave the cluster for various reasons (failures, reboots, autoscalers, etc.). Because of this,
11+
you should have ample spare resources on any machine in your cluster to withstand the additional load of running
12+
services for failed machines.
13+
14+
Deis Workflow components consume approximately 2 - 2.5GB of memory across the cluster, and approximately 30GB of hard
15+
disk space. Because each machine should be able to absorb additional load should a machine fail, each machine must
16+
have:
817

918
* At least 4GB of RAM (more is better)
1019
* At least 40GB of hard disk space
1120

12-
Note that these estimates are for Deis and Kubernetes only, and there should be ample room for deployed applications.
13-
14-
Running smaller machines will likely result in increased system load and has been known to result in component failures and other problems.
15-
21+
Note that these estimates are for Deis Workflow and Kubernetes only. Be sure to leave enough spare capacity for your
22+
application footprint as well.
1623

17-
# Kubernetes Requirements
24+
Running smaller machines will likely result in increased system load and has been known to result in component failures and instability.
1825

19-
## Versions
26+
## Kubernetes Versions
2027

21-
Deis workflow has been tested with the Kubernetes v1.2 release line. It is incompatible with Kubernetes v1.1 and lower.
22-
23-
# Docker Requirements
28+
Deis Workflow has been tested with the **Kubernetes v1.2** release line. It is incompatible with Kubernetes v1.1 and earlier.
2429

2530
## Docker Insecure Registry
2631

27-
The on-cluster, Deis-managed Docker registry is not deployed with TLS by default. As such, all Kubernetes worker nodes must have their Docker daemons configured to use an insecure registry. The subnet should encompass any private networks used by your worker nodes, including any overlay networks. Depending on your Kubernetes and Docker configuration, setting `EXTRA_DOCKER_OPTS="--insecure-registry=10.0.0.0/8"` may be sufficient.
32+
The on-cluster Docker registry is not deployed with TLS enabled. As such, all Kubernetes worker nodes must have their
33+
Docker daemons configured to use an **insecure registry**. The configured subnet should encompass any private networks
34+
used by your worker nodes, including overlay networks.
35+
36+
Depending on your Kubernetes and Docker configuration, setting `EXTRA_DOCKER_OPTS="--insecure-registry=10.0.0.0/8"` may
37+
be sufficient.
2838

2939
## SELinux + OverlayFS
3040

31-
If you are using Docker with OverlayFS you must disable SELinux by adding `--selinux-enabled=false` to `EXTRA_DOCKER_OPTS`. For more background information see:
41+
If you are using Docker with OverlayFS you must disable SELinux by adding `--selinux-enabled=false` to
42+
`EXTRA_DOCKER_OPTS`. For more background information see:
3243

3344
* [https://github.com/docker/docker/issues/7952](https://github.com/docker/docker/issues/7952)
3445
* [https://github.com/deis/postgres/issues/63](https://github.com/deis/postgres/issues/63)

0 commit comments

Comments
 (0)