Skip to content

Commit

Permalink
Add guides for common OIDC providers
Browse files Browse the repository at this point in the history
wip

Signed-off-by: Max Jonas Werner <[email protected]>
  • Loading branch information
Max Jonas Werner committed Nov 14, 2023
1 parent 8b6addb commit 7d1ccbe
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
74 changes: 74 additions & 0 deletions website/docs/guides/oidc.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
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
[...]
```
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@
type: 'category',
label: 'Guides',
items: [
'guides/oidc',
'guides/displaying-custom-metadata',
'guides/fluxga-upgrade',
],
Expand Down

0 comments on commit 7d1ccbe

Please sign in to comment.