Skip to content

Commit bbdedad

Browse files
authored
Simplifying troubleshooting page and minimizing references to call home (#1431)
This commit removes lengthy discussion of SUBNET from the community docs. Other affected pages that linked to removed sections also updated. Also reduces references to Call Home to the remaining mc support pages and links to those pages.
1 parent 942f174 commit bbdedad

File tree

7 files changed

+86
-325
lines changed

7 files changed

+86
-325
lines changed

source/default-conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,8 @@
326326
.. |minio-deb| replace:: DEBURL
327327
.. |minio-rpmarm64| replace:: RPMARM64URL
328328
.. |minio-debarm64| replace:: DEBARM64URL
329-
.. |subnet| replace:: `MinIO SUBNET <https://min.io/pricing?jmp=docs>`__
330-
.. |subnet-short| replace:: `SUBNET <https://min.io/pricing?jmp=docs>`__
329+
.. |subnet| replace:: `MinIO pricing <https://min.io/pricing?jmp=docs>`__
330+
.. |subnet-short| replace:: `pricing <https://min.io/pricing?jmp=docs>`__
331331
.. |SNSD| replace:: :abbr:`SNSD (Single-Node Single-Drive)`
332332
.. |SNMD| replace:: :abbr:`SNMD (Single-Node Multi-Drive)`
333333
.. |MNMD| replace:: :abbr:`MNMD (Multi-Node Multi-Drive)`

source/glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Glossary
5353
See also: :term:`tenant`.
5454

5555
cluster registration
56-
Cluster registration links a MinIO deployment to a :term:`SUBNET` :ref:`subscription <minio-docs-subnet>`.
56+
Cluster registration links a MinIO deployment to a :term:`SUBNET` `subscription <https://min.io/pricing?jmp=docs>`__.
5757
An organization may have more than one MinIO clusters registered to the same SUBNET subscription.
5858

5959
Console

source/operations/checklists/hardware.rst

Lines changed: 50 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -342,58 +342,6 @@ Storage
342342
Recommended Hardware Tests
343343
--------------------------
344344

345-
MinIO Diagnostics
346-
~~~~~~~~~~~~~~~~~
347-
348-
Run the built in health diagnostic tool.
349-
If you have access to :ref:`SUBNET <minio-docs-subnet>`, you can upload the results there.
350-
351-
.. code-block:: shell
352-
:class: copyable
353-
354-
mc support diag ALIAS --airgap
355-
356-
Replace ALIAS with the :mc:`~mc alias` defined for the deployment.
357-
358-
MinIO Support Diagnostic Tools
359-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
360-
361-
For deployments registered with MinIO |subnet-short|, you can run the built-in support diagnostic tools.
362-
363-
Run the three :mc:`mc support perf` tests.
364-
365-
These server-side tests validate network, drive, and object throughput.
366-
Run all three tests with default options.
367-
368-
#. Network test
369-
370-
Run a network throughput test on a cluster with alias ``minio1``.
371-
372-
.. code-block:: shell
373-
:class: copyable
374-
375-
mc support perf net minio1
376-
377-
#. Drive test
378-
379-
Run drive read/write performance measurements on all drive on all nodes for a cluster with alias ``minio1``.
380-
The command uses the default blocksize of 4MiB.
381-
382-
.. code-block:: shell
383-
:class: copyable
384-
385-
mc support perf drive minio1
386-
387-
#. Object test
388-
389-
Measure the performance of S3 read/write of an object on the alias ``minio1``.
390-
MinIO autotunes concurrency to obtain maximum throughput and IOPS (Input/Output Per Second).
391-
392-
.. code-block:: shell
393-
:class: copyable
394-
395-
mc support perf object minio1
396-
397345
Operating System Diagnostic Tools
398346
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399347

@@ -513,3 +461,53 @@ Document the performance numbers for each server in your deployment.
513461
- Number of threads (:math:`numberOfDrives * 16`)
514462
* - ``-F <>``
515463
- list of files (the above command tests with 16 files per drive)
464+
465+
Recommended tools for MinIO subscriptions
466+
-----------------------------------------
467+
468+
.. important::
469+
470+
The tools noted in this section **require** a MinIO subscription.
471+
MinIO strongly recommends all production deployments use `AIStor Object Store <https://min.io/docs/aistor-custom/object-store/>`__ with their SUBNET license.
472+
For more information, see the `MinIO AIStor pricing page <https://min.io/pricing?jmp=docs>`__.
473+
474+
#. Health diagnostic tool
475+
476+
Generate a summary of the health status of your deployment.
477+
If you have access to :ref:`SUBNET <minio-docs-subnet>`, you can upload the results there.
478+
479+
.. code-block:: shell
480+
:class: copyable
481+
482+
mc support diag ALIAS --airgap
483+
484+
Replace ALIAS with the :mc:`~mc alias` defined for the deployment.
485+
486+
#. Network test
487+
488+
Run a network throughput test on a cluster with alias ``minio1``.
489+
490+
.. code-block:: shell
491+
:class: copyable
492+
493+
mc support perf net minio1
494+
495+
#. Drive test
496+
497+
Run drive read/write performance measurements on all drive on all nodes for a cluster with alias ``minio1``.
498+
The command uses the default blocksize of 4MiB.
499+
500+
.. code-block:: shell
501+
:class: copyable
502+
503+
mc support perf drive minio1
504+
505+
#. Object test
506+
507+
Measure the performance of S3 read/write of an object on the alias ``minio1``.
508+
MinIO autotunes concurrency to obtain maximum throughput and IOPS (Input/Output Per Second).
509+
510+
.. code-block:: shell
511+
:class: copyable
512+
513+
mc support perf object minio1

0 commit comments

Comments
 (0)