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

docs: update azurerm backend docs #34564

Merged

Conversation

jaredfholgate
Copy link
Contributor

@jaredfholgate jaredfholgate commented Jan 24, 2024

This PR refactors the documentation for the azurerm backend to provide clarity for users on the various authentication options. The existing documentation was missing clarity on the Access Key vs Entra ID option to access the storage account. This change is designed to provide that clarity and make it clear that the use_azuread_auth variable is not mutually exclusive with the other authentication options, it is additive.

Fixes N/A

Target Release

1.7.1

Draft CHANGELOG entry

NEW FEATURES | UPGRADE NOTES | ENHANCEMENTS | BUG FIXES | EXPERIMENTS

jaredfholgate and others added 9 commits January 24, 2024 17:38
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
Co-authored-by: Luke Taylor <77284962+luke-taylor@users.noreply.github.com>
@jaredfholgate
Copy link
Contributor Author

@luke-taylor Thanks for spotting all my typos! :)

Copy link
Contributor

@manicminer manicminer left a comment

Choose a reason for hiding this comment

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

Hi @jaredledvina, thanks for this PR! I agree that the array of configuration options around authentication, particularly with storage, and even more so in the context of the remote backend, can be very challenging to reason about. I agree that better examples improve the documentation and I like what you're put together here.

I've gone through and tidied up a little, as well as made some suggestions around wording - notably the use of the new branding of Entra ID. We are likely going to update all our docs together at some point, but in the meantime we are continuing to refer to the platform as Azure Active Directory. This is both for consistency, to reduce overall confusion, and to avoid a PR surge where these references are changed piecemeal. I've also tweaked the table of auth scenarios to merge the two rightmost columns.

Since my suggestions are all formatting related, or minor wording changes, I'm going to go ahead and incorporate these and merge your PR. Thanks again for working on this, I expect you have spent a lot of time on this and it's greatly appreciated 🚀

@jaredfholgate
Copy link
Contributor Author

@manicminer LGTM, thanks for the updates.

@manicminer manicminer merged commit d9ccdfb into hashicorp:main Jan 31, 2024
6 of 7 checks passed
Copy link
Contributor

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

@jaredfholgate jaredfholgate deleted the docs-improve-azurerm-backend-docs branch January 31, 2024 13:12
Copy link
Contributor

github-actions bot commented Mar 2, 2024

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants