Skip to content

Commit 6bba375

Browse files
author
Aaron Schlesinger
committed
doc(object-storage): add note on base64 encoding credentials
1 parent 4e0b134 commit 6bba375

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

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

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,13 @@ The builder reads credentials from the below locations on the filesystem.
5454

5555
### Helm Chart
5656

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.
57+
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.
58+
59+
Note - to base64 encode your credentials, you can use the `base64` tool on most systems. Here's an example usage:
60+
61+
```console
62+
echo $MY_ACCESS_KEY | base64
63+
```
5864

5965
### A Note on Google Cloud Storage
6066

@@ -82,7 +88,13 @@ The slugbuilder reads credentials from the below locations on the filesystem.
8288

8389
### Helm Chart
8490

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.
91+
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.
92+
93+
Note - to base64 encode your credentials, you can use the `base64` tool on most systems. Here's an example usage:
94+
95+
```console
96+
echo $MY_ACCESS_KEY | base64
97+
```
8698

8799
## [deis/slugrunner](https://github.com/deis/slugrunner)
88100

@@ -103,7 +115,7 @@ The slugrunner reads credentials from the below locations on the filesystem.
103115

104116
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.
105117

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:
118+
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 base64-encoded credentials information into the `access-key-id` and `access-secret-key` fields, and mount the secret like this:
107119

108120
Under the `spec.template.spec.volumes` section:
109121

@@ -121,6 +133,12 @@ Under the `spec.template.spec.containers[0].volumeMounts` section:
121133
readOnly: true
122134
```
123135

136+
Note - to base64 encode your credentials, you can use the `base64` tool on most systems. Here's an example usage:
137+
138+
```console
139+
echo $MY_ACCESS_KEY | base64
140+
```
141+
124142
## [deis/controller](https://github.com/deis/controller)
125143

126144
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.
@@ -149,7 +167,13 @@ The registry reads the credential information from a `/var/run/secrets/deis/regi
149167

150168
### Helm Chart
151169

152-
If you are using the [Helm Chart for Workflow][helm-chart], put your credentials in the [objectstorage.toml][objectstorage-toml] file before you run `helm generate`. For more information, see the [installation instructions][helm-install] for more details on using Helm.
170+
If you are using the [Helm Chart for Workflow][helm-chart], put your base64-encoded credentials in the [objectstorage.toml][objectstorage-toml] file before you run `helm generate`. For more information, see the [installation instructions][helm-install] for more details on using Helm.
171+
172+
Note - to base64 encode your credentials, you can use the `base64` tool on most systems. Here's an example usage:
173+
174+
```console
175+
echo $MY_ACCESS_KEY | base64
176+
```
153177

154178
## [deis/database](https://github.com/deis/postgres)
155179

@@ -188,7 +212,13 @@ You'll also need to add two environment variables to the https://github.com/deis
188212

189213
### Helm Chart
190214

191-
If you are using the [Helm Chart for Workflow][helm-chart], put your credentials in the [objectstorage.toml][objectstorage-toml] file before you run `helm generate`. For more information, see the [installation instructions][helm-install] for more details on using Helm.
215+
If you are using the [Helm Chart for Workflow][helm-chart], put your base64-encoded credentials in the [objectstorage.toml][objectstorage-toml] file before you run `helm generate`. For more information, see the [installation instructions][helm-install] for more details on using Helm.
216+
217+
Note - to base64 encode your credentials, you can use the `base64` tool on most systems. Here's an example usage:
218+
219+
```console
220+
echo $MY_ACCESS_KEY | base64
221+
```
192222

193223
[helm-chart]: https://github.com/deis/charts/tree/master/workflow-dev
194224
[minio-user-secret]: https://github.com/deis/charts/blob/master/workflow-dev/manifests/deis-minio-secret-user.yaml

0 commit comments

Comments
 (0)