mirror of
https://github.com/minio/docs.git
synced 2025-07-28 19:42:10 +03:00
docs: add mc admin speedtest documentation
Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
This commit is contained in:
@ -90,6 +90,11 @@ The following table lists :mc-cmd:`mc admin` commands:
|
||||
:start-after: start-mc-admin-service-desc
|
||||
:end-before: end-mc-admin-service-desc
|
||||
|
||||
* - :mc:`mc admin speedtest`
|
||||
- .. include:: /reference/minio-cli/minio-mc-admin/mc-admin-speedtest.rst
|
||||
:start-after: start-mc-admin-speedtest-desc
|
||||
:end-before: end-mc-admin-speedtest-desc
|
||||
|
||||
* - :mc:`mc admin tier`
|
||||
- .. include:: /reference/minio-cli/minio-mc-admin/mc-admin-tier.rst
|
||||
:start-after: start-mc-admin-tier-desc
|
||||
|
@ -0,0 +1,68 @@
|
||||
======================
|
||||
``mc admin speedtest``
|
||||
======================
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
.. contents:: Table of Contents
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. mc:: mc admin speedtest
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
.. start-mc-admin-speedtest-desc
|
||||
|
||||
The :mc-cmd:`mc admin speedtest` command tests throughputs per host with ``PUT``
|
||||
and ``GET`` operations.
|
||||
|
||||
.. end-mc-admin-speedtest-desc
|
||||
|
||||
:mc-cmd:`~mc admin speedtest` is available starting with ``mc``
|
||||
:mc-release:`RELEASE.2021-09-02T09-21-27Z` and supports distributed MinIO
|
||||
deployments running :minio-release:`RELEASE.2021-07-30T00-02-00Z` or later.
|
||||
|
||||
:mc-cmd:`~mc admin speedtest` does not support standalone or MinIO Gateway
|
||||
deployments.
|
||||
|
||||
.. 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
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
||||
:mc-cmd:`mc admin speedtest` has the following syntax:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc admin speedtest [FLAGS] TARGET
|
||||
|
||||
:mc-cmd:`mc admin speedtest` supports the following arguments:
|
||||
|
||||
.. mc-cmd:: TARGET
|
||||
|
||||
*Required*
|
||||
|
||||
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment to run the speedtest against.
|
||||
|
||||
.. mc-cmd:: duration
|
||||
:option:
|
||||
|
||||
The duration the entire speedtests are run. Defaults to ``10s``.
|
||||
|
||||
.. mc-cmd:: size
|
||||
:option:
|
||||
|
||||
The size of the objects used for uploads/downloads. Defaults to ``64MiB``.
|
||||
|
||||
.. mc-cmd:: concurrent
|
||||
:option:
|
||||
|
||||
The number of concurrent requests per server. Defaults to ``32``.
|
Reference in New Issue
Block a user