Skip to content

Commit c8b3548

Browse files
author
Sivaram Mothiki
committed
Merge pull request #240 from smothiki/storage
feat(storage): modify docs for configuring storage using env vars
2 parents 70221f4 + 1d9b301 commit c8b3548

1 file changed

Lines changed: 27 additions & 5 deletions

File tree

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

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,34 @@ The helm classic chart for Deis Workflow can be easily configured to connect Wor
1818
* Note: If you provide credentials with sufficient access to the underlying storage, Workflow components will create the buckets if they do not exist.
1919
* **Step 2:** If applicable, generate credentials that have write access to the storage buckets created in Step 1
2020
* **Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-beta4`
21-
* **Step 4:** Open the helm classic chart with `helmc edit workflow-beta4` and look for the template file `tpl/generate_params.toml`
22-
* **Step 5:** Update the `storage` parameter to reference the storage platform you are using: `s3`, `azure`, `gcs`
23-
* **Step 6:** Update the values in the section which corresponds to your storage type, including region, bucket names and access credentials
21+
* **Step 4:** Update storage details either by setting the appropriate environment variables or by modifying the template file `tpl/generate_params.toml`
22+
* **1.** Using environment variables:
23+
* Set `STORAGE_TYPE` to `s3`, `azure` or `gcs`, then set the following environment variables accordingly.
24+
* For `STORAGE_TYPE=gcs`:
25+
26+
```
27+
export GCS_KEY_JSON, GCS_REGISTRY_BUCKET, GCS_DATABASE_BUCKET, GCS_BUILDER_BUCKET
28+
```
29+
30+
* For `STORAGE_TYPE=s3`:
31+
32+
```
33+
export AWS_ACCESS_KEY, AWS_SECRET_KEY, AWS_REGISTRY_BUCKET, AWS_DATABASE_BUCKET, AWS_BUILDER_BUCKET, S3_REGION
34+
```
35+
36+
* For `STORAGE_TYPE=azure`:
37+
38+
```
39+
export AZURE_ACCOUNT_NAME, AZURE_ACCOUNT_KEY, AZURE_REGISTRY_CONTAINER, AZURE_DATABASE_CONTAINER, AZURE_BUILDER_CONTAINER
40+
```
41+
42+
* **2.** Using template file `tpl/generate_params.toml`:
43+
* Open the helm classic chart with `helmc edit workflow-beta4` and look for the template file `tpl/generate_params.toml`
44+
* Update the `storage` parameter to reference the storage platform you are using: `s3`, `azure`, `gcs`
45+
* Update the values in the section which corresponds to your storage type, including region, bucket names and access credentials
2446
* Note: you do not need to base64 encode any of these values as Helm Classic will handle encoding automatically
25-
* **Step 7:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-beta4`
26-
* **Step 8:** Check the generated file in your manifests directory, you should see `deis-objectstorage-secret.yaml`
47+
* **Step 5:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-beta4`
48+
* **Step 6:** Check the generated file in your manifests directory, you should see `deis-objectstorage-secret.yaml`
2749

2850
You are now ready to `helmc install workflow-beta4` using your desired object storage.
2951

0 commit comments

Comments
 (0)