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.

Sign up for GitHub

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

Jump to bottom

Apply small edits #3780

Merged
merged 2 commits into from
Jul 21, 2023
Merged

Apply small edits #3780

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcc6c5c
Apply small edits
Jessie212 Jul 19, 2023
62198b5
Merge branch 'current' into jt-dbt-trino
dataders Jul 21, 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
28 changes: 14 additions & 14 deletions website/docs/quickstarts/starburst-galaxy-qs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Using Starburst Galaxy, you can create tables and also transform them with dbt.
```

## Connect Starburst Galaxy to the Amazon S3 bucket {#connect-to-s3-bucket}
If your Starburst Galaxy instance is not already connected to your S3 bucket, you need to create a cluster, create a catalog that connects to the S3 bucket, associate the new catalog (your data source) to your new cluster, and configure privilege settings.
If your Starburst Galaxy instance is not already connected to your S3 bucket, you need to create a cluster, configure a catalog that allows Starburst Galaxy to connect to the S3 bucket, add the catalog to your new cluster, and configure privilege settings.

In addition to Amazon S3, Starburst Galaxy supports many other data sources. To learn more about them, you can refer to the [Catalogs overview](https://docs.starburst.io/starburst-galaxy/catalogs/index.html) in the Starburst Galaxy docs.

Expand All @@ -79,11 +79,11 @@ In addition to Amazon S3, Starburst Galaxy supports many other data sources. To

When done, click **Create cluster**.

1. Create a catalog. Click **Catalogs** on the left sidebar of the Starburst Galaxy UI, then click **Create catalog** in the main body of the page.
2. On the **Create a data source** page, select the Amazon S3 tile.
3. In the **Name and description** section of the **Amazon S3** page, fill out the fields.
4. In the **Authentication to S3** section of the **Amazon S3** page, select the [AWS (S3) authentication mechanism](#prerequisites) you chose to connect with.
5. In the **Metastore configuration** section, set these options:
3. Create a catalog. Click **Catalogs** on the left sidebar of the Starburst Galaxy UI, then click **Create catalog** in the main body of the page.
4. On the **Create a data source** page, select the Amazon S3 tile.
5. In the **Name and description** section of the **Amazon S3** page, fill out the fields.
6. In the **Authentication to S3** section of the **Amazon S3** page, select the [AWS (S3) authentication mechanism](#prerequisites) you chose to connect with.
7. In the **Metastore configuration** section, set these options:
- **Default S3 bucket name** — Enter the name of your S3 bucket you want to access.
- **Default directory name** — Enter the folder name of where the Jaffle Shop data lives in the S3 bucket. This is the same folder name you used in [Load data to an Amazon S3 bucket](#load-data-to-s3).
- **Allow creating external tables** — Enable this option.
Expand All @@ -93,19 +93,19 @@ In addition to Amazon S3, Starburst Galaxy supports many other data sources. To

<Lightbox src="/img/quickstarts/dbt-cloud/starburst-galaxy-config-s3.png" title="Amazon S3 connection settings in Starburst Galaxy" />

7. Click **Test connection**. This verifies that Starburst Galaxy can access your S3 bucket.
8. Click **Connect catalog** if the connection test passes.
8. Click **Test connection**. This verifies that Starburst Galaxy can access your S3 bucket.
9. Click **Connect catalog** if the connection test passes.
<Lightbox src="/img/quickstarts/dbt-cloud/test-connection-success.png" title="Successful connection test" />

9. On the **Set permissions** page, click **Skip**. You can add permissions later if you want.
10. On the **Add to cluster** page, choose the cluster you want to add the data source to from the dropdown and click **Add to cluster**.
11. Add the location privilege for your S3 bucket to your role in Starburst Galaxy. Click **Access control > Roles and privileges** on the left sidebar of the Starburst Galaxy UI. Then, in the **Roles** table, click the role name **accountadmin**.
10. On the **Set permissions** page, click **Skip**. You can add permissions later if you want.
11. On the **Add to cluster** page, choose the cluster you want to add the catalog to from the dropdown and click **Add to cluster**.
12. Add the location privilege for your S3 bucket to your role in Starburst Galaxy. Click **Access control > Roles and privileges** on the left sidebar of the Starburst Galaxy UI. Then, in the **Roles** table, click the role name **accountadmin**.

If you're using an existing Starburst Galaxy cluster and don't have access to the accountadmin role, then select a role that you do have access to.

To learn more about access control, refer to [Access control](https://docs.starburst.io/starburst-galaxy/security/access-control.html) in the Starburst Galaxy docs.
1. On the **Roles** page, click the **Privileges** tab and click **Add privilege**.
2. On the **Add privilege** page, set these options:
13. On the **Roles** page, click the **Privileges** tab and click **Add privilege**.
14. On the **Add privilege** page, set these options:
- **What would you like to modify privileges for?** &mdash; Choose **Location**.
- **Enter a storage location provide** &mdash; Enter the storage location of _your S3 bucket_ and the folder of where the Jaffle Shop data lives. Make sure to include the `/*` at the end of the location.
- **Create SQL** &mdash; Enable the option.
Expand All @@ -115,7 +115,7 @@ In addition to Amazon S3, Starburst Galaxy supports many other data sources. To
<Lightbox src="/img/quickstarts/dbt-cloud/add-privilege.png" title="Add privilege to accountadmin role" />

## Create tables with Starburst Galaxy
To query the Jaffle Shop data with Starburst Galaxy, you need to create tables using the Jaffle Shop data that you [loaded to your S3 bucket](#load-data-to-s3). You can do this (and run any SQL statement) from the [query editor](https://docs.starburst.io/starburst-galaxy/query/index.html).
To query the Jaffle Shop data with Starburst Galaxy, you need to create tables using the Jaffle Shop data that you [loaded to your S3 bucket](#load-data-to-s3). You can do this (and run any SQL statement) from the [query editor](https://docs.starburst.io/starburst-galaxy/query/query-editor.html).

1. Click **Query > Query editor** on the left sidebar of the Starburst Galaxy UI. The main body of the page is now the query editor.
2. Configure the query editor so it queries your S3 bucket. In the upper right corner of the query editor, select your cluster in the first gray box and select your catalog in the second gray box:
Expand Down