mc admin bucket remote
Table of Contents
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.
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
.
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.
Use mc admin bucket remote ls
to list a bucket’s configured
replication targets:
mc admin bucket remote ls SOURCE/BUCKET
Adds a remote target to a bucket on a MinIO deployment. The command has the following syntax:
mc admin bucket remote add SOURCE DESTINATION --service "replication" [FLAGS]
The command accepts the following arguments:
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 remote add play/mybucket
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
ACCESSKEY
with the access key for a user on thedestination MinIO deployment.
SECRETKEY
with the secret key for a user on thedestination MinIO deployment.
DESTHOSTNAME
with the hostname and port of the MinIOdeployment (i.e. minio-server.example.net:9000
).
DESTBUCKET
with the bucket on thedestination.
The region of the DESTINATION
.
Mutually exclusive with add
The bucket path lookup supported by the destination server. Specify one of the following:
on
off
auto
(Default)
Mutually exclusive with
add
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.
Lists all remote targets associated to a bucket on the MinIO deployment. The command has the following syntax:
mc admin bucket remote ls SOURCE --service "replication"
The command accepts the following arguments:
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 remote ls play/mybucket
Removes a remote target for a bucket on the MinIO deployment. The command has the following syntax:
mc admin bucket remote rm SOURCE --arn ARN
The command accepts the following arguments:
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 remote rm play/mybucket
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.
This work is licensed under a Creative Commons Attribution 4.0 International License.
©2020-Present, MinIO, Inc.