Minor: Adding Docs for Custom OIDC Troubleshooting (#16485)

This commit is contained in:
Prajwal214 2024-06-03 19:45:49 +05:30 committed by GitHub
parent fedf6906c3
commit a7fc064a36
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 72 additions and 0 deletions

View File

@ -41,3 +41,13 @@ authorizerConfiguration:
```
{% partial file="/v1.3/deployment/configure-ingestion.md" /%}
### Troubleshooting
* If you are seeing the below trace in the logs, you need to add the discovery URL
```
org.pac4j.core.exception.TechnicalException: You must define either the discovery URL or directly the provider metadata
```
To resolve the error regarding the discovery URL, you need to set the `AUTHENTICATION_DISCOVERY_URI` in your configuration. This URI is used to discover the OpenID Connect provider's configuration.

View File

@ -34,3 +34,19 @@ docker compose --env-file ~/openmetadata_oidc.env up -d
```
{% partial file="/v1.3/deployment/configure-ingestion.md" /%}
### Troubleshooting
* If you are seeing the below trace in the logs, you need to add the discovery URL
```
org.pac4j.core.exception.TechnicalException: You must define either the discovery URL or directly the provider metadata
```
To resolve the error regarding the discovery URL, you need to set the `AUTHENTICATION_DISCOVERY_URI` in your configuration. This URI is used to discover the OpenID Connect provider's configuration.
* If you are using a confidential type to start the server
When using a confidential type to start the server, it is necessary to provide all the details in the `docker-compose` file at the time of starting the server. For more information, refer to the [here](https://github.com/open-metadata/OpenMetadata/blob/main/conf/openmetadata.yaml#L179C3-L190C59).
Alternatively, the client type can be set to "public", which does not require a secret key.

View File

@ -30,3 +30,13 @@ global:
```
{% partial file="/v1.3/deployment/configure-ingestion.md" /%}
### Troubleshooting
* If you are seeing the below trace in the logs, you need to add the discovery URL
```
org.pac4j.core.exception.TechnicalException: You must define either the discovery URL or directly the provider metadata
```
To resolve the error regarding the discovery URL, you need to set the `AUTHENTICATION_DISCOVERY_URI` in your configuration. This URI is used to discover the OpenID Connect provider's configuration.

View File

@ -41,3 +41,13 @@ authorizerConfiguration:
```
{% partial file="/v1.4/deployment/configure-ingestion.md" /%}
### Troubleshooting
* If you are seeing the below trace in the logs, you need to add the discovery URL
```
org.pac4j.core.exception.TechnicalException: You must define either the discovery URL or directly the provider metadata
```
To resolve the error regarding the discovery URL, you need to set the `AUTHENTICATION_DISCOVERY_URI` in your configuration. This URI is used to discover the OpenID Connect provider's configuration.

View File

@ -34,3 +34,19 @@ docker compose --env-file ~/openmetadata_oidc.env up -d
```
{% partial file="/v1.4/deployment/configure-ingestion.md" /%}
### Troubleshooting
* If you are seeing the below trace in the logs, you need to add the discovery URL
```
org.pac4j.core.exception.TechnicalException: You must define either the discovery URL or directly the provider metadata
```
To resolve the error regarding the discovery URL, you need to set the `AUTHENTICATION_DISCOVERY_URI` in your configuration. This URI is used to discover the OpenID Connect provider's configuration.
* If you are using a confidential type to start the server
When using a confidential type to start the server, it is necessary to provide all the details in the `docker-compose` file at the time of starting the server. For more information, refer to the [here](https://github.com/open-metadata/OpenMetadata/blob/main/conf/openmetadata.yaml#L179C3-L190C59).
Alternatively, the client type can be set to "public", which does not require a secret key.

View File

@ -30,3 +30,13 @@ global:
```
{% partial file="/v1.4/deployment/configure-ingestion.md" /%}
### Troubleshooting
* If you are seeing the below trace in the logs, you need to add the discovery URL
```
org.pac4j.core.exception.TechnicalException: You must define either the discovery URL or directly the provider metadata
```
To resolve the error regarding the discovery URL, you need to set the `AUTHENTICATION_DISCOVERY_URI` in your configuration. This URI is used to discover the OpenID Connect provider's configuration.