From 155b13300bcb6c7bda9d300f46e653f204c6d155 Mon Sep 17 00:00:00 2001 From: Max Jonas Werner Date: Fri, 4 Aug 2023 18:19:04 +0200 Subject: [PATCH] Add guides for common OIDC providers wip --- website/docs/guides/oidc.mdx | 58 ++++++++++++++++++++++++++++++++++++ website/sidebars.js | 1 + 2 files changed, 59 insertions(+) create mode 100644 website/docs/guides/oidc.mdx diff --git a/website/docs/guides/oidc.mdx b/website/docs/guides/oidc.mdx new file mode 100644 index 00000000000..c3d7658ba5a --- /dev/null +++ b/website/docs/guides/oidc.mdx @@ -0,0 +1,58 @@ +--- +title: Common OIDC provider configurations +hide_title: true +--- + +# Common OIDC provider configurations + +## Google + +### Obtaining client ID and secret + +Follow the [official guide](https://developers.google.com/identity/openid-connect/openid-connect) from Google to obtain client ID and secret. + +### Configuring Weave GitOps + +```yaml +apiVersion: v1 +kind: Secret +stringData: + clientID: YOUR_CLIENT_ID + clientSecret: YOUR_CLIENT_SECRET + issuerURL: https://accounts.google.com + redirectURL: http://YOUR_WEAVE_GITOPS_DOMAIN/oauth2/callback + customScopes: openid,email +metadata: + name: oidc-auth +[...] +``` + +## Azure AD + +### Obtaining client ID and secret + +tbd + +### Configuring Weave GitOps + +tbd + +## Keycloak + +### Obtaining client ID and secret + +tbd + +### Configuring Weave GitOps + +```yaml +apiVersion: v1 +kind: Secret +stringData: + clientID: YOUR_CLIENT_ID + clientSecret: YOUR_CLIENT_SECRET + issuerURL: https://KEYCLOAK_DOMAIN/realms/KEYCLOAK_REALM + redirectURL: https://YOUR_WEAVE_GITOPS_DOMAIN/oauth2/callback +metadata: + name: oidc-auth +[...] diff --git a/website/sidebars.js b/website/sidebars.js index e3434b12eb9..74f3c353fbf 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -136,6 +136,7 @@ label: 'Guides', items: [ 'guides/setting-up-dex', + 'guides/oidc', 'guides/cert-manager', 'guides/displaying-custom-metadata', 'guides/fluxga-upgrade',