1
0
mirror of https://github.com/minio/docs.git synced 2025-09-10 20:12:12 +03:00
Files
docs/source/reference/minio-mc-admin/mc-admin-heal.rst
Daryl White 9db99342d4 MinIO Nov 2022 releases updates (#658)
Updates docs for various releases through November 2022.

## Updates for mc RELEASE.2022-11-17T21-20-39Z
    
- Creates `mc admin idp ldap policy entities` section
- Corrects incorrect `--tier` flag in `mc ilm add`
- Adds info to `mc ilm ls` about new tabular format of output
    
Closes #645
    
- Adds info about modifying endpoints for distributed endpoits.
    
Partially addresses #644

## Updates for Bugfix [minio
RELEASE.2022-11-29T23-40-49Z](https://github.com/minio/minio/releases/tag/RELEASE.2022-11-29T23-40-49Z)
    
- Adds information about the --remove flag dropping data directories as
well and running on a per-drive basis [PR
16122](https://github.com/minio/minio/pull/16122)
- Adds note that MinIO only supports one JWT based OpenID provider [PR
#16145](https://github.com/minio/minio/pull/16145)
    
Note: There was no Docs issue to track this release.
    
## Other fix:
- Minor correction to Admin Trace
- Clarifies that mc admin idp ldap policy entities command is
cumulative, not exclusive when using multiple flags

## Add additional `mc admin config` commands

- Adds three additional commands. 
- Notes under several commands that environment variables override
config keys.

Closes #653
2022-12-06 17:41:33 -06:00

97 lines
2.2 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 arguments:
.. 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.
.. mc-cmd:: --scan
The type of scan to perform. Specify one of the following supported scan
modes:
- ``normal`` (default)
- ``deep``
.. mc-cmd:: --recursive, r
Recursively scans for objects in the specified bucket or bucket prefix.
.. mc-cmd:: --dry-run
Inspects the :mc-cmd:`~mc admin heal TARGET` bucket or bucket prefix,
but does *not* perform any object healing.
.. mc-cmd:: --force-start, f
Force starts the healing process.
.. mc-cmd:: --force-stop, s
Force stops the healing sequence.
.. mc-cmd:: --remove
Removes dangling objects and data directories in the healing process not referenced by the metadata on a per-drive basis.