From 422d0d915fe533f42b5ad95d8dde8e5cb51add1b Mon Sep 17 00:00:00 2001 From: Daryl White <53910321+djwfyi@users.noreply.github.com> Date: Wed, 16 Nov 2022 16:03:57 -0600 Subject: [PATCH] Update docs for mc release 2022-10-01 (#643) Closes #602 - Revises the note about mc support commands requiring SUBNET registration - Moves note to the top of each `mc support` subcommand page --- source/includes/common-mc-support.rst | 10 +++++----- source/reference/minio-mc/mc-support-diag.rst | 7 ++++--- source/reference/minio-mc/mc-support-inspect.rst | 8 ++++---- source/reference/minio-mc/mc-support-logs-disable.rst | 8 ++++---- source/reference/minio-mc/mc-support-logs-enable.rst | 11 ++++++----- source/reference/minio-mc/mc-support-logs-show.rst | 8 ++++---- source/reference/minio-mc/mc-support-logs-status.rst | 8 ++++---- 7 files changed, 31 insertions(+), 29 deletions(-) diff --git a/source/includes/common-mc-support.rst b/source/includes/common-mc-support.rst index 7c927e6b..927e6423 100644 --- a/source/includes/common-mc-support.rst +++ b/source/includes/common-mc-support.rst @@ -1,16 +1,16 @@ .. start-minio-only -.. note:: +.. admonition:: SUBNET Registration Required + :class: note - The ``mc support`` commands were designed for MinIO deployments registered with |subnet| to ensure optimal outcome of diagnostics and performance testing. - MinIO does not guarantee any functionality if used against non-MinIO deployments or if used independently of MinIO engineering and support. + The ``mc support`` commands are designed for MinIO deployments registered with |subnet| to ensure optimal outcome of diagnostics and performance testing. + Deployments not registered with SUBNET cannot use the ``mc support`` commands. .. end-minio-only .. start-support-logs-opt-in -Uploading logs requires registration to SUBNET. The uploading feature remains disabled by default until explicitly enabled for a deployment on an opt-in only basis. -You can then disable the feature at any time with :mc-cmd:`mc support logs disable`. +If enabled, you can disable the feature at any time with :mc-cmd:`mc support logs disable`. .. end-support-logs-opt-in \ No newline at end of file diff --git a/source/reference/minio-mc/mc-support-diag.rst b/source/reference/minio-mc/mc-support-diag.rst index 1cd894d8..c74f95c5 100644 --- a/source/reference/minio-mc/mc-support-diag.rst +++ b/source/reference/minio-mc/mc-support-diag.rst @@ -10,6 +10,10 @@ .. mc:: mc support diag +.. include:: /includes/common-mc-support.rst + :start-after: start-minio-only + :end-before: end-minio-only + Description ----------- @@ -32,9 +36,6 @@ For clusters registered with SUBNET, the command uploads the results as part of For airgapped or firewalled environments, or other environments that prevent direct network access from the deployment, you can save the report locally with the :mc-cmd:`~mc support diag --airgap` flag. After saving, you can then upload the results of the test to SUBNET manually. -.. include:: /includes/common-mc-support.rst - :start-after: start-minio-only - :end-before: end-minio-only Sample Output ~~~~~~~~~~~~~ diff --git a/source/reference/minio-mc/mc-support-inspect.rst b/source/reference/minio-mc/mc-support-inspect.rst index 13c1e898..a5b8acf3 100644 --- a/source/reference/minio-mc/mc-support-inspect.rst +++ b/source/reference/minio-mc/mc-support-inspect.rst @@ -10,6 +10,10 @@ .. mc:: mc support inspect +.. include:: /includes/common-mc-support.rst + :start-after: start-minio-only + :end-before: end-minio-only + Description ----------- @@ -27,10 +31,6 @@ Exercise caution before sending a report to a third party or posting the report :mc:`mc support inspect` requires a MinIO deployment server from October 2021 or later. -.. include:: /includes/common-mc-support.rst - :start-after: start-minio-only - :end-before: end-minio-only - Wildcards --------- diff --git a/source/reference/minio-mc/mc-support-logs-disable.rst b/source/reference/minio-mc/mc-support-logs-disable.rst index faba6710..279bb0a1 100644 --- a/source/reference/minio-mc/mc-support-logs-disable.rst +++ b/source/reference/minio-mc/mc-support-logs-disable.rst @@ -10,6 +10,10 @@ .. mc:: mc support logs disable +.. include:: /includes/common-mc-support.rst + :start-after: start-minio-only + :end-before: end-minio-only + Description ----------- @@ -19,10 +23,6 @@ Use the :mc-cmd:`mc support logs disable` command to disable the uploading of re :start-after: start-support-logs-opt-in :end-before: end-support-logs-opt-in -.. include:: /includes/common-mc-support.rst - :start-after: start-minio-only - :end-before: end-minio-only - Example ------- diff --git a/source/reference/minio-mc/mc-support-logs-enable.rst b/source/reference/minio-mc/mc-support-logs-enable.rst index b20cb58b..72ade1bc 100644 --- a/source/reference/minio-mc/mc-support-logs-enable.rst +++ b/source/reference/minio-mc/mc-support-logs-enable.rst @@ -10,6 +10,10 @@ .. mc:: mc support logs enable +.. include:: /includes/common-mc-support.rst + :start-after: start-minio-only + :end-before: end-minio-only + Description ----------- @@ -19,11 +23,8 @@ Use the :mc-cmd:`mc support logs enable` command to allow real-time MinIO logs t :start-after: start-support-logs-opt-in :end-before: end-support-logs-opt-in -.. include:: /includes/common-mc-support.rst - :start-after: start-minio-only - :end-before: end-minio-only - -.. note:: +.. admonition:: Sensitive Data + :class: important By default, MinIO does not scrub the logs uploaded to SUBNET. diff --git a/source/reference/minio-mc/mc-support-logs-show.rst b/source/reference/minio-mc/mc-support-logs-show.rst index d11265bd..9d94e8ac 100644 --- a/source/reference/minio-mc/mc-support-logs-show.rst +++ b/source/reference/minio-mc/mc-support-logs-show.rst @@ -10,15 +10,15 @@ .. mc:: mc support logs show +.. include:: /includes/common-mc-support.rst + :start-after: start-minio-only + :end-before: end-minio-only + Description ----------- Use the :mc-cmd:`mc support logs show` command to display MinIO server logs. -.. include:: /includes/common-mc-support.rst - :start-after: start-minio-only - :end-before: end-minio-only - Examples -------- diff --git a/source/reference/minio-mc/mc-support-logs-status.rst b/source/reference/minio-mc/mc-support-logs-status.rst index 00e35f99..ed17097b 100644 --- a/source/reference/minio-mc/mc-support-logs-status.rst +++ b/source/reference/minio-mc/mc-support-logs-status.rst @@ -10,6 +10,10 @@ .. mc:: mc support logs status +.. include:: /includes/common-mc-support.rst + :start-after: start-minio-only + :end-before: end-minio-only + Description ----------- @@ -19,10 +23,6 @@ Use the :mc-cmd:`mc support logs status` command to output whether the specified :start-after: start-support-logs-opt-in :end-before: end-support-logs-opt-in -.. include:: /includes/common-mc-support.rst - :start-after: start-minio-only - :end-before: end-minio-only - Example -------