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

Update docs on asymmetric network partitions #18953

Merged
merged 4 commits into from
Oct 10, 2024
Merged

Update docs on asymmetric network partitions #18953

merged 4 commits into from
Oct 10, 2024

Conversation

rmloveland
Copy link
Contributor

Fixes DOC-11224

Summary of changes:

  • Provide more context on asymmetric partitions and how they're no longer a thing in CockroachDB v23.1+. (Since that's quite an old version, we don't bother mentioning the version numbers.)

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 26, 2024 •
edited
Loading

Files changed:

@netlify Netlify
Copy link

netlify bot commented Sep 26, 2024 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 7d71f9a
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/67081edcc44a000008eec96d

@netlify Netlify
Copy link

netlify bot commented Sep 26, 2024 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 7d71f9a
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/67081edc42a96c0008f2f248

@rmloveland
Copy link
Contributor Author

@andrewbaptist this is kind of a random little PR, I'm warming up to work on Leader Leases docs for v24.3

I noticed we didn't mention (except in v23.1 release notes) that we convert asymmetric network partitions into symmetric, which increases resiliency (AIUI).

Def open to feedback on the language used here, etc. Not sure if the way I described our handling of asymmetric partitions is quite right, please advise.

@netlify Netlify
Copy link

netlify bot commented Sep 26, 2024 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit 7d71f9a
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/67081edccf89ed0008d9b90d
😎 Deploy Preview https://deploy-preview-18953--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 site configuration.

andrewbaptist
andrewbaptist requested changes Oct 1, 2024
View reviewed changes
Copy link

@andrewbaptist andrewbaptist left a comment

Choose a reason for hiding this comment

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

See comment. I think it is a little confusing the way the last paragraph is phrased. I'm not exactly sure how to present this, but potentially it needs a whole blog post to describe when there is unavailability.

@rmloveland
Copy link
Contributor Author

See comment. I think it is a little confusing the way the last paragraph is phrased. I'm not exactly sure how to present this, but potentially it needs a whole blog post to describe when there is unavailability.

probably could use a longer form blog post - i think your suggested text def makes it clearer than before at least

andrewbaptist
andrewbaptist approved these changes Oct 4, 2024
View reviewed changes
Copy link

@andrewbaptist andrewbaptist left a comment

Choose a reason for hiding this comment

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

Thanks for the changes!

LGTM!

@rmloveland
Copy link
Contributor Author

Thanks for the changes!
LGTM!

Thanks for the review and the much improved description of the situation!

taroface
taroface approved these changes Oct 4, 2024
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.

LGTM, some optional nits

src/current/_includes/common/network-partitions.md Outdated Show resolved Hide resolved
src/current/_includes/common/network-partitions.md Show resolved Hide resolved
@rmloveland
Update docs on asymmetric network partitions
f66028a 
Fixes DOC-11224

Summary of changes:

- Provide more context on asymmetric partitions and how they're no
  longer a thing in CockroachDB v23.1+.  (Since that's quite an old
  version, we don't bother mentioning the version numbers.)
@rmloveland
Update with andrewbaptist feedback (1)
e721ceb
@rmloveland
Update with taroface feedback (1)
c8686ae
@rmloveland
Port changes back to all versions v23.1+
7d71f9a 
Since they're all updated by
cockroachdb/cockroach#94778
@rmloveland rmloveland force-pushed the 20240926-DOC-11224-no-more-asymmetric-network-partitions branch from f300058 to 7d71f9a Compare October 10, 2024 18:37
@rmloveland rmloveland enabled auto-merge (squash) October 10, 2024 18:37
@rmloveland rmloveland merged commit afc72a9 into main Oct 10, 2024
7 checks passed
@rmloveland rmloveland deleted the 20240926-DOC-11224-no-more-asymmetric-network-partitions branch October 10, 2024 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewbaptist andrewbaptist andrewbaptist approved these changes

@taroface taroface taroface 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.
3 participants
@rmloveland @taroface @andrewbaptist