[26.1] Ordered rack/region preference for leader pinning#1598
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
|
|
||
| * Enable config_ref:enable_rack_awareness,true,properties/cluster-properties[`enable_rack_awareness`] to distribute replicas across racks automatically. | ||
| * Set config_ref:default_leaders_preference,true,properties/cluster-properties[`default_leaders_preference`] before creating topics, so that rack-aware replica placement aligns with the preferred racks. | ||
| * Use xref:manage:cluster-maintenance/cluster-balancing.adoc[partition balancing] to move existing replicas to preferred racks. |
There was a problem hiding this comment.
Is this sufficient or should we link/mention a specific kind of balancing listed on this page? https://deploy-preview-1598--redpanda-docs-preview.netlify.app/current/manage/cluster-maintenance/cluster-balancing/
| Produce requests that write data to Redpanda topics route through the topic partition leader, which syncs messages across its follower replicas. For a Redpanda cluster deployed across multiple availability zones (AZs), Leader Pinning ensures that a topic's partition leaders are geographically closer to clients, which helps decrease networking costs and guarantees lower latency. | ||
|
|
||
| If consumers are located in the same preferred region or AZ for leader pinning, and you have not set up xref:develop:consume-data/follower-fetching.adoc[follower fetching], leader pinning can also help reduce networking costs on consume requests. | ||
| If consumers are located in the same preferred region or AZ for Leader Pinning, and you have not set up xref:develop:consume-data/follower-fetching.adoc[follower fetching], Leader Pinning can also help reduce networking costs on consume requests. |
There was a problem hiding this comment.
Thinking maybe you should also mention Cloud Topics, as this is another way to reduce networking costs (at a slight expense to latency, but great for logs, data not reliant on speed).
There was a problem hiding this comment.
I added a TODO in the Suggested Reading section - that might be a better place to mention Cloud Topics instead of introducing multiple new ideas/contexts right at the start of this doc.
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
…red-rack-region-preference-for-leader-pinning
|
@Feediver1 new glossary term for Leader Pinning: #1605 |
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
kbatuigas
deleted the
DOC-1607-Document-feature-Support-ordered-rack-region-preference-for-leader-pinning
branch
4 participants
Description
This pull request updates the documentation for Leader Pinning in Redpanda, introducing support for the new
ordered_racksconfiguration value and clarifying how Leader Pinning works, its limitations, and failover behavior. The changes enhance the explanation of how to configure Leader Pinning, especially for multi-region or multi-AZ deployments, and add guidance to avoid common pitfalls.Key changes include:
Leader Pinning feature enhancements:
ordered_racksconfiguration, which allows specifying preferred racks in priority order for partition leaders. This enables explicit failover sequencing for disaster recovery scenarios and is supported in Redpanda v26.1 and later. [1] [2]racks:(uniform distribution) andordered_racks:(priority-based failover) in both the main Leader Pinning docs and the release notes. [1] [2]Configuration and usage guidance:
Limitations and failover behavior:
racks:andordered_racks:under AZ/rack failures.These updates provide clearer, more actionable documentation for users configuring advanced leader placement strategies in Redpanda.
Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 11 Mar
Page previews
Self-Managed - Leader Pinning
Topic properties >
redpanda.leaders.preferenceWhat's New
Cloud - Leader Pinning (need learning objectives added)
Checks