mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-05 07:38:26 +00:00
f0ef0ad933
* (Docs) Correct URLs and Enable OIDC The KeyCloak URLs were incorrect for the current version of KeyCloak, and additionally the documentation was missing the required key to enable OIDC. * fix conflict * enable true --------- Co-authored-by: ulixius9 <mayursingal9@gmail.com>
99 lines
4.0 KiB
Markdown
99 lines
4.0 KiB
Markdown
---
|
|
title: Keycloak SSO for Kubernetes
|
|
slug: /deployment/security/keycloak/kubernetes
|
|
collate: false
|
|
---
|
|
|
|
# Keycloak SSO for Kubernetes
|
|
|
|
Check the Helm information [here](https://artifacthub.io/packages/search?repo=open-metadata).
|
|
|
|
Here is an example for reference, showing where to place the values in the `values.yaml` file after setting up your Keycloak account and obtaining the application credentials.
|
|
|
|
Check the more information about environment variable [here](/deployment/security/configuration-parameters).
|
|
|
|
|
|
{% codeWithLanguageSelector title="Auth Configuration" id="container-1" languagesArray=["implicit","authcode"] theme="dark" %}
|
|
|
|
```implicit
|
|
# Public Flow
|
|
|
|
openmetadata:
|
|
config:
|
|
authorizer:
|
|
className: "org.openmetadata.service.security.DefaultAuthorizer"
|
|
containerRequestFilter: "org.openmetadata.service.security.JwtFilter"
|
|
initialAdmins: # john.doe from john.doe@example.com
|
|
- "admin"
|
|
- "user1"
|
|
- "user2"
|
|
principalDomain: "open-metadata.org" # Update with your Domain,The primary domain for the organization (example.com from john.doe@example.com).
|
|
|
|
authentication:
|
|
clientType: public
|
|
provider: "custom-oidc"
|
|
publicKeys:
|
|
- "{OMD-server-domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
|
|
- "{Keycloak-server-URL}/realms/{your-realm-name}/protocol/openid-connect/certs"
|
|
authority: "{Keycloak-server-URL}/realms/{your-realm-name}/protocol/openid-connect/auth"
|
|
clientId: "{Client ID}" # Update your Client ID
|
|
callbackUrl: "http://localhost:8585/callback"
|
|
```
|
|
|
|
```authcode
|
|
# Auth Code Flow
|
|
|
|
openmetadata:
|
|
config:
|
|
authorizer:
|
|
className: "org.openmetadata.service.security.DefaultAuthorizer"
|
|
containerRequestFilter: "org.openmetadata.service.security.JwtFilter"
|
|
initialAdmins: # john.doe from john.doe@example.com
|
|
- "admin"
|
|
- "user1"
|
|
- "user2"
|
|
principalDomain: "open-metadata.org" # Update with your Domain,The primary domain for the organization (example.com from john.doe@example.com).
|
|
|
|
authentication:
|
|
clientType: confidential
|
|
provider: "custom-oidc"
|
|
publicKeys:
|
|
- "{OMD-server-domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
|
|
- "{Keycloak-server-URL}/realms/{your-realm-name}/protocol/openid-connect/certs"
|
|
authority: "{Keycloak-server-URL}/realms/{your-realm-name}/protocol/openid-connect/auth"
|
|
clientId: "{Client ID}" # Update your Client ID
|
|
callbackUrl: "http://localhost:8585/callback"
|
|
oidcConfiguration:
|
|
enabled: true
|
|
oidcType: "Keycloak"
|
|
clientId:
|
|
secretRef: oidc-secrets
|
|
secretKey: openmetadata-oidc-client-id
|
|
clientSecret:
|
|
secretRef: oidc-secrets
|
|
secretKey: openmetadata-oidc-client-secret
|
|
discoveryUri:"{Keycloak-server-URL}/realms/{your-realm-name}/.well-known/openid-configuration" # Keycloak's discovery URI Update your Keycloak's Domain and Realm
|
|
callbackUrl: http://localhost:8585/callback
|
|
serverUrl: http://localhost:8585
|
|
```
|
|
|
|
{% /codeWithLanguageSelector %}
|
|
|
|
{% note %}
|
|
|
|
Altering the order of claims in `jwtPrincipalClaims` may lead to problems when matching a user from a token with an existing user in the system. The mapping process relies on the specific order of claims, so changing it can result in inconsistencies or authentication failures, as the system cannot ensure correct user mapping with a new claim order.
|
|
|
|
{% /note %}
|
|
|
|
{% partial file="/v1.8/deployment/configure-ingestion.md" /%}
|
|
|
|
{% inlineCalloutContainer %}
|
|
{% inlineCallout
|
|
color="violet-70"
|
|
icon="MdArrowBack"
|
|
bold="KeyCloak"
|
|
href="/deployment/security/keycloak" %}
|
|
Go to KeyCloak Configuration
|
|
{% /inlineCallout %}
|
|
{% /inlineCalloutContainer %}
|