yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-11-02 19:48:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor: Updated dbt cloud docs (#17952)

Browse Source 
* Minor: Updated dbt cloud docs

* removed conflicting changes
This commit is contained in:
Suman Maharana 2024-09-23 14:40:59 +05:30 committed by GitHub
parent 9ed21cec4a
commit 2bf5e75739
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
openmetadata-docs/content/v1.5.x/connectors/pipeline/dbtcloud/index.md
View File

@ -1,5 +1,5 @@
--- ---
title: DBTCloud title: dbt Cloud
slug: /connectors/pipeline/dbtcloud slug: /connectors/pipeline/dbtcloud
--- ---
@ -12,12 +12,12 @@ unavailableFeatures=["Owners", "Tags"]
/ %} / %}
In this section, we provide guides and references to use the DBTCloud connector. In this section, we provide guides and references to use the dbt Cloud connector.
Configure and schedule DBTCloud metadata and profiler workflows from the OpenMetadata UI: Configure and schedule dbt Cloud metadata and profiler workflows from the OpenMetadata UI:
- [Requirements](#requirements) - [Requirements](#requirements)
- [DBTCloud Versions](#dbtcloud-versions) - [dbt Cloud Versions](#dbtcloud-versions)
- [Metadata Ingestion](#metadata-ingestion) - [Metadata Ingestion](#metadata-ingestion)
- [Service Name](#service-name) - [Service Name](#service-name)
- [Connection Details](#connection-details) - [Connection Details](#connection-details)
@ -29,18 +29,18 @@ Configure and schedule DBTCloud metadata and profiler workflows from the OpenMet
## Requirements ## Requirements
### DBTCloud Versions ### dbt Cloud Versions
OpenMetadata is integrated with DBT cloud up to version [1.8](https://docs.getdbt.com/docs/get-started-dbt) and will continue to work for future DBT cloud versions. OpenMetadata is integrated with DBT cloud up to version [1.8](https://docs.getdbt.com/docs/get-started-dbt) and will continue to work for future DBT cloud versions.
The Ingestion framework uses [DBT Cloud APIs](https://docs.getdbt.com/dbt-cloud/api-v2#/) to connect to the dbtcloud and fetch metadata. The Ingestion framework uses [DBT Cloud APIs](https://docs.getdbt.com/dbt-cloud/api-v2#/) to connect to the dbtcloud and fetch metadata.
### DBTCloud Permissions ### dbt Cloud Permissions
The DBT Clous API User token or Service account token must have the permission to fetch Metadata. The DBT Clous API User token or Service account token must have the permission to fetch Metadata.
To know more about permissions required refer [here](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens#permissions-for-service-account-tokens). To know more about permissions required refer [here](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens#permissions-for-service-account-tokens).
### DBTCloud Account ### dbt Cloud Account
- DBT Cloud [multi-tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#multi-tenant) or [single tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#single-tenant) account is required. - DBT Cloud [multi-tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#multi-tenant) or [single tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#single-tenant) account is required.
- You must be on a [Team or Enterprise plan](https://www.getdbt.com/pricing/). - You must be on a [Team or Enterprise plan](https://www.getdbt.com/pricing/).
@ -65,7 +65,7 @@ To know more about permissions required refer [here](https://docs.getdbt.com/doc
- **Host**: DBT cloud Access URL eg.`https://abc12.us1.dbt.com`. Go to your dbt cloud account settings to know your Access URL. - **Host**: DBT cloud Access URL eg.`https://abc12.us1.dbt.com`. Go to your dbt cloud account settings to know your Access URL.
- **Discovery API URL** : DBT cloud Access URL eg. `https://metadata.cloud.getdbt.com/graphql`. Go to your dbt cloud account settings to know your Discovery API url. - **Discovery API URL** : DBT cloud Access URL eg. `https://metadata.cloud.getdbt.com/graphql`. Go to your dbt cloud account settings to know your Discovery API url. Make sure you have `/graphql` at the end of your URL.
- **Account Id** : The Account ID of your DBT cloud Project. Go to your dbt cloud account settings to know your Account Id. This will be a numeric value but in openmetadata we parse it as a string. - **Account Id** : The Account ID of your DBT cloud Project. Go to your dbt cloud account settings to know your Account Id. This will be a numeric value but in openmetadata we parse it as a string.
@ -92,7 +92,7 @@ Steps to retrieve and display the lineage information for a DBT Cloud service. N
By successfully completing these steps, the lineage information for the service will be displayed. By successfully completing these steps, the lineage information for the service will be displayed.
{% image {% image
src="/images/v1.5/connectors/dbtcloud/lineage.webp" src="/images/v1.5/connectors/dbtcloud/lineage.png"
alt="DBT Cloud Lineage" /%} alt="DBT Cloud Lineage" /%}

8
openmetadata-docs/content/v1.5.x/connectors/pipeline/dbtcloud/yaml.md
View File

@ -1,5 +1,5 @@
--- ---
title: Run the DBTCloud Connector Externally title: Run the dbt Cloud Connector Externally
slug: /connectors/pipeline/dbtcloud/yaml slug: /connectors/pipeline/dbtcloud/yaml
--- ---
@ -12,9 +12,9 @@ unavailableFeatures=["Owners", "Lineage"]
/ %} / %}
In this section, we provide guides and references to use the DBTCloud connector. In this section, we provide guides and references to use the dbt Cloud connector.
Configure and schedule DBTCloud metadata and profiler workflows from the OpenMetadata UI: Configure and schedule dbt Cloud metadata and profiler workflows from the OpenMetadata UI:
- [Requirements](#requirements) - [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion) - [Metadata Ingestion](#metadata-ingestion)
@ -42,7 +42,7 @@ The workflow is modeled around the following
### 1. Define the YAML Config ### 1. Define the YAML Config
This is a sample config for DBTCloud: This is a sample config for dbt Cloud:
{% codePreview %} {% codePreview %}

24
openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/pipeline/dbtcloud/index.md
View File

@ -1,5 +1,5 @@
--- ---
title: DBTCloud title: dbt Cloud
slug: /connectors/pipeline/dbtcloud slug: /connectors/pipeline/dbtcloud
--- ---
@ -12,12 +12,12 @@ unavailableFeatures=["Owners", "Tags"]
/ %} / %}
In this section, we provide guides and references to use the DBTCloud connector. In this section, we provide guides and references to use the dbt Cloud connector.
Configure and schedule DBTCloud metadata and profiler workflows from the OpenMetadata UI: Configure and schedule dbt Cloud metadata and profiler workflows from the OpenMetadata UI:
- [Requirements](#requirements) - [Requirements](#requirements)
- [DBTCloud Versions](#dbtcloud-versions) - [dbt Cloud Versions](#dbtcloud-versions)
- [Metadata Ingestion](#metadata-ingestion) - [Metadata Ingestion](#metadata-ingestion)
- [Service Name](#service-name) - [Service Name](#service-name)
- [Connection Details](#connection-details) - [Connection Details](#connection-details)
@ -29,18 +29,18 @@ Configure and schedule DBTCloud metadata and profiler workflows from the OpenMet
## Requirements ## Requirements
### DBTCloud Versions ### dbt Cloud Versions
OpenMetadata is integrated with DBT cloud up to version [1.8](https://docs.getdbt.com/docs/get-started-dbt) and will continue to work for future DBT cloud versions. OpenMetadata is integrated with DBT cloud up to version [1.8](https://docs.getdbt.com/docs/get-started-dbt) and will continue to work for future DBT cloud versions.
The Ingestion framework uses [DBT Cloud APIs](https://docs.getdbt.com/dbt-cloud/api-v2#/) to connect to the dbtcloud and fetch metadata. The Ingestion framework uses [DBT Cloud APIs](https://docs.getdbt.com/dbt-cloud/api-v2#/) to connect to the dbtcloud and fetch metadata.
### DBTCloud Permissions ### dbt Cloud Permissions
The DBT Clous API User token or Service account token must have the permission to fetch Metadata. The DBT Clous API User token or Service account token must have the permission to fetch Metadata.
To know more about permissions required refer [here](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens#permissions-for-service-account-tokens). To know more about permissions required refer [here](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens#permissions-for-service-account-tokens).
### DBTCloud Account ### dbt Cloud Account
- DBT Cloud [multi-tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#multi-tenant) or [single tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#single-tenant) account is required. - DBT Cloud [multi-tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#multi-tenant) or [single tenant](https://docs.getdbt.com/docs/cloud/about-cloud/tenancy#single-tenant) account is required.
- You must be on a [Team or Enterprise plan](https://www.getdbt.com/pricing/). - You must be on a [Team or Enterprise plan](https://www.getdbt.com/pricing/).
@ -52,9 +52,9 @@ To know more about permissions required refer [here](https://docs.getdbt.com/doc
file="/v1.5/connectors/metadata-ingestion-ui.md" file="/v1.5/connectors/metadata-ingestion-ui.md"
variables={ variables={
connector: "DBTCloud", connector: "DBTCloud",
selectServicePath: "/images/v1.5/connectors/dbtcloud/select-service.webp", selectServicePath: "/images/v1.6/connectors/dbtcloud/select-service.webp",
addNewServicePath: "/images/v1.5/connectors/dbtcloud/add-new-service.webp", addNewServicePath: "/images/v1.6/connectors/dbtcloud/add-new-service.webp",
serviceConnectionPath: "/images/v1.5/connectors/dbtcloud/service-connection.webp", serviceConnectionPath: "/images/v1.6/connectors/dbtcloud/service-connection.webp",
} }
/%} /%}
@ -65,7 +65,7 @@ To know more about permissions required refer [here](https://docs.getdbt.com/doc
- **Host**: DBT cloud Access URL eg.`https://abc12.us1.dbt.com`. Go to your dbt cloud account settings to know your Access URL. - **Host**: DBT cloud Access URL eg.`https://abc12.us1.dbt.com`. Go to your dbt cloud account settings to know your Access URL.
- **Discovery API URL** : DBT cloud Access URL eg. `https://metadata.cloud.getdbt.com/graphql`. Go to your dbt cloud account settings to know your Discovery API url. - **Discovery API URL** : DBT cloud Access URL eg. `https://metadata.cloud.getdbt.com/graphql`. Go to your dbt cloud account settings to know your Discovery API url. Make sure you have `/graphql` at the end of your URL.
- **Account Id** : The Account ID of your DBT cloud Project. Go to your dbt cloud account settings to know your Account Id. This will be a numeric value but in openmetadata we parse it as a string. - **Account Id** : The Account ID of your DBT cloud Project. Go to your dbt cloud account settings to know your Account Id. This will be a numeric value but in openmetadata we parse it as a string.
@ -92,7 +92,7 @@ Steps to retrieve and display the lineage information for a DBT Cloud service. N
By successfully completing these steps, the lineage information for the service will be displayed. By successfully completing these steps, the lineage information for the service will be displayed.
{% image {% image
src="/images/v1.5/connectors/dbtcloud/lineage.webp" src="/images/v1.6/connectors/dbtcloud/lineage.png"
alt="DBT Cloud Lineage" /%} alt="DBT Cloud Lineage" /%}

8
openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/pipeline/dbtcloud/yaml.md
View File

@ -1,5 +1,5 @@
--- ---
title: Run the DBTCloud Connector Externally title: Run the dbt Cloud Connector Externally
slug: /connectors/pipeline/dbtcloud/yaml slug: /connectors/pipeline/dbtcloud/yaml
--- ---
@ -12,9 +12,9 @@ unavailableFeatures=["Owners", "Lineage"]
/ %} / %}
In this section, we provide guides and references to use the DBTCloud connector. In this section, we provide guides and references to use the dbt Cloud connector.
Configure and schedule DBTCloud metadata and profiler workflows from the OpenMetadata UI: Configure and schedule dbt Cloud metadata and profiler workflows from the OpenMetadata UI:
- [Requirements](#requirements) - [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion) - [Metadata Ingestion](#metadata-ingestion)
@ -42,7 +42,7 @@ The workflow is modeled around the following
### 1. Define the YAML Config ### 1. Define the YAML Config
This is a sample config for DBTCloud: This is a sample config for dbt Cloud:
{% codePreview %} {% codePreview %}

BIN
openmetadata-docs/images/v1.5/connectors/dbtcloud/lineage.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 177 KiB

BIN
openmetadata-docs/images/v1.6/connectors/dbtcloud/lineage.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 177 KiB