Document consequences of replacing secrets #18138
Open
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.
Document consequences of replacing secrets. The covered config options are
registration_shared_secret
,macaroon_secret_key
,form_secret
andworker_replication_secret
.Even though I looked at the source code to check the added documentation is right, I would appreciate additional verification of the statements made.
In an hand-wavy attempt at classifying how bad the consequences of secret replacement are, I added some explanations as warnings and others as regular paragraphs.
Closes #17971
Pull Request Checklist
EventStore
toEventWorkerStore
.".code blocks
.(run the linters)