diff --git a/source/operations/troubleshooting.rst b/source/operations/troubleshooting.rst index 2b88338e..b962787e 100644 --- a/source/operations/troubleshooting.rst +++ b/source/operations/troubleshooting.rst @@ -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. For example, deployments that exist with an airgap, behind a firewall, or in other environments with no direct Internet access. + From the Console: #. 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 ` 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: Download License File @@ -171,10 +175,12 @@ Optionally, use :ref:`Call Home ` to start auto 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. -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:: diff --git a/source/reference/minio-mc/mc-license-register.rst b/source/reference/minio-mc/mc-license-register.rst index 106d208a..f382ce69 100644 --- a/source/reference/minio-mc/mc-license-register.rst +++ b/source/reference/minio-mc/mc-license-register.rst @@ -11,6 +11,32 @@ .. mc:: mc support 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 ----------- @@ -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. +.. 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 :class: copyable diff --git a/source/reference/minio-mc/mc-support-diag.rst b/source/reference/minio-mc/mc-support-diag.rst index 99c8d0bd..afecc749 100644 --- a/source/reference/minio-mc/mc-support-diag.rst +++ b/source/reference/minio-mc/mc-support-diag.rst @@ -14,6 +14,33 @@ :start-after: start-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 ----------- @@ -23,18 +50,14 @@ The :mc-cmd:`mc support diag` command generates a health report for a MinIO depl .. 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. 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. -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 `. -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. For clusters registered with SUBNET, the command uploads the results as part of SUBNET Health reports.