mc admin tier
Table of Contents
The mc admin tier
command configures a remote supported S3-compatible
service for supporting MinIO
Lifecycle Management: Object Transition (“Tiering”).
Use mc admin
on MinIO Deployments Only
MinIO does not support using mc admin
commands with other
S3-compatible services, regardless of their claimed compatibility with MinIO
deployments.
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
MinIO requires the following permissions scoped to to the bucket or buckets for which you are creating lifecycle management rules.
MinIO also requires the following administrative permissions on the cluster in which you are creating remote tiers for object transition lifecycle management rules:
For example, the following policy provides permission for configuring object transition lifecycle management rules on any bucket in the cluster:.
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"admin:SetTier",
"admin:ListTier"
],
"Effect": "Allow",
"Sid": "EnableRemoteTierManagement"
},
{
"Action": [
"s3:PutLifecycleConfiguration",
"s3:GetLifecycleConfiguration"
],
"Resource": [
"arn:aws:s3:::*"
],
"Effect": "Allow",
"Sid": "EnableLifecycleManagementRules"
}
]
}
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:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"s3:ListBucket"
],
"Effect": "Allow",
"Resource": [
"arn:aws:s3:::MyDestinationBucket"
],
"Sid": ""
},
{
"Action": [
"s3:GetObject",
"s3:PutObject",
"s3:DeleteObject"
],
"Effect": "Allow",
"Resource": [
"arn:aws:s3:::MyDestinationBucket/*"
],
"Sid": ""
}
]
}
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:
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:
mc admin tier add TIER_TYPE TARGET TIER_NAME [FLAGS]
The command accepts the following arguments:
Required
The Cloud Service Provider storage backend (“Tier”) to which MinIO transitions objects. Specify one of the following supported values:
|
Use AWS S3 or a remote MinIO deployment as the storage backend for the new Tier. Requires specifying the following additional options: |
---|---|
|
Use Azure Blob Storage as the storage backend for the new Tier. Requires specifying the following additional options: |
|
Use GCP Cloud Storage as the storage backend for the new Tier. Requires specifying the following additional option: |
Required
The alias
of a configured MinIO deployment on which
the command creates the new remote tier.
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
.
Required
The URL endpoint for the cloud service provider. The URL endpoint
must resolve to the provider specified to
TIER_TYPE
.
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 TIER_TYPE
is s3
.
This option has no effect for any other value of TIER_TYPE
.
Required
The secret key for a user on the remote S3 tier.
Required if TIER_TYPE
is s3
.
This option has no effect for any other value of TIER_TYPE
.
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 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.
Required
The account key for the --account-name
associated to the remote Azure tier.
Required if TIER_TYPE
is azure
.
This option has no effect for any other value of TIER_TYPE
.
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.
Required if TIER_TYPE
is gcs
.
This option has no effect for any other value of TIER_TYPE
.
Optional
The prefix path for the specified --bucket
to which MinIO transitions objects.
Omit this field to transition objects into the bucket root.
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 TIER_TYPE
is
s3
. This option has no effect for any other value of TIER_TYPE
.
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:
mc admin tier edit TARGET TIER_NAME [FLAGS]
The command accepts the following arguments:
Required
The alias
of a configured MinIO deployment.
Required
The name of the remote tier the command modifies. The value
corresponds to the mc admin tier add TIER_NAME
specified
when creating the remote tier.
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
TIER_TYPE
is s3
.
This option has no effect for any other TIER_TYPE
.
Optional
The secret key for a user on the remote S3 tier.
This option only applies to remote storage tiers with
TIER_TYPE
is s3
.
This option has no effect for any other TIER_TYPE
.
Required
The account key for a user on the remote Azure tier.
Use this option to rotate the credentials for the
--account-name
associated to the remote tier.
This option only applies to remote storage tiers with
TIER_TYPE
is azure
.
This option has no effect for any other TIER_TYPE
.
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
TIER_TYPE
is gcs
.
This option has no effect for any other TIER_TYPE
.
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:
mc admin tier ls TARGET [FLAGS]
The command accepts the following arguments:
Required
The alias
of a configured MinIO deployment.
This work is licensed under a Creative Commons Attribution 4.0 International License.
©2020-Present, MinIO, Inc.