Skip to content

Conversation

@nphilbrook
Copy link
Contributor

Description

While figuring out how to use Azure auto-join from VMs with both a System-managed identity and a User-managed identity, when I needed to use the User-managed identity, I stumbled on some serious pain. This is probably not the best way to explain it, but I wanted others to benefit from my journey of pain. I will happily accept any suggestions on wording, organization, or verbiage. The 2 main points I want to get across that I discovered from reading both the go-discover code and the Azure/go-autorest code are that:

Contributor checklists

Review urgency:

  • ASAP: Bug fixes, broken content, imminent releases
  • 3 days: Small changes, easy reviews
  • 1 week: Default expectation
  • Best effort: No urgency

Pull request:

  • Verify that the PR is set to merge into the correct base branch
  • Verify that all status checks passed
  • Verify that the preview environment deployed successfully
  • Add additional reviewers if they are not part of assigned groups

Content:

  • I added redirects for any moved or removed pages
  • I followed the Education style guide
  • I looked at the local or Vercel build to make sure the content rendered correctly

Reviewer checklist

  • This PR is set to merge into the correct base branch.
  • The content does not contain technical inaccuracies.
  • The content follows the Education content and style guides.
  • I have verified and tested changes to instructions for end users.

@nphilbrook nphilbrook changed the title Consul Docs Consul Docs: Azure auto-join MSI clarification Nov 19, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 19, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Thu Nov 20 13:24:58 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Thu Nov 20 13:18:18 UTC 2025

@nphilbrook nphilbrook marked this pull request as ready for review November 20, 2025 13:02
@nphilbrook nphilbrook requested review from a team as code owners November 20, 2025 13:02
@github-actions
Copy link
Contributor

github-actions bot commented Nov 20, 2025

Broken Link Checker

No broken links found! 🎉

Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

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

Please implement suggestions for style guide alignment.

Comment on lines +194 to +200
<Note>

If any of the tentant, client, or client_secret arguments are omitted, then Consul will fall back to Managed Service Identities (see below) and
any client_id that _was_ specified will be ignored for the purposes of MSI. To pass a specific client_id to MSI (for example,
to use a User-Managed identity on a VM that also has a System-Managed identity, you must use the environment variable `AZURE_CLIENT_ID` (reference the [Azure autorest package documentation](https://github.com/Azure/go-autorest/blob/autorest/v0.11.29/autorest/azure/auth/auth.go#L43)

</Note>
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
<Note>
If any of the tentant, client, or client_secret arguments are omitted, then Consul will fall back to Managed Service Identities (see below) and
any client_id that _was_ specified will be ignored for the purposes of MSI. To pass a specific client_id to MSI (for example,
to use a User-Managed identity on a VM that also has a System-Managed identity, you must use the environment variable `AZURE_CLIENT_ID` (reference the [Azure autorest package documentation](https://github.com/Azure/go-autorest/blob/autorest/v0.11.29/autorest/azure/auth/auth.go#L43)
</Note>
If you omit any of the `TENANT`, `CLIENT`, or `CLIENT_SECRET` arguments, then Consul defaults to Managed Service Identities instead. Any client identification that was specified is ignored for the purposes of MSI. To pass client identity to MSI, you must use the `AZURE_CLIENT_ID` environment variable. For more information, refer to the [Azure autorest package documentation](https://github.com/Azure/go-autorest/blob/autorest/v0.11.29/autorest/azure/auth/auth.go#L43).

Style guide alignments and sentence simplification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants