From 5865c3b93ddc77cb385033117eb0512013154060 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Thu, 8 Aug 2024 14:58:54 -0600 Subject: [PATCH] deprecate mc quota (#1294) 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: https://github.com/minio/mc/pull/5011 https://github.com/minio/mc/pull/5012 --- .../mc-quota-clear.rst | 6 +- .../mc-quota-info.rst | 6 +- .../{minio-mc => deprecated}/mc-quota-set.rst | 4 ++ source/reference/deprecated/mc-quota.rst | 71 +++++++++++++++++++ source/reference/minio-mc-deprecated.rst | 20 ++++++ source/reference/minio-mc.rst | 8 --- source/reference/minio-mc/mc-quota.rst | 59 --------------- 7 files changed, 105 insertions(+), 69 deletions(-) rename source/reference/{minio-mc => deprecated}/mc-quota-clear.rst (92%) rename source/reference/{minio-mc => deprecated}/mc-quota-info.rst (92%) rename source/reference/{minio-mc => deprecated}/mc-quota-set.rst (97%) create mode 100644 source/reference/deprecated/mc-quota.rst delete mode 100644 source/reference/minio-mc/mc-quota.rst diff --git a/source/reference/minio-mc/mc-quota-clear.rst b/source/reference/deprecated/mc-quota-clear.rst similarity index 92% rename from source/reference/minio-mc/mc-quota-clear.rst rename to source/reference/deprecated/mc-quota-clear.rst index 735831611..f36e99814 100644 --- a/source/reference/minio-mc/mc-quota-clear.rst +++ b/source/reference/deprecated/mc-quota-clear.rst @@ -14,6 +14,10 @@ ``mc quota clear`` replaced ``mc admin bucket quota --clear``. +.. versionchanged:: RELEASE.2024-07-31T15-58-33Z + + ``mc quota clear`` is deprecated. + Description ----------- @@ -79,4 +83,4 @@ S3 Compatibility .. include:: /includes/common-minio-mc.rst :start-after: start-minio-mc-s3-compatibility - :end-before: end-minio-mc-s3-compatibility \ No newline at end of file + :end-before: end-minio-mc-s3-compatibility diff --git a/source/reference/minio-mc/mc-quota-info.rst b/source/reference/deprecated/mc-quota-info.rst similarity index 92% rename from source/reference/minio-mc/mc-quota-info.rst rename to source/reference/deprecated/mc-quota-info.rst index 63c4b065e..aadaa963c 100644 --- a/source/reference/minio-mc/mc-quota-info.rst +++ b/source/reference/deprecated/mc-quota-info.rst @@ -14,6 +14,10 @@ ``mc quota info`` replaced ``mc admin bucket quota``. +.. versionchanged:: RELEASE.2024-07-31T15-58-33Z + + ``mc quota info`` is deprecated. + Description ----------- @@ -77,4 +81,4 @@ S3 Compatibility .. include:: /includes/common-minio-mc.rst :start-after: start-minio-mc-s3-compatibility - :end-before: end-minio-mc-s3-compatibility \ No newline at end of file + :end-before: end-minio-mc-s3-compatibility diff --git a/source/reference/minio-mc/mc-quota-set.rst b/source/reference/deprecated/mc-quota-set.rst similarity index 97% rename from source/reference/minio-mc/mc-quota-set.rst rename to source/reference/deprecated/mc-quota-set.rst index 9a0d5e4ca..646302cb2 100644 --- a/source/reference/minio-mc/mc-quota-set.rst +++ b/source/reference/deprecated/mc-quota-set.rst @@ -14,6 +14,10 @@ ``mc quota set`` replaced ``mc admin bucket quota --hard``. +.. versionchanged:: RELEASE.2024-07-31T15-58-33Z + + ``mc quota set`` is deprecated. + Description ----------- diff --git a/source/reference/deprecated/mc-quota.rst b/source/reference/deprecated/mc-quota.rst new file mode 100644 index 000000000..4a3e4ca8c --- /dev/null +++ b/source/reference/deprecated/mc-quota.rst @@ -0,0 +1,71 @@ +============ +``mc quota`` +============ + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + +.. mc:: mc quota + +.. versionchanged:: RELEASE.2024-07-31T15-58-33Z + + ``mc quota`` and its subcommands are deprecated. + +Description +----------- + +.. start-mc-quota-desc + +The :mc:`mc quota` commands configure, display, or remove a quota limit on a bucket. + +.. end-mc-quota-desc + +When a bucket with a quota configured reaches the specified limit, as determined by the MinIO object scanner, MinIO rejects further ``PUT`` requests for the bucket. + +Each time the MinIO :ref:`object scanner ` scans a bucket for pending :ref:`object lifecycle transitions `, it also checks if the bucket has exceeded a configured quota. + +.. admonition:: Quota enforcement is not immediate + :class: note + + Bucket quotas are not intended to enforce a strict hard limit on a bucket's size. + If a bucket exceeds its quota between scanner passes, MinIO continues to accept ``PUT`` requests for that bucket until _after_ the next scanner pass identifies the quota violation. + + +Subcommands +----------- + +:mc:`mc quota` includes the following subcommands: + +.. list-table:: + :header-rows: 1 + :widths: 30 70 + :width: 100% + + * - Subcommand + - Description + + * - :mc:`~mc quota clear` + - .. include:: /reference/deprecated/mc-quota-clear.rst + :start-after: start-mc-quota-clear-desc + :end-before: end-mc-quota-clear-desc + + * - :mc:`~mc quota info` + - .. include:: /reference/deprecated/mc-quota-info.rst + :start-after: start-mc-quota-info-desc + :end-before: end-mc-quota-info-desc + + * - :mc:`~mc quota set` + - .. include:: /reference/deprecated/mc-quota-set.rst + :start-after: start-mc-quota-set-desc + :end-before: end-mc-quota-set-desc + +.. toctree:: + :titlesonly: + :hidden: + + /reference/deprecated/mc-quota-clear + /reference/deprecated/mc-quota-info + /reference/deprecated/mc-quota-set diff --git a/source/reference/minio-mc-deprecated.rst b/source/reference/minio-mc-deprecated.rst index 8d76cbc4a..09fc9dd50 100644 --- a/source/reference/minio-mc-deprecated.rst +++ b/source/reference/minio-mc-deprecated.rst @@ -51,6 +51,22 @@ Table of Deprecated Commands - :mc-cmd:`mc ilm rule rm` - mc RELEASE.2022-12-24T15-21-38Z + * - ``mc quota`` + - None + - mc RELEASE.2024-07-31T15-58-33Z + + * - ``mc quota clear`` + - None + - mc RELEASE.2024-07-31T15-58-33Z + + * - ``mc quota info`` + - None + - mc RELEASE.2024-07-31T15-58-33Z + + * - ``mc quota set`` + - None + - mc RELEASE.2024-07-31T15-58-33Z + * - ``mc replicate diff`` - :mc-cmd:`mc replicate backlog` - mc RELEASE.2023-07-18T21-05-38Z @@ -210,6 +226,10 @@ Table of Deprecated Admin Commands /reference/deprecated/mc-ilm-import /reference/deprecated/mc-ilm-ls /reference/deprecated/mc-ilm-rm + /reference/deprecated/mc-quota + /reference/deprecated/mc-quota-clear + /reference/deprecated/mc-quota-info + /reference/deprecated/mc-quota-set /reference/deprecated/mc-admin-bucket-quota /reference/deprecated/mc-admin-console /reference/deprecated/mc-admin-idp-ldap diff --git a/source/reference/minio-mc.rst b/source/reference/minio-mc.rst index 5229a60dd..b91522033 100644 --- a/source/reference/minio-mc.rst +++ b/source/reference/minio-mc.rst @@ -344,13 +344,6 @@ The following table lists :mc-cmd:`mc` commands: :start-after: start-mc-put-desc :end-before: end-mc-put-desc - * - | :mc:`mc quota clear` - | :mc:`mc quota info` - | :mc:`mc quota set` - - .. include:: /reference/minio-mc/mc-quota.rst - :start-after: start-mc-quota-desc - :end-before: end-mc-quota-desc - * - :mc:`mc rb` - .. include:: /reference/minio-mc/mc-rb.rst :start-after: start-mc-rb-desc @@ -673,7 +666,6 @@ You can also define some of these options using :ref:`Environment Variables