Reference on SILO

mc ilm add

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm add replaced by mc ilm rule add.

Syntax

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 --expire-days 90 --noncurrent-expire-days 30 myminio/mydata

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

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

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

The configured rules have the following effect:

mc quota clear

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-13T00-23-28Z

mc quota clear replaced mc admin bucket quota --clear.

Changed: RELEASE.2024-07-31T15-58-33Z

mc quota clear is deprecated.

Description

The mc quota clear command removes a configured storage quota for a bucket.

Examples

Clear Configured Bucket Quota

Use mc quota clear flag to remove the quota from a bucket.

mc quota clear TARGET/BUCKET

Replace TARGET with the alias of a configured MinIO deployment. Replace BUCKET with the name of the bucket on which to clear the quota.

Syntax

mc quota clear has the following syntax:

MinIO Custom Resource Definition

Mon, 01 Jan 0001 00:00:00 +0000

The MinIO Operator installs a Custom Resource Definition (CRD) that describes a MinIO Tenant object. The Operator uses this CRD for provisioning and managing Tenant resources within a Kubernetes cluster.

This page documents the CRD reference for use in customizing Operator-deployed Tenants. This documentation assumes familiarity with all referenced Kubernetes concepts, utilities, and procedures.

Operator CRD v2 Reference

Package v2 - This page provides a quick automatically generated reference for the MinIO Operator Operator CRD v2 Reference CRD. For more complete documentation on the MinIO Operator CRD, see MinIO Kubernetes Documentation.

mc ilm edit

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm edit replaced by mc ilm rule edit.

Syntax

The mc ilm edit command modifies an existing object lifecycle management rule on a MinIO bucket.

The following command modifies existing lifecycle management rules for the mydata bucket on the myminio deployment:

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:

mc quota info

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-13T00-23-28Z

mc quota info replaced mc admin bucket quota.

Changed: RELEASE.2024-07-31T15-58-33Z

mc quota info is deprecated.

Description

The mc quota info command displays the currently configured quota for a bucket.

Examples

Retrieve Bucket Quota Configuration

Use mc quota info to retrieve the current quota configuration for a bucket:

mc quota info TARGET/BUCKET

Replace TARGET with the alias of a configured MinIO deployment. Replace BUCKET with the name of the bucket on which to retrieve the quota.

MinIO Operator Environment Variables

Mon, 01 Jan 0001 00:00:00 +0000

The MinIO Operator uses the following environment variables during startup to set configuration settings. Configure these variables in the minio-operator container.

Setting Environment Variables in Kubernetes

To set these environment variables, modify the operator container’s yaml at .spec.env or use the following kubectl command syntax:

kubectl set env -n minio-operator deployment/minio-operator <ENV_VARIABLE>=<value> ... <ENV_VARIABLE2>=<value2>

Replace:

minio-operator with the namespace for your Operator, if not using the default value.
deployment/minio-operator with the deployment for your Operator, if not the default value. (Most deployments use the default value.)
<ENV_VARIABLE> with the environment variable to set or modify.
<value> with the value to use for the environment variable.

You can set or modify multiple environment variables by separating each VARIABLE=value pair with a space.

mc ilm export

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm export replaced by mc ilm rule export.

Syntax

The mc ilm export command exports the object lifecycle management configuration for a MinIO bucket.

The mc ilm export command outputs to STDOUT by default. You can output the contents to a .json file for archival or ingestion using mc ilm import.

The following command exports the lifecycle management configuration of the mydata bucket on the myminio deployment to the mydata-lifecycle-config.json file:

mc quota set

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-13T00-23-28Z

mc quota set replaced mc admin bucket quota --hard.

Changed: RELEASE.2024-07-31T15-58-33Z

mc quota set is deprecated.

Description

The mc quota set assigns a hard quota limit to a bucket beyond which MinIO does not allow writes.

Units of Measurement

The mc quota set --size flag accepts the following case-insensitive suffixes to represent the unit of the specified size value:

Suffix	Unit Size
`k`	KB (Kilobyte, 1000 Bytes)
`m`	MB (Megabyte, 1000 Kilobytes)
`g`	GB (Gigabyte, 1000 Megabytes)
`t`	TB (Terabyte, 1000 Gigabytes)
`ki` or `kib`	KiB (Kibibyte, 1024 Bites)
`mi` or `mib`	MiB (Mebibyte, 1024 Kibibytes)
`gi` or `gib`	GiB (Gibibyte, 1024 Mebibytes)
`ti` or `tib`	TiB (Tebibyte, 1024 Gibibytes)

Omitting a suffix defaults to bytes.

Operator Helm Charts

Mon, 01 Jan 0001 00:00:00 +0000

