Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add zone config troubleshooting guide #19283

Merged
merged 2 commits into from
Mar 19, 2025
Merged

Add zone config troubleshooting guide #19283

merged 2 commits into from
Mar 19, 2025

Conversation

rmloveland
Copy link
Contributor

@rmloveland rmloveland commented Jan 6, 2025 •
edited
Loading

Fixes DOC-9210

Summary of changes:

  • Add a new page, 'Troubleshoot Replication Zones', to The
    ZoneConfigonomicon (tm)

  • Update the 'Replication controls' page with more detailed info re:
    zone config inheritance hierarchy and behavior

  • Update the made-up examples in the 'Critical nodes endpoint' docs to
    point back to 'Troubleshoot Replication Zones'

  • Fix incorrect statements on the ALTER RANGE page since they're
    needed to map from range IDs returned by the critical nodes
    endpoint (mentioned in 'Troubleshoot Replication Zones') to actual
    schema objects

  • Add moar links (tm) from various zone config-related pages to the new
    troubleshooting guide and amongst themselves

  • Add a note to various zone config-related docs saying "most users
    should not do manual zone config changes, see Multi-region SQL and
    Zone Config Extensions instead"

For reviewers, the main changes are:

  • new Troubleshoot replication zones page
  • new section of 'Replication Controls' page called How zone config inheritance works
  • small changes to ALTER RANGE docs to update the SHOW RANGES queries to get them to actually work (they were missing the ... WITH DETAILS clause, and/or using crdb_internal.ranges - this was a bit of a driveby change but seemed good to do since I was touching ALTER RANGE ... CONFIGURE ZONE to point to the troubleshooting guide
  • most of the other changes are "infrastructure", adding links, etc.

@rmloveland rmloveland marked this pull request as draft January 6, 2025 22:39
@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch 7 times, most recently from e8df32a to 674915d Compare January 15, 2025 19:52
@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch 6 times, most recently from e11a980 to d460824 Compare January 27, 2025 21:57
@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch 3 times, most recently from fc2c697 to ab3faec Compare February 3, 2025 22:57
@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch from ab3faec to fb31a32 Compare February 4, 2025 17:03
@cockroachdb cockroachdb deleted a comment from netlify bot Feb 4, 2025
@cockroachdb cockroachdb deleted a comment from netlify bot Feb 4, 2025
@cockroachdb cockroachdb deleted a comment from netlify bot Feb 4, 2025
@rmloveland rmloveland marked this pull request as ready for review February 4, 2025 19:08
@cockroachdb cockroachdb deleted a comment from github-actions bot Feb 4, 2025
@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch 2 times, most recently from 0f0bfde to a2f820e Compare February 4, 2025 19:13
@cockroachdb cockroachdb deleted a comment from github-actions bot Feb 4, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 4, 2025 •
edited
Loading

Files changed:

@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch from a2f820e to a91c384 Compare February 4, 2025 20:13
@rmloveland rmloveland requested review from fqazi and annrpom February 4, 2025 21:58
annrpom
annrpom reviewed Feb 6, 2025
View reviewed changes
Copy link
Contributor

@annrpom annrpom left a comment

Choose a reason for hiding this comment

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

woah this is great!!! i left some comments, but feel free to ask me for any clarification

fqazi
fqazi reviewed Feb 7, 2025
View reviewed changes
Copy link

@fqazi fqazi left a comment

Choose a reason for hiding this comment

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

Looks good a few minor comments

@rmloveland
Copy link
Contributor Author

@fqazi and @annrpom thanks for looking at this! i've updated it based on your feedback so far, PTAL and let me know what you think. happy to update as needed

@rmloveland rmloveland requested review from fqazi and annrpom February 13, 2025 21:30
annrpom
annrpom approved these changes Feb 18, 2025
View reviewed changes
Copy link
Contributor

@annrpom annrpom left a comment

Choose a reason for hiding this comment

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

lgtm! 🚀

fqazi
fqazi approved these changes Feb 18, 2025
View reviewed changes
Copy link

@fqazi fqazi left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM :shipit:

@rmloveland
Copy link
Contributor Author

woooohooooo thanks for the reviews @annrpom and @fqazi !!!!!!!!!!

now on to docs team review

@rmloveland rmloveland requested a review from taroface February 18, 2025 15:44
@rmloveland
Copy link
Contributor Author

hi @taroface ping on this, mind taking a look this week?

taroface
taroface approved these changes Mar 17, 2025
View reviewed changes
Copy link
Contributor

@taroface taroface left a comment

Choose a reason for hiding this comment

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

Approving so that I don't block this any longer, but had various suggestions for readability!

@rmloveland
Copy link
Contributor Author

Approving so that I don't block this any longer, but had various suggestions for readability!

thanks for the review @taroface ! porting to various other versions now (v23.1+) and then will merge

@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch from 47199b4 to 4a55b7c Compare March 19, 2025 19:42
@rmloveland
Add zone config troubleshooting guide v1
16a9eba 
Fixes DOC-9210

Summary of changes:

- Add a new page, 'Troubleshoot Replication Zones', to _The
  ZoneConfigonomicon (tm)_

- Update the 'Replication controls' page with more detailed info re:
  zone config inheritance hierarchy and behavior

- Update the made-up examples in the 'Critical nodes endpoint' docs to
  point back to 'Troubleshoot Replication Zones'

- Fix incorrect statements on the `ALTER RANGE` page since they're
  needed to map from range IDs returned by the critical nodes
  endpoint (mentioned in 'Troubleshoot Replication Zones') to actual
  schema objects

- Add moar links (tm) from various zone config-related pages to the new
  troubleshooting guide and amongst themselves

- Add a note to various zone config-related docs saying "most users
  should not do manual zone config changes, see Multi-region SQL and
  Zone Config Extensions instead"

NB. These changes are backported to all supported versions v23.1+
@rmloveland rmloveland force-pushed the 20241209-DOC-9210-zone-config-troubleshooting-guide branch from 4a55b7c to 16a9eba Compare March 19, 2025 20:17
@rmloveland rmloveland enabled auto-merge (squash) March 19, 2025 20:18
@rmloveland rmloveland merged commit a2674a7 into main Mar 19, 2025
7 checks passed
@rmloveland rmloveland deleted the 20241209-DOC-9210-zone-config-troubleshooting-guide branch March 19, 2025 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fqazi fqazi fqazi approved these changes

@taroface taroface taroface approved these changes

@annrpom annrpom annrpom approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rmloveland @fqazi @taroface @annrpom