Document how to use zone config extensions to remove read replicas #22371
+10
−0
Conversation
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
rmloveland
changed the title
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
rmloveland
force-pushed
the
20260127-DOC-15023-zone-config-extensions
branch
from
ad06ca2 to
c007aea
Compare
Contributor
Author
|
@rafiss mind taking a look at this doc update? asking bc you are the author of cockroachdb/cockroach#156228 please let me know if any of what i've written is incorrect, or if i'm missing any important information - thank you! |
rafiss
approved these changes
Jan 27, 2026
Contributor
rafiss
left a comment
rafiss
left a comment
There was a problem hiding this comment.
lgtm! thanks for handling this
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
florence-crl
left a comment
florence-crl
left a comment
There was a problem hiding this comment.
@rmloveland please check this snippet in the context of the surrounding section. thanks.
|
|
||
| #### Override specific fields of a schema object's zone configs | ||
|
|
||
| In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. |
Contributor
There was a problem hiding this comment.
The new num_replicas update that you added in the example should be mentioned in this intro sentence:
Suggested change
| In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its `num_replicas` and [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) fields. |
|
|
||
| In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. | ||
|
|
||
| Setting the [primary region](#set-primary-region) to `us-east1` [during the setup steps](#use-zone-config-extensions) added `us-east1` to `lease_preferences`. |
Contributor
There was a problem hiding this comment.
Suggested change
| Setting the [primary region](#set-primary-region) to `us-east1` [during the setup steps](#use-zone-config-extensions) added `us-east1` to `lease_preferences` and set `num_replicas` to `5`. |
| | range_min_bytes = 134217728, | ||
| | range_max_bytes = 536870912, | ||
| | gc.ttlseconds = 90000, | ||
| | num_replicas = 5, |
Contributor
There was a problem hiding this comment.
Suggested change
| | num_replicas = 3, |
| (1 row) | ||
| ~~~ | ||
|
|
||
| The `lease_preferences` field is now updated to include `us-west1`. |
Contributor
There was a problem hiding this comment.
Suggested change
| The `num_replicas` field is now updated to include `3`. The `lease_preferences` field is now updated to include `us-west1`. |
| (1 row) | ||
| ~~~ | ||
|
|
||
| In a multi-region database, the default zone configuration may include additional non-voting replicas (for example, to support [follower reads]({% link {{ page.version.version }}/follower-reads.md %})). The database's [survival goal]({% link {{ page.version.version }}/multiregion-overview.md %}#survival-goals) depends only on the number of voting replicas (`num_voters`), not the total number of replicas (`num_replicas`). |
Contributor
There was a problem hiding this comment.
nit
Suggested change
| In a multi-region database, the default zone configuration may include additional non-voting replicas (for example, to support [follower reads]({% link {{ page.version.version }}/follower-reads.md %})). The database's [survival goal]({% link {{ page.version.version }}/multiregion-overview.md %}#survival-goals) depends only on the number of voting replicas (`num_voters`), not the total number of replicas (`num_replicas`). | |
| In a multi-region database, the default zone configuration can include additional non-voting replicas, for example, to support [follower reads]({% link {{ page.version.version }}/follower-reads.md %}). The database's [survival goal]({% link {{ page.version.version }}/multiregion-overview.md %}#survival-goals) depends only on the number of voting replicas (`num_voters`), not on the total number of replicas (`num_replicas`). |
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.
Fixes DOC-15023