mirror of
https://github.com/minio/docs.git
synced 2025-07-31 18:04:52 +03:00
20124c9a59
- Deprecates mc admin heal flags
- Adds info about healing colors
- Adds mc mirror --exclude-storageclass flag
Closes #1009
Closes #1005
120 lines
3.4 KiB
ReStructuredText
120 lines
3.4 KiB
ReStructuredText
=================
|
|
``mc admin heal``
|
|
=================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc admin heal
|
|
|
|
Description
|
|
-----------
|
|
|
|
.. start-mc-admin-heal-desc
|
|
|
|
The :mc-cmd:`mc admin heal` command scans for objects that are damaged or
|
|
corrupted and heals those objects.
|
|
|
|
.. end-mc-admin-heal-desc
|
|
|
|
:mc-cmd:`mc admin heal` is resource intensive and typically not required even
|
|
after drive failures or corruption events. Instead, MinIO automatically heals
|
|
objects damaged by silent bit rot corruption, drive failure, or other issues on
|
|
POST/GET. MinIO also performs periodic background object healing.
|
|
|
|
.. 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
|
|
|
|
Syntax
|
|
------
|
|
|
|
:mc-cmd:`mc admin heal` has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin heal [FLAGS] TARGET
|
|
|
|
:mc-cmd:`mc admin heal` supports the following argument:
|
|
|
|
.. mc-cmd:: TARGET
|
|
|
|
*Required*
|
|
|
|
The full path to the bucket or bucket prefix on which the command should
|
|
perform object healing. Specify the :mc-cmd:`alias <mc alias>` of a
|
|
configured MinIO deployment as the prefix for the path. For example:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin heal play/mybucket/myprefix
|
|
|
|
If the ``TARGET`` bucket or bucket prefix has an active healing scan,
|
|
the command returns the status of that scan.
|
|
|
|
|
|
++++++++++++++++++++
|
|
|
|
|
|
.. dropdown:: Deprecated Arguments
|
|
|
|
The following command flags have been deprecated and should only be used under guidance from MinIO Engineers in association with a SUBNET ticket.
|
|
|
|
- ``--scan``
|
|
|
|
The type of scan to perform. Specify one of the following supported scan modes:
|
|
|
|
- ``normal`` (default)
|
|
- ``deep``
|
|
|
|
- ``--recursive, r``
|
|
|
|
Recursively scans for objects in the specified bucket or bucket prefix.
|
|
|
|
- ``--dry-run``
|
|
|
|
Inspects the :mc-cmd:`~mc admin heal TARGET` bucket or bucket prefix, but does *not* perform any object healing.
|
|
|
|
- ``--force-start, f``
|
|
|
|
Force starts the healing process.
|
|
|
|
- ``--force-stop, s``
|
|
|
|
Force stops the healing sequence.
|
|
|
|
- ``--remove``
|
|
|
|
Removes dangling objects and data directories in the healing process not referenced by the metadata on a per-drive basis.
|
|
|
|
Healing Output Color Key
|
|
------------------------
|
|
|
|
Originally, the healing mechanism output a table that used a Green-Yellow-Red-Gray color key to attempt to differentiate the status of objects in healing.
|
|
These colors have been deprecated in favor of more detailed :ref:`healing metrics available at the cluster level <minio-metrics-and-alerts-available-metrics>`.
|
|
|
|
The following table describes the intent of each of the deprecated color keys.
|
|
|
|
.. list-table::
|
|
:widths: 25 75
|
|
:width: 100%
|
|
|
|
* - **Green**
|
|
- *Healthy*, the object has all data and parity shards available as required to serve the object
|
|
|
|
* - **Yellow**
|
|
- *Healing*, the object is still in the process of healing, and there are sufficient data or parity shards available to complete the healing
|
|
|
|
* - **Red**
|
|
- *Unhealthy*, the object has lost one or more shards and requires healing
|
|
|
|
* - **Grey**
|
|
- *Unrecoverable*, the object has lost too many data and/or parity shards and cannot be healed or recovered |