Skip to content

docs: add documentation for decrypting Vault secrets in property sources#2416

Merged
ryanjbaxter merged 2 commits intospring-cloud:mainfrom
apappascs:add-vault-decryptor-docs
May 10, 2024
Merged

docs: add documentation for decrypting Vault secrets in property sources#2416
ryanjbaxter merged 2 commits intospring-cloud:mainfrom
apappascs:add-vault-decryptor-docs

Conversation

@apappascs
Copy link
Copy Markdown
Contributor

This pull request updates the documentation to include steps for configuring the decryption of secrets from Vault using the {vault} prefix. It provides detailed configuration examples and explains error handling related to Vault integration.

Resolves #2377, #1785


=== Configuration Steps

All configuration settings for integrating with Vault should be placed in your `application.yml`. Below are the specific configurations required to activate the Vault profile, connect to your Vault server, and format properties using the `\{vault}` prefix.
Copy link
Copy Markdown
Contributor

@ryanjbaxter ryanjbaxter May 10, 2024

Choose a reason for hiding this comment

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

It could be in application.yaml or application.properties so maybe we say application.[yaml | properties]?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@ryanjbaxter, I've updated the documentation to include both application.yml and application.properties as suggested. Thanks for the feedback!

@ryanjbaxter ryanjbaxter merged commit 4e960ca into spring-cloud:main May 10, 2024
natedanner pushed a commit to natedanner/spring-cloud__spring-cloud-config that referenced this pull request May 20, 2024
…ces (spring-cloud#2416)

* docs: add documentation for decrypting Vault secrets in property sources

* docs: update application configuration file references to include both YAML and properties formats
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhance Spring ConfigServer: Introduce {secret} Prefix for Efficient Management of Shared Secrets

3 participants