mirror of
https://github.com/minio/docs.git
synced 2025-07-30 07:03:26 +03:00
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
This commit is contained in:
Daryl White
GitHub
@ -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
|
||||
@ -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
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
@ -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
|
||||
---------
|
||||
|
||||
|
||||
@ -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
|
||||
-------
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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
|
||||
--------
|
||||
|
||||
|
||||
@ -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
|
||||
-------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user