diff --git a/website/docs/guides/oidc.mdx b/website/docs/guides/oidc.mdx new file mode 100644 index 00000000000..452cfffbb4c --- /dev/null +++ b/website/docs/guides/oidc.mdx @@ -0,0 +1,73 @@ +--- +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 +type: Opaque +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 + +Follow the [official guide](https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) from Microsoft to obtain client ID and secret. + +### Configuring Weave GitOps + +```yaml +apiVersion: v1 +kind: Secret +type: Opaque +stringData: + clientID: YOUR_CLIENT_ID + clientSecret: YOUR_CLIENT_SECRET + issuerURL: https://login.microsoftonline.com/TENANT_ID/v2.0 + redirectURL: http://YOUR_WEAVE_GITOPS_DOMAIN/oauth2/callback + customScopes: openid + claimUsername: sub +metadata: + name: oidc-auth +[...] +``` + +## 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 1bd335c1295..2c102a7a283 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -136,6 +136,7 @@ label: 'Guides', items: [ 'guides/setting-up-dex', + 'guides/oidc', 'guides/displaying-custom-metadata', 'guides/fluxga-upgrade', ],