docs: Add documentation for nextcloud oidc support (glasskube#252)

Signed-off-by: Jens Schneider <jens.schneider.ac@posteo.de>
JensAc · Sep 8, 2023 · 8bc1697 · 8bc1697
1 parent 314c780
commit 8bc1697
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/docs/03_crd-reference/nextcloud/index.md b/docs/docs/03_crd-reference/nextcloud/index.md
@@ -41,6 +41,7 @@ spec:
 | Name   | Type                   |        |
 |--------|------------------------|--------|
 | office | [OfficeSpec](./office) | `null` |
+| oidc   | [OidcSpec](./oidc)     | `null` |
 
 ### StorageSpec {#storage}
 

diff --git a/docs/docs/03_crd-reference/nextcloud/oidc.md b/docs/docs/03_crd-reference/nextcloud/oidc.md
@@ -0,0 +1,21 @@
+# Oidc
+
+The Glasskube operator can configure the [`oidc_login`](https://apps.nextcloud.com/apps/oidc_login) nextcloud app for you. Currently, the operator only passes the most basic configuration options throuh.
+
+## Example
+
+```yaml title=spec.apps.office
+    oidc:
+      name: my-oidc-issuer
+      issuerUrl: https://my-oidc-issuer.org
+      oidcSecret:
+        name: oidc-login
+```
+
+## Spec
+
+| Name       | Type                                                                                                                   |            |
+|------------|------------------------------------------------------------------------------------------------------------------------|------------|
+| name       | String                                                                                                                 | (required) |
+| issuerUrl  | String                                                                                                                 | (required) |
+| oidcSecret | [LocalObjectReference](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/local-object-reference/) | (required) |