docs: explain scanner bucket quota check process #5011
Merged
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.
Community Contribution License
All community contributions in this pull request are licensed to the project maintainers
under the terms of the Apache 2 license.
By creating this pull request I represent that I have the right to license the
contributions to the project maintainers under the Apache 2 license.
Description
Proposed addition to
mc quota set
help to clarify that bucket quotas are only checked at the time of a scanner pass. Discussion on what exactly this text should say is very welcome.Motivation and Context
The current docs (mc help, web) don't describe the role of the scanner in determining the quota status. Since the scanner only runs periodically, a bucket can exceed its quota until the next scanner pass notices.
In my opinion we should also not describe this as a "hard quota." That suggests MinIO will never allow writes beyond the configured quota, which is incorrect.
How to test this PR?
Docs only change (mc quota set help text)
Types of changes
Checklist:
commit-id
orPR #
here)