chore(backend): add TLS certificate rotation documentation and helper scripts. Fixes #12328 #12457
+207
−293
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.
chore(backend): add TLS certificate rotation documentation and helper scripts. Fixes #12328
Description of your changes:
This PR adds missing documentation for TLS certificate rotation required when using the pod-to-pod TLS feature introduced in PR #12082. When TLS secrets are renewed, backend services (API server, persistence agent, metadata writer, cache server, etc.) do not automatically reload updated certificate data. A rolling restart is required. This behavior was previously undocumented.
The updates included in this PR:
Documentation update (
backend/README.md):server.crt/server.key)kubectl create secret tls ... | kubectl apply -f -kubectl rollout restartHelper scripts added (optional but helpful for operators):
scripts/find-tls-refs.shIdentifies which pods/deployments reference the TLS secret (via volumes or env secretKeyRef).
Helps operators know exactly which deployments must be restarted.
scripts/rotate-tls.shApplies new TLS cert/key to the Kubernetes Secret and automatically restarts all deployments referencing the secret, waiting for rollout completion.
General improvements:
These changes directly address the missing operational documentation noted in issue #12328 and align with the maintainers’ suggestion to include example commands.
Checklist:
Learn more about the pull request title convention used in this repository.
Links