minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Code Activity

DOCS-380: Refactor CLI reference

Browse Source
This commit is contained in:
ravindk89
2021-12-16 14:19:49 -05:00
committed by Ravind Kumar
parent 0d3be1d74f
commit ef30821063
127 changed files with 10929 additions and 6960 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
source/replication/enable-server-side-multi-site-bucket-replication.rst
View File

@ -78,19 +78,19 @@ Replication Requires Versioning
MinIO relies on the immutability protections provided by versioning to
synchronize objects as part of replication.
Use the :mc-cmd:`mc version enable` command to enable versioning for the bucket
Use the :mc-cmd:`mc version suspend` command to enable versioning for the bucket
across *all* MinIO deployments participating in the multi-site replication
configuration.
.. code-block:: shell
:class: copyable
mc version enable ALIAS/PATH
mc version ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc version enable TARGET>` with the
- Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the
:mc:`alias <mc alias>` of the MinIO deployment.
- Replace :mc-cmd:`PATH <mc version enable TARGET>` with the bucket on which
- Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which
to enable versioning.
Install and Configure ``mc`` with Access to Both Clusters.

23
source/replication/enable-server-side-one-way-bucket-replication.rst
View File

@ -60,18 +60,18 @@ Enable Versioning on Source and Destination Buckets
MinIO relies on the immutability protections provided by versioning to
synchronize objects between the source and replication target.
Use the :mc-cmd:`mc version enable` command to enable versioning on
Use the :mc-cmd:`mc version suspend` command to enable versioning on
*both* the source and destination bucket before starting this procedure:
.. code-block:: shell
:class: copyable
mc version enable ALIAS/PATH
mc version ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc version enable TARGET>` with the
- Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the
:mc:`alias <mc alias>` of the MinIO cluster.
- Replace :mc-cmd:`PATH <mc version enable TARGET>` with the bucket on which
- Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which
to enable versioning.
Install and Configure ``mc`` with Access to Both Clusters.
@ -359,22 +359,17 @@ replication rule to the source MinIO cluster.
:class: copyable
mc replicate add AlphaReplication/SOURCEBUCKET \
--remote-bucket DESTINATIONBUCKET \
--arn 'arn:minio:replication::<UUID>:DESTINATIONBUCKET' \
--remote-bucket 'arn:minio:replication::<UUID>:DESTINATIONBUCKET' \
--replicate "delete,delete-marker,existing-objects"
- Replace ``SOURCEBUCKET`` with the name of the bucket from which Alpha
replicates data. The name *must* match the bucket specified when
creating the remote target in the previous step.
- Replace the ``DESTINATIONBUCKET`` with the name of the ``Baker`` bucket to
which Alpha replicates data. The name *must* match the bucket specified
when creating the remote target in the previous step.
- Replace the ``--arn`` value with the ARN returned in the previous step.
Ensure you specify the ARN created on the ``Alpha`` cluster. You can use
:mc-cmd:`mc admin bucket remote ls` to list all remote ARNs configured
on the cluster.
- Replace the ``--remote-bucket`` value with the ARN returned in the previous
step. Ensure you specify the ARN created on the ``Alpha`` cluster. You can use
:mc-cmd:`mc admin bucket remote ls` to list all remote ARNs configured on the
cluster.
- The ``--replicate "delete,delete-marker,existing-objects"`` flag enables
the following replication features:

37
source/replication/enable-server-side-two-way-bucket-replication.rst
View File

@ -65,18 +65,18 @@ Replication Requires Versioning
MinIO relies on the immutability protections provided by versioning to
synchronize objects between the source and replication target.
Use the :mc-cmd:`mc version enable` command to enable versioning on
Use the :mc-cmd:`mc version suspend` command to enable versioning on
*both* the source and destination bucket before starting this procedure:
.. code-block:: shell
:class: copyable
mc version enable ALIAS/PATH
mc version ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc version enable TARGET>` with the
- Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the
:mc:`alias <mc alias>` of the MinIO cluster.
- Replace :mc-cmd:`PATH <mc version enable TARGET>` with the bucket on which
- Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which
to enable versioning.
Install and Configure ``mc`` with Access to Both Clusters.
@ -438,20 +438,15 @@ A\) Create Replication Rule on Alpha
:class: copyable
mc replicate add AlphaReplication/SOURCEBUCKET \
--remote-bucket DESTINATIONBUCKET \
--arn 'arn:minio:replication::<UUID>:DESTINATIONBUCKET' \
--remote-bucket 'arn:minio:replication::<UUID>:DESTINATIONBUCKET' \
--replicate "delete,delete-marker,existing-objects"
- Replace ``SOURCEBUCKET`` with the name of the bucket from which Alpha
replicates data. The name *must* match the bucket specified when
creating the remote target in the previous step.
- Replace the ``DESTINATIONBUCKET`` with the name of the ``Baker`` bucket to
which Alpha replicates data. The name *must* match the bucket specified
when creating the remote target in the previous step.
- Replace the ``--arn`` value with the ARN returned in the previous step.
Ensure you specify the ARN created on the ``Alpha`` cluster. You can use
- Replace the ``--remote-bucket`` value ARN returned in the previous step.
Ensure you specify the ARN created for the ``Baker`` cluster. You can use
:mc-cmd:`mc admin bucket remote ls` to list all remote ARNs configured
on the cluster.
@ -478,22 +473,17 @@ B\) Create Replication Rule on Baker
:class: copyable
mc replicate add BakerReplication/SOURCEBUCKET \
--remote-bucket DESTINATIONBUCKET \
--arn 'arn:minio:replication::<UUID>:DESTINATIONBUCKET' \
--remote-bucket 'arn:minio:replication::<UUID>:DESTINATIONBUCKET' \
--replicate "delete,delete-marker,existing-objects"
- Replace ``SOURCEBUCKET`` with the name of the bucket from which Baker
replicates data. The name *must* match the bucket specified when
creating the remote target in the previous step.
- Replace the ``DESTINATIONBUCKET`` with the name of the ``Alpha`` bucket to
which Baker replicates data. The name *must* match the bucket specified
when creating the remote target in the previous step.
- Replace the ``--arn`` value with the ARN returned in the previous step.
Ensure you specify the ARN created on the ``Alpha`` cluster. You can use
:mc-cmd:`mc admin bucket remote ls` to list all remote ARNs configured
on the cluster.
- Replace the ``--remote-bucket`` with the value with the ARN returned in the
previous step. Ensure you specify the ARN created for the ``Alpha``
cluster. You can use :mc-cmd:`mc admin bucket remote ls` to list all remote
ARNs configured on the cluster.
- The ``--replicate "delete,delete-marker,existing-objects"`` flag enables
the following replication features:
@ -508,9 +498,6 @@ B\) Create Replication Rule on Baker
Specify any other supported optional arguments for
:mc-cmd:`mc replicate add`.
Specify any other supported optional arguments for
:mc-cmd:`mc replicate add`.
5) Validate the Replication Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

24
source/replication/replication-overview.rst
View File

@ -24,7 +24,7 @@ and destination buckets.
remote replication target.
:ref:`Client-side Bucket Replication <minio-bucket-replication-clientside>`
Use the :mc-cmd:`mc mirror` process to synchronize objects between buckets
Use The command process to synchronize objects between buckets
within the same S3-compatible cluster *or* between two independent
S3-compatible clusters. Client-side replication using :mc-cmd:`mc mirror`
supports MinIO-to-S3 and similar replication configurations.
@ -105,10 +105,16 @@ Replication of Delete Operations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
MinIO supports replicating delete operations, where MinIO synchronizes
deleting specific object versions *and* new :s3-docs:`delete markers
<delete-marker-replication.html>`. Delete operation replication uses
the same :ref:`replication process <minio-replication-process>` as all other
replication operations.
deleting specific object versions *and* new
:s3-docs:`delete markers <delete-marker-replication.html>`. Delete operation
replication uses the same :ref:`replication process <minio-replication-process>`
as all other replication operations.
MinIO requires explicitly enabling versioned deletes and delete marker
replication . Use the :mc-cmd-option:`mc replicate add replicate` field to
specify both or either ``delete`` and ``delete-marker`` to enable versioned
deletes and delete marker replication respectively. To enable both, specify both
strings using a comma separator ``delete,delete-marker``.
For delete marker replication, MinIO begins the replication process after
a delete operation creates the delete marker. MinIO uses the
@ -127,12 +133,6 @@ in listing operations returning the object version after the initial
delete operation. MinIO uses the ``X-Minio-Replication-Delete-Status`` for
tracking delete version replication status.
MinIO requires explicitly enabling versioned deletes and delete marker
replication . Use the :mc-cmd-option:`mc replicate add replicate` field to
specify both or either ``delete`` and ``delete-marker`` to enable versioned
deletes and delete marker replication respectively. To enable both, specify both
strings using a comma separator ``delete,delete-marker``.
MinIO only replicates explicit client-driven delete operations. MinIO does *not*
replicate objects deleted from the application of
:ref:`lifecycle management expiration rules
@ -211,7 +211,7 @@ overall cluster load, and the size of the namespace (all objects in the bucket).
MinIO does not synchronize existing unversioned objects. Specifically, the
bucket *must* have :ref:`versioning <minio-bucket-versioning>` enabled when the
object was created. You can use the :mc-cmd:`mc cp` command to create a
object was created. You can use The command command to create a
"versioned" copy of that object. Once that object replicates successfully,
you can delete the unversioned object (versionid = ``null``).