From 8ad71d4a5be72de91df641529a76961c971bc5b5 Mon Sep 17 00:00:00 2001 From: Daryl White <53910321+djwfyi@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:56:07 -0400 Subject: [PATCH] Updates for mc RELEASE.2024-10-02T08-27-28Z (#1339) - Adds a `--checksum` flag to `mc cp`, `mc mirror`, `mc pipe`, and `mc put` - Adds `--disable-multipart` to `mc put` - Adds alias name to outputs of `mc ready` - Adds flags to `mc admin heal` Closes #1334 --- .../minio-mc-admin/mc-admin-heal.rst | 48 +++++++++++++------ source/reference/minio-mc/mc-cp.rst | 20 ++++++++ source/reference/minio-mc/mc-mirror.rst | 17 +++++++ source/reference/minio-mc/mc-pipe.rst | 21 +++++++- source/reference/minio-mc/mc-put.rst | 25 ++++++++++ source/reference/minio-mc/mc-ready.rst | 18 +++---- source/reference/minio-mc/mc-stat.rst | 2 +- 7 files changed, 124 insertions(+), 27 deletions(-) diff --git a/source/reference/minio-mc-admin/mc-admin-heal.rst b/source/reference/minio-mc-admin/mc-admin-heal.rst index 8b387798..ea8505be 100644 --- a/source/reference/minio-mc-admin/mc-admin-heal.rst +++ b/source/reference/minio-mc-admin/mc-admin-heal.rst @@ -15,15 +15,17 @@ 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. +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 `. +:mc-cmd:`mc admin heal` is resource intensive and typically not required as a manual process, even after drive failures or corruption events. + +As a part of normal operations, MinIO: + +- automatically heals objects damaged by silent bit rot corruption, drive failure, or other issues on each ``POST`` or ``GET`` operation. +- performs periodic background object healing using the :ref:`scanner `. +- aggressively heals objects after drive replacement. Refer to :ref:`minio-concepts-healing` for more details on how MinIO heals objects. @@ -42,25 +44,41 @@ Syntax .. code-block:: shell :class: copyable - mc admin heal [FLAGS] TARGET + mc admin heal [FLAGS] TARGET \ + [--all-drives, -a] \ + [--force] \ + [--verbose, -v] -:mc-cmd:`mc admin heal` supports the following argument: +:mc-cmd:`mc admin heal` supports the following arguments: .. mc-cmd:: TARGET + :required: - *Required* - - The full path to the bucket or bucket prefix on which the command should - perform object healing. Specify the :mc-cmd:`alias ` of a - configured MinIO deployment as the prefix for the path. For example: + The full path to the bucket or bucket prefix on which the command should perform object healing. + Specify the :mc-cmd:`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. + If the ``TARGET`` bucket or bucket prefix has an active healing scan, the command returns the status of that scan. + +.. mc-cmd:: --all-drives, -a + :optional: + + Select all drives and show verbose information. + +.. mc-cmd:: --force + :optional: + + Disables warning prompts. + +.. mc-cmd:: --verbose, -v + :optional: + + Show information about offline and faulty healing drives. Healing Colors diff --git a/source/reference/minio-mc/mc-cp.rst b/source/reference/minio-mc/mc-cp.rst index cfe71801..12039a18 100644 --- a/source/reference/minio-mc/mc-cp.rst +++ b/source/reference/minio-mc/mc-cp.rst @@ -142,6 +142,22 @@ Parameters Specify key-value pairs as ``KEY=VALUE\;``. For example, ``--attr key1=value1\;key2=value2\;key3=value3``. +.. mc-cmd:: --checksum + :optional: + + .. versionadded:: RELEASE.2024-10-02T08-27-28Z + + Add a checksum to an uploaded object. + + Valid values are: + - ``MD5`` + - ``CRC32`` + - ``CRC32C`` + - ``SHA1`` + - ``SHA256`` + + The flag requires server trailing headers and works with AWS or MinIO targets. + .. mc-cmd:: --disable-multipart :optional: @@ -167,6 +183,10 @@ Parameters .. mc-cmd:: --md5 :optional: + .. versionchanged:: RELEASE.2024-10-02T08-27-28Z + + Replaced by the :mc-cmd:`~mc cp --checksum` flag. + Forces all uploads to calculate MD5 checksums. .. mc-cmd:: --newer-than diff --git a/source/reference/minio-mc/mc-mirror.rst b/source/reference/minio-mc/mc-mirror.rst index a18a9465..9bf13f57 100644 --- a/source/reference/minio-mc/mc-mirror.rst +++ b/source/reference/minio-mc/mc-mirror.rst @@ -52,6 +52,7 @@ The :mc:`mc mirror` command synchronizes content to MinIO deployment, similar to mc [GLOBALFLAGS] mirror \ [--active-active] \ [--attr "string"] \ + [--checksum "value"] \ [--disable-multipart] \ [--dry-run] \ [--enc-kms "string"] \ @@ -151,6 +152,22 @@ Parameters Add custom metadata for mirrored objects. Specify key-value pairs as ``KEY=VALUE\;``. For example, ``--attr key1=value1\;key2=value2\;key3=value3``. +.. mc-cmd:: --checksum + :optional: + + .. versionadded:: RELEASE.2024-10-02T08-27-28Z + + Add a checksum to an uploaded object. + + Valid values are: + - ``MD5`` + - ``CRC32`` + - ``CRC32C`` + - ``SHA1`` + - ``SHA256`` + + The flag requires server trailing headers and works with AWS or MinIO targets. + .. mc-cmd:: --disable-multipart :optional: diff --git a/source/reference/minio-mc/mc-pipe.rst b/source/reference/minio-mc/mc-pipe.rst index bb70c0e7..beb64f5a 100644 --- a/source/reference/minio-mc/mc-pipe.rst +++ b/source/reference/minio-mc/mc-pipe.rst @@ -39,12 +39,13 @@ The :mc:`mc pipe` command streams content from `STDIN