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.

Sign up for GitHub

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

Improve Secret Keys Expressions documentation #33635

Merged
merged 1 commit into from
Jun 20, 2023
Merged

Improve Secret Keys Expressions documentation #33635

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/src/main/asciidoc/config-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,9 @@ A secret configuration may be expressed as `${handler::value}`, where the `handl
[source,properties]
----
my.secret=${aes-gcm-nopadding::DJNrZ6LfpupFv6QbXyXhvzD8eVDnDa_kTliQBpuzTobDZxlg}

# the encryption key required to decode the secret. It can be set in any source.
smallrye.config.secret-handler.aes-gcm-nopadding.encryption-key=somearbitrarycrazystringthatdoesnotmatter
----

A lookup to `my.secret` will use the `SecretKeysHandler` name `aes-gcm-nopadding` to decode the value
Expand All @@ -540,6 +543,12 @@ A lookup to `my.secret` will use the `SecretKeysHandler` name `aes-gcm-nopadding
For more information, please check SmallRye Config
link:https://smallrye.io/smallrye-config/Main/config/secret-keys/[Secret Keys] documentation.

[WARNING]
====
SmallRye Config may provide handlers not fully supported by Quarkus. Currently, only `smallrye-config-crypto` is
supported.
====

== Accessing a generating UUID

The default config source from Quarkus provides a random UUID value.
Expand Down