docs/source/reference/minio-mc-admin/mc-admin-replicate.rst

mc admin replicate

minio

Table of Contents

mc admin replicate

RELEASE.2023-01-11T03-14-16Z

• mc admin replicate edit renamed to mc admin replicate update
• mc admin replicate remove renamed to mc admin replicate rm

Description

The mc admin replicate command creates and manages site replication <minio-site-replication-overview> for a set of MinIO peer sites.

Site replication mimics an active-active bucket replication, but for multiple MinIO deployments. Wherever a change occurs to IAM settings, buckets, or objects across the set of sites, the change replicates across all sites in the site replication group.

Where bucket replication <minio-bucket-replication> manages the mirroring of particular buckets or objects from one location to another within a deployment or across deployments, site replication continuously mirrors an entire MinIO site to other sites.

mc admin replicate only supports site replication for distributed deployments <deploy-minio-distributed> when configuring site replication.

Only one deployment can have any data when initiating a new site replication configuration.

Site replication enforces bucket versioning <minio-bucket-versioning> on all buckets, including existing buckets and any buckets added after initiating site replication. Site replication fully synchronizes versioned objects, compared to mc mirror which operates only on the latest version of an object

Use mc admin on MinIO Deployments Only

The mc admin replicate command has the following subcommands:

Subcommand	Description
mc admin replicate add	Create a new site replication configuration or expand an existing configuration.
mc admin replicate info	Returns information about site replication configuration.
mc admin replicate resync	Resynchronizes content from one site to a second site if the second site has lost data.
mc admin replicate rm	Removes an entire site replication configuration or one or more peer sites from participating in site replication.
mc admin replicate status	Displays the status for replicable data <minio-site-replication-what-replicates> across participating sites.
mc admin replicate update	Modify the endpoint of the specified peer site in the site replication configuration.

Syntax

add

Create or expand a site replication configuration. The configuration uses asynchronous site replication by default, as MinIO recommends.

If your circumstances require synchronous site replication, complete the configuration, then use mc admin replicate update --sync.

EXAMPLES

Consider a multi-site MinIO topology with three separate MinIO deployments using the following aliases <alias>: minio1, minio2, and minio3. All three sites have complete bidirectional network access and low latency between sites.

mc admin replicate add minio1 minio2 minio3

The following command expands an existing site replication that includes peer site minio1 to an additional peer site, minio5. minio5 contains no data.

mc admin replicate add minio1 minio5

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin replicate add      \
                            ALIAS1        \
                            ALIAS2        \
                            [ALIAS3 ...]

ALIAS

The alias <alias> of a MinIO deployment to include in site replication.

At least two MinIO deployment aliases are required to create a site replication. Only the first alias can have buckets or objects. The first site can also be empty.

To expand an existing site replication to one more new replication sites, the first alias <alias> must be a peer site in the site replication set to expand. Then include one or more additional aliases <alias> to add to the existing site replication. The deployments to add must be empty.

update

Modifies the endpoint used for an existing peer site participating in site replication.

RELEASE.2023-01-11T03-14-16Z

mc admin replicate edit renamed to mc admin replicate update.

EXAMPLE

mc admin replicate update                                                   \
                   minio2                                                 \
                   --deployment-id c1758167-4426-454f-9aae-5c3dfdf6df64   \
                   --endpoint https://minio2:9000

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin replicate update                     \
                            ALIAS                           \
                            --deployment-id [deploymentID]  \
                            --endpoint [newEndpoint]        \
                            --sync ["enable" | "disable"]

ALIAS

The alias <alias> of the MinIO deployment.

--deployment-id

The unique id of the deployment to change.

The deployment ID can be found by running mc admin replicate info ALIAS

--endpoint

The new endpoint or URL to associate with the peer site.

--sync

Enable or disable synchronous site replication. Available values are enable and disable. If not defined, MInIO uses asynchronous site replication.

rm, remove

RELEASE.2023-01-11T03-14-16Z

The mc admin replicate remove subcommand renamed to mc admin replicate rm.

Removes one or more sites from a site replication configuration.

