From 9841b0887fad3f91f67ea04ac2f4c1a04d92f63a Mon Sep 17 00:00:00 2001 From: Pere Miquel Brull Date: Tue, 30 Aug 2022 17:25:02 +0200 Subject: [PATCH] Remove required fields from BQ for ADC (#7037) --- .../schema/security/credentials/gcsCredentials.json | 11 +---------- .../connectors/database/bigquery/airflow.md | 12 ++++++++++++ .../openmetadata/connectors/database/bigquery/cli.md | 12 ++++++++++++ .../connectors/database/bigquery/index.md | 2 ++ 4 files changed, 27 insertions(+), 10 deletions(-) diff --git a/catalog-rest-service/src/main/resources/json/schema/security/credentials/gcsCredentials.json b/catalog-rest-service/src/main/resources/json/schema/security/credentials/gcsCredentials.json index 9b5a9ce9075..0500bda10f3 100644 --- a/catalog-rest-service/src/main/resources/json/schema/security/credentials/gcsCredentials.json +++ b/catalog-rest-service/src/main/resources/json/schema/security/credentials/gcsCredentials.json @@ -70,16 +70,7 @@ "format": "uri" } }, - "additionalProperties": false, - "required": [ - "type", - "projectId", - "privateKeyId", - "privateKey", - "clientEmail", - "clientId", - "clientX509CertUrl" - ] + "additionalProperties": false }, "GCSCredentialsPath": { "title": "GCS Credentials Path", diff --git a/openmetadata-docs/content/openmetadata/connectors/database/bigquery/airflow.md b/openmetadata-docs/content/openmetadata/connectors/database/bigquery/airflow.md index c9ae3171ff2..1283615131a 100644 --- a/openmetadata-docs/content/openmetadata/connectors/database/bigquery/airflow.md +++ b/openmetadata-docs/content/openmetadata/connectors/database/bigquery/airflow.md @@ -204,6 +204,18 @@ credentials: - In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"` - In case you authenticate with SSO using an external browser popup, then add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "externalbrowser"` +If you want to use [ADC authentication](https://cloud.google.com/docs/authentication#adc) for BigQuery you can just leave +the GCS credentials empty. This is why they are not marked as required. + +```yaml +... + config: + type: BigQuery + credentials: + gcsConfig: {} +... +``` + #### Source Configuration - Source Config The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/metadataIngestion/databaseServiceMetadataPipeline.json): diff --git a/openmetadata-docs/content/openmetadata/connectors/database/bigquery/cli.md b/openmetadata-docs/content/openmetadata/connectors/database/bigquery/cli.md index 7857d185bbb..dffefd9d8f1 100644 --- a/openmetadata-docs/content/openmetadata/connectors/database/bigquery/cli.md +++ b/openmetadata-docs/content/openmetadata/connectors/database/bigquery/cli.md @@ -204,6 +204,18 @@ credentials: - In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"` - In case you authenticate with SSO using an external browser popup, then add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "externalbrowser"` +If you want to use [ADC authentication](https://cloud.google.com/docs/authentication#adc) for BigQuery you can just leave +the GCS credentials empty. This is why they are not marked as required. + +```yaml +... + config: + type: BigQuery + credentials: + gcsConfig: {} +... +``` + #### Source Configuration - Source Config The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/metadataIngestion/databaseServiceMetadataPipeline.json): diff --git a/openmetadata-docs/content/openmetadata/connectors/database/bigquery/index.md b/openmetadata-docs/content/openmetadata/connectors/database/bigquery/index.md index 6b4b5d4d7ce..2ef312aad28 100644 --- a/openmetadata-docs/content/openmetadata/connectors/database/bigquery/index.md +++ b/openmetadata-docs/content/openmetadata/connectors/database/bigquery/index.md @@ -179,6 +179,8 @@ the changes. - In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"` - In case you authenticate with SSO using an external browser popup, then add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "externalbrowser"` +If you want to use [ADC authentication](https://cloud.google.com/docs/authentication#adc) for BigQuery you can just leave +the GCS credentials empty. This is why they are not marked as required. ### 6. Configure Metadata Ingestion