Skip to content

Commit

Permalink
Simplifying troubleshooting page and minimizing references to call ho…
Browse files Browse the repository at this point in the history
…me (#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.
  • Loading branch information
djwfyi authored Mar 7, 2025
1 parent 942f174 commit bbdedad
Show file tree
Hide file tree
Showing 7 changed files with 86 additions and 325 deletions.
4 changes: 2 additions & 2 deletions source/default-conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -326,8 +326,8 @@
.. |minio-deb| replace:: DEBURL
.. |minio-rpmarm64| replace:: RPMARM64URL
.. |minio-debarm64| replace:: DEBARM64URL
.. |subnet| replace:: `MinIO SUBNET <https://min.io/pricing?jmp=docs>`__
.. |subnet-short| replace:: `SUBNET <https://min.io/pricing?jmp=docs>`__
.. |subnet| replace:: `MinIO pricing <https://min.io/pricing?jmp=docs>`__
.. |subnet-short| replace:: `pricing <https://min.io/pricing?jmp=docs>`__
.. |SNSD| replace:: :abbr:`SNSD (Single-Node Single-Drive)`
.. |SNMD| replace:: :abbr:`SNMD (Single-Node Multi-Drive)`
.. |MNMD| replace:: :abbr:`MNMD (Multi-Node Multi-Drive)`
Expand Down
2 changes: 1 addition & 1 deletion source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Glossary
See also: :term:`tenant`.

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

Console
Expand Down
102 changes: 50 additions & 52 deletions source/operations/checklists/hardware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -342,58 +342,6 @@ Storage
Recommended Hardware Tests
--------------------------

MinIO Diagnostics
~~~~~~~~~~~~~~~~~

Run the built in health diagnostic tool.
If you have access to :ref:`SUBNET <minio-docs-subnet>`, you can upload the results there.

.. code-block:: shell
:class: copyable
mc support diag ALIAS --airgap
Replace ALIAS with the :mc:`~mc alias` defined for the deployment.

MinIO Support Diagnostic Tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For deployments registered with MinIO |subnet-short|, you can run the built-in support diagnostic tools.

Run the three :mc:`mc support perf` tests.

These server-side tests validate network, drive, and object throughput.
Run all three tests with default options.

#. Network test

Run a network throughput test on a cluster with alias ``minio1``.

.. code-block:: shell
:class: copyable
mc support perf net minio1
#. Drive test

Run drive read/write performance measurements on all drive on all nodes for a cluster with alias ``minio1``.
The command uses the default blocksize of 4MiB.

.. code-block:: shell
:class: copyable
mc support perf drive minio1
#. Object test

Measure the performance of S3 read/write of an object on the alias ``minio1``.
MinIO autotunes concurrency to obtain maximum throughput and IOPS (Input/Output Per Second).

.. code-block:: shell
:class: copyable
mc support perf object minio1
Operating System Diagnostic Tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -513,3 +461,53 @@ Document the performance numbers for each server in your deployment.
- Number of threads (:math:`numberOfDrives * 16`)
* - ``-F <>``
- list of files (the above command tests with 16 files per drive)

Recommended tools for MinIO subscriptions
-----------------------------------------

.. important::

The tools noted in this section **require** a MinIO subscription.
MinIO strongly recommends all production deployments use `AIStor Object Store <https://min.io/docs/aistor-custom/object-store/>`__ with their SUBNET license.
For more information, see the `MinIO AIStor pricing page <https://min.io/pricing?jmp=docs>`__.

#. Health diagnostic tool

Generate a summary of the health status of your deployment.
If you have access to :ref:`SUBNET <minio-docs-subnet>`, you can upload the results there.

.. code-block:: shell
:class: copyable
mc support diag ALIAS --airgap
Replace ALIAS with the :mc:`~mc alias` defined for the deployment.

#. Network test

Run a network throughput test on a cluster with alias ``minio1``.

.. code-block:: shell
:class: copyable
mc support perf net minio1
#. Drive test

Run drive read/write performance measurements on all drive on all nodes for a cluster with alias ``minio1``.
The command uses the default blocksize of 4MiB.

.. code-block:: shell
:class: copyable
mc support perf drive minio1
#. Object test

Measure the performance of S3 read/write of an object on the alias ``minio1``.
MinIO autotunes concurrency to obtain maximum throughput and IOPS (Input/Output Per Second).

.. code-block:: shell
:class: copyable
mc support perf object minio1
Loading

0 comments on commit bbdedad

Please sign in to comment.