docs(configuration): warn about Jackson errors when injecting storage credentials via env vars#4765
Merged
Conversation
… credentials via env vars Helm deployments that inject KESTRA_STORAGE_S3_ACCESS_KEY (single underscore) hit an UnrecognizedPropertyException at startup because the path is parsed as kestra.storage.s3.access.key (nested) and the storage plugin's Jackson mapper rejects the nested shape. Add a warning callout on the S3 and GCS sections of the Runtime and Storage page and on the Environment variable conversion section of Configuration Basics, showing the double-underscore env-var form and the YAML interpolation alternative as working approaches. Refs kestra-io/kestra#15964 Signed-off-by: ChrisJr404 <chris@hacknow.com>
Contributor
Hey @ChrisJr404 👋Thanks for raising your first pull request - we really appreciate it! ❤️ Make sure you've checked our contribution guide, and don't forget to give us a star! ⭐ If you're looking for more issues to contribute to, we'd suggest checking our curated list of good first issues to see if there's something you find interesting and feel comfortable tackling independently. You can further filter the list by labels to narrow down the results (we recommend |
MilosPaunovic
added
kind/external
aj-emerich
approved these changes
May 26, 2026
Member
|
Thank you ! @ChrisJr404 <3 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a warning callout to three places in the Configuration docs explaining the env-var naming pitfall that affects Helm deployments of the S3 and GCS internal-storage backends:
configuration/01.configuration-basics/index.md— Environment variable conversion sectionconfiguration/02.runtime-and-storage/index.md— S3 sectionconfiguration/02.runtime-and-storage/index.md— Google Cloud Storage sectionWhy
Per kestra-io/kestra#15964, a user on v1.3.16 hit a fatal pod startup error when injecting
KESTRA_STORAGE_S3_ACCESS_KEYthroughextraEnvVars:The single-underscore env-var form is read by Micronaut's relaxed binding as the path
kestra.storage.s3.access.key, producing a nested{access: {key: ...}}shape. The S3/GCS storage plugins then deserialize that subtree with Jackson into a flat config bean and crash withUnrecognizedPropertyException. The same problem affects every multi-word property underkestra.storage.<backend>.*.The reporter's own workaround (double-underscore on the last hop, or YAML interpolation from a simpler env var) is shown in each callout, with a back-link from S3/GCS to the Configuration Basics rule.
What's not changed
KESTRA_STORAGE_S3_ACCESS_KEY=myKeyexample on the Configuration Basics page is left in place because it remains correct for Micronaut's documented relaxed binding. The new callout flags the storage-plugin-specific case where Jackson observes the nested form and refuses it.Refs