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

Adds mc ready to reference docs (#1221)

Closes #1188
This commit is contained in:
Daryl White
2024-05-22 13:52:25 -04:00
committed by GitHub
parent 9374fb56e4
commit c1bbe71ceb
3 changed files with 119 additions and 1 deletions

View File

@ -356,6 +356,11 @@ The following table lists :mc-cmd:`mc` commands:
:start-after: start-mc-rb-desc
:end-before: end-mc-rb-desc
* - :mc:`mc ready`
- .. include:: /reference/minio-mc/mc-ready.rst
:start-after: start-mc-ready-desc
:end-before: end-mc-ready-desc
* - | :mc:`mc replicate add`
| :mc:`mc replicate backlog`
| :mc:`mc replicate export`
@ -663,6 +668,7 @@ You can also define some of these options using :ref:`Environment Variables <min
/reference/minio-mc/mc-put
/reference/minio-mc/mc-quota
/reference/minio-mc/mc-rb
/reference/minio-mc/mc-ready
/reference/minio-mc/mc-replicate
/reference/minio-mc/mc-retention
/reference/minio-mc/mc-rm

View File

@ -0,0 +1,112 @@
============
``mc ready``
============
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ready
Syntax
------
.. start-mc-ready-desc
The :mc:`mc ready` command checks the status of a cluster and whether the cluster has ``read`` and ``write`` quorum.
.. end-mc-ready-desc
.. tab-set::
.. tab-item:: EXAMPLE
The following sends a ``GET`` request to the cluster and returns its status.
.. code-block:: shell
:class: copyable
mc ready play
The command sends a ``GET`` request to the deployment at the :mc:`~mc alias` ``play``.'
The command repeats the request until it is successful.
The output before a cluster is ready resembles the following:
.. code-block:: shell
The cluster is unreachable: Get "http://play.min.io:9000/minio/health/cluster": dial tcp 127.0.0.1:9000: connect: connection refused
Once the request succeeds, the output resembles the following:
.. code-block:: shell
The cluster is ready
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ready \
TARGET \
[--cluster-read] \
[--maintenance]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: TARGET
:required:
The full path to the :ref:`alias <minio-mc-alias>` or prefix where the command should run.
.. mc-cmd:: --cluster-read
:optional:
Checks if the cluster has enough :term:`quorum <read quorum>` to serve ``READ`` requests.
.. mc-cmd:: --maintenance
:optional:
Checks if the cluster can maintain read and write quorum if the node for the alias is taken down for maintenance.
Use an alias for the specific node you expect to take down for maintenance and not an alias set to a load balancer.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Check if the cluster has read quorum
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command checks that a deployment has sufficient drives available for read operations.
.. code-block:: shell
:class: copyable
mc read myminio --cluster-read
Check if a cluster is down for maintenance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command checks whether the cluster can maintain read and write quorum during maintenance when the node at alias ``myminio`` is taken down.
.. code-block:: shell
:class: copyable
mc ready myminio --maintenance