[docs] Add CRDB survivability configuration - #1613
Open
mickmis wants to merge 2 commits into
Open
Conversation
mickmis
force-pushed
the
survivability-doc
branch
from
August 5, 2026 13:58
11f4545 to
5fee90f
Compare
the-glu
reviewed
Aug 5, 2026
mickmis
force-pushed
the
survivability-doc
branch
from
August 6, 2026 07:27
5fee90f to
1433b79
Compare
barroco
reviewed
Aug 20, 2026
|
|
||
| ## 1. Setting Node Locality | ||
|
|
||
| When starting each CockroachDB node, you must configure its `--locality` flag to specify which USS and node it represents. The locality must use first at least the `uss` key, and optionally second the `node` key. |
Contributor
There was a problem hiding this comment.
InterUSS recommends those keys, however, users may already be using other keys (ie region, zone).
Can you please add a note on what they should do if it was the case ?
Contributor
Author
There was a problem hiding this comment.
Clarified the scope of the doc so that:
- it covers only the default case
- and what is important if they are outside the default case, however they are on their own in that case
|
|
||
| ### Explanation of the Parameters: | ||
| * `num_replicas = 3`: Tells CockroachDB to keep 3 copies of each range. | ||
| * `constraints`: A JSON object specifying per-replica constraints. Do note that specifying this might not always be necessary depending on your deployment. |
Contributor
There was a problem hiding this comment.
Please, be more precise on the case when it would not be necessary.
mickmis
commented
Aug 26, 2026
mickmis
commented
Aug 26, 2026
mickmis
commented
Aug 26, 2026
mickmis
commented
Aug 26, 2026
Co-authored-by: Mickaël Misbach <mickael@misba.ch>
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.
This relates to interuss/monitoring#1551 and might be enough to address #482 if we decide pursuing automatic configuration is not relevant anymore given the current CRDB situation.