Documentation

Documentation

mc replicate resync

Syntax

The mc replicate resync command resynchronizes all objects in the specified MinIO bucket to a remote replication target.

This command requires first configuring the remote bucket target using the mc admin bucket remote add command. You must specify the resulting remote ARN as part of running mc replicate resync.

This command supports rebuilding a MinIO deployment using an active-active replication remote as the “backup” source. See the following tutorials for more information on active-active replication:

The following command resynchronizes the content of the mydata bucket on the myminio MinIO deployment to the remote MinIO deployment associated to the specified --remote-bucket:

mc replicate resync start \
   --remote-bucket "arn:minio:replication::d3c086c7-1d64-40c2-954b-fe8222907033:mydata" \
   myminio/mydata

The command has the following syntax:

mc [GLOBALFLAGS] replicate resync start|status  \
                 --remote-bucket "string"       \
                 [--older-than "string"]        \
                 ALIAS
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters seperated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS
Required

The alias of the MinIO deployment and full path to the bucket or bucket prefix which MinIO uses as the replication source. For example, the following command starts replication using the data bucket on the MinIO deployment associated to the primary alias.

mc replicate resync start primary/data --remote-bucket "ARN"
start
Required

Starts the resynchronization procedure using the specified bucket as the source and the --remote-bucket as the remote target.

Mutually exclusive with mc replicate resync status.

status
Required

Returns the status of resynchronization on the specified bucket to all remote targets.

Include the --remote-bucket argument to filter the status output to only the specified remote target.

--remote-bucket
Required

Specify the ARN for the destination deployment and bucket. You can retrieve the ARN using mc admin bucket remote:

older-than
Optional

Specify a duration in days where MinIO only resynchronizes objects older than the specified duration.

Only valid with mc replicate resync start.

Global Flags

This command supports any of the global flags.

Examples

Resynchronize Remote Replication Target from Source Bucket

The following mc replicate resync command resynchronizes all objects on the specified source bucket to the remote target regardless of their replication status:

mc replicate resync start --remote-bucket "arn:minio:replication::UUID:data" primary/data
  • Replace primary/data with the ALIAS and full bucket path for which to create the replication configuration.

  • Replace the --remote-bucket value with the ARN of the remote target. Use mc admin bucket remote ls to list all configured remote replication targets.

Behavior

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested MinIO and AWS S3 for expected functionality and behavior.

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