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

Azure secret doc enhancement #23079

Merged
merged 5 commits into from
Sep 21, 2023
Merged

Azure secret doc enhancement #23079

merged 5 commits into from
Sep 21, 2023

Conversation

maxcoulombe
Copy link
Contributor

@maxcoulombe maxcoulombe commented Sep 14, 2023

Using environment variables over config provided explicitely through the API is counter-intuitve, which leads to wasted time figuring out why the provided configuration is not being used by Vault as expected.

Unfortunately changing this behavior would be a significant breaking change. As a short term mitigation solution we are adding a more explicit note in the documentaiton to help people avoid this pitfall.

Preview:

azure_secret_note

@maxcoulombe maxcoulombe requested a review from a team as a code owner September 14, 2023 15:54
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Sep 14, 2023
Copy link
Contributor

@austingebauer austingebauer 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 doing this!

@@ -0,0 +1,3 @@
```release-note:improvement
secrets/azure: Added note that environment variables take precedence over API config.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need a CL entry for docs changes. Typically only for product changes.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1

@github-actions
Copy link

CI Results:
All Go tests succeeded! ✅

@github-actions
Copy link

Build Results:
All builds succeeded! ✅

@@ -0,0 +1,3 @@
```release-note:improvement
secrets/azure: Added note that environment variables take precedence over API config.
Copy link
Contributor

Choose a reason for hiding this comment

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

+1

website/content/docs/secrets/azure.mdx Outdated Show resolved Hide resolved
@maxcoulombe maxcoulombe merged commit 5ba15de into main Sep 21, 2023
41 of 42 checks passed
@maxcoulombe maxcoulombe deleted the azure-doc-improvement branch September 21, 2023 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants