docs: don't call the bucket quota a "hard quota" #5012
Conversation
| @@ -32,7 +32,7 @@ import ( | |||
| var quotaSetFlags = []cli.Flag{ | |||
| cli.StringFlag{ | |||
| Name: "size", | |||
| Usage: "set a hard quota, disallowing writes after quota is reached", | |||
| Usage: "set a quota, disallowing writes after quota is reached", | |||
There was a problem hiding this comment.
| Usage: "set a quota, disallowing writes after quota is reached", | |
| Usage: "Set a quota or usage limit for a bucket. Depends on the scanner for determining usage." |
Maybe - a little weird because we don't talk about the scanner, but I think it's not terrible either.
There was a problem hiding this comment.
Is there a practical limit on how long these descriptions should be? Maybe
| Usage: "set a quota, disallowing writes after quota is reached", | |
| Usage: "set a quota, disallowing writes if the object scanner determines the quota has been exceeded.", |
The text added yesterday does cover the scanner at least. This is what it currently looks like:
$ ./mc --dp quota set
NAME:
mc quota set - set bucket quota
USAGE:
mc quota set TARGET [--size QUOTA]
QUOTA
Quota accepts human-readable case-insensitive number.
Suffixes such as "k", "m", "g" and "t" referring to the metric units KB,
MB, GB and TB respectively. Adding an "i" to these prefixes, uses the IEC
units, so that "gi" refers to "gibibyte" or "GiB". A "b" at the end is
also accepted. Without suffixes the unit is bytes.
The MinIO object scanner checks a bucket's quota each time it is scanned.
If the scanner determines a bucket has met or exceeded its quota, MinIO
rejects subsequent object write requests until the scanner determines the
bucket no longer exceeds its quota.
FLAGS:
--size value set a hard quota, disallowing writes after quota is reached
--config-dir value, -C value path to configuration folder (default: "/Users/andrealongo/.mc") [$MC_CONFIG_DIR]
--quiet, -q disable progress bar display [$MC_QUIET]
--disable-pager, --dp disable mc internal pager and print to raw stdout [$MC_DISABLE_PAGER]
--no-color disable color theme [$MC_NO_COLOR]
--json enable JSON lines formatted output [$MC_JSON]
--debug enable debug output [$MC_DEBUG]
--insecure disable SSL certificate verification [$MC_INSECURE]
--limit-upload value limits uploads to a maximum rate in KiB/s, MiB/s, GiB/s. (default: unlimited) [$MC_LIMIT_UPLOAD]
--limit-download value limits downloads to a maximum rate in KiB/s, MiB/s, GiB/s. (default: unlimited) [$MC_LIMIT_DOWNLOAD]
--help, -h show help
EXAMPLES:
1. Set hard quota of 1gb for a bucket "mybucket" on MinIO.
$ mc quota set myminio/mybucket --size 1GB
There was a problem hiding this comment.
If it's very wide I guess it can clip in the CLI view, but that's not the end of the world either. Your edit works for me.
set a hard quota on the bucket based on scanner usage measurements
Brings back hard but at least folds the scanner into it.
it is hard quota, as long as the quota has not changed what server sees. This is due with any quota system, if you can keep increasing your top level limit it is as good as not having any limit. |
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
|
Consensus is deprecate this. Already done in docs: minio/docs#1294 See #5014 |
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
Follow up to #5011, already merged.
Calling the
mc quota setquota value a "hard quota" is misleading. It is indeed possible to go over quota while waiting for the next scanner pass to notice. Removehardfrom the command help and example.Note: there is also a reference in the code itself, which could be confusing to future maintainers. (Maybe used in an error message on failure to set quota?) Someone more familiar with the code should determine what to do about that.
Motivation and Context
How to test this PR?
Docs only
Types of changes
Checklist:
commit-idorPR #here)