Skip to content

Commit 02a7036

Browse files
committed
Merge pull request #115 from arschles/fix-grammar
doc(README.md): fix grammar and add clarity
2 parents b81b0de + ccbe476 commit 02a7036

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

src/installing-workflow/configuring-object-storage.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ A variety of Deis components rely on an object storage system to do their work.
1111

1212
These components are flexible and 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).
1313

14-
Note: object storage configuration has not been standardized across all components in our beta release. As such, configuration instructions differ for each component. We plan to remediate this problem in our next release. Please see our [deis/deis#4966](https://github.com/deis/deis/issues/4966) for our progress on that work.
14+
Note: object storage configuration has not been standardized across all components in our beta release. As such, configuration instructions differ for each component. We plan to remediate this problem in our next release. Please see [deis/deis#4966](https://github.com/deis/deis/issues/4966) for our progress on that work.
1515

1616
## Minio
1717

18-
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.
18+
Additionally, Deis ships with a [Minio](http://minio.io) [component](https://github.com/deis/minio) by default, which provides in-cluster, ephemeral object storage. This means that _if the Minio server crashes, all data will be lost_. Therefore, **Minio should be used for development or testing only**.
19+
20+
In our beta release, the components listed above are configured by default to automatically use the Minio [service][k8s-service] for object storage.
1921

2022
## Google Cloud Storage
2123

@@ -27,9 +29,9 @@ We recommend storing these and all other credentials as Kubernetes secrets. See
2729

2830
Every Deis component that relies on object storage relies on the following two inputs for configuration:
2931

30-
- One or more environment variables with host and port to describe where the object storage system is
32+
- One or more environment variables that describe what object storage system to use
3133
- One or more files to provide access credentials for the object storage system.
32-
- We suggest storing these values in [Kubernetes secrets](http://kubernetes.io/v1.1/docs/user-guide/secrets.html) and mounting them as volumes to each pod
34+
- We suggest storing the contents of these files in [Kubernetes secrets][k8s-secret] and mounting them as volumes to each pod
3335
- See [the workflow-dev chart](https://github.com/deis/charts/tree/master/workflow-dev) for examples of using and mounting secrets.
3436

3537
The subsections herein explain how to configure these two inputs for each applicable component.
@@ -81,6 +83,8 @@ The slugbuilder looks for the below environment variables to determine where to
8183
- `TAR_URL` - The location of the `.tar` archive (which it will build)
8284
- `put_url` - The location this component will upload the finished slug to
8385

86+
Note that these environment variables are case-sensitive.
87+
8488
### Credentials
8589

8690
The slugbuilder reads credentials from the below locations on the filesystem.
@@ -90,7 +94,9 @@ The slugbuilder reads credentials from the below locations on the filesystem.
9094

9195
### Helm Chart
9296

93-
If you are using the [Helm Chart for Workflow][helm-chart], put your base64-encoded credentials in the [`minio-user` secret][minio-user-secret] (under `access-key-id` and `access-secret-key`) before you `helm install`. For more information, see the [installation instructions][helm-install] for more details on using Helm.
97+
The [Helm Chart for Workflow][helm-chart] contains no manifest for the slugbuilder. As noted above, the builder handles all configuration and lifecycle management for you.
98+
99+
If, however, you wish to run the slugbuilder as a standalone component, you can use the [`minio-user` secret][minio-user-secret] to easily provide your pods with the credentials information they need. To do so, put your base64-encoded credentials in the [`minio-user` secret][minio-user-secret] (under `access-key-id` and `access-secret-key`) before you `helm install`. For more information, see the [installation instructions][helm-install] for more details on using Helm.
94100

95101
Note - to base64 encode your credentials, you can use the `base64` tool on most systems. Here's an example usage:
96102

@@ -175,7 +181,7 @@ The registry looks for a `REGISTRY_STORAGE` environment variable, which it then
175181

176182
### Credentials
177183

178-
The registry reads the credential information from a `/var/run/secrets/deis/registry/creds/objectstorage-keyfile` file. This is generated automatically (as part of the `helm generate` command) based on the configuration options given in the https://github.com/deis/charts/blob/master/workflow-dev/tpl/objectstorage.toml file.
184+
The registry reads the credential information from a `/var/run/secrets/deis/registry/creds/objectstorage-keyfile` file. This is generated automatically (as part of the `helm generate` command) based on the configuration options given in the [objectstorage.toml file][objectstorage-toml] file.
179185

180186
### Helm Chart
181187

@@ -233,3 +239,5 @@ echo $MY_ACCESS_KEY | base64
233239
[minio-user-secret]: https://github.com/deis/charts/blob/master/workflow-dev/manifests/deis-minio-secret-user.yaml
234240
[helm-install]: https://github.com/deis/workflow/blob/master/src/installing-workflow/installing-deis-workflow.md
235241
[objectstorage-toml]: https://github.com/deis/charts/blob/master/workflow-dev/tpl/objectstorage.toml
242+
[k8s-service]: http://kubernetes.io/docs/user-guide/services/
243+
[k8s-secret]: http://kubernetes.io/docs/user-guide/secrets/

0 commit comments

Comments
 (0)