MinIO publishes Helm Charts for the Helm Operator Charts and Helm Tenant Charts. You can use these charts to deploy the MinIO Operator and managed Tenants through Helm.

The following page documents the values.yaml chart for the MinIO Operator. For documentation on the chart for a MinIO Tenant, see Tenant Helm Charts

MinIO Operator Chart

operator

mc ilm import

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm import replaced by mc ilm rule import.

Syntax

The mc ilm import command imports an object lifecycle management configuration and applies it to a MinIO bucket.

The mc ilm import command imports from STDIN by default. You can input the contents from a .json file, such as one produced by mc ilm export.

The following command imports the lifecycle management configuration from mydata-lifecycle-config.json and applies it to the mydata bucket on the myminio deployment:

Tenant Helm Charts

Mon, 01 Jan 0001 00:00:00 +0000

MinIO publishes Helm Charts for the Helm Operator Charts and Helm Tenant Charts. You can use these charts to deploy the MinIO Operator and managed Tenants through Helm.

The following page documents the values.yaml chart for a MinIO Tenant. For documentation on the chart for a MinIO Operator, see Operator Helm Charts

MinIO Tenant Chart

tenant

mc ilm ls

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm ls replaced by mc ilm rule ls.

Syntax

The mc ilm ls command summrizes all configured object lifecycle management rules on a MinIO bucket in a tabular format.

The output of the command might resemble the following:

┌───────────────────────────────────────────────────────────────────────────────┐
│ 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 │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴───────────────┘

The following command lists all lifecycle management rules for the mydata bucket on the myminio MinIO deployment:

mc ilm rm

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm rm replaced by mc ilm rule rm.

Syntax

The mc ilm rm command removes an object lifecycle management rule from a MinIO Bucket.

The mc ilm remove command has equivalent functionality to mc ilm rm.

The following command removes a single lifecycle management rule from the mydata bucket on the myminio MinIO deployment:

mc admin bucket quota

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-13T00-23-28Z

mc admin bucket quota replaced by:

Description

The mc admin bucket quota command manages per-bucket storage quotas.

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.

Units of Measurement

The mc admin bucket quota --hard flag accepts the following case-insensitive suffixes to represent the unit of the specified size value:

mc admin bucket remote

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc admin bucket remote add replaced by mc replicate add
mc admin bucket remote update replaced by mc replicate update
mc admin bucket remote rm replaced by mc replicate rm
mc admin bucket remote ls replaced by mc replicate ls

Changed: RELEASE.2023-02-16T19-20-11Z

mc admin bucket remote bandwidth replaced by mc replicate status

Replication related statistics are moving to the mc replicate status command.

Description

The mc admin bucket remote command manages the ARN resources for use with bucket replication.

mc admin console

Mon, 01 Jan 0001 00:00:00 +0000

Important

This command has been replaced by mc admin logs in mc RELEASE.2022-12-02T23-48-47Z.

The command was previously replaced by mc support logs show in mc RELEASE.2022-06-26T18-51-48Z.

Description

The mc admin console command returns server log entries for each MinIO server in the deployment.

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.

Syntax

mc admin console has the following syntax:

mc admin idp ldap

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2023-05-26T23-31-54Z

mc admin idp ldap and its subcommands replaced by mc idp ldap.

Description

The mc admin idp ldap commands allow you to add, modify, review, list, remove, enable, and disable server configurations to 3rd party Active Directory or LDAP Identity and Access Management (IAM) integrations.

Define configuration settings as an alternative to using environment variables when setting up an AD/LDAP connection.

Note

Configuration settings do not override settings configured as environment variables.

mc admin idp ldap policy

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2023-05-26T23-31-54Z

mc admin idp ldap policy and its subcommands replaced by mc idp ldap policy.

Description

The mc admin idp ldap policy command allows you to view the mapping relationships between policies and the associated groups or users.

The mc admin idp ldap policy command has the following subcommands:

Subcommand	Description
`mc admin idp ldap policy attach`	Attach a policy to an entity
`mc admin idp ldap policy detach`	Detach a policy from an entity
`mc admin idp ldap policy entities`	List policy entity mappings

Syntax

`attach`

mc-cmd

mc admin idp openid

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2023-05-26T23-31-54Z

mc admin idp openid and its subcommands replaced by mc idp openid.

Description

The mc admin idp openid commands allow you to add, modify, review, list, remove, enable, and disable server configurations to 3rd party OpenID Identity and Access Management (IAM) integrations.

Define configuration settings as an alternative to using environment variables when setting up an OpenID connection.

The mc admin idp openid command has the following subcommands:

