Skip to content

Commit

Permalink
Add some correction in the Auth tutorial for Keycloak (netbox-communi…
Browse files Browse the repository at this point in the history
…ty#338)

Co-authored-by: Léo Colombaro <git@colombaro.fr>
Co-authored-by: MALAMELLI Mehdi <mehdi.malamelli@groupe-cyllene.com>
  • Loading branch information
3 people authored Sep 22, 2024
1 parent e42c932 commit 9f74f9f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
2 changes: 1 addition & 1 deletion charts/netbox/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: netbox
version: 5.0.0-beta.102
version: 5.0.0-beta.103
appVersion: "v4.1.1"
type: application
kubeVersion: ^1.25.0-0
Expand Down
13 changes: 12 additions & 1 deletion docs/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,17 @@ data:
continue
```
> [!note]
> A hardcoded custom audience mapper is required on Keycloak.
>
> For the audience name to be in the token, enter the Client ID
> in the _Included **Custom** Audience_ field instead of the _Included **Client** Audience_ field.
>
> Refer to the Keycloak usage materials:
> - [Python Social Auth Documentation](https://python-social-auth.readthedocs.io/en/latest/backends/keycloak.html)
> - [Python Social Auth Source Code](https://github.com/python-social-auth/social-core/blob/d9554fa40e751c85ae60231fe2f5bd5a528c4452/social_core/backends/keycloak.py#L7-L96)
> - [Keycloak Documentation](https://www.keycloak.org/docs/latest/server_admin/#_audience_hardcoded)
### Example config for GitLab backend
```yaml
remoteAuth:
Expand Down Expand Up @@ -196,7 +207,7 @@ data:
In order to enable LDAP authentication, please carry out the following steps:
1. Configure the `remoteAuth` settings to enable the LDAP backend (see below)
2. Make sure you set *all* of the `remoteAuth.ldap` settings shown in the `values.yaml` file
2. Make sure you set _all_ of the `remoteAuth.ldap` settings shown in the `values.yaml` file

For example:

Expand Down

0 comments on commit 9f74f9f

Please sign in to comment.