yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-19 06:28:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

MINOR: Bigquery Create Credentials Docs Correction (#16812)

Browse Source
This commit is contained in:
Mayur Singal 2024-06-27 11:23:25 +05:30 committed by GitHub
parent bafe3da5bc
commit 83678b0047
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 32 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
openmetadata-docs/content/v1.4.x/connectors/database/bigquery/create-credentials.md
View File

@ -3,11 +3,13 @@ title: BigQuery
slug: /connectors/database/bigquery/create-credentials slug: /connectors/database/bigquery/create-credentials
--- ---
# Create custom role in GCP # Create Credentials for BigQuery Ingestion
This documentation will guide you on how to create a custom role in GCP with the necessary permissions to ingest BigQuery in OpenMetadata. This documentation provides a step-by-step guide on how to create a custom role in Google Cloud Platform (GCP) with the necessary permissions to ingest BigQuery in OpenMetadata. It covers the process of navigating to the Roles section in the GCP console, creating a role, adding permissions, and creating a service account with credentials. By following these instructions, you will be able to set up the required role and credentials to access and ingest BigQuery metadata in OpenMetadata. Let's get started!
## Step 1: Navigate to Roles ## 1. Create custom role in GCP
### Step 1: Navigate to Roles
Search for `Roles` in your GCP console and select the first result under `IAM & Roles` section. Search for `Roles` in your GCP console and select the first result under `IAM & Roles` section.
@ -17,18 +19,15 @@ alt="Navigate to Roles"
caption="Navigate to Roles" /%} caption="Navigate to Roles" /%}
## Step 2: Create Role & Add Permissions ### Step 2: Create Role & Add Permissions
Below the search bar you should see a `Create Role` button click on that & navigate to create role page. Below the search bar you should see a `Create Role` button click on that & navigate to create role page.
{% image {% image
src="/images/v1.4/connectors/bigquery/create-role-2.png" src="/images/v1.4/connectors/bigquery/create-role-2.png"
alt="Create Role Button" alt="Create Role Button"
caption="Create Role" /%} caption="Create Role" /%}
Once You are on the create role page, you can edit the description & title of the role and finally you can click on `add permissions` to grant permissions to role. Once You are on the create role page, you can edit the description & title of the role and finally you can click on `add permissions` to grant permissions to role.
{% image {% image
@ -36,11 +35,9 @@ src="/images/v1.4/connectors/bigquery/create-role-3.png"
alt="Create Role" alt="Create Role"
caption="Create Role" /%} caption="Create Role" /%}
You can search for the required permissions in the filter box and add them accordingly. To ingest metadata from BigQuery you need to grant the following permissions to the user. You can search for the required permissions in the filter box and add them accordingly. To ingest metadata from BigQuery you need to grant the following permissions to the user.
| # | GCP Permission | Required For | | # | GCP Permission | Required For |
| :--- | :---------------------------- | :---------------------- | | :--- | :---------------------------- | :---------------------- |
| 1 | bigquery.datasets.get | Metadata Ingestion | | 1 | bigquery.datasets.get | Metadata Ingestion |
@ -70,12 +67,9 @@ src="/images/v1.4/connectors/bigquery/create-role-5.png"
alt="Add Permissions" alt="Add Permissions"
caption="Add Permissions" /%} caption="Add Permissions" /%}
# Create Service Account & Credential ## 2. Create Service Account
This documentation will guide you on how to create a service account in GCP and create credentials to access the same. ### Step 1: Navigate to Service Accounts
## Navigate to Service Accounts
Login to your GCP console and navigate to service accounts page. Login to your GCP console and navigate to service accounts page.
@ -85,7 +79,7 @@ alt="Navigate to Service Accounts"
caption="Navigate to Service Accounts" /%} caption="Navigate to Service Accounts" /%}
## Create Service Account & Grant Role ### Step 2: Create Service Account & Grant Role
Once you are on service account page, click on `Create Service Account` button. Once you are on service account page, click on `Create Service Account` button.
@ -109,7 +103,9 @@ alt="Grant Role to Service Account"
caption="Grant Role to Service Account" /%} caption="Grant Role to Service Account" /%}
## Create Key Credentials ## 3. Create & Download Key Credentials
### Step 1: Navigate to Service Accounts
On service accounts page, look for the service account that you just created, click on the three dots menu and go to manage keys On service accounts page, look for the service account that you just created, click on the three dots menu and go to manage keys
@ -119,6 +115,8 @@ alt="Service Account Manage Keys"
caption="Service Account Manage Keys" /%} caption="Service Account Manage Keys" /%}
### Step 2: Download Key Credentials
Click on Add Key > New Key > Select Json and download the key. Click on Add Key > New Key > Select Json and download the key.
{% image {% image

4
openmetadata-docs/content/v1.4.x/connectors/database/bigquery/index.md
View File

@ -37,7 +37,7 @@ You need to create an service account in order to ingest metadata from bigquery
{% tile {% tile
icon="manage_accounts" icon="manage_accounts"
title="Create Credentials" title="Create Credentials"
description="Checkout this documentation on how to create a custom role and assign it to the service account." description="Check out this documentation on how to create a custom role and assign it to the service account."
link="/connectors/database/bigquery/create-credentials" link="/connectors/database/bigquery/create-credentials"
/ %} / %}
{% /tilesContainer %} {% /tilesContainer %}
@ -107,7 +107,7 @@ This will help you simplify your data management and optimize your performance i
**GCP Credentials**: **GCP Credentials**:
You can authenticate with your bigquery instance using either `GCP Credentials Path` where you can specify the file path of the service account key or you can pass the values directly by choosing the `GCP Credentials Values` from the service account key file. You can authenticate with your bigquery instance using either `GCP Credentials Path` where you can specify the file path of the service account key or you can pass the values directly by choosing the `GCP Credentials Values` from the service account key file.
You can checkout [this](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console) documentation on how to create the service account keys and download it. You can check out [this](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console) documentation on how to create the service account keys and download it.
**GCP Credentials Values**: Passing the raw credential values provided by BigQuery. This requires us to provide the following information, all provided by BigQuery: **GCP Credentials Values**: Passing the raw credential values provided by BigQuery. This requires us to provide the following information, all provided by BigQuery:

30
openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/create-credentials.md
View File

@ -3,11 +3,13 @@ title: BigQuery
slug: /connectors/database/bigquery/create-credentials slug: /connectors/database/bigquery/create-credentials
--- ---
# Create custom role in GCP # Create Credentials for BigQuery Ingestion
This documentation will guide you on how to create a custom role in GCP with the necessary permissions to ingest BigQuery in OpenMetadata. This documentation provides a step-by-step guide on how to create a custom role in Google Cloud Platform (GCP) with the necessary permissions to ingest BigQuery in OpenMetadata. It covers the process of navigating to the Roles section in the GCP console, creating a role, adding permissions, and creating a service account with credentials. By following these instructions, you will be able to set up the required role and credentials to access and ingest BigQuery metadata in OpenMetadata. Let's get started!
## Step 1: Navigate to Roles ## 1. Create custom role in GCP
### Step 1: Navigate to Roles
Search for `Roles` in your GCP console and select the first result under `IAM & Roles` section. Search for `Roles` in your GCP console and select the first result under `IAM & Roles` section.
@ -17,18 +19,15 @@ alt="Navigate to Roles"
caption="Navigate to Roles" /%} caption="Navigate to Roles" /%}
## Step 2: Create Role & Add Permissions ### Step 2: Create Role & Add Permissions
Below the search bar you should see a `Create Role` button click on that & navigate to create role page. Below the search bar you should see a `Create Role` button click on that & navigate to create role page.
{% image {% image
src="/images/v1.4/connectors/bigquery/create-role-2.png" src="/images/v1.4/connectors/bigquery/create-role-2.png"
alt="Create Role Button" alt="Create Role Button"
caption="Create Role" /%} caption="Create Role" /%}
Once You are on the create role page, you can edit the description & title of the role and finally you can click on `add permissions` to grant permissions to role. Once You are on the create role page, you can edit the description & title of the role and finally you can click on `add permissions` to grant permissions to role.
{% image {% image
@ -36,11 +35,9 @@ src="/images/v1.4/connectors/bigquery/create-role-3.png"
alt="Create Role" alt="Create Role"
caption="Create Role" /%} caption="Create Role" /%}
You can search for the required permissions in the filter box and add them accordingly. To ingest metadata from BigQuery you need to grant the following permissions to the user. You can search for the required permissions in the filter box and add them accordingly. To ingest metadata from BigQuery you need to grant the following permissions to the user.
| # | GCP Permission | Required For | | # | GCP Permission | Required For |
| :--- | :---------------------------- | :---------------------- | | :--- | :---------------------------- | :---------------------- |
| 1 | bigquery.datasets.get | Metadata Ingestion | | 1 | bigquery.datasets.get | Metadata Ingestion |
@ -70,12 +67,9 @@ src="/images/v1.4/connectors/bigquery/create-role-5.png"
alt="Add Permissions" alt="Add Permissions"
caption="Add Permissions" /%} caption="Add Permissions" /%}
# Create Service Account & Credential ## 2. Create Service Account
This documentation will guide you on how to create a service account in GCP and create credentials to access the same. ### Step 1: Navigate to Service Accounts
## Navigate to Service Accounts
Login to your GCP console and navigate to service accounts page. Login to your GCP console and navigate to service accounts page.
@ -85,7 +79,7 @@ alt="Navigate to Service Accounts"
caption="Navigate to Service Accounts" /%} caption="Navigate to Service Accounts" /%}
## Create Service Account & Grant Role ### Step 2: Create Service Account & Grant Role
Once you are on service account page, click on `Create Service Account` button. Once you are on service account page, click on `Create Service Account` button.
@ -109,7 +103,9 @@ alt="Grant Role to Service Account"
caption="Grant Role to Service Account" /%} caption="Grant Role to Service Account" /%}
## Create Key Credentials ## 3. Create & Download Key Credentials
### Step 1: Navigate to Service Accounts
On service accounts page, look for the service account that you just created, click on the three dots menu and go to manage keys On service accounts page, look for the service account that you just created, click on the three dots menu and go to manage keys
@ -119,6 +115,8 @@ alt="Service Account Manage Keys"
caption="Service Account Manage Keys" /%} caption="Service Account Manage Keys" /%}
### Step 2: Download Key Credentials
Click on Add Key > New Key > Select Json and download the key. Click on Add Key > New Key > Select Json and download the key.
{% image {% image

4
openmetadata-docs/content/v1.5.x-SNAPSHOT/connectors/database/bigquery/index.md
View File

@ -37,7 +37,7 @@ You need to create an service account in order to ingest metadata from bigquery
{% tile {% tile
icon="manage_accounts" icon="manage_accounts"
title="Create Custom GCP Role" title="Create Custom GCP Role"
description="Checkout this documentation on how to create a custom role and assign it to the service account." description="Check out this documentation on how to create a custom role and assign it to the service account."
link="/connectors/database/bigquery/roles" link="/connectors/database/bigquery/roles"
/ %} / %}
{% /tilesContainer %} {% /tilesContainer %}
@ -106,7 +106,7 @@ This will help you simplify your data management and optimize your performance i
**GCP Credentials**: **GCP Credentials**:
You can authenticate with your bigquery instance using either `GCP Credentials Path` where you can specify the file path of the service account key or you can pass the values directly by choosing the `GCP Credentials Values` from the service account key file. You can authenticate with your bigquery instance using either `GCP Credentials Path` where you can specify the file path of the service account key or you can pass the values directly by choosing the `GCP Credentials Values` from the service account key file.
You can checkout [this](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console) documentation on how to create the service account keys and download it. You can check out [this](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console) documentation on how to create the service account keys and download it.
**GCP Credentials Values**: Passing the raw credential values provided by BigQuery. This requires us to provide the following information, all provided by BigQuery: **GCP Credentials Values**: Passing the raw credential values provided by BigQuery. This requires us to provide the following information, all provided by BigQuery: