diff --git a/openmetadata-docs/content/v1.4.x/connectors/database/bigquery/create-credentials.md b/openmetadata-docs/content/v1.4.x/connectors/database/bigquery/create-credentials.md new file mode 100644 index 00000000000..49eb554bef9 --- /dev/null +++ b/openmetadata-docs/content/v1.4.x/connectors/database/bigquery/create-credentials.md @@ -0,0 +1,67 @@ +--- +title: BigQuery +slug: /connectors/database/bigquery/create-credentials +--- + +# Create Service Account & Credential + +This documentation will guide you on how to create a service account in GCP and create credentials to access the same. + + +## Navigate to Service Accounts + +Login to your GCP console and navigate to service accounts page. + +{% image +src="/images/v1.4/connectors/bigquery/bq-service-account-search.png" +alt="Navigate to Service Accounts" +caption="Navigate to Service Accounts" /%} + + +## Create Service Account & Grant Role + +Once you are on service account page, click on `Create Service Account` button. + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-service-account.png" +alt="Create Service Accounts" +caption="Create Service Accounts" /%} + +Fill the service account details + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-service-account-1.png" +alt="Create Service Accounts" +caption="Create Service Accounts" /%} + +Grant a role to service account which has all the required permission to ingest BigQuery metadata in OpenMetadata checkout [this](/connectors/database/bigquery/roles) documentation for details on how to create a custom role with required permissions. + +{% image +src="/images/v1.4/connectors/bigquery/bq-service-account-grant-role.png" +alt="Grant Role to Service Account" +caption="Grant Role to Service Account" /%} + + +## Create Key Credentials + +On service accounts page, look for the service account that you just created, click on the three dots menu and go to manage keys + +{% image +src="/images/v1.4/connectors/bigquery/bq-service-account-manage-keys.png" +alt="Service Account Manage Keys" +caption="Service Account Manage Keys" /%} + + +Click on Add Key > New Key > Select Json and download the key. + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-service-account-key.png" +alt="Create New Key" +caption="Create New Key" /%} + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-key-modal.png" +alt="Download json Key" +caption="Download json Key" /%} + +Open this downloaded key and you will get all the required credentials details to fetch metadata from Bigquery. diff --git a/openmetadata-docs/content/v1.4.x/connectors/database/bigquery/index.md b/openmetadata-docs/content/v1.4.x/connectors/database/bigquery/index.md index b3bbe45b72a..c0d3a707927 100644 --- a/openmetadata-docs/content/v1.4.x/connectors/database/bigquery/index.md +++ b/openmetadata-docs/content/v1.4.x/connectors/database/bigquery/index.md @@ -31,6 +31,8 @@ Configure and schedule BigQuery metadata and profiler workflows from the OpenMet ## Requirements +You need to create an service account in order to ingest metadata from bigquery refer [this](/connectors/database/bigquery/create-credentials) guide on how to create service account. + ### Data Catalog API Permissions - Go to [https://console.cloud.google.com/apis/library/datacatalog.googleapis.com](https://console.cloud.google.com/apis/library/datacatalog.googleapis.com) diff --git a/openmetadata-docs/content/v1.4.x/menu.md b/openmetadata-docs/content/v1.4.x/menu.md index 2d04f45aec8..ce9302f54b3 100644 --- a/openmetadata-docs/content/v1.4.x/menu.md +++ b/openmetadata-docs/content/v1.4.x/menu.md @@ -508,6 +508,8 @@ site_menu: url: /connectors/database/bigquery/yaml - category: Connectors / Database / BigQuery / Roles url: /connectors/database/bigquery/roles + - category: Connectors / Database / BigQuery / Create Credentials + url: /connectors/database/bigquery/create-credentials - category: Connectors / Database / BigTable url: /connectors/database/bigtable - category: Connectors / Database / BigTable / Run Externally diff --git a/openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/create-credentials.md b/openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/create-credentials.md new file mode 100644 index 00000000000..49eb554bef9 --- /dev/null +++ b/openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/create-credentials.md @@ -0,0 +1,67 @@ +--- +title: BigQuery +slug: /connectors/database/bigquery/create-credentials +--- + +# Create Service Account & Credential + +This documentation will guide you on how to create a service account in GCP and create credentials to access the same. + + +## Navigate to Service Accounts + +Login to your GCP console and navigate to service accounts page. + +{% image +src="/images/v1.4/connectors/bigquery/bq-service-account-search.png" +alt="Navigate to Service Accounts" +caption="Navigate to Service Accounts" /%} + + +## Create Service Account & Grant Role + +Once you are on service account page, click on `Create Service Account` button. + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-service-account.png" +alt="Create Service Accounts" +caption="Create Service Accounts" /%} + +Fill the service account details + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-service-account-1.png" +alt="Create Service Accounts" +caption="Create Service Accounts" /%} + +Grant a role to service account which has all the required permission to ingest BigQuery metadata in OpenMetadata checkout [this](/connectors/database/bigquery/roles) documentation for details on how to create a custom role with required permissions. + +{% image +src="/images/v1.4/connectors/bigquery/bq-service-account-grant-role.png" +alt="Grant Role to Service Account" +caption="Grant Role to Service Account" /%} + + +## Create Key Credentials + +On service accounts page, look for the service account that you just created, click on the three dots menu and go to manage keys + +{% image +src="/images/v1.4/connectors/bigquery/bq-service-account-manage-keys.png" +alt="Service Account Manage Keys" +caption="Service Account Manage Keys" /%} + + +Click on Add Key > New Key > Select Json and download the key. + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-service-account-key.png" +alt="Create New Key" +caption="Create New Key" /%} + +{% image +src="/images/v1.4/connectors/bigquery/bq-create-key-modal.png" +alt="Download json Key" +caption="Download json Key" /%} + +Open this downloaded key and you will get all the required credentials details to fetch metadata from Bigquery. diff --git a/openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/index.md b/openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/index.md index dc8fa990e61..7e5da73943e 100644 --- a/openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/index.md +++ b/openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/index.md @@ -31,6 +31,8 @@ Configure and schedule BigQuery metadata and profiler workflows from the OpenMet ## Requirements +You need to create an service account in order to ingest metadata from bigquery refer [this](/connectors/database/bigquery/create-credentials) guide on how to create service account. + ### Data Catalog API Permissions - Go to [https://console.cloud.google.com/apis/library/datacatalog.googleapis.com](https://console.cloud.google.com/apis/library/datacatalog.googleapis.com) diff --git a/openmetadata-docs/content/v1.5.x-SNAPSHOT/menu.md b/openmetadata-docs/content/v1.5.x-SNAPSHOT/menu.md index 09eee7c4ddd..95fa74fb150 100644 --- a/openmetadata-docs/content/v1.5.x-SNAPSHOT/menu.md +++ b/openmetadata-docs/content/v1.5.x-SNAPSHOT/menu.md @@ -465,6 +465,8 @@ site_menu: url: /connectors/database/bigquery/yaml - category: Connectors / Database / BigQuery / Roles url: /connectors/database/bigquery/roles + - category: Connectors / Database / BigQuery / Create Credentials + url: /connectors/database/bigquery/create-credentials - category: Connectors / Database / BigTable url: /connectors/database/bigtable - category: Connectors / Database / BigTable / Run Externally diff --git a/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-key-modal.png b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-key-modal.png new file mode 100644 index 00000000000..783f670e545 Binary files /dev/null and b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-key-modal.png differ diff --git a/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account-1.png b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account-1.png new file mode 100644 index 00000000000..c21ff785610 Binary files /dev/null and b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account-1.png differ diff --git a/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account-key.png b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account-key.png new file mode 100644 index 00000000000..97ae2840ead Binary files /dev/null and b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account-key.png differ diff --git a/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account.png b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account.png new file mode 100644 index 00000000000..1aca947136d Binary files /dev/null and b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-create-service-account.png differ diff --git a/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-grant-role.png b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-grant-role.png new file mode 100644 index 00000000000..c02530e34ee Binary files /dev/null and b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-grant-role.png differ diff --git a/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-manage-keys.png b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-manage-keys.png new file mode 100644 index 00000000000..51ba5e39714 Binary files /dev/null and b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-manage-keys.png differ diff --git a/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-search.png b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-search.png new file mode 100644 index 00000000000..ab62e257abe Binary files /dev/null and b/openmetadata-docs/images/v1.4/connectors/bigquery/bq-service-account-search.png differ