Skip to content

Commit

Permalink
add callout for redshift (#6049)
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 authored Sep 11, 2024
2 parents 1c2f909 + 8438da5 commit e6e288c
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions website/docs/guides/redshift-qs.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ Check out [dbt Fundamentals](https://learn.getdbt.com/courses/dbt-fundamentals)
1. Sign in to your [AWS account](https://signin.aws.amazon.com/console) as a root user or an IAM user depending on your level of access.
2. Use a CloudFormation template to quickly set up a Redshift cluster. A CloudFormation template is a configuration file that automatically spins up the necessary resources in AWS. [Start a CloudFormation stack](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=dbt-workshop&templateURL=https://tpch-sample-data.s3.amazonaws.com/create-dbtworkshop-infr) and you can refer to the [create-dbtworkshop-infr JSON file](https://github.com/aws-samples/aws-modernization-with-dbtlabs/blob/main/resources/cloudformation/create-dbtworkshop-infr) for more template details.

:::tip
To avoid connectivity issues with dbt Cloud, make sure to allow inbound traffic on port 5439 from [dbt Cloud's IP addresses](/docs/cloud/about-cloud/access-regions-ip-addresses) in your Redshift security groups and Network Access Control Lists (NACLs) settings.
:::

3. Click **Next** for each page until you reach the **Select acknowledgement** checkbox. Select **I acknowledge that AWS CloudFormation might create IAM resources with custom names** and click **Create Stack**. You should land on the stack page with a CREATE_IN_PROGRESS status.

Expand Down Expand Up @@ -165,6 +168,7 @@ Now we are going to load our sample data into the S3 bucket that our Cloudformat
select * from jaffle_shop.orders;
select * from stripe.payment;
```
## Connect dbt Cloud to Redshift
1. Create a new project in [dbt Cloud](/docs/cloud/about-cloud/access-regions-ip-addresses). From **Account settings** (using the gear menu in the top right corner), click **+ New Project**.
2. Enter a project name and click **Continue**.
Expand All @@ -173,17 +177,19 @@ Now we are going to load our sample data into the S3 bucket that our Cloudformat
- **Hostname** — Your entire hostname.
- **Port** — `5439`
- **Database** — `dbtworkshop`.
<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/redshift_tutorial/images/dbt_cloud_redshift_account_settings.png" title="dbt Cloud - Redshift Cluster Settings" />
</div>
<Lightbox src="/img/redshift_tutorial/images/dbt_cloud_redshift_account_settings.png" width="90%" title="dbt Cloud - Redshift Cluster Settings" />
:::tip
To avoid connectivity issues with dbt Cloud, make sure to allow inbound traffic on port 5439 from [dbt Cloud's IP addresses](/docs/cloud/about-cloud/access-regions-ip-addresses) in your Redshift security groups and Network Access Control Lists (NACLs) settings.
:::

5. Set your development credentials. These credentials will be used by dbt Cloud to connect to Redshift. Those credentials (as provided in your CloudFormation output) will be:
- **Username** &mdash; `dbtadmin`
- **Password** &mdash; This is the autogenerated password that you used earlier in the guide
- **Schema** &mdash; dbt Cloud automatically generates a schema name for you. By convention, this is `dbt_<first-initial><last-name>`. This is the schema connected directly to your development environment, and it's where your models will be built when running dbt within the Cloud IDE.
<div style={{maxWidth: '400px'}}>
<Lightbox src="/img/redshift_tutorial/images/dbt_cloud_redshift_development_credentials.png" title="dbt Cloud - Redshift Development Credentials" />
</div>
6. Click **Test Connection**. This verifies that dbt Cloud can access your Redshift cluster.
7. Click **Next** if the test succeeded. If it failed, you might need to check your Redshift settings and credentials.
Expand Down

0 comments on commit e6e288c

Please sign in to comment.