[chart/v1-2x-test] Document how to rotate the Fernet key with the Helm chart (#70242) - #70644
Merged
Merged
Conversation
…m chart (#70242) * Document how to rotate the Fernet key with the Helm chart The Helm chart docs explained how to point at a custom Fernet key Secret but never how to safely rotate one. The chart also generates the Fernet key Secret via a pre-install hook, which means it cannot be updated through helm upgrade, so a self-managed Secret plus the standard prepend/rotate/trim procedure is required. Document that gap so operators aren't left guessing or reverse-engineering the chart templates. closes: #18509 * Address review feedback on Fernet key rotation docs Reviewers pointed out three gaps: the plaintext-key warning didn't explicitly say not to commit values.yaml to version control, the kubectl-created Secret example didn't mention that it needs to be managed as infrastructure so it survives a cluster migration or redeploy, and the rotation steps described updating the Secret's value without ever showing the command to do it. Rename the newsfragment to the PR number (70242) instead of the issue number (18509) per towncrier convention. * Address review feedback on Fernet key rotation docs Tighten the wording per reviewer suggestions and drop the newsfragment, since a docs-only addition does not need one. (cherry picked from commit 88f95c7) Co-authored-by: Aaryan Mahajan <aaryanmhjn@gmail.com>
5 tasks
Miretpl
marked this pull request as ready for review
July 28, 2026 21:05
Miretpl
requested review from
Miretpl,
bugraoz93,
hussein-awala,
jedcunningham and
jscheffl
as code owners
July 28, 2026 21:05
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
2 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.
The Helm chart docs explained how to point at a custom Fernet key
Secret but never how to safely rotate one. The chart also generates
the Fernet key Secret via a pre-install hook, which means it cannot be
updated through helm upgrade, so a self-managed Secret plus the
standard prepend/rotate/trim procedure is required. Document that gap
so operators aren't left guessing or reverse-engineering the chart
templates.
closes: #18509
Reviewers pointed out three gaps: the plaintext-key warning didn't
explicitly say not to commit values.yaml to version control, the
kubectl-created Secret example didn't mention that it needs to be
managed as infrastructure so it survives a cluster migration or
redeploy, and the rotation steps described updating the Secret's
value without ever showing the command to do it.
Rename the newsfragment to the PR number (70242) instead of the issue
number (18509) per towncrier convention.
Tighten the wording per reviewer suggestions and drop the newsfragment,
since a docs-only addition does not need one.
(cherry picked from commit 88f95c7)
Co-authored-by: Aaryan Mahajan aaryanmhjn@gmail.com