From 4e8feedd3de4754ed79bde09e270dc44485b0d10 Mon Sep 17 00:00:00 2001 From: Jens Schneider Date: Fri, 8 Sep 2023 13:40:15 +0200 Subject: [PATCH] docs: add documentation for nextcloud oidc support (#252) Signed-off-by: Jens Schneider --- docs/docs/03_crd-reference/nextcloud/index.md | 1 + docs/docs/03_crd-reference/nextcloud/oidc.md | 21 +++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 docs/docs/03_crd-reference/nextcloud/oidc.md diff --git a/docs/docs/03_crd-reference/nextcloud/index.md b/docs/docs/03_crd-reference/nextcloud/index.md index a3c8e3bc..0d08dbc3 100644 --- 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 new file mode 100644 index 00000000..741480a4 --- /dev/null +++ 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) |