Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add cloud cli links #4179

Merged
merged 42 commits into from
Oct 10, 2023
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
f67d8f2
add card
mirnawong1 Oct 4, 2023
48e2408
Merge branch 'mwong-cloud-cli-beta' into mwong-cloud-cli-links
mirnawong1 Oct 4, 2023
bda6e5d
add cloud cli to relevant pages
mirnawong1 Oct 4, 2023
95c7015
cloud cli updates
mirnawong1 Oct 4, 2023
2e6d1b2
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 4, 2023
c429896
update command page
mirnawong1 Oct 4, 2023
123437f
clarify language
mirnawong1 Oct 4, 2023
169f5e0
tweak language
mirnawong1 Oct 4, 2023
183619a
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 5, 2023
54a3b2f
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 5, 2023
f3fedc7
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 6, 2023
4cc2dc8
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
5cc4ccd
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
2c287c4
update commands
mirnawong1 Oct 6, 2023
b796849
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
f849f29
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
533f1d6
Update website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md
mirnawong1 Oct 6, 2023
0d5b0f7
Update website/docs/docs/core/about-the-cli.md
mirnawong1 Oct 6, 2023
6e0f27f
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 6, 2023
2074866
improve ux
mirnawong1 Oct 6, 2023
4e1789b
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
3e567d0
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
224e839
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
9a399cb
update intro
mirnawong1 Oct 9, 2023
1852c42
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 9, 2023
c5f98e8
Update cloud-cli-installation.md
mirnawong1 Oct 9, 2023
01fd0e5
Update website/docs/docs/cloud/cloud-cli-installation.md
mirnawong1 Oct 9, 2023
96a6ff1
Update website/docs/docs/about-setup.md
mirnawong1 Oct 10, 2023
f9a1cf1
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 10, 2023
814ac40
Update website/docs/docs/cloud/about-cloud-develop.md
mirnawong1 Oct 10, 2023
c123877
Update website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md
mirnawong1 Oct 10, 2023
66c20e7
Update website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md
mirnawong1 Oct 10, 2023
0b8abe5
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
356d126
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
43d57da
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
ac4ae6d
Update cloud-cli-installation.md
mirnawong1 Oct 10, 2023
94562f5
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
21b1db8
updates
mirnawong1 Oct 10, 2023
c42e2f9
Merge branch 'cloud-cli-2' into mwong-cloud-cli-links
mirnawong1 Oct 10, 2023
e2abba0
update pages and add redirect
mirnawong1 Oct 10, 2023
a71635a
Update website/docs/docs/cloud/about-cloud/dbt-cloud-features.md
mirnawong1 Oct 10, 2023
9408875
Update develop-in-the-cloud.md
mirnawong1 Oct 10, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/docs/docs/about-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: "About dbt setup"

dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. There are two options for deploying dbt:

**dbt Cloud** runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based interface. The intuitive UI will aid you in setting up the various components. dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring & alerting, and an integrated developer environment (IDE).
**dbt Cloud** runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based interface. The intuitive UI will aid you in setting up the various components. dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring and alerting, an integrated development environment (IDE), and allows you to develop and run dbt commands from your local command line (CLI) or code editor.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

**dbt Core** is an open-source command line tool that can be installed locally in your environment, and communication with databases is facilitated through adapters.

Expand All @@ -19,7 +19,7 @@ To begin configuring dbt now, select the option that is right for you.

<Card
title="dbt Cloud setup"
body="Learn how to connect to a data platform, integrate with secure authentication methods, configure a sync with a git repo, and how to use the IDE."
body="Learn how to connect to a data platform, integrate with secure authentication methods, configure a sync with a git repo, how to use the IDE, and how to install the dbt Cloud CLI."
link="/docs/cloud/about-cloud-setup"
icon="dbt-bit"/>

Expand Down
4 changes: 1 addition & 3 deletions website/docs/docs/cloud/about-cloud-develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@ pagination_next: "docs/cloud/cloud-cli-installation"
dbt Cloud offers a fast and reliable way to work on your dbt project. You can use it through an integrated development environment (IDE) in your browser or a dbt Cloud-powered command line interface (CLI):

