diff --git a/openmetadata-docs/content/deployment/kubernetes/gke-troubleshooting.md b/openmetadata-docs/content/deployment/kubernetes/gke-troubleshooting.md new file mode 100644 index 00000000000..c264f4f54a6 --- /dev/null +++ b/openmetadata-docs/content/deployment/kubernetes/gke-troubleshooting.md @@ -0,0 +1,29 @@ +--- +title: GKE Setup Troubleshooting +slug: /deployment/kubernetes/gke-troubleshooting +--- + +# GKE Setup Troubleshooting + +If you came across `invalid access type while creating the pvc`, and the permission pod is stuck in "pending" state. + +The above error might have occurred due to the pvc volumes not setup or pvc volumes are not mounted properly. + +
+dag-log +
+
+permission-pod-events +
+ +Please validate: +- all the prerequisites mentioned in this [section](/deployment/kubernetes/gke) +- the configuration of `dags_pv_pvc.yml` file +- `storageClassName` field in YAML file diff --git a/openmetadata-docs/content/deployment/security/jwt-troubleshooting.md b/openmetadata-docs/content/deployment/security/jwt-troubleshooting.md new file mode 100644 index 00000000000..3e36596e768 --- /dev/null +++ b/openmetadata-docs/content/deployment/security/jwt-troubleshooting.md @@ -0,0 +1,49 @@ +--- +title: JWT validation Troubleshooting +slug: /deployment/security/jwt-troubleshooting +--- +# JWT Troubleshooting + +Add the `{domain}:{port}/config/jwks` in the list of publicKeys + +```yaml + authentication: + provider: "google" + publicKeys: + - "https://www.googleapis.com/oauth2/v3/certs" + - "http://localhost:8585/api/v1/config/jwks" (your domain and port) +``` + +This config with `"http://localhost:8585/api/v1/config/jwks"` is the default behavior. If you are configuring and expecting a JWT token to work, configuring with that extra URL is required. + +JWT Tokens are issued by private certificates. + +We need public keys to decrypt it and get that token's user name, expiry time, etc. + +In OpenMetadata users can enable SSO for users to login and use JWT tokens issued by OpenMetadata for bots +The way OpenMetadata issues a JWT Token is using this [config](https://github.com/open-metadata/OpenMetadata/blob/main/conf/openmetadata.yaml#L155). It uses the `rsapublicKeyFilePath` file to generate a token. + +When the ingestion workflow uses this token, we use `rsapublicKeyPath` to decrypt it. The way we do this is using the response from this endpoint `http://localhost:8585/api/v1/config/jwks`. + + +## Get JWT token from UI. + +First Open Open-Metadata UI than go to settings > Bots > Ingestion Bot + +
+jwt-token +
+ +You can validate that in [jwt.io](https://jwt.io/). if there's something wrong on how the JWT token was generated. + +
+jwt.io +
diff --git a/openmetadata-docs/content/menu.md b/openmetadata-docs/content/menu.md index f4f7997ddb0..1f275d6ea4e 100644 --- a/openmetadata-docs/content/menu.md +++ b/openmetadata-docs/content/menu.md @@ -52,6 +52,8 @@ site_menu: url: /deployment/kubernetes/security - category: Deployment / Kubernetes Deployment / Helm Values url: /deployment/kubernetes/helm-values + - category: Deployment / Kubernetes Deployment / GKE Troubleshooting + url: /deployment/kubernetes/gke-troubleshooting - category: Deployment / Enable Security url: /deployment/security @@ -133,6 +135,8 @@ site_menu: url: /deployment/security/enable-ssl/openmetadata-server - category: Deployment / Enable Security / Enable JWT Tokens url: /deployment/security/enable-jwt-tokens + - category: Deployment / Enable Security / JWT Troubleshooting + url: /deployment/security/jwt-troubleshooting - category: Deployment / Enable Secrets Manager url: /deployment/secrets-manager diff --git a/openmetadata-docs/images/deployment/troubleshoot/dag-log.png b/openmetadata-docs/images/deployment/troubleshoot/dag-log.png new file mode 100644 index 00000000000..21085a7a44c Binary files /dev/null and b/openmetadata-docs/images/deployment/troubleshoot/dag-log.png differ diff --git a/openmetadata-docs/images/deployment/troubleshoot/jwt-token.png b/openmetadata-docs/images/deployment/troubleshoot/jwt-token.png new file mode 100644 index 00000000000..37f86a56586 Binary files /dev/null and b/openmetadata-docs/images/deployment/troubleshoot/jwt-token.png differ diff --git a/openmetadata-docs/images/deployment/troubleshoot/jwt-validation.png b/openmetadata-docs/images/deployment/troubleshoot/jwt-validation.png new file mode 100644 index 00000000000..3f3c0560db0 Binary files /dev/null and b/openmetadata-docs/images/deployment/troubleshoot/jwt-validation.png differ diff --git a/openmetadata-docs/images/deployment/troubleshoot/permission-pod-events.png b/openmetadata-docs/images/deployment/troubleshoot/permission-pod-events.png new file mode 100644 index 00000000000..6e44fd1ee73 Binary files /dev/null and b/openmetadata-docs/images/deployment/troubleshoot/permission-pod-events.png differ