MINOR: Add docs for big query create credentials/service account (#16759)

This commit is contained in:
Mayur Singal 2024-06-21 15:58:40 +05:30 committed by GitHub
parent 3c5d705793
commit d8a4e4d4ff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 142 additions and 0 deletions

View File

@ -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.

View File

@ -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)

View File

@ -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

View File

@ -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.

View File

@ -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)

View File

@ -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

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 245 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 207 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 264 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 182 KiB