Added documentation for Resource protection#3701
Open
MaheshS08 wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
@wuchong , could you please review this PR ! |
1 task
swuferhong
self-requested a review
July 20, 2026 07:58
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This PR adds documentation for the resource protection mechanisms in Fluss: data disk write protection and KV leader replica capacity control. Both mechanisms were previously undocumented — the KV leader replica capacity feature was flagged as needing docs during review of #3614, and this PR follows the structure suggested in the linked issue to combine it with data disk write protection under a single "Resource Protection" page, leaving room for future protection mechanisms to be added alongside them.
Linked issue: close #3673
Brief change log
Added
website/docs/maintenance/operations/resource-protection.mdwith two sections:Data Disk Write Protection — covers
server.data-disk.write-limit-ratio,server.data-disk.write-recover-ratio, andserver.data-disk.check-interval; the hysteresis behavior between the limit and recover ratios; the retriableDiskWriteLockedExceptionerror; the interaction withcoordinator.offline-leader.retry-delayduring leader election; and thediskUsageRatio/diskWriteLockedmetrics.KV Leader Replica Capacity Protection — covers
kv.leader-replica.memory-reserved; TabletServer resource reporting viatablet-server.advertised-resource.cpu-cores/ tablet-server.advertised-resource.memory-size; how cluster-level capacity is calculated; theINSUFFICIENT_KV_LEADER_REPLICA_CAPACITYerror; and thekvLeaderReplicaCount/kvLeaderReplicaCapacitymetrics.Tests
Documentation-only change; no code paths modified. No new tests required.
API and Format
No public API or config changes. No new config options were introduced — this PR documents existing options from #3340, #3612, #3539 and #3614.
Documentation
This PR is the documentation change described above.