Skip to content

Commit

Permalink
add cloud cli to relevant pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 committed Oct 4, 2023
1 parent 48e2408 commit bda6e5d
Show file tree
Hide file tree
Showing 13 changed files with 62 additions and 57 deletions.
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.

**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
53 changes: 27 additions & 26 deletions website/docs/docs/cloud/about-cloud/dbt-cloud-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,90 +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 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/cloud-cli-installation"
icon="pencil-paper"/>
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 CLI"
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"
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
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
4 changes: 2 additions & 2 deletions website/docs/docs/dbt-cloud-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ id: "dbt-cloud-environments"
description: "Learn about dbt Cloud's development environment to execute your project in the IDE"
---

An environment determines how dbt Cloud will execute your project in both the dbt Cloud IDE (for development) and scheduled jobs (for deployment).
An environment determines how dbt Cloud will execute your project in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) or [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) (for development) and scheduled jobs (for deployment).

Critically, in order to execute dbt, environments define three variables:

Expand Down Expand Up @@ -34,7 +34,7 @@ To create a new dbt Cloud development environment:

### Set developer credentials

To use the IDE, each developer will need to set up [personal development credentials](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud#access-the-cloud-ide) to your warehouse connection in their **Profile Settings**. This allows you to set separate target information and maintain individual credentials to connect to your warehouse via the dbt Cloud IDE.
To use the dbt Cloud IDE or dbt Cloud CLI, each developer will need to set up [personal development credentials](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud#access-the-cloud-ide) to your warehouse connection in their **Profile Settings**. This allows you to set separate target information and maintain individual credentials to connect to your warehouse.


<Lightbox src="/img/docs/dbt-cloud/refresh-ide/new-environment-fields.png" width="85%" height="100" title="Creating a development environment"/>
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/environments-in-dbt.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Configure environments to tell dbt Cloud or dbt Core how to build and execute yo

<Card
title="Environments in dbt Cloud"
body="Seamlessly configure development and deployment environments in dbt Cloud to control how your project runs in both the dbt Cloud IDE and dbt jobs."
body="Seamlessly configure development and deployment environments in dbt Cloud to control how your project runs in both the dbt Cloud IDE, dbt Cloud CLI, and dbt jobs."
link="/docs/dbt-cloud-environments"
icon="dbt-bit"/>

Expand Down
5 changes: 4 additions & 1 deletion website/docs/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,17 @@ Read more about why we want to enable analysts to work more like software engine
You can access dbt using dbt Core or dbt Cloud. dbt Cloud is built around dbt Core, but it also provides:

- Web-based UI so it’s more accessible
- dbt Cloud-powered command line (CLI) to develop, test, version control dbt projects, and run dbt commands
- Hosted environment so it’s faster to get up and running
- Differentiated features, such as metadata, in-app job scheduler, observability, integrations with other tools, integrated development environment (IDE), and more.

You can learn about plans and pricing on [www.getdbt.com](https://www.getdbt.com/pricing/).

### dbt Cloud

dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, and investigate data models all in one web-based UI. Learn more about [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features) and try one of the [dbt Cloud quickstarts](/quickstarts).
dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, and investigate data models all in one web-based UI. dbt Cloud also natively supports developing using a command line to run dbt commands against your dbt Cloud development environment.

Learn more about [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features) and try one of the [dbt Cloud quickstarts](/quickstarts).

### dbt Core

Expand Down
4 changes: 2 additions & 2 deletions website/docs/docs/supported-data-platforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide_table_of_contents: true

dbt connects to and runs SQL against your database, warehouse, lake, or query engine. These SQL-speaking platforms are collectively referred to as _data platforms_. dbt connects with data platforms by using a dedicated adapter plugin for each. Plugins are built as Python modules that dbt Core discovers if they are installed on your system. Read [What are Adapters](/guides/dbt-ecosystem/adapter-development/1-what-are-adapters) for more info.

You can [connect](/docs/connect-adapters) to adapters and data platforms either directly in the dbt Cloud user interface (UI) or install them manually using the command line (CLI).
You can [connect](/docs/connect-adapters) to adapters and data platforms natively in dbt Cloud or install them manually using dbt Core.

You can also further customize how dbt works with your specific data platform via configuration: see [Configuring Postgres](/reference/resource-configs/postgres-configs) for an example.

Expand Down Expand Up @@ -36,5 +36,5 @@ import AdaptersTrusted from '/snippets/_adapters-trusted.md';

<AdaptersTrusted />

<br/> * Install these adapters using the CLI as they're not currently supported in dbt Cloud. <br />
<br/> * Install these adapters using dbt Core as they're not currently supported in dbt Cloud. <br />

2 changes: 1 addition & 1 deletion website/docs/docs/trusted-adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ hide_table_of_contents: true

Trusted adapters are adapters not maintained by dbt Labs, that we feel comfortable recommending to users for use in production.

Free and open-source tools for the data professional are increasingly abundant. This is by-and-large a *good thing*, however it requires due dilligence that wasn't required in a paid-license, closed-source software world. As a user, there are questions to answer important before taking a dependency on an open-source project. The trusted adapter designation is meant to streamline this process for end users.
Free and open-source tools for the data professional are increasingly abundant. This is by-and-large a *good thing*, however it requires due diligence that wasn't required in a paid-license, closed-source software world. As a user, there are questions to answer important before taking a dependency on an open-source project. The trusted adapter designation is meant to streamline this process for end users.

<details><summary>Considerations for depending on an open-source project</summary>

Expand Down
2 changes: 1 addition & 1 deletion website/snippets/_adapters-trusted.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<Card
title="Athena*"
body="<a href='/docs/core/connect-data-platform/athena-setup'><img src='/img/icons/dbt-bit.svg' width='7%'/>Install using the CLI </a> <br /><br /><a href=https://badge.fury.io/py/dbt-athena-community><img src=https://badge.fury.io/py/dbt-athena-community.svg/></a>"
body="<a href='/docs/core/connect-data-platform/athena-setup'><img src='/img/icons/dbt-bit.svg' width='7%'/>Install with dbt Core </a> <br /><br /><a href=https://badge.fury.io/py/dbt-athena-community><img src=https://badge.fury.io/py/dbt-athena-community.svg/></a>"
icon="athena"/>

</div>
Loading

0 comments on commit bda6e5d

Please sign in to comment.