Subcommand	Description
`mc admin idp openid add`	Create an OpenID IDP server configuration.
`mc admin idp openid update`	Modify an existing OpenID IDP server configuration.
`mc admin idp openid rm`	Remove an OpenID IDP server configuration from a deployment.
`mc admin idp openid ls`	Outputs a list of the existing OpenID server configurations for a deployment.
`mc admin idp openid info`	Displays details for a specific OpenID server configuration.
`mc admin idp openid enable`	Enables an OpenID server configuration.
`mc admin idp openid disable`	Disables an OpenID server configuration.

Configuration Parameters

The mc admin idp openid subcommands support configuration parameters. The parameters define the server’s interaction with the IAM provider.

mc admin profile

Mon, 01 Jan 0001 00:00:00 +0000

Note

This command has been replaced by mc support profile as of mc RELEASE.2023-04-06T16-51-10Z.

Description

The mc admin profile command generates profiling data for debugging purposes.

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.

Profile Data Format

mc admin profile produces a ZIP archive profile.zip that contains one or more .pprof files. Use the pprof go utility to read the profile data.

mc admin speedtest

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-07-24T02-25-13Z

mc admin speedtest replaced by mc support perf.

Description

The mc admin speedtest command tests throughputs per host with PUT and GET operations.

speedtest is available starting with mc RELEASE.2021-09-02T09-21-27Z and supports distributed MinIO deployments running RELEASE.2021-07-30T00-02-00Z or later.

speedtest does not support standalone or MinIO Gateway deployments.

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

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc admin tier replaced by mc ilm tier.

Description

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.

Supported S3 Services

mc admin tier supports only the following S3-compatible services as a remote target for object tiering:

mc admin top

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-08-11T00-30-48Z

mc admin top replaced by mc support top.

Description

The mc admin top command returns statistics for distributed MinIO deployments, similar to the output of the top command.

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.

Syntax

`mc admin top locks`

mc-cmd

Returns the 10 oldest locks on the MinIO deployment.

S3 API Compatibility

Mon, 01 Jan 0001 00:00:00 +0000

This page documents S3 APIs supported by MinIO Object Storage. For reference documentation on any given API, see the corresponding documentation for Amazon S3.

Important

MinIO strongly recommends using an S3-Compatible SDK for performing object storage operations.

Object APIs

Object Locking

Unsupported API Object Endpoints

GetObjectAcl
PutObjectAcl

Multipart Uploads

Differences from S3 APIs for Multipart Uploads

ListMultipartUploads requires the exact object name as a prefix.
The AbortIncompleteMultipartUpload lifecycle action is not supported with PutBucketLifecycle.

Bucket APIs

Bucket Replication

Bucket Lifecycle

Bucket Notifications

Bucket Policies

Unsupported API Bucket Operations

GetBucketInventoryConfiguration
PutBucketInventoryConfiguration
DeleteBucketInventoryConfiguration
PutBucketCors
DeleteBucketCors
GetBucketMetricsConfiguration
PutBucketMetricsConfiguration
DeleteBucketMetricsConfiguration
PutBucketWebsite
GetBucketLogging
PutBucketLogging
PutBucketAccelerateConfiguration
DeleteBucketAccelerateConfiguration
PutBucketRequestPayment
DeleteBucketRequestPayment
PutBucketAcl
HeadBucketAcl
GetPublicAccessBlock
PutPublicAccessBlock
DeletePublicAccessBlock
GetBucketOwnershipControls
PutBucketOwnershipControls
DeleteBucketOwnershipControls
GetBucketIntelligentTieringConfiguration
PutBucketIntelligentTieringConfiguration
ListBucketIntelligentTieringConfigurations
DeleteBucketIntelligentTieringConfiguration
GetBucketAnalyticsConfiguration
PutBucketAnalyticsConfiguration
ListBucketAnalyticsConfigurations
DeleteBucketAnalyticsConfiguration
CreateSession

MinIO alternatives for unsupported Bucket resources

For calls to BucketACL or ObjectACL operations, use Policies.
Calls to BucketCORS operations are not needed because CORS is enabled by default on all buckets for all HTTP verbs.
For calls to BucketWebsite operations, use caddy or nginx.
For calls to BucketAnalytics, BucketMetrics, or BucketLogging operations, use Bucket Notifications.

kubectl minio init

Mon, 01 Jan 0001 00:00:00 +0000

Description

The kubectl minio init command initialize the MinIO Operator.

If the Kubernetes cluster has an existing MinIO Operator installation, this command upgrades the Operator to match the MinIO plugin version. For more information on upgrading the MinIO Operator, see Upgrade MinIO Operator.

Syntax

The following command initializes a new MinIO Operator deployment running 7.1.1.