mirror of
https://github.com/minio/docs.git
synced 2025-07-30 07:03:26 +03:00
Creating site replication documentation.
Adding replication overview and site replication overview docs. Distinguising between bucket replication and site replication. Adds mc admin replicate docs. Including tutorials for how to do site replication.
This commit is contained in:
Daryl White
@ -90,6 +90,11 @@ The following table lists :mc-cmd:`mc admin` commands:
|
||||
:start-after: start-mc-admin-prometheus-desc
|
||||
:end-before: end-mc-admin-prometheus-desc
|
||||
|
||||
* - :mc:`mc admin replicate`
|
||||
- .. include:: /reference/minio-mc-admin/mc-admin-replicate.rst
|
||||
:start-after: start-mc-admin-replicate-desc
|
||||
:end-before: end-mc-admin-replicate-desc
|
||||
|
||||
* - :mc:`mc admin service`
|
||||
- .. include:: /reference/minio-mc-admin/mc-admin-service.rst
|
||||
:start-after: start-mc-admin-service-desc
|
||||
|
||||
372
source/reference/minio-mc-admin/mc-admin-replicate.rst
Normal file
372
source/reference/minio-mc-admin/mc-admin-replicate.rst
Normal file
@ -0,0 +1,372 @@
|
||||
.. _minio-mc-admin-replicate:
|
||||
|
||||
======================
|
||||
``mc admin replicate``
|
||||
======================
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
.. contents:: Table of Contents
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. mc:: mc admin replicate
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
.. start-mc-admin-replicate-desc
|
||||
|
||||
The :mc:`mc admin replicate` command creates and manages :ref:`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.
|
||||
|
||||
.. end-mc-admin-replicate-desc
|
||||
|
||||
Where :ref:`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:`mc admin replicate` only supports site replication for :ref:`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 :ref:`bucket versioning <minio-bucket-versioning>` on all buckets, including existing buckets and any buckets added after initiating site replication.
|
||||
|
||||
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
||||
:class: note
|
||||
|
||||
.. include:: /includes/facts-mc-admin.rst
|
||||
:start-after: start-minio-only
|
||||
:end-before: end-minio-only
|
||||
|
||||
|
||||
The :mc:`mc admin replicate` command has the following subcommands:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:widths: 40 60
|
||||
|
||||
* - Subcommand
|
||||
- Description
|
||||
|
||||
* - :mc-cmd:`mc admin replicate add`
|
||||
- Create a new site replication configuration or expand an existing configuration.
|
||||
|
||||
* - :mc-cmd:`mc admin replicate edit`
|
||||
- Edits the endpoint of the specified peer site in the site replication configuration.
|
||||
|
||||
* - :mc-cmd:`mc admin replicate info`
|
||||
- Returns information about site replication configuration.
|
||||
|
||||
* - :mc-cmd:`mc admin replicate remove`
|
||||
- Removes an entire site replication configuration or one or more peer sites from participating in site replication.
|
||||
|
||||
* - :mc-cmd:`mc admin replicate status`
|
||||
- Displays the status for :ref:`replicable data <minio-site-replication-what-replicates>` across participating sites.
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
||||
.. mc-cmd:: add
|
||||
:fullpath:
|
||||
|
||||
Create or expand a site replication configuration.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: EXAMPLES
|
||||
|
||||
Consider a multi-site MinIO topology with three separate MinIO deployments using the following :ref:`aliases <alias>`: ``minio1``, ``minio2``, and ``minio3``.
|
||||
All three sites have complete bidirectional network access and low latency between sites.
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc admin replicate add minio1 minio2 minio3
|
||||
|
||||
The following command explands an existing site replication that includes peer site ``minio1`` to an additional peer site, ``minio5``.
|
||||
``minio5`` contains no data.
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc admin replicate add minio1 minio5
|
||||
|
||||
.. tab-item:: SYNTAX
|
||||
|
||||
The command has the following syntax:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc [GLOBALFLAGS] admin replicate add \
|
||||
ALIAS1 \
|
||||
ALIAS2 \
|
||||
[ALIAS3 ...]
|
||||
|
||||
.. mc-cmd:: ALIAS
|
||||
:required:
|
||||
|
||||
The :ref:`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 :ref:`alias <alias>` must be a peer site in the site replication set to expand.
|
||||
Then include one or more additional :ref:`aliases <alias>` to add to the existing site replication.
|
||||
The deployments to add must be empty.
|
||||
|
||||
|
||||
.. mc-cmd:: edit
|
||||
:fullpath:
|
||||
|
||||
Modifies the endpoint used for an existing peer site participating in site replication.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: EXAMPLE
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc admin replicate edit \
|
||||
minio2 \
|
||||
--deployment-id c1758167-4426-454f-9aae-5c3dfdf6df64 \
|
||||
--endpoint https://minio2:9000
|
||||
|
||||
.. tab-item:: SYNTAX
|
||||
|
||||
The command has the following syntax:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mc [GLOBALFLAGS] admin replicate edit \
|
||||
ALIAS \
|
||||
--deployment-id [deploymentID] \
|
||||
--endpoint [newEndpoint]
|
||||
|
||||
.. mc-cmd:: ALIAS
|
||||
:required:
|
||||
|
||||
The :ref:`alias <alias>` of the MinIO deployment.
|
||||
|
||||
.. mc-cmd:: --deployment-id
|
||||
:required:
|
||||
|
||||
The unique id of the deployment to change.
|
||||
|
||||
The deployment ID can be found by running :mc-cmd:`mc admin replicate info ALIAS`
|
||||
|
||||
.. mc-cmd:: --endpoint
|
||||
:required:
|
||||
|
||||
The new endpoint or URL to associate with the peer site.
|
||||
|
||||
.. mc-cmd:: remove
|
||||
:fullpath:
|
||||
|
||||
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 :ref:`replicable data <minio-site-replication-what-replicates>`.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: 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.
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc admin replicate remove \
|
||||
minio2 \
|
||||
--all \
|
||||
--force
|
||||
|
||||
Remove the sites with alias names ``minio5`` and ``minio6`` from an existing site replication configuration that includes `minio2`
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc admin replicate remove \
|
||||
minio2 \
|
||||
minio5 \
|
||||
minio6 \
|
||||
--force \
|
||||
|
||||
.. tab-item:: SYNTAX
|
||||
|
||||
The command has the following syntax:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mc [GLOBALFLAGS] admin remove \
|
||||
TARGET \
|
||||
ALIAS1 \
|
||||
[ALIAS2...] \
|
||||
--all \
|
||||
--force
|
||||
|
||||
.. mc-cmd:: TARGET
|
||||
:required:
|
||||
|
||||
The :ref:`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.
|
||||
|
||||
.. mc-cmd:: ALIAS
|
||||
:optional:
|
||||
|
||||
The :ref:`alias <alias>` of an active MinIO deployment to remove from a site replication configuration.
|
||||
May be repeated to remove additional sites.
|
||||
|
||||
.. mc-cmd:: --all
|
||||
:optional:
|
||||
|
||||
Include this flag to remove all sites configured for site replication and end the site replication configuration.
|
||||
|
||||
.. mc-cmd:: --force
|
||||
:required:
|
||||
|
||||
This flag forces the removal of the specified peer site(s) from the site replication configuration.
|
||||
|
||||
|
||||
.. mc-cmd:: info
|
||||
:fullpath:
|
||||
|
||||
Returns information about the sites in the site replication configuration.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: EXAMPLE
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc admin replicate info minio1
|
||||
|
||||
.. tab-item:: SYNTAX
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mc [GLOBALFLAGS] admin replicate info ALIAS
|
||||
|
||||
.. mc-cmd:: ALIAS
|
||||
:required:
|
||||
|
||||
The :ref:`alias <alias>` of an active MinIO deployment in the site replication configuration.
|
||||
|
||||
|
||||
.. mc-cmd:: status
|
||||
:fullpath:
|
||||
|
||||
Displays the status of the sites, buckets, users, groups, or policies for a site replication configuration.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: EXAMPLES
|
||||
|
||||
Display the overall replication status for a site replication configuration that includes the site ``minio1``.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mc admin replicate status minio1
|
||||
|
||||
Display the replication status of buckets across sites for a site replication configuration that includes the site ``minio1``.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
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``.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mc admin replicate status \
|
||||
minio1 \
|
||||
--bucket images
|
||||
|
||||
Display the site repliction status for the setting for a user, ``janedoe``, across sites for a site replication configuration that contains the site ``minio1``.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mc admin replicate status \
|
||||
minio1 \
|
||||
--user janedoe
|
||||
|
||||
.. tab-item:: SYNTAX
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mc [GLOBALFLAGS] admin replicate status \
|
||||
TARGET \
|
||||
[--all] \
|
||||
[--buckets] \
|
||||
[--bucket nameOfBucket] \
|
||||
[--groups] \
|
||||
[--group nameOfGroup] \
|
||||
[--policies] \
|
||||
[--policy nameOfPolicy] \
|
||||
[--users] \
|
||||
[--user accessKey]
|
||||
|
||||
.. mc-cmd:: TARGET
|
||||
:required:
|
||||
|
||||
The :ref:`alias <alias>` of an active MinIO deployment in the site replication configuration.
|
||||
|
||||
.. mc-cmd:: --all
|
||||
:optional:
|
||||
|
||||
Display all available site replication status information.
|
||||
|
||||
.. mc-cmd:: --buckets
|
||||
:optional:
|
||||
|
||||
Display the replication status of all buckets.
|
||||
|
||||
.. mc-cmd:: --bucket
|
||||
:optional:
|
||||
|
||||
Display the replciation status of a specific buckt by inlcuding the bucket name after the flag.
|
||||
|
||||
.. mc-cmd:: --groups
|
||||
:optional:
|
||||
|
||||
Display the replication status of all groups.
|
||||
|
||||
.. mc-cmd:: --group
|
||||
:optional:
|
||||
|
||||
Display the replication status of a specific group by including the group name after the flag.
|
||||
|
||||
.. mc-cmd:: --policies
|
||||
:optional:
|
||||
|
||||
Display the replication status of all policies.
|
||||
|
||||
.. mc-cmd:: --policy
|
||||
:optional:
|
||||
|
||||
Display the replication status of a specific policy by including the policy name after the flag.
|
||||
|
||||
.. mc-cmd:: --users
|
||||
:optional:
|
||||
|
||||
Display the replication status of all users.
|
||||
|
||||
.. mc-cmd:: --user
|
||||
:optional:
|
||||
|
||||
Display the replication status of a specific user by including the user name after the flag.
|
||||
|
||||
|
||||
Global Flags
|
||||
------------
|
||||
|
||||
.. include:: /includes/common-minio-mc.rst
|
||||
:start-after: start-minio-mc-globals
|
||||
:end-before: end-minio-mc-globals
|
||||
@ -1,3 +1,5 @@
|
||||
.. _minio-mc-admin-user-svcacct:
|
||||
|
||||
=========================
|
||||
``mc admin user svcacct``
|
||||
=========================
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
.. _minio-mc-admin-config:
|
||||
|
||||
===================
|
||||
``mc admin config``
|
||||
===================
|
||||
|
||||
Reference in New Issue
Block a user