Skip to content

Update zone configuration constraints to provide cloud vendor region …#23146

Open
jeevanshu wants to merge 1 commit intocockroachdb:mainfrom
jeevanshu:zonal-region-config
Open

Update zone configuration constraints to provide cloud vendor region …#23146
jeevanshu wants to merge 1 commit intocockroachdb:mainfrom
jeevanshu:zonal-region-config

Conversation

@jeevanshu
Copy link
Copy Markdown

Part of CC-34931

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 1, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit eb06f2a
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69ccba1ac6c1400008cb9888

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 1, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit eb06f2a
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69ccba1a8cac480008d459a2

@jeevanshu jeevanshu force-pushed the zonal-region-config branch from 1d39f46 to 9a9e519 Compare April 1, 2026 05:24
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 1, 2026

Netlify Preview

Built without sensitive environment variables

Name Link
🔨 Latest commit 1d39f46
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69ccabea222c44000802dd2e
😎 Deploy Preview https://deploy-preview-23146--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 1, 2026

Netlify Preview

Built without sensitive environment variables

Name Link
🔨 Latest commit eb06f2a
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69ccba1a18600300080f38af
😎 Deploy Preview https://deploy-preview-23146--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jeevanshu jeevanshu force-pushed the zonal-region-config branch 2 times, most recently from f5caf1b to 0fa2eec Compare April 1, 2026 06:06
@jeevanshu jeevanshu force-pushed the zonal-region-config branch from 0fa2eec to eb06f2a Compare April 1, 2026 06:24
@jeevanshu jeevanshu marked this pull request as ready for review April 1, 2026 07:21
{% include {{ page.version.version }}/zone-configs/create-a-replication-zone-for-a-table-partition.md %}

{{site.data.alerts.callout_info}}
When specifying region constraints or lease preferences for nodes running on cloud providers, you must include the cloud provider prefix in the region name. The format is `{provider}-{region}`.
Copy link
Copy Markdown
Contributor

@rmloveland rmloveland Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jeevanshu can you say more about the motivation for this docs PR? it wasn't clear from reading the postmortem in Confluence why this is necessary

this says "you must include the cloud provider prefix in the region name" but AIUI that isn't actually true, the --locality flag just does arbitrary string matching:

https://www.cockroachlabs.com/docs/v26.1/cockroach-start#locality

so it's only necessary to pass that exact string using the cloud provider if that's what you passed to the cockroach binary in the cockroach start --locality flag

this seems like it might be something internal to how we run CockroachCloud and not something that is generally true for self-hosted clusters where people run cockroach start --locality={foo} with arbitrary values of {foo}

but maybe i'm misunderstanding this, please say more about what is motivating this change

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the comment @rmloveland.
I was not aware of locality flags can be arbitrary value.

You are also correct about CC clusters, where we pass locality flags to include cloud provider prefix like --locality=region=gcp-asia-southeast1,zone=gcp-asia-southeast1-c.

Context behind this change is during the incident, engineers tried to run the query to restrict zonal config for liveness ranges of CC host cluster away from certain zones but due to regional config missing the cloud provider prefix it was failing and there was no check present to validate the config.

Since it looks to be limited to just CockroachCloud clusters, do you recommend closing this PR and documenting this behaviour elsewhere?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants