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

Updates for mc RELEASE.2023-01-11T03-14-16Z (#704)

Browse Source 
- Adds info on `mc mirror` continuing after a failed object sync [PR
4427](https://github.com/minio/mc/pull/4427)
- Adds addition call type to `mc admin trace` [PR
4416](https://github.com/minio/mc/pull/4416)
- Adds info about changed default file behavior for `mc support inspect`
[PR 4420](https://github.com/minio/mc/pull/4420)
- Concurrent upload support for `mc pipe` [PR
4435](https://github.com/minio/mc/pull/4435)
- Renames two `mc admin replicate` subcommands [PR
4383](https://github.com/minio/mc/pull/4383)
- Updates behavior of `mc license update` to no longer require license
file [PR 4429](https://github.com/minio/mc/pull/4429)
- New flag for `mc admin update` to bypass confirmation prompt [PR
4439](https://github.com/minio/mc/pull/4427)

There is no doc issue to track this update.
This commit is contained in:
Daryl White
2023-01-17 13:19:53 -06:00
committed by GitHub
parent 3559267dea
commit b0a97ce1f4
10 changed files with 88 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
source/operations/data-recovery/recover-after-site-failure.rst
View File

@ -47,14 +47,14 @@ If a peer site fails, such as due to a major disaster or long power outage, you
The following procedure can restore data in scenarios where :ref:`site replication <minio-site-replication-overview>` was active prior to the site loss. The following procedure can restore data in scenarios where :ref:`site replication <minio-site-replication-overview>` was active prior to the site loss.
This procedure assumes a *total loss* of one or more peer sites versus replication lag or delays due to latency or transient deployment downtime. This procedure assumes a *total loss* of one or more peer sites versus replication lag or delays due to latency or transient deployment downtime.
1. Remove the failed site from the MinIO site replication configuration using the :mc-cmd:`mc admin replicate remove` command with the ``--force`` option. 1. Remove the failed site from the MinIO site replication configuration using the :mc-cmd:`mc admin replicate rm` command with the ``--force`` option.
The following command force-removes an unhealthy peer site from the replication configuration: The following command force-removes an unhealthy peer site from the replication configuration:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin replicate remove HEALTHY_PEER UNHEALTHY_PEER --force mc admin replicate rm HEALTHY_PEER UNHEALTHY_PEER --force
- Replace ``HEALTHY_PEER`` with the :ref:`alias <alias>` of any healthy peer in the replication configuration - Replace ``HEALTHY_PEER`` with the :ref:`alias <alias>` of any healthy peer in the replication configuration
@ -70,7 +70,7 @@ This procedure assumes a *total loss* of one or more peer sites versus replicati
.. warning:: .. warning::
The :mc-cmd:`mc admin replicate remove --force` command only operates on the online or healthy nodes in the site replication configuration. The :mc-cmd:`mc admin replicate rm --force` command only operates on the online or healthy nodes in the site replication configuration.
The removed offline MinIO deployment retains its original replication configuration, such that if the deployment resumes normal operations it would continue replication operations to its configured peer sites. The removed offline MinIO deployment retains its original replication configuration, such that if the deployment resumes normal operations it would continue replication operations to its configured peer sites.
If you plan to re-use the hardware for the site replication configuration, you **must** completely wipe the drives for the deployment before re-initializing MinIO and adding the site back to the replication configuration. If you plan to re-use the hardware for the site replication configuration, you **must** completely wipe the drives for the deployment before re-initializing MinIO and adding the site back to the replication configuration.

8
source/operations/install-deploy-manage/multi-site-replication.rst
View File

@ -434,11 +434,11 @@ If a peer site changes its hostname, you can modify the replication configuratio
mc admin replicate info <ALIAS> mc admin replicate info <ALIAS>
#. Update the site's endpoint with :mc-cmd:`mc admin replicate edit` #. Update the site's endpoint with :mc-cmd:`mc admin replicate update`
.. code-block:: shell .. code-block:: shell
mc admin replicate edit ALIAS --deployment-id [DEPLOYMENT-ID] --endpoint [NEW-ENDPOINT] mc admin replicate update ALIAS --deployment-id [DEPLOYMENT-ID] --endpoint [NEW-ENDPOINT]
Replace [DEPLOYMENT-ID] with the deployment ID of the site to update. Replace [DEPLOYMENT-ID] with the deployment ID of the site to update.
@ -482,11 +482,11 @@ You can re-add the site at a later date, but you must first completely wipe buck
.. tab-item:: Command Line .. tab-item:: Command Line
:sync: cli :sync: cli
Use :mc-cmd:`mc admin replicate remove` Use :mc-cmd:`mc admin replicate rm`
.. code-block:: shell .. code-block:: shell
mc admin replicate remove ALIAS PEER_TO_REMOVE --force mc admin replicate rm ALIAS PEER_TO_REMOVE --force
- Replace ``ALIAS`` with the :ref:`alias <alias>` of any peer site in the replication configuration. - Replace ``ALIAS`` with the :ref:`alias <alias>` of any peer site in the replication configuration.

59
source/reference/minio-mc-admin/mc-admin-replicate.rst
View File

@ -12,6 +12,11 @@
.. mc:: mc admin replicate .. mc:: mc admin replicate
.. versionchanged:: RELEASE.2023-01-11T03-14-16Z
- ``mc admin replicate edit`` renamed to :mc-cmd:`mc admin replicate update`
- ``mc admin replicate remove`` renamed to :mc-cmd:`mc admin replicate rm`
Description Description
----------- -----------
@ -53,21 +58,21 @@ The :mc-cmd:`mc admin replicate` command has the following subcommands:
* - :mc-cmd:`mc admin replicate add` * - :mc-cmd:`mc admin replicate add`
- Create a new site replication configuration or expand an existing configuration. - 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` * - :mc-cmd:`mc admin replicate info`
- Returns information about site replication configuration. - 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 resync` * - :mc-cmd:`mc admin replicate resync`
- Resynchronizes content from one site to a second site if the second site has lost data. - Resynchronizes content from one site to a second site if the second site has lost data.
* - :mc-cmd:`mc admin replicate rm`
- Removes an entire site replication configuration or one or more peer sites from participating in site replication.
* - :mc-cmd:`mc admin replicate status` * - :mc-cmd:`mc admin replicate status`
- Displays the status for :ref:`replicable data <minio-site-replication-what-replicates>` across participating sites. - Displays the status for :ref:`replicable data <minio-site-replication-what-replicates>` across participating sites.
* - :mc-cmd:`mc admin replicate update`
- Modify the endpoint of the specified peer site in the site replication configuration.
Syntax Syntax
------ ------
@ -122,11 +127,15 @@ Syntax
The deployments to add must be empty. The deployments to add must be empty.
.. mc-cmd:: edit .. mc-cmd:: update
:fullpath: :fullpath:
Modifies the endpoint used for an existing peer site participating in site replication. Modifies the endpoint used for an existing peer site participating in site replication.
.. versionchanged:: RELEASE.2023-01-11T03-14-16Z
``mc admin replicate edit`` renamed to ``mc admin replicate update``.
.. tab-set:: .. tab-set::
.. tab-item:: EXAMPLE .. tab-item:: EXAMPLE
@ -134,7 +143,7 @@ Syntax
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin replicate edit \ mc admin replicate update \
minio2 \ minio2 \
--deployment-id c1758167-4426-454f-9aae-5c3dfdf6df64 \ --deployment-id c1758167-4426-454f-9aae-5c3dfdf6df64 \
--endpoint https://minio2:9000 --endpoint https://minio2:9000
@ -145,7 +154,7 @@ Syntax
.. code-block:: shell .. code-block:: shell
mc [GLOBALFLAGS] admin replicate edit \ mc [GLOBALFLAGS] admin replicate update \
ALIAS \ ALIAS \
--deployment-id [deploymentID] \ --deployment-id [deploymentID] \
--endpoint [newEndpoint] --endpoint [newEndpoint]
@ -167,9 +176,13 @@ Syntax
The new endpoint or URL to associate with the peer site. The new endpoint or URL to associate with the peer site.
.. mc-cmd:: remove .. mc-cmd:: rm
:fullpath: :fullpath:
.. versionchanged:: 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. 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>`. 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>`.
@ -184,9 +197,9 @@ Syntax
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin replicate remove \ mc admin replicate rm \
minio2 \ minio2 \
--all \ --all \
--force --force
Remove the sites with alias names ``minio5`` and ``minio6`` from an existing site replication configuration that includes `minio2` Remove the sites with alias names ``minio5`` and ``minio6`` from an existing site replication configuration that includes `minio2`
@ -194,11 +207,11 @@ Syntax
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin replicate remove \ mc admin replicate rm \
minio2 \ minio2 \
minio5 \ minio5 \
minio6 \ minio6 \
--force \ --force
.. tab-item:: SYNTAX .. tab-item:: SYNTAX
@ -206,11 +219,11 @@ Syntax
.. code-block:: shell .. code-block:: shell
mc [GLOBALFLAGS] admin remove \ mc [GLOBALFLAGS] admin rm \
TARGET \ TARGET \
ALIAS1 \ ALIAS1 \
[ALIAS2...] \ [ALIAS2...] \
--all \ --all \
--force --force
.. mc-cmd:: TARGET .. mc-cmd:: TARGET

2
source/reference/minio-mc-admin/mc-admin-trace.rst
View File

@ -123,6 +123,7 @@ Syntax
Valid call types include: Valid call types include:
- ``batch-replication`` - ``batch-replication``
- ``bootstrap``
- ``decommission`` - ``decommission``
- ``healing`` - ``healing``
- ``internal`` - ``internal``
@ -130,6 +131,7 @@ Syntax
- ``rebalance`` - ``rebalance``
- ``replication-resync`` - ``replication-resync``
- ``s3`` - ``s3``
- ``scanner``
- ``storage`` - ``storage``
If not specified, MinIO returns call types of ``s3``. If not specified, MinIO returns call types of ``s3``.

11
source/reference/minio-mc-admin/mc-admin-update.rst
View File

@ -20,6 +20,9 @@ The command also supports using a private mirror server for environments where t
.. end-mc-admin-update-desc .. end-mc-admin-update-desc
After running the command, a prompt displays to confirm the update.
Type ``y`` and ``[ENTER]`` to confirm and proceed with the update.
.. admonition:: Use ``mc admin`` on MinIO Deployments Only .. admonition:: Use ``mc admin`` on MinIO Deployments Only
:class: note :class: note
@ -62,7 +65,9 @@ Syntax
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin update ALIAS [MIRROR_URL] mc admin update ALIAS \
[MIRROR_URL] \
[--yes]
:mc-cmd:`mc admin update` supports the following arguments: :mc-cmd:`mc admin update` supports the following arguments:
@ -78,3 +83,7 @@ Syntax
The mirror URL of the ``minio`` server binary to use for updating MinIO servers in the :mc-cmd:`~mc admin update ALIAS` deployment. The mirror URL of the ``minio`` server binary to use for updating MinIO servers in the :mc-cmd:`~mc admin update ALIAS` deployment.
.. mc-cmd:: --yes, -y
:optional:
Pass this flag to confirm the update and bypass the confirmation prompt.

10
source/reference/minio-mc-deprecated.rst
View File

@ -64,6 +64,14 @@ Table of Deprecated Admin Commands
- Replacement Command - Replacement Command
- Version of Change - Version of Change
* - ``mc admin replicate edit``
- :mc:`mc admin replicate update`
- mc RELEASE.2023-01-11T03-14-16Z
* - ``mc admin replicate remove``
- :mc:`mc admin replicate rm`
- mc RELEASE.2023-01-11T03-14-16Z
* - ``mc admin tier add`` * - ``mc admin tier add``
- :mc:`mc ilm tier add` - :mc:`mc ilm tier add`
- mc RELEASE.2022-12-24T15-21-38Z - mc RELEASE.2022-12-24T15-21-38Z
@ -98,6 +106,8 @@ Table of Deprecated Admin Commands
.. toctree:: .. toctree::
:titlesonly: :titlesonly:
:hidden: :hidden:

10
source/reference/minio-mc/mc-license-update.rst
View File

@ -33,9 +33,9 @@ The command has the following syntax:
.. code-block:: shell .. code-block:: shell
mc [GLOBALFLAGS] license update \ mc [GLOBALFLAGS] license update \
ALIAS \ ALIAS \
LICENSE-FILE-WITH-PATH \ [LICENSE-FILE-WITH-PATH] \
[--airgap] [--airgap]
Parameters Parameters
@ -47,10 +47,12 @@ Parameters
The :ref:`alias <alias>` of the MinIO deployment. The :ref:`alias <alias>` of the MinIO deployment.
.. mc-cmd:: LICENSE-FILE-WITH-PATH .. mc-cmd:: LICENSE-FILE-WITH-PATH
:required: :optional:
The path (relative to the current working directory) and file name of the key to use to update the deployment's license. The path (relative to the current working directory) and file name of the key to use to update the deployment's license.
If not passed with the command, MinIO checks the license file on SUBNET and automatically updates it.
.. mc-cmd:: --airgap .. mc-cmd:: --airgap
:optional: :optional:

6
source/reference/minio-mc/mc-mirror.rst
View File

@ -306,6 +306,12 @@ Use :mc:`mc mirror` with :mc-cmd:`~mc mirror --watch` to continuously mirror obj
Behavior Behavior
-------- --------
Mirror Continues on Failed Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If an object of the same name exists on the target, MinIO outputs an error for the duplicate object.
``mc mirror`` continues to mirror other objects from the source to the destination after the error.
MinIO Trims Empty Prefixes on Object Removal MinIO Trims Empty Prefixes on Object Removal
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

4
source/reference/minio-mc/mc-pipe.rst
View File

@ -49,6 +49,10 @@ The :mc:`mc pipe` command streams content from `STDIN <https://www.gnu.org/softw
:start-after: start-minio-syntax :start-after: start-minio-syntax
:end-before: end-minio-syntax :end-before: end-minio-syntax
.. versionchanged:: RELEASE.2023-01-11T03-14-16Z
``mc pipe`` now supports concurrent uploads for better throughput of large streams.
Parameters Parameters
~~~~~~~~~~ ~~~~~~~~~~

7
source/reference/minio-mc/mc-support-inspect.rst
View File

@ -22,6 +22,11 @@ MinIO assembles this data from each backend drive storing an :ref:`erasure shard
The command produces an encrypted zip file that includes all matching files with their respective *host+drive+path*. The command produces an encrypted zip file that includes all matching files with their respective *host+drive+path*.
.. versionchanged:: RELEASE.2023-01-11T03-14-16Z
The file uploads to MinIO for use by the engineering team in support efforts.
The file saves the the current working directory in the event the file does not successfully upload (such as in an airgapped environment).
.. versionchanged:: RELEASE.2022-12-12T19-27-27Z .. versionchanged:: RELEASE.2022-12-12T19-27-27Z
When writing the zip archive, MinIO also encrypts the zip index of file names included in the archive. When writing the zip archive, MinIO also encrypts the zip index of file names included in the archive.
@ -36,7 +41,7 @@ Exercise caution before sending a report to a third party or posting the report
Wildcards Wildcards
--------- ---------
The command suports wildcard ``*`` pattern matching for prefixes or objects. The command supports wildcard ``*`` pattern matching for prefixes or objects.
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable