Skip to content

Commit 0730d2c

Browse files
committed
doc(quickstart.md,configuring-object-storage.md): start documenting object storage configs
1 parent d91209d commit 0730d2c

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Configure Object Storage
2+
3+
A variety of Deis components rely on an object storage system to do their work. These components are:
4+
5+
- [workflow](https://github.com/deis/workflow)
6+
- [builder](https://github.com/deis/builder)
7+
- [slugbuilder](https://github.com/deis/slugbuilder)
8+
- [slugrunner](https://github.com/deis/slugrunner)
9+
- [registry](https://github.com/deis/registry)
10+
11+
These components are built flexibly, so they can work out of the box with almost any system that is compatible with the [S3 API](http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html).
12+
13+
# Minio
14+
15+
Additionally, Deis ships with a [Minio](http://minio.io) [component](https://github.com/deis/minio). This component runs as a Kubernetes service, and the components listed above are configured to automatically look for that service and use it as object storage if it's available.
16+
17+
# Telling Deis What to Use
18+
19+
The Deis components determine what object storage system to use via environment variables that you set up:
20+
21+
TODO: list the lookup order
22+
23+
# Limitations
24+
25+
- In some cases, the minio service must be started up before other components, so that they see the Minio service's environment variables. If you use [helm](https://github.com/helm/helm) to install deis, this ordering won't be ensured. (builder, slugbuilder and slugrunner are fine)
26+
- Registry doesn't currently automatically look up the minio service, nor will it look for other storage env vars.

docs/src/installing-deis/quickstart.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ Now that you've finished provisioning a cluster, please [Install the Deis Platfo
2626
[configuring dns]: ../managing-deis/configuring-dns.md
2727
[install deis]: installing-the-deis-platform.md
2828
[system requirements]: system-requirements.md
29+
[configuring object storage]: configuring-object-storage.md

0 commit comments

Comments
 (0)