Skip to content

Commit 5d84444

Browse files
author
Aaron Schlesinger
committed
doc(object-storage): add sections on configuring secrets for the helm chart
Fixes deis/workflow#101
1 parent d46a0ad commit 5d84444

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ The builder reads credentials from the below locations on the filesystem.
5252
- Key: `/var/run/secrets/object/store/access-key-id`
5353
- Secret `/var/run/secrets/object/store/access-key-secret`
5454

55+
### Helm Chart
56+
57+
If you are using the [Helm Chart for Workflow][helm-chart], put your 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.
58+
5559
### A Note on Google Cloud Storage
5660

5761
Google Cloud Storage (GCS) can interoperate with the S3 API using a feature called [interoperability](https://cloud.google.com/storage/docs/interoperability). If you choose to use GCS for object storage, you'll have to turn on this interoperability mode. In order to do so, please follow the steps at https://cloud.google.com/storage/docs/migrating?hl=en_US#migration-simple.
@@ -76,20 +80,47 @@ The slugbuilder reads credentials from the below locations on the filesystem.
7680
- Key: `/var/run/secrets/object/store/access-key-id`
7781
- Secret `/var/run/secrets/object/store/access-key-secret`
7882

83+
### Helm Chart
84+
85+
If you are using the [Helm Chart for Workflow][helm-chart], put your 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.
7986

8087
## [deis/slugrunner](https://github.com/deis/slugrunner)
8188

8289
### Environment Variables
8390

8491
The slugrunner uses the `SLUG_URL` environment variable to determine where to download the slug (that it will run) from.
8592

93+
Note that if you are using slugrunner inside a Deis cluster, the [controller](https://github.com/deis/controller) handles all configuration and lifecycle management for you. The remainder of this section only applies if you intend to run the slugrunner as a standalone component.
94+
8695
### Credentials
8796

8897
The slugrunner reads credentials from the below locations on the filesystem.
8998

9099
- Key: `/var/run/secrets/object/store/access-key-id`
91100
- Secret: `/var/run/secrets/object/store/access-key-secret`
92101

102+
### Helm Chart
103+
104+
The [Helm Chart for Workflow][helm-chart] contains no manifest for the slugrunner. As noted above, the controller handles all configuration and lifecycle management for you.
105+
106+
If, however, you wish to run the slugrunner 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 credentials information into the `access-key-id` and `access-secret-key` fields, and mount the secret like this:
107+
108+
Under the `spec.template.spec.volumes` section:
109+
110+
```yaml
111+
- name: minio-user
112+
secret:
113+
secretName: minio-user
114+
```
115+
116+
Under the `spec.template.spec.containers[0].volumeMounts` section:
117+
118+
```yaml
119+
- name: minio-user
120+
mountPath: /var/run/secrets/object/store
121+
readOnly: true
122+
```
123+
93124
## [deis/controller](https://github.com/deis/controller)
94125

95126
When the controller needs to launch or scale a new buildpack application, it uses a [replication controller](http://kubernetes.io/docs/user-guide/replication-controller/). Since the slugrunner needs to download the slug to run, it needs the object storage location of the slug and the object storage credentials.
@@ -150,3 +181,7 @@ You'll also need to add two environment variables to the https://github.com/deis
150181
- name: DEIS_MINIO_SERVICE_PORT
151182
value: "443"
152183
```
184+
185+
[helm-chart]: https://github.com/deis/charts/tree/master/workflow-dev
186+
[minio-user-secret]: https://github.com/deis/charts/blob/master/workflow-dev/manifests/deis-minio-secret-user.yaml
187+
[helm-install]: https://github.com/deis/workflow/blob/master/src/installing-workflow/installing-deis-workflow.md

0 commit comments

Comments
 (0)