mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-17 14:09:52 +00:00
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
|
---
|
||
|
|
title: Custom OIDC SSO for Bare Metal
|
||
|
|
slug: /deployment/security/custom-oidc/bare-metal
|
||
|
|
---
|
||
|
|
|
||
|
|
# Custom OIDC SSO for Bare Metal
|
||
|
|
|
||
|
|
## Update conf/openmetadata.yaml
|
||
|
|
|
||
|
|
Once the `Client Id` and `Client Secret` are generated add the `Client Id` in `openmetadata.yaml` file in `client_id` field.
|
||
|
|
|
||
|
|
Update the `providerName` config to the name you want to display in the `Sign In` button in the UI. For example, with the
|
||
|
|
following configuration with `providerName` set to `KeyCloak`, the users will see `Sign In with KeyCloak SSO` in the `Sign In`
|
||
|
|
page of the OpenMetadata UI.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
authenticationConfiguration:
|
||
|
|
provider: "custom-oidc"
|
||
|
|
providerName: "KeyCloak"
|
||
|
|
publicKeyUrls:
|
||
|
|
- "http://localhost:8080/realms/myrealm/protocol/openid-connect/certs"
|
||
|
|
authority: "http://localhost:8080/realms/myrealm"
|
||
|
|
clientId: "{client id}"
|
||
|
|
callbackUrl: "http://localhost:8585/callback"
|
||
|
|
```
|
||
|
|
|
||
|
|
Then,
|
||
|
|
- Update `authorizerConfiguration` to add login names of the admin users in `adminPrincipals` section as shown below.
|
||
|
|
- Update the `principalDomain` to your company domain name.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
authorizerConfiguration:
|
||
|
|
className: "org.openmetadata.service.security.DefaultAuthorizer"
|
||
|
|
# JWT Filter
|
||
|
|
containerRequestFilter: "org.openmetadata.service.security.JwtFilter"
|
||
|
|
adminPrincipals:
|
||
|
|
- "user1"
|
||
|
|
- "user2"
|
||
|
|
principalDomain: "open-metadata.org"
|
||
|
|
```
|
||
|
|
|
||
|
|
In `0.12.1` the `className` and `containerRequestFilter` must replace `org.openmetadata.catalog` by `org.openmetadata.service`.
|
||
|
|
|
||
|
|
Finally, update the Airflow information:
|
||
|
|
|
||
|
|
**Before 0.12.1**
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
airflowConfiguration:
|
||
|
|
apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
|
||
|
|
username: ${AIRFLOW_USERNAME:-admin}
|
||
|
|
password: ${AIRFLOW_PASSWORD:-admin}
|
||
|
|
metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api}
|
||
|
|
authProvider: custom-oidc
|
||
|
|
customOidc:
|
||
|
|
clientId: ${OM_AUTH_AIRFLOW_CUSTOM_OIDC_CLIENT_ID:-""}
|
||
|
|
secretKey: ${OM_AUTH_AIRFLOW_CUSTOM_OIDC_SECRET_KEY_PATH:-""}
|
||
|
|
tokenEndpoint: ${OM_AUTH_AIRFLOW_CUSTOM_OIDC_TOKEN_ENDPOINT_URL:-""}
|
||
|
|
```
|
||
|
|
|
||
|
|
**After 0.12.1**
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
airflowConfiguration:
|
||
|
|
apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
|
||
|
|
username: ${AIRFLOW_USERNAME:-admin}
|
||
|
|
password: ${AIRFLOW_PASSWORD:-admin}
|
||
|
|
metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api}
|
||
|
|
```
|
||
|
|
|
||
|
|
**Note:** Follow [this](/how-to-guides/feature-configurations/bots) guide to configure the `ingestion-bot` credentials for
|
||
|
|
ingesting data from Airflow.
|