Remember, if you intend to re-add the site to a site replication configuration in the future, it must be empty of replicable data <minio-site-replication-what-replicates>.

EXAMPLES

Remove site replication for all connected sites for an existing site replication configuration that includes minio2. This deletes the site replication configuration for all participating sites.

mc admin replicate rm      \
                   minio2  \
                   --all   \
                   --force

Remove the sites with alias names minio5 and minio6 from an existing site replication configuration that includes minio2

mc admin replicate rm      \
                   minio2  \
                   minio5  \
                   minio6  \
                   --force

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin rm          \
                       TARGET      \
                       ALIAS1      \
                       [ALIAS2...] \
                       --all       \
                       --force

TARGET

The alias <alias> of an active MinIO deployment participating in the site replication to target. Do not use an alias of a deployment to be removed, unless removing all sites from site replication.

ALIAS

The alias <alias> of an active MinIO deployment to remove from a site replication configuration. May be repeated to remove additional sites.

--all

Include this flag to remove all sites configured for site replication and end the site replication configuration.

--force

This flag forces the removal of the specified peer site(s) from the site replication configuration.

info

Returns information about the sites in the site replication configuration.

EXAMPLE

mc admin replicate info minio1

SYNTAX

mc [GLOBALFLAGS] admin replicate info ALIAS

ALIAS

The alias <alias> of an active MinIO deployment in the site replication configuration.

status

Displays the status of the sites, buckets, users, groups, or policies for a site replication configuration.

EXAMPLES

Display the overall replication status for a site replication configuration that includes the site minio1.

mc admin replicate status minio1

Display the replication status of buckets across sites for a site replication configuration that includes the site minio1.

mc admin replicate status     \
                   minio1     \
                   --buckets

Display the site replication status of a bucket called images across sites for a site replication configuration that contains the site minio1.

mc admin replicate status           \
                    minio1          \
                    --bucket images

Display the site replication status for the setting for a user, janedoe, across sites for a site replication configuration that contains the site minio1.

mc admin replicate status         \
                   minio1         \
                   --user janedoe

SYNTAX

mc [GLOBALFLAGS] admin replicate status     \
                   TARGET                   \
                   [--all]                  \
                   [--buckets]              \
                   [--bucket nameOfBucket]  \
                   [--groups]               \
                   [--group nameOfGroup]    \
                   [--policies]             \
                   [--policy nameOfPolicy]  \
                   [--users]                \
                   [--user accessKey]

TARGET

The alias <alias> of an active MinIO deployment in the site replication configuration.

--all

Display all available site replication status information.

--buckets

Display the replication status of all buckets.

--bucket

Display the replication status of a specific bucket by including the bucket name after the flag.

--groups

Display the replication status of all groups.

--group

Display the replication status of a specific group by including the group name after the flag.

--policies

Display the replication status of all policies.

--policy

Display the replication status of a specific policy by including the policy name after the flag.

--users

Display the replication status of all users.

--user

Display the replication status of a specific user by including the user name after the flag.

resync

Resynchronizes data from one site in the replication configuration to a second site in the replication configuration in the event of lost data.

EXAMPLES

The following command starts a resynchronization process to restore minio2 from minio1

mc admin replicate resync start minio1 minio2

The following command shows the status of a resynchronization currently in progress.

mc admin replicate resync status minio1 minio2

The following command stops a resynchronization that is in progress.

mc admin replicate resync cancel minio1 minio2

SYNTAX

mc [GLOBALFLAGS] admin replicate resync start|status|cancel ALIAS1 ALIAS2   

• Replace ALIAS1 with the alias for the site that has the data to restore.
• Replace ALIAS2 with the alias for the site that needs resynched data.

start

Launches a new resynchronization process from one site with data to a second site that needs synchronization.

status

Shows the status of an existing resynchronization process between two sites configured for site replication.

cancel

Ends a resynchronization process currently in progress between two sites configured for site replication.

alias1

The alias <alias> of an active MinIO deployment in the site replication configuration with the data you want to resync to another site.

alias2

The alias <alias> of an active MinIO deployment in the site replication configuration that needs data resynced from another site.

Global Flags