Skip to content

Commit ffd0410

Browse files
authored
bug(docs): clarify object storage requirements (#444)
* ref(docs): move system requirements above install instructions * ref(docs): add system requirements to prerequisites * ref(docs): callout deployment options in install doc * ref(docs): add storage callout to system requirements
1 parent 218465e commit ffd0410

3 files changed

Lines changed: 29 additions & 3 deletions

File tree

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ pages:
2727
- Architecture: understanding-workflow/architecture.md
2828
- Components: understanding-workflow/components.md
2929
- Installing Workflow:
30-
- Installing Workflow: installing-workflow/index.md
3130
- System Requirements: installing-workflow/system-requirements.md
31+
- Installing Workflow: installing-workflow/index.md
3232
- Configuring Object Storage: installing-workflow/configuring-object-storage.md
3333
- Configuring Postgres: installing-workflow/configuring-postgres.md
3434
- Configuring the Registry: installing-workflow/configuring-registry.md

src/installing-workflow/index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This document is aimed at those who have already provisioned a [Kubernetes v1.2
44
and want to install Deis Workflow. If you are just getting started with Kubernetes and
55
Deis Workflow, follow our [quickstart guide](../quickstart/index.md) for help.
66

7-
87
## Prerequisites
98

10-
You need to [install Helm Classic and Deis Workflow CLI before continuing](../quickstart/install-cli-tools.md).
9+
1. Verify the [Kubernetes system requirements](system-requirements.md)
10+
1. Install [Helm Classic and Deis Workflow CLI](../quickstart/install-cli-tools.md) tools
1111

1212
## Check Your Setup
1313

@@ -38,6 +38,20 @@ InfluxDB is running at https://52.9.206.49/api/v1/proxy/namespaces/kube-system/s
3838
If you see a list of targets like the one above, `helmc` can communicate with the Kubernetes master. Double check that
3939
the master returned by `helmc target` matches the expected cluster.
4040

41+
## Choose Your Deployment Strategy
42+
43+
Deis Workflow includes everything it needs to run out of the box. However, these defaults are aimed at simplicity rather than
44+
production readiness. Production and staging deployments of Workflow should, at a minimum, use off-cluster storage.
45+
Which is used by Workflow components to store and backup critical data. Should an operator need to completely re-install
46+
Workflow, the required components can recover from off-cluster storage. See our documentation for [configuring object
47+
storage](configuring-object-storage.md) for more details.
48+
49+
Workflow may also be configured to use off-cluster persistence for [Postgres](configuring-postgres.md) and
50+
Redis. A deployment strategy that mirrors the "stateless" clusters from Deis v1 PaaS.
51+
52+
Last but not least, Workflow may also use a dedicated off-cluster image registry, including Docker Hub, Quay.io, ECR or
53+
GCR for all container images. Read more about [configuring your registry](configuring-registry.md).
54+
4155
## Add the Deis Chart Repository
4256

4357
The [Deis Chart Repository](https://github.com/deis/charts) contains everything you need to install Deis Workflow onto

src/installing-workflow/system-requirements.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ Kubernetes v1.1, and Kubernetes v1.3.0 through v1.3.3 have
99
[a bug when mounting secrets](https://github.com/deis/workflow/issues/372) which prevents Deis
1010
Workflow from starting.
1111

12+
## Storage Requirements
13+
14+
A variety of Deis Workflow components rely on an object storage system to do their work, including storing application
15+
slugs, Docker images and database logs.
16+
17+
Deis Workflow ships with Minio by default, which provides in-cluster, ephemeral object storage. This means that if the
18+
Minio server crashes, all data will be lost. Therefore, Minio should be used for development or testing only.
19+
20+
Workflow supports Amazon Simple Storage Service (S3), Google Cloud Storage (GCS), OpenShift Swift, and Azure Blob
21+
Storage. See [configuring object storage][storage-configuration] for setup instructions.
22+
1223
## Resource Requirements
1324

1425
When deploying Deis Workflow, it's important to provision machines with adequate resources. Deis is a highly-available
@@ -39,5 +50,6 @@ and instability.
3950
If you are using Docker with OverlayFS, you must disable SELinux by adding `--selinux-enabled=false` to
4051
`EXTRA_DOCKER_OPTS`. For more background information, see:
4152

53+
* [storage-configuration](configuring-object-storage.md)
4254
* [https://github.com/docker/docker/issues/7952](https://github.com/docker/docker/issues/7952)
4355
* [https://github.com/deis/workflow/issues/63](https://github.com/deis/postgres/issues/63)

0 commit comments

Comments
 (0)