From 7d705fceaeff21d653e62a1f3cef66c12c70e5c8 Mon Sep 17 00:00:00 2001 From: tushargite96 Date: Thu, 3 Sep 2020 12:59:14 +0530 Subject: [PATCH] Basic volume QoS doc. The Cinder Basic volume quality of service documentation does not provide enough information to understand difference between options to control volume quality of service. These option can categorized into fixed and burst IOPS per volume and fixed and burst bandwidth per volume. Change-Id: Ia4533185fece4576640968e91c0112add7ce73ae Closes-Bug: #1894052 --- .../admin/blockstorage-basic-volume-qos.rst | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/doc/source/admin/blockstorage-basic-volume-qos.rst b/doc/source/admin/blockstorage-basic-volume-qos.rst index d1af7e38168..27bd14a996b 100644 --- a/doc/source/admin/blockstorage-basic-volume-qos.rst +++ b/doc/source/admin/blockstorage-basic-volume-qos.rst @@ -12,18 +12,32 @@ As of the 13.0.0 Rocky release, Cinder supports the following options to control volume quality of service, the values of which should be fairly self-explanatory: +For Fixed IOPS per volume. + * `read_iops_sec` * `write_iops_sec` * `total_iops_sec` -* `read_bytes_sec` -* `write_bytes_sec` -* `total_bytes_sec` + +For Burst IOPS per volume. + * `read_iops_sec_max` * `write_iops_sec_max` * `total_iops_sec_max` + +For Fixed bandwidth per volume. + +* `read_bytes_sec` +* `write_bytes_sec` +* `total_bytes_sec` + +For Burst bandwidth per volume. + * `read_bytes_sec_max` * `write_bytes_sec_max` * `total_bytes_sec_max` + +For burst bucket size. + * `size_iops_sec` Note that the `total_*` and `total_*_max` options for both iops and bytes