mc ilm rule add

The mc ilm rule add command adds an object lifecycle management rule to a bucket.

The command supports adding both Transition (Tiering) and Expiration lifecycle management rules.

mc ilm rule add --expire-days 90 --noncurrent-expire-days 30  myminio/mydata

mc ilm rule add --expire-delete-marker myminio/mydata

mc ilm rule add --transition-days 30 --transition-tier "COLDTIER" myminio/mydata

mc ilm rule add --noncurrent-transition-days 7 --noncurrent-transition-tier "COLDTIER"

mc [GLOBALFLAGS] ilm rule 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-tier "string"]      \
                 [--site-gt "string"]                         \
                 [--size-lt "string"]                         \
                 [--purge-all-object-versions-days "integer"] \
                 [--purge-all-object-versions-delete-marker]  \
                 ALIAS

Required

The alias and bucket on the AIStor deployment to which to add the object lifecycle management rule.

For example:

mc ilm rule add myminio/mydata

Optional

Restrict the management rule to a specific object prefix.

For example:

mc ilm rule 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.

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:

• --expire-delete-marker

Optional

The number of days to retain an object after being created. AIStor marks the object for deletion after the specified number of days pass. Specify the number of days as an integer, for example 30 for 30 days.

For versioned buckets, the expiry rule applies only to the current object version. Use either the --noncurrent-expire-days flag or the --purge-all-object-versions-days flag to apply expiration behavior to noncurrent object versions.

AIStor 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:

• --expire-delete-marker

For more complete documentation on object expiration, see Object Expiration and Object Deletion.

Optional

Specify this option to direct AIStor 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:

• --tags
• --expire-days

AIStor 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 and Object Deletion.

Optional

The number of calendar days from object creation after which AIStor marks an object as eligible for transition. AIStor transitions the object to the configured remote tier specified to the --transition-tier. Specify the number of days as an integer, e.g. 30 for 30 days. If the remote tier is another AIStor deployment, you can set the value to 0 to mark new objects as immediately eligible for transition to the remote tier.

For versioned buckets, the transition rule applies only to the current object version. Use the --noncurrent-transition-days option to apply transition behavior to noncurrent object versions.

Requires specifying --transition-tier.

AIStor 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”).

Optional

The remote tier to which AIStor transition objects. Specify an existing remote tier created by mc ilm tier add.

Required if specifying --transition-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). AIStor marks noncurrent object versions for deletion after the specified number of days pass.

This option has the same behavior as the S3 NoncurrentVersionExpiration action.

AIStor 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 AIStor marks the object version as eligible for transition. AIStor transitions the object to the configured remote tier specified to the --transition-tier once the system host datetime passes that calendar date.

This option has no effect on non-versioned buckets. Requires specifying --noncurrent-transition-tier.

This option has the same behavior as the S3 NoncurrentVersionTransition action.

AIStor 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 tier to which AIStor transitions noncurrent objects versions. Specify a remote tier created by mc ilm tier add.

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, AIStor 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:

AIStor retains the current version, v5. AIStor also retains the next 3 non-current versions, starting with the newest. This means AIStor 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 AIStor 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.

AIStor 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

Select objects larger than the specified value. Enter the value as a number and a unit, such as 5GiB for 5 gibibytes.

Valid units include:

Optional

Select objects smaller than the specified value. Enter the value as a number and a unit, such as 1M for 1 megabyte.

Valid units include:

Optional

Specify the number of days after which to delete all versions of an object. This flag does not remove delete markers.

To remove delete markers, use --expire-delete-marker or --purge-all-object-versions-delete-marker.

Optional

Use this flag to purge all versions of objects where the latest version of the object is a delete marker, including the delete marker.

This command supports any of the global flags.

Use mc ilm rule add with the --purge-all-object-versions-days flag to mark all current and non-current bucket contents for expiration after a number of days pass from the object’s creation:

mc ilm rule add ALIAS/PATH --purge-all-object-versions-days "DAYS"

• Replace ALIAS with the alias of the S3-compatible host.
• Replace PATH with the path to the bucket on the S3-compatible host.
• Replace DAYS with the number of days after which to expire each object. For example, specify 30 to expire objects 30 days after creation.

Use the mc ilm rule add with --prefix and --transition-tier to transition older non-current versions of an object to a different storage tier.

mc ilm rule add --prefix "doc/" --transition-days "90" --transition-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 ilm tier add.

Use the mc ilm rule add command with --prefix, --expire-days, and --noncurrent-expire-days to expire current and non-current versions of an object at different times.

mc ilm rule 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.

Use the mc ilm rule add command with --prefix, --size-gt, and --noncurrent-expire-days to expire current and non-current versions of an object at different times.

mc ilm rule add --prefix "doc/" --size-gt 1MiB --transition-days "90" --transition-tier "MINIOTIER-1" \
      --noncurrent-transition-days "45" --noncurrent-transition-tier "MINIOTIER-1" \
      myminio/mybucket/

This command looks at the contents with the doc/ prefix in the mybucket bucket on the myminio deployment.

The command selects the following objects:

• Current objects older than 90 days larger than 1MiB.
• Non-current objects older than 45 days larger than 1MiB.

Selected objects transition to MINIOTIER-1.

The following command removes delete markers for objects where the delete marker is the only version of the object that remains.

mc ilm rule add ALIAS/PATH --expire-delete-marker

• Replace ALIAS with the alias of the S3-compatible host.
• Replace PATH with the path to the bucket on the S3-compatible host.

For permissions required to add a rule, refer to the required permissions on the parent command.

AIStor 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.

AIStor supports specifying both expiry and transition rules in the same bucket or bucket prefix. AIStor can execute an expiration rule on an object regardless of its transition status. Use mc ilm rule 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 with AIStor and AWS S3 for expected functionality and behavior.

AIStor 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.