docs/source/reference/minio-mc/mc-ready.rst

mc ready

minio

Table of Contents

mc ready

Syntax

The mc ready command checks the status of a cluster and whether the cluster has read and write quorum.

EXAMPLE

The following sends a GET request to the cluster and returns its status.

mc ready play

The command sends a GET request to the deployment at the ~mc alias play.' The command repeats the request until it is successful.

The output before a cluster is ready resembles the following:

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:

The cluster is ready

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] ready            \
                 TARGET           \
                 [--cluster-read] \
                 [--maintenance]

Parameters

TARGET

The full path to the alias <minio-mc-alias> or prefix where the command should run.

--cluster-read

Checks if the cluster has enough quorum <read quorum> to serve READ requests.

--maintenance

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

Examples

Check if the cluster has read quorum

The following command checks that a deployment has sufficient drives available for read operations.

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.

mc ready myminio --maintenance