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

Rearranging ADO page #6826

Merged
merged 34 commits into from
Jan 28, 2025
Merged

Rearranging ADO page #6826

merged 34 commits into from
Jan 28, 2025

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Jan 24, 2025

What are you changing in this pull request and why?

This moves around some sections and brings the full Service User instructions back. This is a bandaid for some clients between worlds and utilizes two H1 headers. I know this is a little outside our style requirements, but this would be helpful.

Splits the ADO setup into two docs - one for service principal one for service user
Updates the intro page to link to the appropriate files

There is a banner up top that is new language in need of review

https://www.notion.so/dbtlabs/Azure-DevOps-Service-Principal-18abb38ebda7808f96bcf4a4bc9a4944?pvs=4

Checklist

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • The content in this PR requires a dbt release note, so I added one to the release notes page.

🚀 Deployment available! Here are the direct links to the updated files:

@matthewshaver matthewshaver requested a review from a team as a code owner January 24, 2025 00:29
Copy link

vercel bot commented Jan 24, 2025

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

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Jan 28, 2025 6:13pm

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address Docs team Authored by the Docs team @dbt Labs labels Jan 24, 2025
2. Remove the **Microsoft Graph / User Read** permission.
3. Click **Add a permission**.
4. Select **Azure DevOps**.
5. Select the **user_impersonation** permission. This is the only permission available for Azure DevOps.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'user_impersonation'?

Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

Approved with some wording suggestions!

website/docs/docs/cloud/git/setup-azure.md Outdated Show resolved Hide resolved

:::

To use dbt Cloud's native integration with Azure DevOps, an account admin needs to set up an Microsoft Entra ID app as a service principal. We recommend setting up a separate [Entra ID application than used for SSO](/docs/cloud/manage-access/set-up-sso-microsoft-entra-id).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
To use dbt Cloud's native integration with Azure DevOps, an account admin needs to set up an Microsoft Entra ID app as a service principal. We recommend setting up a separate [Entra ID application than used for SSO](/docs/cloud/manage-access/set-up-sso-microsoft-entra-id).
To use dbt Cloud's native integration with Azure DevOps, an account admin needs to set up a Microsoft Entra ID app as a service principal. We recommend setting up a separate [Entra ID application than used for SSO](/docs/cloud/manage-access/set-up-sso-microsoft-entra-id).

website/docs/docs/cloud/git/setup-azure.md Outdated Show resolved Hide resolved
Copy link

@sidpatel13 sidpatel13 left a comment

Choose a reason for hiding this comment

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

Two changes I'm requesting:

  1. I want us to move service user to a separate page rather than having all 3 sections on adding service principal for the first time, migrating to service principal and service user overview on the same page to avoid any confusion.
  2. The migrating to service principal might still be incorrect. We don't want the user to add in the app credentials again, rather we want to tell them to use the same app for service principal which they used for service user to begin with. They need to go to org settings > users and add their service user app registration as a service principal. The adding the user to the ADO org settings might be missing as well which we need to add.

To avoid the back and forth and so we can ship this early next week, I've scheduled a pairing session for us. Let me know if there's a better time for you if that doesn't work. Thanks!


You can use these instructions to create a service principal app. The service principal feature is being gradually rolled out to dbt Cloud accounts, so it may not be available in all accounts.

If you need to configure dbt Cloud and Azure DevOps but don't see the **Service principal** option in your account settings, use the [**Service user**](#set-up-service-user) configuration for now. You can easily [migrate to a service principal](#migrate-to-service-principal) when available for your account.

Choose a reason for hiding this comment

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

This URL for service user doesn't work. I think it needs to be #connect-a-service-user

@runleonarun
Copy link
Collaborator

Thanks for proactively setting time up with @matthewshaver on Monday, @sidpatel13!

3. A dbt Cloud account admin needs to [add the app to dbt Cloud](/docs/cloud/git/setup-azure#add-your-azure-ad-app-to-dbt-cloud).
4. dbt Cloud developers need to [personally authenticate with Azure DevOps](/docs/cloud/git/authenticate-azure) from dbt Cloud.
- [**Service principal (recommended)**](/docs/cloud/git/setup-service-principal): Currently, this feature is in a phased rollout and not widely available to all accounts.
- [**Service user (legacy)**](/docs/cloud/git/setup-service-user): Availble to all accounts.

Choose a reason for hiding this comment

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

typo: Available

2. Click the **edit icon** to the right of the **Azure DevOps** settings.
3. Change **Service user** to **Service principal** and click **Save**. You do not need to edit any existing fields.

Continue on from the [add role to your service principal](#add-a-role-to-service-principal) section on this page and follow the remaining instructions.

Choose a reason for hiding this comment

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

Can we update this line and include the other section that is relevant here as well which is to connect azure devops. Following the remaining instructions is misleading since it will also include adding the app details to dbt cloud which we don't want the migration flow to include

@matthewshaver matthewshaver merged commit 3709fb2 into current Jan 28, 2025
8 checks passed
@matthewshaver matthewshaver deleted the ado-updates branch January 28, 2025 18:34
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: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants