Skip to content

Update docs for Leader Leases GA in v25.2 #19587

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
Merged
merged 6 commits into from
May 12, 2025
Merged

Update docs for Leader Leases GA in v25.2 #19587

merged 6 commits into from
May 12, 2025

Conversation

rmloveland
Copy link
Contributor

@rmloveland rmloveland commented May 6, 2025 •
edited
Loading

Fixes DOC-11671, DOC-12861

Summary of changes:

  • Update 'Architecture > Replication Layer > Leader Leases' to remove the
    stuff about them being off by default

    • While we're in there, also update the 'How leases are transferred
      off a dead node' section to match the new reality.

  • Revise 'Troubleshoot Self-Hosted Setup > Node liveness issues'

@rmloveland rmloveland marked this pull request as draft May 6, 2025 20:52
@github-actions GitHub Actions
Copy link

github-actions bot commented May 6, 2025 •
edited
Loading

Files changed:

@netlify Netlify
Copy link

netlify bot commented May 6, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit e725aff
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/682269e2b18a4b00084ebe23

@netlify Netlify
Copy link

netlify bot commented May 6, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit e725aff
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/682269e2d465f60008f1c144

@netlify Netlify
Copy link

netlify bot commented May 6, 2025 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit e725aff
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/682269e2a6015c00086c0bca
😎 Deploy Preview https://deploy-preview-19587--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.

@rmloveland rmloveland force-pushed the 20250506-DOC-11671-leader-leases branch 5 times, most recently from a298691 to 11a4b6d Compare May 7, 2025 20:26
@rmloveland
Update docs for Leader Leases GA in v25.2
e61c059 
Fixes DOC-11671, DOC-12861

Summary of changes:

- Update 'Architecture > Replication Layer > Leader Leases' to remove the
  stuff about them being off by default

  - While we're in there, also update the 'How leases are transferred
    off a dead node' section to match the new reality.  Also did various
    other edits on that page re: leaseholder vs. Raft leader mismatches
    which won't exist anymore

- Revise 'Troubleshoot Self-Hosted Setup > Node liveness issues' so that
  the content there stops referring to Ye Olde SPOF liveness range

- Update many, many other places where we said things like "sometimes
  the leaseholder and the Raft leader are different, and that can be
  sad, but usually they aren't" etc. that no longer apply

- Attempt to rebrand the old "node liveness" stuff as "node heartbeats"
  in a few places and clarify that it is only used for a couple of less
  central purposes like cluster membership, etc., in v25.2+

- Also remove lots of extemporaneous mentions of "node liveness
  heartbeats" etc. from various places where it was sprinkled around.

- Also remove various references to range quiescence, which is not a
  thing for Leader leases
@rmloveland rmloveland force-pushed the 20250506-DOC-11671-leader-leases branch from 11a4b6d to e61c059 Compare May 7, 2025 20:37
@rmloveland rmloveland marked this pull request as ready for review May 7, 2025 20:37
@rmloveland
Copy link
Contributor Author

hi @arulajmani @miraradeva @iskettaneh !

in addition to what I wrote in the PR description describing the high level changes, I also sprinkled some 'xxx' broken links in here where I had specific questions.

Commonly, these are things like places in the DB Console that still talk about "node liveness" etc (at least as of the beta.3 which is still the most recent available release). Often it's asking if we can/should just delete these things? or add some words around "oh this is semi-obsolete, look at Leader Leases instead".

thanks!

@rmloveland rmloveland requested a review from taroface May 12, 2025 14:04
@rmloveland
Copy link
Contributor Author

@miraradeva and @iskettaneh i've tried to address your comments to hopefully get us closer, this is RFAL

miraradeva
miraradeva approved these changes May 12, 2025
View reviewed changes
Copy link

@miraradeva miraradeva left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the multiple revisions!

taroface
taroface approved these changes May 12, 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.

LGTM! Mostly style nits, but one place where it sounded like the Raft leader was still described as 'sometimes' also being the leaseholder

@rmloveland rmloveland enabled auto-merge (squash) May 12, 2025 21:35
@rmloveland rmloveland merged commit 19fc8a2 into main May 12, 2025
6 checks passed
@rmloveland rmloveland deleted the 20250506-DOC-11671-leader-leases branch May 12, 2025 21:45
rmloveland added a commit that referenced this pull request May 12, 2025
@rmloveland
Remove Leader Leases from list of Preview features
7b2579a 
Follow-up to #19587
@rmloveland rmloveland mentioned this pull request May 12, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taroface taroface taroface approved these changes

@miraradeva miraradeva miraradeva approved these changes

@iskettaneh iskettaneh iskettaneh approved these changes

@arulajmani arulajmani Awaiting requested review from arulajmani

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 @taroface @miraradeva @iskettaneh