1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00

Adds information for command history and airgap version requirements. (#811)

- Updates troubleshooting doc for airgap registration
- Updates `mc license register` doc with airgap registration and command
history
- Updates `mc support diag` with command history

Closes #804
This commit is contained in:
Daryl White
2023-04-14 09:51:11 -05:00
committed by GitHub
parent 2ea1b14032
commit eaca36720d
3 changed files with 68 additions and 8 deletions

View File

@ -59,6 +59,7 @@ Registering Your MinIO Deployment with SUBNET
Use the steps below to register MinIO deployments that do not have direct Internet access. Use the steps below to register MinIO deployments that do not have direct Internet access.
For example, deployments that exist with an airgap, behind a firewall, or in other environments with no direct Internet access. For example, deployments that exist with an airgap, behind a firewall, or in other environments with no direct Internet access.
From the Console: From the Console:
#. Go to your MinIO cluster's URL, then sign in #. Go to your MinIO cluster's URL, then sign in
@ -79,6 +80,9 @@ Registering Your MinIO Deployment with SUBNET
For clusters without direct Internet access, refer to the instructions in the :ref:`airgap example <minio-license-register-airgap>` of the :mc:`mc license register` documentation. For clusters without direct Internet access, refer to the instructions in the :ref:`airgap example <minio-license-register-airgap>` of the :mc:`mc license register` documentation.
The airgap registration process works with MinIO Client version ``RELEASE.2022-07-29T19-17-16Z`` or later.
Earlier versions of the MinIO Client cannot register an airgapped deployment.
.. _minio-subnet-license-file-download: .. _minio-subnet-license-file-download:
Download License File Download License File
@ -171,10 +175,12 @@ Optionally, use :ref:`Call Home <minio-troubleshooting-call-home>` to start auto
Call Home Call Home
--------- ---------
.. versionadded:: ``minio`` RELEASE.2022-11-17T23-20-09Z and ``mc`` RELEASE.2022-12-02T23-48-47Z .. versionadded::
minio RELEASE.2022-11-17T23-20-09Z and mc RELEASE.2022-12-02T23-48-47Z
MinIO's opt-in Call Home service automates the collection and uploading of diagnostic data or error logs to SUBNET. MinIO's opt-in Call Home service automates the collection and uploading of diagnostic data or error logs to SUBNET.
Call Home requires the cluster have both an active SUBNET registration and reliable access to the internet. Call Home requires the cluster to have both an active SUBNET registration and reliable access to the internet.
.. important:: .. important::

View File

@ -11,6 +11,32 @@
.. mc:: mc support register .. mc:: mc support register
.. mc:: mc license register .. mc:: mc license register
Command History
---------------
The command used to register a deployment with SUBNET has changed over time.
.. list-table::
:header-rows: 1
:widths: 40 30 30
:width: 100%
* - MinIO Client Release
- Command
- Notes
* - RELEASE.2021-11-05T10-05-06Z
- ``mc admin subnet register``
- First available
* - RELEASE.2022-02-13T23-26-13Z
- ``mc support register``
- Command moved to an ``mc support`` function
* - RELEASE.2022-07-15T09-20-55Z
- ``mc license register``
- Command moved to an ``mc license`` function
Description Description
----------- -----------
@ -56,6 +82,11 @@ Register a Deployment Without Direct Internet Access
Register a MinIO deployment at alias ``minio3`` on SUBNET that does not have direct Internet access due to a firewall, airgap, or the like. Register a MinIO deployment at alias ``minio3`` on SUBNET that does not have direct Internet access due to a firewall, airgap, or the like.
.. versionchanged:: mc RELEASE.2022-07-29T19-17-16Z
The airgap registration process works with MinIO Client version ``RELEASE.2022-07-29T19-17-16Z`` or later.
Earlier versions of the MinIO Client cannot register an airgapped deployment.
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable

View File

@ -14,6 +14,33 @@
:start-after: start-minio-only :start-after: start-minio-only
:end-before: end-minio-only :end-before: end-minio-only
Command History
---------------
The command used to create the diagnostic report has changed over time.
.. list-table::
:header-rows: 1
:widths: 40 30 30
:width: 100%
* - MinIO Client Release
- Command
- Notes
* - RELEASE.2020-10-03T02-54-56Z
- ``mc admin health``
- First available
* - RELEASE.2020-11-17T00-39-14Z
- ``mc admin subnet health``
- Command made a SUBNET subcommand
* - RELEASE.2022-02-13T23-26-13Z
- ``mc support diag``
- Command moved to ``mc support``
Description Description
----------- -----------
@ -23,18 +50,14 @@ The :mc-cmd:`mc support diag` command generates a health report for a MinIO depl
.. end-mc-support-diag-desc .. end-mc-support-diag-desc
For deployments registered with the MinIO subscription network (|subnet-short|), the command can automatically upload the health report for analysis. For deployments registered with the MinIO subscription network (|subnet-short|), the command generates and uploads the health report for analysis.
Optionally, automate generating and uploading the report every 24 hours by enabling :mc-cmd:`~mc support callhome`.
The resulting health report is intended for use by MinIO Engineering via SUBNET and may contain internal or private data points. The resulting health report is intended for use by MinIO Engineering via SUBNET and may contain internal or private data points.
Exercise caution before sending a health report to a third party or posting the health report in a public forum. Exercise caution before sending a health report to a third party or posting the health report in a public forum.
MinIO recommends that you run the health diagnostics when first provisioning the cluster and again at any failure scenario. MinIO recommends that you run the health diagnostics when first provisioning the cluster and again at any failure scenario.
This diagnostic test runs as a one-shot test and can run for as long as 5 minutes.
During the test, MinIO freezes all S3 calls and queues read or write operations until the test completes.
The queue is limited based on the supported maximum concurrent :ref:`requests per host <minio-hardware-checklist-memory>`.
Requests that exceed this limit on a given host return a ``503`` error after ~10 seconds.
Use the :mc-cmd:`mc support diag` command to trigger the diagnostic test. Use the :mc-cmd:`mc support diag` command to trigger the diagnostic test.
For clusters registered with SUBNET, the command uploads the results as part of SUBNET Health reports. For clusters registered with SUBNET, the command uploads the results as part of SUBNET Health reports.