From a4909655b0acd9aa1d5ed49a0b96cfef9f9ea1fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20N=C3=A4gele?= Date: Sat, 4 Sep 2021 00:04:51 +0200 Subject: [PATCH] docs: add mc admin speedtest documentation Co-authored-by: Ravind Kumar --- source/reference/minio-cli/minio-mc-admin.rst | 5 ++ .../minio-mc-admin/mc-admin-speedtest.rst | 68 +++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 source/reference/minio-cli/minio-mc-admin/mc-admin-speedtest.rst diff --git a/source/reference/minio-cli/minio-mc-admin.rst b/source/reference/minio-cli/minio-mc-admin.rst index 3fd8b2e1..374cf17d 100644 --- a/source/reference/minio-cli/minio-mc-admin.rst +++ b/source/reference/minio-cli/minio-mc-admin.rst @@ -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 diff --git a/source/reference/minio-cli/minio-mc-admin/mc-admin-speedtest.rst b/source/reference/minio-cli/minio-mc-admin/mc-admin-speedtest.rst new file mode 100644 index 00000000..8feb9b09 --- /dev/null +++ b/source/reference/minio-cli/minio-mc-admin/mc-admin-speedtest.rst @@ -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 ` 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``.