mc ilm add
Table of Contents
The mc ilm add
command adds an object lifecycle management rule to a
bucket.
The command supports adding both Transition (Tiering) and Expiration lifecycle management rules.
The following command adds new lifecycle management rules to the
mydata
bucket on the myminio
deployment:
mc ilm add --expiry-days 90 --noncurrentversion-expiry-days 30 mydata/myminio
mc ilm add --expired-object-delete-marker mydata/myminio
mc ilm add --transition-days 30 --storage-class "COLDTIER" mydata/myminio
mc ilm add --noncurrentversion-transition-days 7 --noncurrent-version-transition-storage-class "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.
The command has the following syntax:
mc [GLOBALFLAGS] ilm add \
--expiry-days "string" | --expired-object-delete-marker \
--transition-days "string" --storage-class "string" \
[--noncurrentversion-expiration-days "string"] \
[--noncurrentversion-transition-days "string" --noncurrentversion-transition-storage-class "string"] \
[--tags] \
ALIAS
Brackets []
indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters seperated using the pipe |
operator are mutually exclusive.
Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.
Required The alias and full path to the bucket on the MinIO deployment to which to add the object lifecycle management rule. For example:
mc ilm add myminio/mydata
To restrict the management rule to a specific bucket prefix, specify that
prefix as part of the ALIAS
. For example:
mc ilm add myminio/mydata/someprefix
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
--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 Lifecycle Management Object Scanner for more information.
Mutually exclusive with the following options:
For more complete documentation on object expiration, see Object Expiration.
Required 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:
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 Lifecycle Management Object Scanner for more information.
For more complete documentation on object expiration, see Object Expiration.
Required 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
--storage-class
. 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
--noncurrentversion-transition-days
option
to apply transition behavior to noncurrent object versions.
Requires specifying --storage-class
.
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 Lifecycle Management Object Scanner for more information.
For more complete documentation on object transition, see Object Transition (“Tiering”).
Required The remote storage tier to which MinIO
transition objects.
Specify a remote storage tier created by mc admin tier
.
Required if specifying --transition-days
.
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:
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 Lifecycle Management Object Scanner for more information.
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
--storage-class
once the system host datetime
passes that calendar date.
This option has no effect on non-versioned buckets. Requires specifying
--noncurrentversion-transition-storage-class
.
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 Lifecycle Management Object Scanner for more information.
Optional The remote storage tier to which MinIO
transitions noncurrent objects versions. Specify a remote storage tier created
by mc admin tier
.
The path to a JSON
formatted configuration file that
mc uses for storing data. See Configuration File for
more information on how mc uses the configuration file.
Enables JSON lines formatted output to the console.
For example:
mc --JSON COMMAND
Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.
Displays the current version of mc
.
Use mc ilm add
with --expiry-days
to
expire bucket contents a number of days after object creation:
mc ilm add ALIAS/PATH --expiry-days "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 Lifecycle Management Object Scanner for more information.
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 ilm ls
to review the currently configured object lifecycle
management rules for any potential interactions between expiry and transition
rules.
The mc commandline tool is built for compatibility with the AWS S3 API and is tested MinIO and AWS S3 for expected functionality and behavior.
MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.
This work is licensed under a Creative Commons Attribution 4.0 International License.
©2020-Present, MinIO, Inc.