mirror of
https://github.com/minio/docs.git
synced 2025-09-13 04:26:43 +03:00
3399695e18
Remove several `mc admin heal` options from the reference docs. These were previously deprecated and are now hidden. Also add two `mc admin trace` call types from the same PR, noted in the relevant GitHub docs: `batch-keyrotation` and `ilm`. Staged http://192.241.195.202:9000/staging/DOCS-1029/linux/reference/minio-mc-admin/mc-admin-heal.html http://192.241.195.202:9000/staging/DOCS-1029/linux/reference/minio-mc-admin/mc-admin-trace.html#mc.admin.trace.-call Fixes https://github.com/minio/docs/issues/1029
71 lines
1.9 KiB
ReStructuredText
71 lines
1.9 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`` or ``GET``. MinIO also performs periodic background object healing using the :ref:`scanner <minio-concepts-scanner>`.
|
|
|
|
Refer to :ref:`minio-concepts-healing` for more details on how MinIO heals objects.
|
|
|
|
.. 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.
|
|
|
|
|
|
Healing Colors
|
|
--------------
|
|
|
|
Some versions of MinIO used a color key as a way to differentiate objects with different healing statuses.
|
|
For details of this key, see the :ref:`Healing <minio-concepts-healing-colors>` concept page.
|