add documention on how to use a secret to store the API key

localstack · Oct 9, 2023 · 0e34a27 · 0e34a27
1 parent 6904194
commit 0e34a27
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/charts/localstack/README.md b/charts/localstack/README.md
@@ -54,6 +54,16 @@ extraEnvVars:
     value: "<your api key>"
 ```
 
+If you have the LocalStack API key in a secret, you can also reference it directly with `extraEnvVars`:
+```
+extraEnvVars:
+- name: LOCALSTACK_API_KEY
+  valueFrom:
+    secretKeyRef:
+      name: <name of the secret>
+      key: <name of the key in the secret containing the API key>
+```
+
 And you can use these values when installing the chart in your cluster:
 ```bash
 $ helm repo add localstack-charts https://localstack.github.io/helm-charts

diff --git a/charts/localstack/test-values.yaml b/charts/localstack/test-values.yaml
@@ -24,6 +24,15 @@ mountDind:
 # image:
 #   repository: localstack/localstack-pro
 
+# set the API key from an already existing secret
+# extraEnvVars:
+# - name: LOCALSTACK_API_KEY
+#   valueFrom:
+#     secretKeyRef:
+#       name: <name of the secret containing the API key>
+#       key: <name of the key in the secret containing the API key>
+
+# or set the API key directly
 # extraEnvVars:
 #   - name: LOCALSTACK_API_KEY
 #     value: "<your api key>"