- **[dbt Cloud CLI](/docs/cloud/cloud-cli-installation)** &mdash; Allows you to develop and run dbt commands from your local command line or code editor against your dbt Cloud development environment.
- Note, the dbt Cloud CLI is distinct from [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source command-line tool for dbt. Both tools are command lines that use the same dbt commands, however, the dbt Cloud CLI is tailored to run specifically on dbt Cloud's infrastructure.

- **[dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud)** &mdash; Develop directly in your browser, making dbt project development efficient by compiling code into SQL and managing project changes seamlessly using an intuitive user interface (UI).

This documentation section provides detailed instructions on setting up the dbt Cloud CLI and dbt Cloud IDE. To get started with dbt development, you'll need a [developer](/docs/cloud/manage-access/seats-and-users) account. For a more comprehensive setup guide, refer to our [quickstart guides](/quickstarts).
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved



Something to note is that the dbt Cloud CLI and the open-sourced dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions website/docs/docs/cloud/about-cloud-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ dbt Cloud is the fastest and most reliable way to deploy your dbt jobs. It conta
- Configuring access to [GitHub](/docs/cloud/git/connect-github), [GitLab](/docs/cloud/git/connect-gitlab), or your own [git repo URL](/docs/cloud/git/import-a-project-by-git-url).
- [Managing users and licenses](/docs/cloud/manage-access/seats-and-users)
- [Configuring secure access](/docs/cloud/manage-access/about-user-access)
- Configuring the [dbt Cloud IDE](/docs/cloud/about-cloud-develop)
- Installing and configuring the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation)

These settings are intended for dbt Cloud administrators. If you need a more detailed first-time setup guide for specific data platforms, read our [quickstart guides](/quickstarts).

Expand Down
49 changes: 28 additions & 21 deletions website/docs/docs/cloud/about-cloud/dbt-cloud-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,84 +6,91 @@ description: "Explore dbt Cloud's features and learn why dbt Cloud is the fastes
hide_table_of_contents: true
---

dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, document, and investigate data models all in one browser-based UI. In addition to providing a hosted architecture for running dbt across your organization, dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring & alerting, and an integrated development environment (IDE).
dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, document, and investigate data models all in one browser-based UI.

In addition to providing a hosted architecture for running dbt across your organization, dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring and alerting, an integrated development environment (IDE), and allows you to develop and run dbt commands from your local command line (CLI) or code editor.

dbt Cloud's [flexible plans](https://www.getdbt.com/pricing/) and features make it well-suited for data teams of any size &mdash; sign up for your [free 14-day trial](https://www.getdbt.com/signup/)!

<div className="grid--3-col">

<Card
title="dbt Cloud CLI"
body="Use the dbt Cloud CLI to develop, test, run, and version control dbt projects and commands in your dbt Cloud development environment. Collaborate with team members, directly from the command line."
link="/docs/cloud/cloud-cli-installation"
icon="dbt-bit"/>

<Card
title="dbt Cloud IDE"
body="The IDE is the easiest and most efficient way to develop dbt models, allowing you to build, test, run, and version control your dbt projects directly from your browser."
link="/docs/cloud/dbt-cloud-ide/develop-in-the-cloud"
icon="pencil-paper"/>
link="/docs/cloud/cloud-cli-installation"
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
icon="dbt-bit"/>

<Card
title="Manage environments"
body="Set up and manage separate production and development environments in dbt Cloud to help engineers develop and test code more efficiently, without impacting users or data."
link="/docs/environments-in-dbt"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="Schedule and run dbt jobs"
body="Create custom schedules to run your production jobs. Schedule jobs by day of the week, time of day, or a recurring interval. Decrease operating costs by using webhooks to trigger CI jobs and the API to start jobs."
link="/docs/deploy/job-scheduler"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="Notifications"
body="Set up and customize job notifications in dbt Cloud to receive email or slack alerts when a job run succeeds, fails, or is cancelled. Notifications alert the right people when something goes wrong instead of waiting for a user to report it."
link="/docs/deploy/job-notifications"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="Run visibility"
body="View the history of your runs and the model timing dashboard to help identify where improvements can be made to the scheduled jobs."
link="/docs/deploy/run-visibility"
icon="dbt-bit"/>

<Card
title="Host & share documentation"
body="dbt Cloud hosts and authorizes access to dbt project documentation, allowing you to generate data documentation on a schedule for your project. Invite teammates to dbt Cloud to collaborate and share your project's documentation."
link="/docs/collaborate/build-and-view-your-docs"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="Supports GitHub, GitLab, AzureDevOPs"
body="Seamlessly connect your git account to dbt Cloud and provide another layer of security to dbt Cloud. Import new repositories, trigger continuous integration, clone repos using HTTPS, and more!"
link="/docs/cloud/git/connect-github"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="Enable Continuous Integration"
body="Configure dbt Cloud to run your dbt projects in a temporary schema when new commits are pushed to open pull requests. This build-on-PR functionality is a great way to catch bugs before deploying to production, and an essential tool in any analyst's belt."
link="/docs/deploy/continuous-integration"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="Security"
body="Manage risk with SOC-2 compliance, CI/CD deployment, RBAC, and ELT architecture."
link="https://www.getdbt.com/security/"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="dbt Semantic Layer*"
body="Use the dbt Semantic Layer to define metrics alongside your dbt models and query them from any integrated analytics tool. Get the same answers everywhere, every time."
link="/docs/use-dbt-semantic-layer/dbt-sl"
icon="pencil-paper"/>
icon="dbt-bit"/>

