Skip to content

Commit

Permalink
deprecate mc quota (#1294)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
feorlen authored Aug 8, 2024
1 parent b05ae61 commit 5865c3b
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 69 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down Expand Up @@ -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
:end-before: end-minio-mc-s3-compatibility
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down Expand Up @@ -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
:end-before: end-minio-mc-s3-compatibility
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
71 changes: 71 additions & 0 deletions source/reference/deprecated/mc-quota.rst
Original file line number Diff line number Diff line change
@@ -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 <minio-lifecycle-management-scanner>` scans a bucket for pending :ref:`object lifecycle transitions <minio-lifecycle-management>`, 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
20 changes: 20 additions & 0 deletions source/reference/minio-mc-deprecated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 0 additions & 8 deletions source/reference/minio-mc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -673,7 +666,6 @@ You can also define some of these options using :ref:`Environment Variables <min
/reference/minio-mc/mc-ping
/reference/minio-mc/mc-pipe
/reference/minio-mc/mc-put
/reference/minio-mc/mc-quota
/reference/minio-mc/mc-rb
/reference/minio-mc/mc-ready
/reference/minio-mc/mc-replicate
Expand Down
59 changes: 0 additions & 59 deletions source/reference/minio-mc/mc-quota.rst

This file was deleted.

0 comments on commit 5865c3b

Please sign in to comment.