minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00
Code Activity

Updates to mc docs for December 2022 releases (#697)

Browse Source 
This PR applies updates to numerous files to address changes in the two
December 2022 `mc` releases.

- Deprecates `mc admin bucket quota` and links to new commands
- Adds `mc quota set | clear | info` commands
- Adds `attach | detach` subcommands to `mc admin idp ldap policy`
- Updates list of call types available to `mc admin trace`
- Updates `mc` page with new commands
- Fixes minor errors in `mc cp`
- Adds `--limit-*` flags to global flag options
- Adds `--versions` flag to `mc find`
    
Closes #685

- Updates ilm commands for new structure for tiers and rules
    
    - Deprecates `mc admin tier`
- Deprecates `mc ilm add | edit | export | import | ls | rm` commands
    - Adds new `mc ilm rule` and six subcommands
    - Adds new `mc ilm tier` and six subcommands
    - Updates references to ilm and admin tier  commands throughout docs
    - Adds new deprecated commands page
    - Adds `mc ilm rule` and `mc ilm tier` holding pages with toctrees

- Closes #691
- Closes #662
This commit is contained in:
Daryl White
2023-01-10 15:47:02 -06:00
committed by GitHub
parent 45aac689b4
commit 00de8dbeb6
42 changed files with 3546 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
source/reference/deprecated/mc-admin-bucket-quota.rst Normal file
View File

@ -0,0 +1,176 @@
=========================
``mc admin bucket quota``
=========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc admin bucket quota
.. versionchanged:: RELEASE.2022-12-13T00-23-28Z
``mc admin bucket quota`` replaced by :mc-cmd:`mc quota set`, :mc-cmd:`mc quota info`, and :mc-cmd:`mc quota clear`.
Description
-----------
.. start-mc-admin-bucket-quota-desc
The :mc-cmd:`mc admin bucket quota` command manages per-bucket
storage quotas.
.. end-mc-admin-bucket-quota-desc
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
:class: note
.. include:: /includes/facts-mc-admin.rst
:start-after: start-minio-only
:end-before: end-minio-only
.. _mc-admin-bucket-quota-units:
Units of Measurement
~~~~~~~~~~~~~~~~~~~~
The :mc-cmd:`mc admin bucket quota --hard` flag
accepts the following case-insensitive suffixes to represent the unit of the
specified size value:
.. list-table::
:header-rows: 1
:widths: 20 80
:width: 100%
* - Suffix
- Unit Size
* - ``k``
- KB (Kilobyte, 1000 Bytes)
* - ``m``
- MB (Megabyte, 1000 Kilobytes)
* - ``g``
- GB (Gigabyte, 1000 Megabytes)
* - ``t``
- TB (Terrabyte, 1000 Gigabytes)
* - ``ki``
- KiB (Kibibyte, 1024 Bites)
* - ``mi``
- MiB (Mebibyte, 1024 Kibibytes)
* - ``gi``
- GiB (Gibibyte, 1024 Mebibytes)
* - ``ti``
- TiB (Tebibyte, 1024 Gibibytes)
Omitting the suffix defaults to ``bytes``.
Examples
--------
Configure a Hard Quota on a Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc admin bucket quota` with the
:mc-cmd:`~mc admin bucket quota --hard` flag to specify a hard quota
on a bucket. Hard quotas prevent the bucket size from growing past the specified
limit.
.. code-block:: shell
:class: copyable
mc admin bucket quota TARGET/BUCKET --hard LIMIT
- Replace ``TARGET`` with the :mc-cmd:`alias <mc alias>` of a configured
MinIO deployment. Replace ``BUCKET`` with the name of the bucket on which to
set the hard quota.
- Replace ``LIMIT`` with the maximum size to which the bucket can grow.
For example, to set a hard limit of 10 Terrabytes, specify ``10t``.
See :ref:`mc-admin-bucket-quota-units` for supported units.
Retrieve Bucket Quota Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc admin bucket quota` to retrieve the current quota configuration
for a bucket:
.. code-block:: shell
:class: copyable
mc admin bucket quota TARGET/BUCKET
Replace ``TARGET`` with the :mc-cmd:`alias <mc alias>` of a configured
MinIO deployment. Replace ``BUCKET`` with the name of the bucket on which to
retrieve the quota.
Clear Configured Bucket Quota
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc admin bucket quota` with the
:mc-cmd:`~mc admin bucket quota --clear` flag to clear all quotas from
a bucket.
.. code-block:: shell
:class: copyable
mc admin bucket quota TARGET/BUCKET --clear
- Replace ``TARGET`` with the :mc-cmd:`alias <mc alias>` of a configured
MinIO deployment. Replace ``BUCKET`` with the name of the bucket on which to
clear the quota.
Syntax
------
:mc-cmd:`mc admin bucket quota` has the following syntax:
.. code-block:: shell
:class: copyable
mc admin bucket quota TARGET [ARGUMENTS]
:mc-cmd:`mc admin bucket quota` supports the following arguments:
.. mc-cmd:: TARGET
The full path to the bucket for which the command creates the quota.
Specify the :mc-cmd:`alias <mc alias>` of the MinIO deployment as a
prefix to the path. For example:
.. code-block:: shell
:class: copyable
mc admin bucket quota play/mybucket
Omit all other arguments to return the current quota settings for the
specified bucket.
.. mc-cmd:: --hard
Sets a maximum limit to the bucket storage size. The MinIO server rejects any
incoming ``PUT`` request whose contents would exceed the bucket's configured
quota.
For example, a hard limit of ``10GB`` would prevent adding any additional
objects if the bucket reaches ``10GB`` of size.
See :ref:`mc-admin-bucket-quota-units` for supported unit sizes.
.. mc-cmd:: --clear
Clears all quotas configured for the bucket.

388
source/reference/deprecated/mc-admin-tier.rst Normal file
View File

@ -0,0 +1,388 @@
=================
``mc admin tier``
=================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc admin tier
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc admin tier`` replaced by :mc-cmd:`mc ilm tier`.
Description
-----------
.. start-mc-admin-tier-desc
The :mc:`mc admin tier` command configures a remote supported S3-compatible
service for supporting MinIO
:ref:`Lifecycle Management: Object Transition ("Tiering")
<minio-lifecycle-management-expiration>`.
.. end-mc-admin-tier-desc
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
:class: note
.. include:: /includes/facts-mc-admin.rst
:start-after: start-minio-only
:end-before: end-minio-only
Supported S3 Services
~~~~~~~~~~~~~~~~~~~~~
:mc:`mc admin tier` supports *only* the following S3-compatible services
as a remote target for object tiering:
- Amazon S3
- Google Cloud Storage
- Azure Blob Storage
Required Permissions
~~~~~~~~~~~~~~~~~~~~
MinIO requires the following permissions scoped to to the bucket or buckets
for which you are creating lifecycle management rules.
- :policy-action:`s3:PutLifecycleConfiguration`
- :policy-action:`s3:GetLifecycleConfiguration`
MinIO also requires the following administrative permissions on the cluster
in which you are creating remote tiers for object transition lifecycle
management rules:
- :policy-action:`admin:SetTier`
- :policy-action:`admin:ListTier`
For example, the following policy provides permission for configuring object
transition lifecycle management rules on any bucket in the cluster:.
.. literalinclude:: /extra/examples/LifecycleManagementAdmin.json
:language: json
:class: copyable
Transition Permissions
++++++++++++++++++++++
Object transition lifecycle management rules require additional permissions
on the remote storage tier. Specifically, MinIO requires the remote
tier credentials provide read, write, list, and delete permissions.
For example, if the remote storage tier implements AWS IAM policy-based
access control, the following policy provides the necessary permission
for transitioning objects into and out of the remote tier:
.. literalinclude:: /extra/examples/LifecycleManagementUser.json
:language: json
:class: copyable
Modify the ``Resource`` for the bucket into which MinIO tiers objects.
Defer to the documentation for the supported tiering targets for more complete
information on configuring users and permissions to support MinIO tiering:
- :aws-docs:`Amazon S3 Permissions <service-authorization/latest/reference/list_amazons3.html#amazons3-actions-as-permissions>`
- `Google Cloud Storage Access Control <https://cloud.google.com/storage/docs/access-control>`__
- `Authorizing access to data in Azure storage <https://docs.microsoft.com/en-us/azure/storage/common/storage-auth?toc=/azure/storage/blobs/toc.json>`__
Syntax
------
.. mc-cmd:: add
:fullpath:
Creates a new remote storage tier for transitioning objects using MinIO
lifecycle management rules.
.. important::
MinIO does not support removing remote storage tiers. Ensure the
storage backend supports the intended workload *prior* to
adding it as a remote tier target.
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc admin tier add TIER_TYPE TARGET TIER_NAME [FLAGS]
The command accepts the following arguments:
.. mc-cmd:: TIER_TYPE
*Required*
The Cloud Service Provider storage backend ("Tier") to which MinIO
transitions objects. Specify *one* of the following supported values:
.. list-table::
:stub-columns: 1
:width: 100%
:widths: 30 70
* - ``s3``
- Use AWS S3 *or* a remote MinIO deployment as the storage
backend for the new Tier.
Requires specifying the following additional options:
- :mc-cmd:`~mc admin tier add --access-key`
- :mc-cmd:`~mc admin tier add --secret-key`
* - ``azure``
- Use :abbr:`Azure (Microsoft Azure)` Blob Storage as the storage
backend for the new Tier.
Requires specifying the following additional options:
- :mc-cmd:`~mc admin tier add --account-name`
- :mc-cmd:`~mc admin tier add --account-key`
* - ``gcs``
- Use :abbr:`GCP (Google Cloud Platform)` Cloud Storage as the
storage backend for the new Tier.
Requires specifying the following additional option:
- :mc-cmd:`~mc admin tier add --credentials-file`
.. mc-cmd:: TARGET
*Required*
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment on which
the command creates the new remote tier.
.. mc-cmd:: TIER_NAME
*Required*
The name to associate with the new remote tier. The name *must*
be unique across all configured tiers on the MinIO cluster.
You **must** specify the tier in all-caps, e.g. ``WARM_TIER``.
.. mc-cmd:: --endpoint
*Required*
The URL endpoint for the cloud service provider. The URL endpoint
*must* resolve to the provider specified to
:mc-cmd:`~mc admin tier add TIER_TYPE`.
.. mc-cmd:: --access-key
*Required*
The access key for a user on the remote S3 tier. The user must
have permission to perform read/write/list/delete operations on the
remote bucket or bucket prefix.
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: --secret-key
*Required*
The secret key for a user on the remote S3 tier.
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: --account-name
*Required*
The account name for a user on the remote Azure tier. The user
must have permission to perform read/write/list/delete operations on the
remote bucket or bucket prefix.
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``azure``.
This option has no effect for any other value of ``TIER_TYPE``.
MinIO does *not* support changing the account name associated to an Azure
remote tier. Azure storage backends are tied to the account, such that
changing the account would change the storage backend and prevent access
to any objects transitioned to the original account/backend.
.. mc-cmd:: --account-key
*Required*
The account key for the :mc-cmd:`~mc admin tier add --account-name`
associated to the remote Azure tier.
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``azure``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: --credentials-file
*Required*
The `credential file
<https://cloud.google.com/docs/authentication/getting-started>`__ for a
user on the remote GCS tier. The user must have permission to perform
read/write/list/delete operations on the remote bucket or bucket prefix.
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``gcs``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: --bucket
*Required*
The bucket on the remote tier to which MinIO transitions objects.
.. mc-cmd:: --prefix
*Optional*
The prefix path for the specified :mc-cmd:`~mc admin tier add --bucket`
to which MinIO transitions objects.
Omit this field to transition objects into the bucket root.
.. mc-cmd:: --storage-class
*Optional*
The AWS storage class to use for objects transitioned by
MinIO. MinIO supports only the following storage classes:
- ``STANDARD``
- ``REDUCED_REDUNDANCY``
Defaults to ``S3_STANDARD`` if omitted.
This option only applies if :mc-cmd:`~mc admin tier add TIER_TYPE` is
``s3``. This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: --region
*Optional*
The S3 backend region for the specified
:mc-cmd:`~mc admin tier add TIER_TYPE`, such as ``us-west-1``.
This option only applies if :mc-cmd:`~mc admin tier add TIER_TYPE` is
``s3``. This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: edit
:fullpath:
Modify or remove a remote storage tier from a MinIO cluster. Remote
storage tiers support transitioning objects using MinIO lifecycle
management rules.
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc admin tier edit TARGET TIER_NAME [FLAGS]
The command accepts the following arguments:
.. mc-cmd:: TARGET
*Required*
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment.
.. mc-cmd:: TIER_NAME
*Required*
The name of the remote tier the command modifies. The value
corresponds to the :mc-cmd:`mc admin tier add TIER_NAME` specified
when creating the remote tier.
.. mc-cmd:: --access-key
*Optional*
The access key for a user on the remote S3 tier. The user must
have permission to perform read/write/list/delete operations on the
remote bucket or bucket prefix.
This option only applies to remote storage tiers with
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: --secret-key
*Optional*
The secret key for a user on the remote S3 tier.
This option only applies to remote storage tiers with
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: --account-key
*Required*
The account key for a user on the remote Azure tier.
Use this option to rotate the credentials for the
:mc-cmd:`~mc admin tier add --account-name`
associated to the remote tier.
This option only applies to remote storage tiers with
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``azure``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: --credentials-file
*Required*
The credential file for a user on the remote GCS tier. The user must have
permission to perform read/write/list/delete operations on the remote bucket
or bucket prefix.
This option only applies to remote storage tiers with
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``gcs``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: ls
:fullpath:
List all remote storage tiers on a MinIO cluster. Remote storage tiers
support transitioning objects using MinIO lifecycle management rules.
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc admin tier ls TARGET [FLAGS]
The command accepts the following arguments:
.. mc-cmd:: TARGET
*Required*
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment.

378
source/reference/deprecated/mc-ilm-add.rst Normal file
View File

@ -0,0 +1,378 @@
.. _minio-mc-ilm-add:
==============
``mc ilm add``
==============
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ilm add
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc ilm add`` replaced by :mc-cmd:`mc ilm rule add`
Syntax
------
.. start-mc-ilm-add-desc
The :mc:`mc ilm add` command adds an object lifecycle management rule to a bucket.
.. end-mc-ilm-add-desc
The command supports adding both :ref:`Transition (Tiering) <minio-lifecycle-management-tiering>` and :ref:`Expiration <minio-lifecycle-management-expiration>` lifecycle management rules.
.. tab-set::
.. tab-item:: EXAMPLE
The following command adds new lifecycle management rules to the ``mydata`` bucket on the ``myminio`` deployment:
.. code-block:: shell
:class: copyable
mc ilm add --expire-days 90 --noncurrent-expire-days 30 mydata/myminio
mc ilm add --expire-delete-marker mydata/myminio
mc ilm add --transition-days 30 --transition-tier "COLDTIER" mydata/myminio
mc ilm add --noncurrent-transition-days 7 --noncurrent-transition-tier "COLDTIER"
The configured rules have the following effect:
- Delete objects more than 90 days old
- Delete objects 30 days after they become non-current
- Delete ``DeleteMarker`` tombstones if that object has no other versions remaining.
- Transition objects more than 30 days old to the ``COLDTIER`` remote tier.
- Transition objects 7 days after they become non-current to the ``COLDTIER`` remote tier.
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm add \
[--prefix string] \
[--tags string] \
--expire-days "integer" \
[--expire-delete-marker] \
[--transition-days "string"] \
[--transition-tier "string"] \
[--noncurrent-expire-days "integer"] \
[--noncurrent-expire-newer "integer"] \
[--noncurrent-transition-days "integer"] \
[--noncurrent-transition-newer "integer"] \
[--noncurrent-transition-tier "string"] \
ALIAS
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` and bucket on the MinIO deployment to which to add the object lifecycle management rule.
For example:
.. code-block:: none
mc ilm add myminio/mydata
.. mc-cmd:: --prefix
:optional:
Restrict the management rule to a specific object prefix.
For example:
.. code-block:: none
mc ilm add --prefix "meetingnotes/" myminio/mydata/ --expire-days "90"
The command creates a rule that expires objects in the ``mydata`` bucket of the ``myminio`` ALIAS after 90 days for any object with the ``meetingnotes/`` prefix.
.. mc-cmd:: --tags
:optional:
One or more ampersand ``&``-delimited key-value pairs describing the object tags to use for filtering objects to which the lifecycle configuration rule applies.
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm add --expire-delete-marker`
.. mc-cmd:: --expire-days
:required:
The number of days to retain an object after being created.
MinIO marks the object for deletion after the specified number of days pass.
Specify the number of days as an integer, e.g. ``30`` for 30 days.
For versioned buckets, the expiry rule applies only to the *current* object version.
Use the :mc-cmd:`~mc ilm add --noncurrent-expire-days` option to apply expiration behavior to noncurrent object versions.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
Mutually exclusive with the following options:
- :mc-cmd:`~mc ilm add --expire-delete-marker`
For more complete documentation on object expiration, see :ref:`minio-lifecycle-management-expiration`.
.. mc-cmd:: --expire-delete-marker
:optional:
Specify this option to direct MinIO to remove delete markers for objects with no remaining object versions.
Specifically, the delete marker is the *only* remaining "version" of the given object.
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm add --tags`
- :mc-cmd:`~mc ilm add --expire-days`
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
For more complete documentation on object expiration, see
:ref:`minio-lifecycle-management-expiration`.
.. mc-cmd:: --transition-days
:optional:
The number of calendar days from object creation after which MinIO marks an object as eligible for transition.
MinIO transitions the object to the configured remote tier specified to the :mc-cmd:`~mc ilm add --transition-tier`.
Specify the number of days as an integer, e.g. ``30`` for 30 days.
For versioned buckets, the transition rule applies only to the *current* object version.
Use the :mc-cmd:`~mc ilm add --noncurrent-transition-days` option to apply transition behavior to noncurrent object versions.
Requires specifying :mc-cmd:`~mc ilm add --transition-tier`.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
For more complete documentation on object transition, see :ref:`minio-lifecycle-management-tiering`.
.. mc-cmd:: --transition-tier
:optional:
The remote tier to which MinIO :ref:`transition objects <minio-lifecycle-management-tiering>`.
Specify an existing remote tier created by :mc:`mc admin tier`.
Required if specifying :mc-cmd:`~mc ilm add --transition-days`.
.. mc-cmd:: --noncurrent-expire-days
:optional:
The number of days to retain an object version after becoming *non-current* (i.e. a different version of that object is now the `HEAD`).
MinIO marks noncurrent object versions for deletion after the specified number of days pass.
This option has the same behavior as the S3 ``NoncurrentVersionExpiration`` action.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --noncurrent-transition-days
:optional:
The number of days an object has been non-current (i.e. replaced by a newer version of that same object) after which MinIO marks the object version as eligible for transition.
MinIO transitions the object to the configured remote tier specified to the :mc-cmd:`~mc ilm add --transition-tier` once the system host datetime passes that calendar date.
This option has no effect on non-versioned buckets.
Requires specifying :mc-cmd:`~mc ilm add --noncurrent-transition-tier`.
This option has the same behavior as the S3 ``NoncurrentVersionTransition`` action.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --noncurrent-transition-tier
:optional:
The remote tier to which MinIO :ref:`transitions noncurrent objects versions <minio-lifecycle-management-tiering>`.
Specify a remote tier created by :mc:`mc admin tier`.
.. mc-cmd:: --noncurrent-expire-newer
:optional:
The maximum number of non-current object versions to retain, ordered from newest to oldest.
Use this flag to retain a certain number of past versions of a file in a first in, first out fashion.
After retaining the maximum number of non-current versions, MinIO marks any remaining older non-current object versions as eligible for expiration.
The following table lists a number of object versions and their expiration eligibility based on ``--noncurrent-expire-newer 3``:
.. list-table::
:widths: 50 50
:width: 100%
* - v5 (current version)
- Current version not affected by ILM rules.
* - v4
- retained
* - v3
- retained
* - v2
- retained
* - v1
- marked for expiry
MinIO retains the current version, v5.
MinIO also retains the next ``3`` non-current versions, starting with the newest.
This means MinIO marks ``v4``, ``v3``, and ``v2`` for the three non-current version to retain.
``v1`` would be a fourth non-current version, which falls outside the limit of non-current versions to retain, so MinIO marks ``v1`` for expiration.
Updating the number for this flag only impacts the unmarked versions of objects.
Any versions already marked for expiration do not change if you increase the number to retain.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --noncurrent-transition-newer
:optional:
The maximum number of non-current object versions to retain on the current tier.
Older object versions beyond the number to retain transition to a different, specified tier.
Use this flag to keep a certain number of non-current versions of an object accessible on the tier in a first in, first out order.
If not specified, all non-current object versions transition to the different tier.
The following table lists a number of object versions and their transition eligibility based on ``--noncurrent-transition-newer 3``:
.. list-table::
:widths: 50 50
:width: 100%
* - v5 (current version)
- Current version not affected by ILM rules.
* - v4
- kept on current tier
* - v3
- kept on current tier
* - v2
- kept on current tier
* - v1
- marked for transition to other tier
MinIO retains the current version, v5, on the tier.
MinIO also retains the next ``3`` non-current versions on the tier, starting with the newest.
This means MinIO leaves ``v4``, ``v3``, and ``v2`` for the three non-current version to keep on the current tier.
``v1`` would be a fourth non-current version, which falls outside the limit of non-current versions to retain, so MinIO marks ``v1`` for transition.
Updating the number for this flag only impacts the unmarked versions of objects.
Any versions already marked for transition do not change if you increase the number, and any object versions already transitioned do not transition back to the tier.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Expire All Bucket Contents After Number of Days
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc ilm add` with :mc-cmd:`~mc ilm add --expire-days` to mark bucket contents for expiration after a number of days pass from the object's creation:
.. code-block:: shell
:class: copyable
mc ilm add ALIAS/PATH --expire-days "DAYS"
- Replace :mc-cmd:`ALIAS <mc ilm add ALIAS>` with the :mc:`alias <mc alias>` of the S3-compatible host.
- Replace :mc-cmd:`PATH <mc ilm add ALIAS>` with the path to the bucket on the S3-compatible host.
- Replace :mc-cmd:`DATE <mc ilm add --expire-days>` with the number of days after which to expire the object.
For example, specify ``30`` to expire the object 30 days after creation.
Transition Non-Current Object Versions at a Prefix to a Different Tier
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use the :mc:`mc ilm add` with :mc-cmd:`~mc ilm add --prefix` and :mc-cmd:`~mc ilm add --transition-tier` to transition older non-current versions of an object to a different storage tier.
.. code-block:: shell
:class: copyable
mc ilm add --prefix "doc/" --transition-days "90" --trasition-tier "MINIOTIER-1" \
--noncurrent-transition-days "45" --noncurrent-transition-tier "MINIOTIER-2" \
myminio/mybucket/
This command looks at the contents with the ``doc/`` prefix in the ``mybucket`` bucket on the ``myminio`` deployment.
- Current objects in the prefix older than 90 days move to the ``MINIOTIER-1`` storage tier.
- Non-current objects in the prefix older than 45 days move to the ``MINIOTIER-2`` storage tier.
- Both ``MINIOTIER-1`` and ``MINIOTIER-2`` have already been created with :mc:`mc admin tier add`.
Expire All Objects at a Prefix, Retain Current Object Versions Longer Than Non-Current Object Versions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use the :mc:`mc ilm add` command with :mc-cmd:`~mc ilm add --prefix`, :mc-cmd:`~mc ilm add --expire-days`, and :mc-cmd:`~mc ilm add --noncurrent-expire-days` to expire current and non-current versions of an object at different times.
.. code-block:: shell
:class: copyable
mc ilm add --prefix "doc/" --expire-days "300" --noncurrent-expire-days "100" myminio/mybucket/
This command looks at the contents with the ``doc/`` prefix in the ``mybucket`` bucket on the ``myminio`` deployment.
- Current objects expire after 300 days.
- Non-current objects expire after 100 days.
Behavior
--------
Lifecycle Management Object Scanner
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
MinIO uses a scanner process to check objects against all configured
lifecycle management rules. Slow scanning due to high IO workloads or
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
Expiry vs Transition
~~~~~~~~~~~~~~~~~~~~
MinIO supports specifying both expiry and transition rules in the same
bucket or bucket prefix. MinIO can execute an expiration rule on an object
regardless of its transition status. Use
:mc:`mc ilm ls` to review the currently configured object lifecycle
management rules for any potential interactions between expiry and transition
rules.
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility

333
source/reference/deprecated/mc-ilm-edit.rst Normal file
View File

@ -0,0 +1,333 @@
.. _minio-mc-ilm-edit:
===============
``mc ilm edit``
===============
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ilm edit
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc ilm edit`` replaced by :mc-cmd:`mc ilm rule edit`
Syntax
------
.. start-mc-ilm-edit-desc
The :mc:`mc ilm edit` command modifies an existing object lifecycle management
rule on a MinIO bucket.
.. end-mc-ilm-edit-desc
.. tab-set::
.. tab-item:: EXAMPLE
The following command modifies existing lifecycle management rules for
the ``mydata`` bucket on the ``myminio`` deployment:
.. code-block:: shell
:class: copyable
mc ilm edit --id "c79ntj94b0t6rukh6lr0" --expiry-days 90 mydata/myminio
mc ilm edit --id "c79nu2p4b0t6qko19rgg" --expired-object-delete-marker mydata/myminio
mc ilm edit --id "c79n19dn10dnab109fg1" --transition-days 30 --tier "COLDTIER"
The command modifies the specified rules as follows:
- Delete objects more than 90 days old.
- Delete ``DeleteMarker`` tombstones if that object has no other versions
remaining.
- Transition objects more than 30 days old to the ``COLDTIER`` remote
tier.
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm edit \
--id "string" \
[--prefix "string"] \
[--enable] \
[--disable] \
[--expiry-days "string" | --expired-object-delete-marker] \
[--transition-days "string"] --tier "string" \
[--noncurrentversion-expiration-days "string"] \
[--noncurrentversion-transition-days "string" --noncurrentversion-tier "string"] \
[--tags] \
ALIAS
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` and full path to the bucket on the MinIO
deployment to which to modify the object lifecycle management rule. For
example:
.. code-block:: none
mc ilm edit myminio/mydata
.. mc-cmd:: --id
:required:
The unique ID of the rule. Use :mc:`mc ilm rule ls` to list bucket
rules and retrieve the ``id`` for the rule you want to modify.
.. mc-cmd:: --disable
:optional:
Stop using the rule, but retain the rule for future use.
Objects do not transition or expire when a rule is disabled.
.. mc-cmd:: --enable
:optional:
Use a rule to transition or expire objects.
.. mc-cmd:: --prefix
:optional:
Restrict the management rule to a specific bucket prefix.
For example:
.. code-block:: none
mc ilm edit --prefix "meetingnotes/" myminio/mydata/ --expiry-days "90"
The command modifies a rule that expires objects in the ``mydata`` bucket of the ``myminio`` ALIAS after 90 days for any object with the ``meetingnotes/`` prefix.
.. mc-cmd:: --expiry-days
:optional:
The number of days to retain an object after being created. MinIO
marks the object for deletion after the specified number of days pass.
Exercise caution when using this option, as its behavior can result in
immediate expiration of uploaded objects. Any objects created *after*
the specified expiration date are automatically eligible for expiration.
Similarly, specifying a calendar date that is *prior* to the current
system host datetime marks all objects covered by the rule for deletion.
Consider immediately removing any ILM rule using this option once the
specified calendar date has passed.
For versioned buckets, the expiry rule applies only to the *current*
object version. Use the
:mc-cmd:`~mc ilm edit --noncurrentversion-expiration-days` option
to apply expiration behavior to noncurrent object versions.
MinIO uses a scanner process to check objects against all configured
lifecycle management rules. Slow scanning due to high IO workloads or
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
Mutually exclusive with the following options:
- :mc-cmd:`~mc ilm edit --expired-object-delete-marker`
.. mc-cmd:: --expired-object-delete-marker
:optional:
Specify this option to direct MinIO to remove delete markers for
objects with no remaining object versions. Specifically, the delete marker is
the *only* remaining "version" of the given object.
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm edit --tags`
- :mc-cmd:`~mc ilm edit --expiry-days`
MinIO uses a scanner process to check objects against all configured
lifecycle management rules. Slow scanning due to high IO workloads or
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --noncurrentversion-expiration-days
:optional:
The number of days to retain an object version after becoming
*non-current* (i.e. a different version of that object is now the `HEAD`).
MinIO marks noncurrent object versions for deletion after the specified
number of days pass.
This option has the same behavior as the
S3 ``NoncurrentVersionExpiration`` action.
MinIO uses a scanner process to check objects against all configured
lifecycle management rules. Slow scanning due to high IO workloads or
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --noncurrentversion-transition-days
:optional:
The number of days an object has been non-current (i.e. replaced
by a newer version of that same object) after which MinIO marks the object
version as eligible for transition. MinIO transitions the object to the
configured remote storage tier specified to the
:mc-cmd:`~mc ilm edit --tier` once the system host datetime
passes that calendar date.
This option has no effect on non-versioned buckets. Requires specifying
:mc-cmd:`~mc ilm edit --noncurrentversion-tier`.
This option has the same behavior as the
S3 ``NoncurrentVersionTransition`` action.
MinIO uses a scanner process to check objects against all configured
lifecycle management rules. Slow scanning due to high IO workloads or
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --noncurrentversion-tier
:optional:
The remote storage tier to which MinIO
:ref:`transitions noncurrent objects versions
<minio-lifecycle-management-tiering>`. Specify a remote storage tier created
by :mc:`mc admin tier`.
MinIO does *not* automatically migrate objects from the previously
specified remote tier to the new remote tier. MinIO continues to
route requests for objects stored on the old remote tier.
.. mc-cmd:: --newer-noncurrentversions-expiration
:optional:
The number of non-current versions of an object to retain before applying expiration.
Older non-current versions beyond the specified number expire.
By default, MinIO does not retain any non-current versions when an expiration rule applies.
.. mc-cmd:: --newer-noncurrentversions-transition
:optional:
The number of non-current versions of an object to keep on the current storage tier.
Older non-current versions beyond the specified number transition to the specified tier.
By default, MinIO transitions all non-current versions when a transition rule applies.
.. mc-cmd:: --tags
:optional:
One or more ampersand ``&``-delimited key-value pairs describing
the object tags to which to apply the lifecycle configuration rule.
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm edit --expired-object-delete-marker`
.. mc-cmd:: --transition-days
:optional:
The number of calendar days from object creation after which MinIO
marks an object as eligible for transition. MinIO transitions the object to
the configured remote storage tier specified to the
:mc-cmd:`~mc ilm edit --tier`.
For versioned buckets, the transition rule applies only to the *current*
object version. Use the
:mc-cmd:`~mc ilm edit --noncurrentversion-transition-days` option
to apply transition behavior to noncurrent object versions.
Requires specifying :mc-cmd:`~mc ilm edit --tier`.
MinIO uses a scanner process to check objects against all configured
lifecycle management rules. Slow scanning due to high IO workloads or
limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --tier
:optional:
The remote storage tier to which MinIO
:ref:`transition objects <minio-lifecycle-management-tiering>`. Specify a
remote storage tier created by :mc:`mc admin tier`.
Required if specifying :mc-cmd:`~mc ilm edit --transition-days`.
MinIO does *not* automatically migrate objects from the previously
specified remote tier to the new remote tier. MinIO continues to
route requests for objects stored on the old remote tier.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Modify an Existing Lifecycle Management Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc ilm edit` with :mc-cmd:`~mc ilm edit --id` to modify
an existing object expiration rule:
.. code-block:: shell
:class: copyable
mc ilm edit ALIAS/PATH --id "RULEID" [FLAGS]
- Replace :mc-cmd:`ALIAS <mc ilm edit ALIAS>` with the
:mc:`alias <mc alias>` of the S3-compatible host.
- Replace :mc-cmd:`PATH <mc ilm edit ALIAS>` with the path to the bucket on the
S3-compatible host.
- Replace ``RULEID`` with the unique ID of the object lifecycle management
rule.
Use :mc:`mc ilm rule ls` to find the ``RULEID``.
- Specify any additional flags to add or modify the lifecycle management
rule. For example, specify
:mc-cmd:`~mc ilm edit --transition-days` to override the existing
transition days value for the rule.
Disable a Lifecycle Management Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc ilm edit` with :mc-cmd:`~mc ilm edit --disable` to stop using an existing management rule.
.. code-block:: shell
:class: copyable
mc ilm edit --id "RULEID" --disable myminio/mybucket
- Replace ``RULEID`` with the unique ID of the object lifecycle management rule.
Use :mc:`mc ilm rule ls` to find the ``RULEID``.
- Replace ``myminio`` with the ALIAS of the deployment where the rule exists.
- Replace ``mybucket`` with the bucket for the rule.
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility

124
source/reference/deprecated/mc-ilm-export.rst Normal file
View File

@ -0,0 +1,124 @@
.. _minio-mc-ilm-export:
=================
``mc ilm export``
=================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ilm export
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc ilm export`` replaced by :mc-cmd:`mc ilm rule export`
Syntax
------
.. start-mc-ilm-export-desc
The :mc:`mc ilm export` command exports the object lifecycle management
configuration for a MinIO bucket.
.. end-mc-ilm-export-desc
The :mc:`mc ilm export` command outputs to ``STDOUT`` by default. You can
output the contents to a ``.json`` file for archival or ingestion using
:mc:`mc ilm import`.
.. tab-set::
.. tab-item:: EXAMPLE
The following command exports the lifecycle management configuration
of the ``mydata`` bucket on the ``myminio`` deployment to the
``mydata-lifecycle-config.json`` file:
.. code-block:: shell
:class: copyable
mc ilm export myminio/mydata > mydata-lifecycle-config.json
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm export ALIAS > STDOUT
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
*Required* The :ref:`alias <alias>` and full path to the bucket on the MinIO
deployment for which to export object lifecycle management rules. For
example:
.. code-block:: none
mc ilm export myminio/mydata > bucket-lifecycle.json
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Export the Bucket Lifecycle Management Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. tab-set::
.. tab-item:: Example
The following command exports the bucket lifecycle management
configuration to the ``bucket-lifecycle.json`` file:
.. code-block:: shell
:class: copyable
mc ilm export myminio/mybucket > bucket-lifecycle.json
.. tab-item:: Syntax
.. code-block:: shell
:class: copyable
mc ilm export ALIAS > file.json
- Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO
deployment and the bucket for which to export object lifecycle
management rules:
``myminio/mydata``
- Replace ``file.json`` with the name of the file to which to export the
lifecycle management rules.
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility

131
source/reference/deprecated/mc-ilm-import.rst Normal file
View File

@ -0,0 +1,131 @@
.. _minio-mc-ilm-import:
=================
``mc ilm import``
=================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ilm import
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc ilm import`` replaced by :mc-cmd:`mc ilm rule import`
Syntax
------
.. start-mc-ilm-import-desc
The :mc:`mc ilm import` command imports an object lifecycle management
configuration and applies it to a MinIO bucket.
.. end-mc-ilm-import-desc
The :mc:`mc ilm import` command imports from ``STDIN`` by default. You can
input the contents from a ``.json`` file, such as one produced by
:mc:`mc ilm export`.
.. tab-set::
.. tab-item:: EXAMPLE
The following command imports the lifecycle management configuration from
``mydata-lifecycle-config.json`` and applies it to the ``mydata`` bucket
on the ``myminio`` deployment:
.. code-block:: shell
:class: copyable
mc ilm import myminio/mydata <> mydata-lifecycle-config.json
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm import ALIAS < STDIN
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
*Required* The :ref:`alias <alias>` and full path to the bucket on the MinIO
deployment into which to import object lifecycle management rules. For
example:
.. code-block:: none
mc ilm import myminio/mydata < bucket-lifecycle.json
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Import the Bucket Lifecycle Management Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. tab-set::
.. tab-item:: Example
The following command imports the bucket lifecycle management
configuration from the ``bucket-lifecycle.json`` file:
.. code-block:: shell
:class: copyable
mc ilm import myminio/mybucket < bucket-lifecycle.json
.. tab-item:: Syntax
.. code-block:: shell
:class: copyable
mc ilm import ALIAS < file.json
- Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO
deployment and the bucket into which to import object lifecycle
management rules:
``myminio/mydata``
- Replace ``file.json`` with the name of the file from which to import the
lifecycle management rules.
Behavior
--------
Importing Configuration Overrides Existing Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:mc:`mc ilm import` replaces the current bucket lifecycle management
rules with those defined in the imported JSON configuration.
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility

155
source/reference/deprecated/mc-ilm-ls.rst Normal file
View File

@ -0,0 +1,155 @@
.. _minio-mc-ilm-ls:
=============
``mc ilm ls``
=============
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ilm ls
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc ilm ls`` replaced by :mc-cmd:`mc ilm rule ls`
Syntax
------
.. start-mc-ilm-ls-desc
The :mc:`mc ilm ls` command summrizes all configured object lifecycle management
rules on a MinIO bucket in a tabular format.
.. end-mc-ilm-ls-desc
The output of the command might resemble the following:
.. code-block:: shell
┌───────────────────────────────────────────────────────────────────────────────┐
│ Transition for latest version (Transition) │
├────────┬─────────┬────────┬─────────────────────┬──────────────┬──────────────┤
│ ID │ STATUS │ PREFIX │ TAGS │ DAYS TO TIER │ TIER │
├────────┼─────────┼────────┼─────────────────────┼──────────────┼──────────────┤
│ rule-1 │ Enabled │ doc/ │ key1=val1&key2=val2 │ 0 │ WARM-MINIO-1 │
└────────┴─────────┴────────┴─────────────────────┴──────────────┴──────────────┘
┌────────────────────────────────────────────────────────────────┐
│ Transition for older versions (NoncurrentVersionTransition) │
├────────┬─────────┬────────┬──────┬──────────────┬──────────────┤
│ ID │ STATUS │ PREFIX │ TAGS │ DAYS TO TIER │ TIER │
├────────┼─────────┼────────┼──────┼──────────────┼──────────────┤
│ rule-2 │ Enabled │ logs/ │ - │ 10 │ WARM-MINIO-1 │
└────────┴─────────┴────────┴──────┴──────────────┴──────────────┘
┌────────────────────────────────────────────────────────────────────────────────────────┐
│ Expiration for latest version (Expiration) │
├────────┬─────────┬────────┬─────────────────────┬────────────────┬─────────────────────┤
│ ID │ STATUS │ PREFIX │ TAGS │ DAYS TO EXPIRE │ EXPIRE DELETEMARKER │
├────────┼─────────┼────────┼─────────────────────┼────────────────┼─────────────────────┤
│ rule-1 │ Enabled │ doc/ │ key1=val1&key2=val2 │ 30 │ false │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴─────────────────────┘
┌──────────────────────────────────────────────────────────────────────────────────┐
│ Expiration for older versions (NoncurrentVersionExpiration) │
├────────┬─────────┬────────┬─────────────────────┬────────────────┬───────────────┤
│ ID │ STATUS │ PREFIX │ TAGS │ DAYS TO EXPIRE │ KEEP VERSIONS │
├────────┼─────────┼────────┼─────────────────────┼────────────────┼───────────────┤
│ rule-1 │ Enabled │ doc/ │ key1=val1&key2=val2 │ 15 │ 0 │
│ rule-2 │ Enabled │ logs/ │ - │ 1 │ 3 │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴───────────────┘
.. tab-set::
.. tab-item:: EXAMPLE
The following command lists all lifecycle management rules for the
``mydata`` bucket on the ``myminio`` MinIO deployment:
.. code-block:: shell
:class: copyable
mc ilm ls myminio/mydata
.. tab-item:: SYNTAX
The :mc:`mc ilm ls` command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm ls \
[--expiry | --transition] \
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` and full path to the bucket on the MinIO
deployment for which to list the object lifecycle management rules. For
example:
.. code-block:: none
mc ilm ls myminio/mydata
.. mc-cmd:: --expiry
:optional:
:mc:`mc ilm ls` returns only fields related to lifecycle rule expiration.
Mutually exclusive with :mc-cmd:`~mc ilm ls --transition`.
.. mc-cmd:: --transition
:optional:
:mc:`mc ilm ls` returns only fields related to lifecycle rule transition.
Mutually exclusive with :mc-cmd:`~mc ilm ls --expiry`.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
List Bucket Lifecycle Management Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc ilm ls` to list a bucket's lifecycle management rules:
.. code-block:: shell
:class: copyable
mc ilm ls ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc ilm ls ALIAS>` with the
:mc:`alias <mc alias>` of the S3-compatible host.
- Replace :mc-cmd:`PATH <mc ilm ls ALIAS>` with the path to the bucket on the
S3-compatible host.
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility

127
source/reference/deprecated/mc-ilm-rm.rst Normal file
View File

@ -0,0 +1,127 @@
.. _minio-mc-ilm-rm:
=============
``mc ilm rm``
=============
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ilm rm
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc ilm rm`` replaced by :mc-cmd:`mc ilm rule rm`
Syntax
------
.. start-mc-ilm-rm-desc
The :mc:`mc ilm rm` command removes an object lifecycle management rule from a
MinIO Bucket.
.. end-mc-ilm-rm-desc
.. tab-set::
.. tab-item:: EXAMPLE
The following command removes a single lifecycle management rule from
the ``mydata`` bucket on the ``myminio`` MinIO deployment:
.. code-block:: shell
:class: copyable
mc ilm rm --id "bgrt1ghju" myminio/mydata
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm rm \
--id "string" | (--all --force) \
ALIAS \
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
*Required* The :ref:`alias <alias>` and full path to the bucket on the MinIO
deployment to which to remove the object lifecycle management rule. For
example:
.. code-block:: none
mc ilm rm myminio/mydata
.. mc-cmd:: all
*Required* Removes all rules in the bucket. Mutually exclusive with
:mc:`mc ilm rm id`.
Mutually exclusive with :mc:`mc ilm rm id`
Requires including :mc-cmd:`~mc ilm rm force`.
.. mc-cmd:: force
Required if specifying :mc-cmd:`~mc ilm rm all`.
.. mc-cmd:: id
*Required* The unique ID of the rule. Use :mc:`mc ilm rule ls` to list bucket
rules and retrieve the ``id`` for the rule you want to remove.
Mutually exclusive with :mc:`mc ilm rm all`
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Remove a Bucket Lifecycle Management Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc ilm rm` to remove a bucket lifecycle management rule:
.. code-block:: shell
:class: copyable
mc ilm rm --id "RULE" ALIAS/PATH
- Replace :mc-cmd:`RULE <mc ilm rm id>` with the unique name of the lifecycle
management rule.
- Replace :mc-cmd:`ALIAS <mc ilm rm ALIAS>` with the
:mc:`alias <mc alias>` of the S3-compatible host.
- Replace :mc-cmd:`PATH <mc ilm rm ALIAS>` with the path to the bucket on the
S3-compatible host.
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility