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

Adding ADO service principal #6647

Open
wants to merge 9 commits into
base: current
Choose a base branch
from
Open

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Dec 12, 2024

What are you changing in this pull request and why?

This PR adds the ADO service principal configuration instructions

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 December 12, 2024 01:15
Copy link

vercel bot commented Dec 12, 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 Dec 12, 2024 3:45am

@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 Dec 12, 2024
@@ -62,22 +62,20 @@ An Entra ID admin needs to provide your new app access to Azure DevOps:

## Add another redirect URI

A Microsoft Entra ID admin needs to add another redirect URI to your Entra ID application. This redirect URI will be used to authenticate the service user for headless actions in deployment environments.
A Microsoft Entra ID admin needs to add another redirect URI to your Entra ID application. This redirect URI will be used to authenticate the service principal for headless actions in deployment environments.

Choose a reason for hiding this comment

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

With service principal I don't think we need to add redirect uri to the entra app anymore. But if they are switching from service user to service principal with the same application credentials, they can just keep the redirect uri


1. Navigate to your Microsoft Entra ID application.

2. Select the link next to **Redirect URIs**
3. Click **Add URI** and add the URI, replacing `YOUR_ACCESS_URL` with the [appropriate Access URL](/docs/cloud/about-cloud/access-regions-ip-addresses) for your region and plan:
`https://YOUR_ACCESS_URL/complete/azure_active_directory_service_user`
`https://YOUR_ACCESS_URL/complete/azure_active_directory_service_principal`

Choose a reason for hiding this comment

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

Probably don't need this part either. But you could mention perhaps that if they are switching from service user to service principal they don't need to remove the redirect uris. Probably preferred to not remove them if they want to switch back to service user.

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.

Thanks for adding this! I'm not a 100% sure I follow the flow for adding a service principal but maybe you found another way to do it. I was under the impression you just need to create an entra application and add that to your ADO org settings as a user and give it the proper permissions under Azure DevOps Groups. I could be missing something though. We should also tell users migrating from service user -> service principal to use the same application. We don't delete the actual service user so if something goes wrong they can easily switch back. Let's maybe regroup in person and I can show you how I was doing the flow.

@@ -89,7 +87,7 @@ An Azure admin will need one of the following permissions in both the Microsoft
- Azure Service Administrator
- Azure Co-administrator

If your Azure DevOps account is connected to Entra ID, then you can proceed to [Connect a service user](#connect-a-service-user). However, if you're just getting set up, connect Azure DevOps to the Microsoft Entra ID app you just created:
If your Azure DevOps account is connected to Entra ID, then you can proceed to [Connect a service principal](#connect-a-service-principal). However, if you're just getting set up, connect Azure DevOps to the Microsoft Entra ID app you just created:

1. From your Azure DevOps account, select **Organization settings** in the bottom left.
2. Navigate to Microsoft Entra ID.

Choose a reason for hiding this comment

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

This part is incorrect for service principal (unless these are for service user). For service principal, you go to org settings -> navigate to users -> add users -> search and add your application as a service principal in the search bar -> add projects for Add to projects and also for Azure DevOps Groups select Project Administrators (this is important for being able to create webhooks)

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.

2 participants