<Card
title="Discovery API*"
body="Enhance your workflow and run ad-hoc queries, browse schema, or query the dbt Semantic Layer. dbt Cloud serves a GraphQL API, which supports arbitrary queries."
link="/docs/dbt-cloud-apis/discovery-api"
icon="pencil-paper"/>
icon="dbt-bit"/>


<Card
title="Run visibility"
body="View the history of your runs and the model timing dashboard to help identify where improvements can be made to the scheduled jobs."
link="/docs/deploy/run-visibility"
icon="pencil-paper"/>

<Card
<Card
title="dbt Explorer*"
body="Learn about dbt Explorer and how to interact with it to understand, improve, and leverage your data pipelines."
link="/docs/collaborate/explore-projects"
icon="pencil-paper"/>
icon="dbt-bit"/>
</div> <br />

*These features are available on [selected plans](https://www.getdbt.com/pricing/).
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/cloud/git/authenticate-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: "Authenticate with Azure DevOps"
---


If you use the dbt Cloud IDE to collaborate on your team's Azure DevOps dbt repo, you need to [link your dbt Cloud profile to Azure DevOps](#link-your-dbt-cloud-profile-to-azure-devops), which provides an extra layer of authentication.
If you use the dbt Cloud IDE or dbt Cloud CLI to collaborate on your team's Azure DevOps dbt repo, you need to [link your dbt Cloud profile to Azure DevOps](#link-your-dbt-cloud-profile-to-azure-devops), which provides an extra layer of authentication.

## Link your dbt Cloud profile to Azure DevOps

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/cloud/git/connect-azure-devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Connect your Azure DevOps cloud account in dbt Cloud to unlock new product exper
- Import new Azure DevOps repos with a couple clicks during dbt Cloud project setup.
- Clone repos using HTTPS rather than SSH
- Enforce user authorization with OAuth 2.0.
- Carry Azure DevOps user repository permissions (read / write access) through to dbt Cloud IDE's git actions.
- Carry Azure DevOps user repository permissions (read / write access) through to dbt Cloud IDE or dbt Cloud CLI's git actions.
- Trigger Continuous integration (CI) builds when pull requests are opened in Azure DevOps.


Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/cloud/git/connect-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ To connect a personal GitHub account:

4. Once you approve authorization, you will be redirected to dbt Cloud, and you should now see your connected account.

The next time you log into dbt Cloud, you will be able to do so via OAuth through GitHub, and if you're on the Enterprise plan, you're ready to use the dbt Cloud IDE.
The next time you log into dbt Cloud, you will be able to do so via OAuth through GitHub, and if you're on the Enterprise plan, you're ready to use the dbt Cloud IDE or dbt Cloud CLI.


## FAQs
Expand Down
8 changes: 4 additions & 4 deletions website/docs/docs/cloud/git/connect-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ id: "connect-gitlab"
Connecting your GitLab account to dbt Cloud provides convenience and another layer of security to dbt Cloud:
- Import new GitLab repos with a couple clicks during dbt Cloud project setup.
- Clone repos using HTTPS rather than SSH.
- Carry GitLab user permissions through to dbt Cloud IDE's git actions.
- Carry GitLab user permissions through to dbt Cloud or dbt Cloud CLI's git actions.
- Trigger [Continuous integration](/docs/deploy/continuous-integration) builds when merge requests are opened in GitLab.

The steps to integrate GitLab in dbt Cloud depend on your plan. If you are on:
Expand All @@ -35,7 +35,7 @@ Once you've accepted, you should be redirected back to dbt Cloud, and you'll see

dbt Cloud enterprise customers have the added benefit of bringing their own GitLab OAuth application to dbt Cloud. This tier benefits from extra security, as dbt Cloud will:
- Enforce user authorization with OAuth.
- Carry GitLab's user repository permissions (read / write access) through to dbt Cloud IDE's git actions.
- Carry GitLab's user repository permissions (read / write access) through to dbt Cloud or dbt Cloud CLI's git actions.

In order to connect GitLab in dbt Cloud, a GitLab account admin must:
1. [Set up a GitLab OAuth application](#setting-up-a-gitlab-oauth-application).
Expand Down Expand Up @@ -97,15 +97,15 @@ You will then be redirected to GitLab and prompted to sign into your account. Gi
Once you've accepted, you should be redirected back to dbt Cloud, and your integration is ready for developers on your team to [personally authenticate with](#personally-authenticating-with-gitlab).

### Personally authenticating with GitLab
dbt Cloud developers on the Enterprise plan must each connect their GitLab profiles to dbt Cloud, as every developer's read / write access for the dbt repo is checked in the dbt Cloud IDE.
dbt Cloud developers on the Enterprise plan must each connect their GitLab profiles to dbt Cloud, as every developer's read / write access for the dbt repo is checked in the dbt Cloud IDE or dbt Cloud CLI.

To connect a personal GitLab account, dbt Cloud developers should navigate to Your Profile settings by clicking the gear icon in the top right, then select **Linked Accounts** in the left menu.

If your GitLab account is not connected, you’ll see "No connected account". Select **Link** to begin the setup process. You’ll be redirected to GitLab, and asked to authorize dbt Cloud in a grant screen.

<Lightbox src="/img/docs/dbt-cloud/connecting-gitlab/GitLab-Auth.png" title="Authorizing the dbt Cloud app for developers" />

Once you approve authorization, you will be redirected to dbt Cloud, and you should see your connected account. You're now ready to start developing in the dbt Cloud IDE.
Once you approve authorization, you will be redirected to dbt Cloud, and you should see your connected account. You're now ready to start developing in the dbt Cloud IDE or dbt Cloud CLI.


## Troubleshooting
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/cloud/git/setup-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Once you connect your Azure AD app and Azure DevOps, you need to provide dbt Clo
- **Directory(tenant) ID:** Found in the Azure AD App.
<Lightbox src="/img/docs/dbt-cloud/connecting-azure-devops/AzureDevopsAppdbtCloud.gif" title="Adding an Active Directory App to dbt Cloud"/>

Your Azure AD app should now be added to your dbt Cloud Account. People on your team who want to develop in dbt Cloud's IDE can now personally [authorize Azure DevOps from their profiles](/docs/cloud/git/authenticate-azure).
Your Azure AD app should now be added to your dbt Cloud Account. People on your team who want to develop in the dbt Cloud IDE or dbt Cloud CLI can now personally [authorize Azure DevOps from their profiles](/docs/cloud/git/authenticate-azure).

## Connect a service user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The user's assigned license determines the specific capabilities they can access
| Functionality | Developer User | Read-Only Users | IT Users* |
| ------------- | -------------- | --------------- | -------- |
| Use the dbt Cloud IDE | ✅ | ❌ | ❌ |
| Use the dbt Cloud CLI | ✅ | ❌ | ❌ |
| Use Jobs | ✅ | ❌ | ❌ |
| Manage Account | ✅ | ❌ | ✅ |
| API Access | ✅ | ❌ | ❌ |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ The permissions afforded to each role are described below:
| ------ | ------ | ----- |
| View and edit resources | ✅ | ✅ |
| Trigger runs | ✅ | ✅ |
| Access the IDE | ✅ | ✅ |
| Access the dbt Cloud IDE | ✅ | ✅ |
| Access the dbt Cloud CLI | ✅ | ✅ |
| Invite Members to the account | ✅ | ✅ |
| Manage billing | ❌ | ✅ |
| Manage team permissions | ❌ | ✅ |
Expand Down
4 changes: 2 additions & 2 deletions website/docs/docs/connect-adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ This section provides more details on different ways you can connect dbt to an a

Explore the fastest and most reliable way to deploy dbt using dbt Cloud, a hosted architecture that runs dbt Core across your organization. dbt Cloud lets you seamlessly [connect](/docs/cloud/about-cloud-setup) with a variety of [verified](/docs/supported-data-platforms) data platform providers directly in the dbt Cloud UI.

### Install using the CLI
### Install with dbt Core

Install dbt Core, which is an open-source tool, locally using the CLI. dbt communicates with a number of different data platforms by using a dedicated adapter plugin for each. When you install dbt Core, you'll also need to install the specific adapter for your database, [connect to dbt Core](/docs/core/about-core-setup), and set up a `profiles.yml` file.
Install dbt Core, an open-source tool, locally using the command line. dbt communicates with a number of different data platforms by using a dedicated adapter plugin for each. When you install dbt Core, you'll also need to install the specific adapter for your database, [connect to dbt Core](/docs/core/about-core-setup), and set up a `profiles.yml` file.

With a few exceptions [^1], you can install all [Verified adapters](/docs/supported-data-platforms) from PyPI using `pip install adapter-name`. For example to install Snowflake, use the command `pip install dbt-snowflake`. The installation will include `dbt-core` and any other required dependencies, which may include both other dependencies and even other adapter plugins. Read more about [installing dbt](/docs/core/installation).

Expand Down
Loading