charts/authentik: README: add examples

Signed-off-by: Marc 'risson' Schmitt <[email protected]>
goauthentik · Jan 8, 2024 · 8039ae6 · 8039ae6
1 parent fd2c101
commit 8039ae6
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 0 deletions.
diff --git a/charts/authentik/README.md b/charts/authentik/README.md
@@ -40,6 +40,42 @@ redis:
   enabled: true
 ```
 
+## Advanced values examples
+
+<details>
+<summary>External PostgreSQL and Redis</summary>
+
+```yaml
+authentik:
+  postgresql:
+    host: postgres.domain.tld
+    user: file:///postgres-creds/username
+    password: file:///postgres-creds/password
+  redis:
+    host: redis.domain.tld
+server:
+  volumes:
+    - name: postgres-creds
+      secret:
+        secretName: authentik-postgres-credentials
+  volumeMounts:
+    - name: postgres-creds
+      mountPath: /postgres-creds
+      readOnly: true
+worker:
+  volumes:
+    - name: postgres-creds
+      secret:
+        secretName: authentik-postgres-credentials
+  volumeMounts:
+    - name: postgres-creds
+      mountPath: /postgres-creds
+      readOnly: true
+```
+
+The secret `authentik-postgres-credentials` must have `username` and `password` keys.
+</details>
+
 ## Maintainers
 
 | Name | Email | Url |

diff --git a/charts/authentik/README.md.gotmpl b/charts/authentik/README.md.gotmpl
@@ -42,6 +42,42 @@ redis:
   enabled: true
 ```
 
+## Advanced values examples
+
+<details>
+<summary>External PostgreSQL and Redis</summary>
+
+```yaml
+authentik:
+  postgresql:
+    host: postgres.domain.tld
+    user: file:///postgres-creds/username
+    password: file:///postgres-creds/password
+  redis:
+    host: redis.domain.tld
+server:
+  volumes:
+    - name: postgres-creds
+      secret:
+        secretName: authentik-postgres-credentials
+  volumeMounts:
+    - name: postgres-creds
+      mountPath: /postgres-creds
+      readOnly: true
+worker:
+  volumes:
+    - name: postgres-creds
+      secret:
+        secretName: authentik-postgres-credentials
+  volumeMounts:
+    - name: postgres-creds
+      mountPath: /postgres-creds
+      readOnly: true
+```
+
+The secret `authentik-postgres-credentials` must have `username` and `password` keys.
+</details>
+
 {{ template "chart.maintainersSection" . }}
 
 {{ template "chart.sourcesSection" . }}