Welcome to the upcoming version of the MinIO Documentation! The content on this page is under active development and may change at any time. If you can't find what you're looking for, check our legacy documentation. Thank you for your patience.

mc admin bucket remote

Description

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

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.

Examples

Add a New Replication Target

Use mc admin bucket remote add to create a new replication target ARN for use with mc replicate add:

mc admin bucket remote add SOURCE/BUCKET SOURCE/BUCKET
  • Replace SOURCE with the alias of the MinIO deployment to use as the replication target. Replace BUCKET with the full path of the bucket into which MinIO replicates objects from the DESTINATION.

  • Replace DESTINATION with the alias of the MinIO deployment to use as the replication source. Replace BUCKET with the full path of the bucket from which MinIO replicates objects into the SOURCE.

Remove an Existing Replication Target

Use mc admin bucket remote rm to remove a replication target from a bucket:

mc admin bucket remote rm SOURCE/BUCKET --arn ARN
  • Replace SOURCE with the alias of the MinIO deployment being used as the replication source. Replace BUCKET with the full path of the bucket from which MinIO replicates objects.

  • Replace ARN with the ARN of the remote target.

Removing the target halts all in-progress bucket replication to the target.

Retrieve Configured Replication Targets

Use mc admin bucket remote ls to list a bucket’s configured replication targets:

mc admin bucket remote ls SOURCE/BUCKET
  • Replace SOURCE with the alias of the MinIO deployment being used as the replication source. Replace BUCKET with the full path of the bucket from which MinIO replicates objects.

Syntax

mc admin bucket remote add

Adds a remote target to a bucket on a MinIO deployment. The command has the following syntax:

mc admin bucket add SOURCE DESTINATION --service "replication" [FLAGS]

The command accepts the following arguments:

SOURCE

Required

The full path to the bucket to which the command adds the remote target. Specify the alias of a configured MinIO deployment as the prefix to the bucket path. For example:

mc admin bucket add play/mybucket
DESTINATION

Required

The target MinIO deployment and bucket.

Specify the full URL to the destination MinIO deployment and bucket using the following format:

http(s)://ACCESSKEY:SECRETKEY@DESTHOSTNAME/DESTBUCKET
  • Replace ACCESSKEY with the access key for a user on the

    destination MinIO deployment.

  • Replace SECRETKEY with the secret key for a user on the

    destination MinIO deployment.

  • Replace DESTHOSTNAME with the hostname and port of the MinIO

    deployment (i.e. minio-server.example.net:9000).

  • Replace DESTBUCKET with the bucket on the

    destination.

--service

Required

Specify "replication".

--region

The region of the DESTINATION.

Mutually exclusive with --path

--path

The bucket path lookup supported by the destination server. Specify one of the following:

  • on

  • off

  • auto (Default)

Mutually exclusive with --region

--sync

Enables synchronous replication, where MinIO attempts to replicate the object prior to returning the PUT object response. Synchronous replication may increase the time spent waiting for PUT operations to return successfully.

By default, mc admin bucket remote add operates in asynchronous mode, where MinIO attempts replicating objects after returning the PUT object response.

mc admin bucket remote ls

Lists all remote targets associated to a bucket on the MinIO deployment. The command has the following syntax:

mc admin bucket ls SOURCE --service "replication"

The command accepts the following arguments:

SOURCE

The full path to the bucket for which the command returns the configured remote targets. Specify the alias of a configured MinIO deployment as the prefix to the bucket path. For example:

mc admin bucket ls play/mybucket
--service

Required

Specify "replication".

mc admin bucket remote rm

Removes a remote target for a bucket on the MinIO deployment. The command has the following syntax:

mc admin bucket rm SOURCE --arn ARN

The command accepts the following arguments:

SOURCE

Required

The full path to the bucket from which the command removes the remote target. Specify the alias of a configured MinIO deployment as the prefix to the bucket path. For example:

mc admin bucket remove play/mybucket
--ARN

Required

The ARN of the remote target for which the command removes from the target bucket. Use mc admin bucket remote ls to list all remote targets and their associated ARNs for a specific bucket.