You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/installing-workflow/configuring-object-storage.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,13 @@ A variety of Deis components rely on an object storage system to do their work.
11
11
12
12
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).
13
13
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.
15
15
16
16
## Minio
17
17
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.
19
21
20
22
## Google Cloud Storage
21
23
@@ -27,9 +29,9 @@ We recommend storing these and all other credentials as Kubernetes secrets. See
27
29
28
30
Every Deis component that relies on object storage relies on the following two inputs for configuration:
29
31
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
31
33
- 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
33
35
- See [the workflow-dev chart](https://github.com/deis/charts/tree/master/workflow-dev) for examples of using and mounting secrets.
34
36
35
37
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
81
83
-`TAR_URL` - The location of the `.tar` archive (which it will build)
82
84
-`put_url` - The location this component will upload the finished slug to
83
85
86
+
Note that these environment variables are case-sensitive.
87
+
84
88
### Credentials
85
89
86
90
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.
90
94
91
95
### Helm Chart
92
96
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.
94
100
95
101
Note - to base64 encode your credentials, you can use the `base64` tool on most systems. Here's an example usage:
96
102
@@ -175,7 +181,7 @@ The registry looks for a `REGISTRY_STORAGE` environment variable, which it then
175
181
176
182
### Credentials
177
183
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.
0 commit comments