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.

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

docs: explain scanner bucket quota check process #5011

Merged
merged 1 commit into from
Aug 7, 2024

Conversation

feorlen
Copy link
Contributor

@feorlen feorlen commented Aug 6, 2024

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Optimization (provides speedup with no functional changes)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Fixes a regression (If yes, please add commit-id or PR # here)
  • Unit tests added/updated
  • Internal documentation updated
  • Create a documentation update request here

@feorlen
Copy link
Contributor Author

feorlen commented Aug 6, 2024

@klauspost @allanrogerr @zveinn some ideas for additional mc quota set help about the scanner and bucket quota enforcement.

Copy link
Contributor

@dormanze dormanze left a comment

Choose a reason for hiding this comment

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

LGTM

@harshavardhana harshavardhana merged commit a56899e into minio:master Aug 7, 2024
6 checks passed
feorlen added a commit to minio/docs that referenced this pull request Aug 8, 2024
Bucket quotas don't work the way people think they work, as they cannot
enforce hard limits. Deprecate in docs while we sort out what to do with
the commands.

The future replacement is MinIO Enterprise Catalog.

Staged:

http://192.241.195.202:9000/staging/deprecate-bucket-quota/linux/reference/minio-mc-deprecated.html

See:
minio/mc#5011
minio/mc#5012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants