mirror of
https://github.com/minio/docs.git
synced 2025-08-09 13:02:53 +03:00
363e688617
- Adds new environment variable for ILM expiration workers
- Adds new metrics for locks
- Adds keyrotate batch job type
- Adds info about batch replicate from remote to local
Closes #806
Staged:
http://192.241.195.202:9000/staging/minio-2023-04-07/administration/batch-framework.html
162 lines
4.6 KiB
ReStructuredText
162 lines
4.6 KiB
ReStructuredText
.. _minio-mc-admin-rebalance:
|
|
|
|
======================
|
|
``mc admin rebalance``
|
|
======================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc admin rebalance
|
|
|
|
Permission
|
|
----------
|
|
|
|
This command requires that the user performing it have the :policy-action:`admin:Rebalance` :ref:`policy action <minio-policy>` for the deployment.
|
|
|
|
Description
|
|
-----------
|
|
|
|
.. start-mc-admin-rebalance-desc
|
|
|
|
The :mc-cmd:`mc admin rebalance` command allows starts, monitors, or stops a rebalancing operation on a MinIO deployment.
|
|
Rebalancing redistributes objects across all pools in the deployment.
|
|
|
|
.. end-mc-admin-rebalance-desc
|
|
|
|
MinIO does not automatically rebalance objects when adding a new server pool.
|
|
Instead, MinIO :ref:`writes new objects <minio-writing-files>` to the pool with relatively more free space compared to the other available pools on the deployment.
|
|
Triggering a manual rebalancing procedure prompts MinIO to scan the entire deployment and move objects as necessary to achieve a similar available free space across all pools.
|
|
|
|
This is an expensive and time consuming operation.
|
|
Consider only running a rebalance procedure during light or no use of the deployment.
|
|
If write operations do occur during a rebalance operation, they process in parallel and write to a pool not actively in rebalancing.
|
|
|
|
You can stop a rebalance and start it again later as needed.
|
|
|
|
Follow the progress of an ongoing rebalance operation using the following command:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin trace --call rebalance ALIAS
|
|
|
|
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
|
:class: note
|
|
|
|
.. include:: /includes/facts-mc-admin.rst
|
|
:start-after: start-minio-only
|
|
:end-before: end-minio-only
|
|
|
|
|
|
The :mc-cmd:`mc admin rebalance` command has the following subcommands:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:widths: 40 60
|
|
|
|
* - Subcommand
|
|
- Description
|
|
|
|
* - :mc-cmd:`mc admin rebalance start`
|
|
- Starts a rebalance operation on a MinIO deployment.
|
|
|
|
* - :mc-cmd:`mc admin rebalance status`
|
|
- Outputs the current status of an in-progress rebalance operation.
|
|
|
|
* - :mc-cmd:`mc admin rebalance stop`
|
|
- Stops an in-progress rebalance operation.
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. mc-cmd:: start
|
|
:fullpath:
|
|
|
|
Start a rebalance operation for a MinIO deployment.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: EXAMPLES
|
|
|
|
Consider a MinIO deployment with two pools with an assigned alias of ``minio1``.
|
|
One pool has 250 GB of free space while the other pool has 3 TB of free space.
|
|
|
|
The :mc:`mc admin rebalance` command shifts objects from the pool with less free space to the pool with more free space so that there is roughly equal free space on both pools.
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin rebalance start minio1
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc [GLOBALFLAGS] admin rebalance start ALIAS
|
|
|
|
- Replace ALIAS with the :ref:`alias <alias>` of a MinIO deployment to rebalance.
|
|
|
|
.. mc-cmd:: status
|
|
:fullpath:
|
|
|
|
Queries the deployment with an active rebalance process and returns information about the status of the rebalance process.
|
|
|
|
The status returns the ID of the rebalance operation, the time of the operation, and details for each pool on the deployment.
|
|
For each pool, the status shows the pool ID, the pool's rebalance status, the percentage of used space, and rebalance progress for the pool.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: EXAMPLE
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin rebalance status minio1
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
|
|
mc [GLOBALFLAGS] admin rebalance ALIAS
|
|
|
|
- Replace ALIAS with the :ref:`alias <alias>` of the MinIO deployment.
|
|
|
|
.. mc-cmd:: stop
|
|
:fullpath:
|
|
|
|
Ends an in-progress rebalance job on the specified deployment.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: EXAMPLES
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc admin rebalance stop minio1
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
|
|
mc [GLOBALFLAGS] admin rebalance stop ALIAS
|
|
|
|
- Replace ALIAS with the :ref:`alias <alias>` of the MinIO deployment.
|
|
|
|
Global Flags
|
|
------------
|
|
|
|
.. include:: /includes/common-minio-mc.rst
|
|
:start-after: start-minio-mc-globals
|
|
:end-before: end-minio-mc-globals |