Add UBLK docs

2025-08-24 16:55:58 +03:00
parent 31b7021330
commit db63e58b3d
13 changed files with 146 additions and 49 deletions
@@ -25,6 +25,8 @@ affect their interaction with the cluster.
 - [nbd_max_part](#nbd_max_part)
 - [osd_nearfull_ratio](#osd_nearfull_ratio)
 - [hostname](#hostname)
+- [ublk_queue_depth](#ublk_queue_depth)
+- [ublk_max_io_size](#ublk_max_io_size)

 ## client_iothread_count

@@ -225,3 +227,17 @@ without destroying and recreating OSDs.
 Clients use host name to find their distance to OSDs when [localized reads](pool.en.md#local_reads)
 are enabled. By default, standard [gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html)
 function is used to determine host name, but you can also override it with this parameter.
+
+## ublk_queue_depth
+
+- Type: integer
+- Default: 256
+
+Default queue depth for [Vitastor ublk servers](../usage/ublk.en.md).
+
+## ublk_max_io_size
+
+- Type: integer
+
+Default maximum I/O size for Vitastor [ublk servers](../usage/ublk.en.md).
+The largest of 1 MB and pool block size multiplied by EC data chunk count is used if not specified.
@@ -25,6 +25,8 @@
 - [nbd_max_part](#nbd_max_part)
 - [osd_nearfull_ratio](#osd_nearfull_ratio)
 - [hostname](#hostname)
+- [ublk_queue_depth](#ublk_queue_depth)
+- [ublk_max_io_size](#ublk_max_io_size)

 ## client_iothread_count

@@ -230,3 +232,18 @@ RDMA и хотите повысить пиковую производитель
 [локальные чтения](pool.ru.md#local_reads). По умолчанию для определения имени
 хоста используется стандартная функция [gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html),
 но вы также можете задать имя хоста вручную данным параметром.
+
+## ublk_queue_depth
+
+- Тип: целое число
+- Значение по умолчанию: 256
+
+Глубина очереди по умолчанию для [ublk-серверов Vitastor](../usage/ublk.ru.md).
+
+## ublk_max_io_size
+
+- Тип: целое число
+
+Максимальный размер запроса ввода-вывода для [ublk-серверов Vitastor](../usage/ublk.ru.md).
+Если не задан, используется максимум из 1 МБ и размера блока пула, умноженного на число частей
+данных EC-пула.
@@ -283,3 +283,19 @@
    [локальные чтения](pool.ru.md#local_reads). По умолчанию для определения имени
    хоста используется стандартная функция [gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html),
    но вы также можете задать имя хоста вручную данным параметром.
+- name: ublk_queue_depth
+  type: int
+  default: 256
+  online: false
+  info: Default queue depth for [Vitastor ublk servers](../usage/ublk.en.md).
+  info_ru: Глубина очереди по умолчанию для [ublk-серверов Vitastor](../usage/ublk.ru.md).
+- name: ublk_max_io_size
+  type: int
+  online: false
+  info: |
+    Default maximum I/O size for Vitastor [ublk servers](../usage/ublk.en.md).
+    The largest of 1 MB and pool block size multiplied by EC data chunk count is used if not specified.
+  info_ru: |
+    Максимальный размер запроса ввода-вывода для [ublk-серверов Vitastor](../usage/ublk.ru.md).
+    Если не задан, используется максимум из 1 МБ и размера блока пула, умноженного на число частей
+    данных EC-пула.
@@ -24,6 +24,8 @@

 {{../../installation/kubernetes.en.md}}

+{{../../installation/s3.en.md}}
+
 {{../../installation/source.en.md}}

 {{../../config.en.md|indent=1}}
@@ -54,6 +56,8 @@

 {{../../usage/fio.en.md}}

+{{../../usage/ublk.en.md}}
+
 {{../../usage/nbd.en.md}}

 {{../../usage/qemu.en.md}}
@@ -26,6 +26,8 @@

 {{../../installation/source.ru.md}}

+{{../../installation/s3.ru.md}}
+
 {{../../config.ru.md|indent=1}}

 {{../../config/common.ru.md|indent=2}}
@@ -54,6 +56,8 @@

 {{../../usage/fio.ru.md}}

+{{../../usage/ublk.ru.md}}
+
 {{../../usage/nbd.ru.md}}

 {{../../usage/qemu.ru.md}}