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

update sl credentials flow #6008

Merged
merged 11 commits into from
Sep 6, 2024
Merged

update sl credentials flow #6008

merged 11 commits into from
Sep 6, 2024

Conversation

mirnawong1
Copy link
Contributor

this pr updates the SL credentials setup section, screenshots, and adds a table to try to better explain service tokens and credentials, and how they relate to diff plans.

[ ] needs PM review

@mirnawong1 mirnawong1 requested a review from a team as a code owner September 4, 2024 13:41
Copy link

vercel bot commented Sep 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Sep 6, 2024 0:28am

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address and removed Docs team Authored by the Docs team @dbt Labs labels Sep 4, 2024
Copy link

@theyostalservice theyostalservice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a high level note - there are no pictures of a functioning Teams or Enterprise SL Details page. That's what the user should see when they are doing a number of actions:

  1. link new service token
  2. unlink a service token
  3. delete credentials

And while I'm not sure we need a screen capture for EVERY one of those, having at least one image where people would see the correct "edit" button and the link/unlink options and the delete credential option seems like it would be useful.

website/snippets/_new-sl-setup.md Outdated Show resolved Hide resolved
website/snippets/_new-sl-setup.md Show resolved Hide resolved
website/snippets/_new-sl-setup.md Show resolved Hide resolved
website/snippets/_new-sl-setup.md Outdated Show resolved Hide resolved
website/snippets/_new-sl-setup.md Outdated Show resolved Hide resolved
@theyostalservice
Copy link

(I didn't approve or request changes because I'm not sure I'm the person whose review you wanted :P )

@github-actions github-actions bot added the Docs team Authored by the Docs team @dbt Labs label Sep 4, 2024
@mirnawong1
Copy link
Contributor Author

that's amazing, thanks so much for your feedback @theyostalservice ! I've taken them all onboard and folded them in - really appreciate it!

1. In the **Set Up Semantic Layer Configuration** page, enter the credentials specific to your data platform that you want the Semantic Layer to use.
1. After selecting the deployment environment, you should see the **Credentials & service tokens** page.
2. Click the **Add Semantic Layer credential** button.
3. In the **1. Add credentials** section, enter the credentials specific to your data platform that you want the Semantic Layer to use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. In the **1. Add credentials** section, enter the credentials specific to your data platform that you want the Semantic Layer to use.
3. In the **Add credentials** section, enter the credentials specific to your data platform that you want the Semantic Layer to use.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hiya @mirnawong1

I haven't committed this as I was't sure if the addition of the number 1 was intentional. This is a non-blocker btw.

Kind Regards

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes it's intentional bc it's par of the cloud ui flow and I'm referring to it. great question!

2. Name the token and save it. Once the token is generated, you won't be able to view this token again so make sure to record it somewhere safe.
<Lightbox src="/img/docs/dbt-cloud/semantic-layer/sl-add-credential.jpg" width="55%" title="Add credentials and map them to a service token. " />

4. After adding credentials, scroll to **2. Map new service token**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

2. On the **Create New Semantic Layer Credential** page, you can create multiple credentials and map them to a service token.
3. In the **Add credentials** section, fill in the data platform's credential fields. We recommend using “read-only” credentials.
1. After configuring your environment, on the **Credentials & service tokens** page, click the **Add Semantic Layer credential** button to create multiple credentials and map them to a service token.
2. In the **1. Add credentials** section, fill in the data platform's credential fields. We recommend using “read-only” credentials.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above


5. Click **Save** to link the service token to the credential. Remember to copy and save the service token securely, as it won't be viewable again after generation.
<Lightbox src="/img/docs/dbt-cloud/semantic-layer/sl-credential-created.jpg" width="100%" title="Manage multiple credentials and link them to service tokens for more granular control."/>
3. In the **2. Map new service token** section, map a service token to the credential you configured in the previous step. dbt Cloud automatically selects the service token permission set you need (Semantic Layer Only and Metadata Only).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

Copy link
Contributor

@nataliefiann nataliefiann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hiya @mirnawong1

This is a great PR! Thank for posting this! I've approved this for you - I left some non-blocking suggestions and questions but nothing to drastically change the doc / PR.

Kind Regards

@mirnawong1 mirnawong1 enabled auto-merge (squash) September 6, 2024 12:23
@mirnawong1 mirnawong1 merged commit cc18bc9 into current Sep 6, 2024
10 checks passed
@mirnawong1 mirnawong1 deleted the update-SL-credential branch September 6, 2024 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants