vitalif
/
vitastor
5
4
Fork 9
Code Issues 1 Pull Requests 2 Actions Releases 69 Wiki Activity

Fix markdown tables

antietcd
Vitaliy Filippov 2024-03-16 14:12:47 +03:00
parent f12855c31b
commit 8807a1623b
7 changed files with 69 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/intro/features.en.md
View File

@ -14,7 +14,6 @@
- Basic part: highly-available block storage with symmetric clustering and no SPOF - Basic part: highly-available block storage with symmetric clustering and no SPOF
- [Performance](../performance/comparison1.en.md) ;-D - [Performance](../performance/comparison1.en.md) ;-D
- [Cluster file system](../usage/nfs.en.md#vitastorfs)
- [Multiple redundancy schemes](../config/pool.en.md#scheme): Replication, XOR n+1, Reed-Solomon erasure codes - [Multiple redundancy schemes](../config/pool.en.md#scheme): Replication, XOR n+1, Reed-Solomon erasure codes
based on jerasure and ISA-L libraries with any number of data and parity drives in a group based on jerasure and ISA-L libraries with any number of data and parity drives in a group
- Configuration via simple JSON data structures in etcd (parameters, pools and images) - Configuration via simple JSON data structures in etcd (parameters, pools and images)
@ -34,6 +33,7 @@
- [Checksums](../config/layout-osd.en.md#data_csum_type) - [Checksums](../config/layout-osd.en.md#data_csum_type)
- [Client write-back cache](../config/client.en.md#client_enable_writeback) - [Client write-back cache](../config/client.en.md#client_enable_writeback)
- [Intelligent recovery auto-tuning](../config/osd.en.md#recovery_tune_interval) - [Intelligent recovery auto-tuning](../config/osd.en.md#recovery_tune_interval)
- [Clustered file system](../usage/nfs.en.md#vitastorfs)
## Plugins and tools ## Plugins and tools

2
docs/intro/features.ru.md
View File

@ -14,7 +14,6 @@
- Базовая часть - надёжное кластерное блочное хранилище без единой точки отказа - Базовая часть - надёжное кластерное блочное хранилище без единой точки отказа
- [Производительность](../performance/comparison1.ru.md) ;-D - [Производительность](../performance/comparison1.ru.md) ;-D
- [Кластерная файловая система](../usage/nfs.ru.md#vitastorfs)
- [Несколько схем отказоустойчивости](../config/pool.ru.md#scheme): репликация, XOR n+1 (1 диск чётности), коды коррекции ошибок - [Несколько схем отказоустойчивости](../config/pool.ru.md#scheme): репликация, XOR n+1 (1 диск чётности), коды коррекции ошибок
Рида-Соломона на основе библиотек jerasure и ISA-L с любым числом дисков данных и чётности в группе Рида-Соломона на основе библиотек jerasure и ISA-L с любым числом дисков данных и чётности в группе
- Конфигурация через простые человекочитаемые JSON-структуры в etcd - Конфигурация через простые человекочитаемые JSON-структуры в etcd
@ -36,6 +35,7 @@
- [Контрольные суммы](../config/layout-osd.ru.md#data_csum_type) - [Контрольные суммы](../config/layout-osd.ru.md#data_csum_type)
- [Буферизация записи на стороне клиента](../config/client.ru.md#client_enable_writeback) - [Буферизация записи на стороне клиента](../config/client.ru.md#client_enable_writeback)
- [Интеллектуальная автоподстройка скорости восстановления](../config/osd.ru.md#recovery_tune_interval) - [Интеллектуальная автоподстройка скорости восстановления](../config/osd.ru.md#recovery_tune_interval)
- [Кластерная файловая система](../usage/nfs.ru.md#vitastorfs)
## Драйверы и инструменты ## Драйверы и инструменты

30
docs/usage/cli.en.md
View File

@ -141,8 +141,8 @@ Rename, resize image or change its readonly status. Images with children can't b
If the new size is smaller than the old size, extra data will be purged. If the new size is smaller than the old size, extra data will be purged.
You should resize file system in the image, if present, before shrinking it. You should resize file system in the image, if present, before shrinking it.
| `-f|--force` | Proceed with shrinking or setting readwrite flag even if the image has children. | * `-f|--force` - Proceed with shrinking or setting readwrite flag even if the image has children.
| `--down-ok` | Proceed with shrinking even if some data will be left on unavailable OSDs. | * `--down-ok` - Proceed with shrinking even if some data will be left on unavailable OSDs.
## rm ## rm
@ -156,7 +156,7 @@ In other cases parent layers are always merged into children.
Other options: Other options:
| `--down-ok` | Continue deletion/merging even if some data will be left on unavailable OSDs. | * `--down-ok` - Continue deletion/merging even if some data will be left on unavailable OSDs.
## flatten ## flatten
@ -252,12 +252,16 @@ redundancy degradation.
Create a pool. Required parameters: Create a pool. Required parameters:
| `-s|--pg_size R` | Number of replicas for replicated pools | | <!-- --> | <!-- --> |
| `--ec N+K` | Number of data (N) and parity (K) chunks for erasure-coded pools | |--------------------------|---------------------------------------------------------------------------------------|
| `-n|--pg_count N` | PG count for the new pool (start with 10*<OSD count>/pg_size rounded to a power of 2) | | `-s R` or `--pg_size R` | Number of replicas for replicated pools |
| `--ec N+K` | Number of data (N) and parity (K) chunks for erasure-coded pools |
| `-n N` or `--pg_count N` | PG count for the new pool (start with 10*<OSD count>/pg_size rounded to a power of 2) |
Optional parameters: Optional parameters:
| <!-- --> | <!-- --> |
|--------------------------------|----------------------------------------------------------------------------|
| `--pg_minsize <number>` | R or N+K minus number of failures to tolerate without downtime ([details](../config/pool.en.md#pg_minsize)) | | `--pg_minsize <number>` | R or N+K minus number of failures to tolerate without downtime ([details](../config/pool.en.md#pg_minsize)) |
| `--failure_domain host` | Failure domain: host, osd or a level from placement_levels. Default: host | | `--failure_domain host` | Failure domain: host, osd or a level from placement_levels. Default: host |
| `--root_node <node>` | Put pool only on child OSDs of this placement tree node | | `--root_node <node>` | Put pool only on child OSDs of this placement tree node |
@ -271,7 +275,7 @@ Optional parameters:
| `--pg_stripe_size <number>` | Increase object grouping stripe | | `--pg_stripe_size <number>` | Increase object grouping stripe |
| `--max_osd_combinations 10000` | Maximum number of random combinations for LP solver input | | `--max_osd_combinations 10000` | Maximum number of random combinations for LP solver input |
| `--wait` | Wait for the new pool to come online | | `--wait` | Wait for the new pool to come online |
| `-f|--force` | Do not check that cluster has enough OSDs to create the pool | | `-f` or `--force` | Do not check that cluster has enough OSDs to create the pool |
See also [Pool configuration](../config/pool.en.md) for detailed parameter descriptions. See also [Pool configuration](../config/pool.en.md) for detailed parameter descriptions.
@ -322,8 +326,10 @@ Remove a pool. Refuses to remove pools with images without `--force`.
List pools (only matching <glob> patterns if passed). List pools (only matching <glob> patterns if passed).
| `-l|--long` | Also report I/O statistics | | <!-- --> | <!-- --> |
| `--detail` | Use list format (not table), show all details | |----------------------|-------------------------------------------------------|
| `--sort FIELD` | Sort by specified field (see fields in --json output) | | `-l` or `--long` | Also report I/O statistics |
| `-r|--reverse` | Sort in descending order | | `--detail` | Use list format (not table), show all details |
| `-n|--count N` | Only list first N items | | `--sort FIELD` | Sort by specified field (see fields in --json output) |
| `-r` or `--reverse` | Sort in descending order |
| `-n` or `--count N` | Only list first N items |

30
docs/usage/cli.ru.md
View File

@ -144,8 +144,8 @@ vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
Если новый размер меньше старого, "лишние" данные будут удалены, поэтому перед уменьшением Если новый размер меньше старого, "лишние" данные будут удалены, поэтому перед уменьшением
образа сначала уменьшите файловую систему в нём. образа сначала уменьшите файловую систему в нём.
| -f|--force | Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны. | * `-f|--force` - Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны.
| --down-ok | Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD. | * `--down-ok` - Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD.
## rm ## rm
@ -163,7 +163,7 @@ vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
Другие опции: Другие опции:
| `--down-ok` | Продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD. | * `--down-ok` - Продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD.
## flatten ## flatten
@ -269,12 +269,16 @@ vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
Создать пул. Обязательные параметры: Создать пул. Обязательные параметры:
| `-s|--pg_size R` | Число копий данных для реплицированных пулов | | <!-- --> | <!-- --> |
| `--ec N+K` | Число частей данных (N) и чётности (K) для пулов с кодами коррекции ошибок | |---------------------------|---------------------------------------------------------------------------------------------|
| `-n|--pg_count N` | Число PG для нового пула (начните с 10*<число OSD>/pg_size, округлённого до степени двойки) | | `-s R` или `--pg_size R` | Число копий данных для реплицированных пулов |
| `--ec N+K` | Число частей данных (N) и чётности (K) для пулов с кодами коррекции ошибок |
| `-n N` или `--pg_count N` | Число PG для нового пула (начните с 10*<число OSD>/pg_size, округлённого до степени двойки) |
Необязательные параметры: Необязательные параметры:
| <!-- --> | <!-- --> |
|--------------------------------|----------------------------------------------------------------------------|
| `--pg_minsize <number>` | (R или N+K) минус число разрешённых отказов без остановки пула ([подробнее](../config/pool.ru.md#pg_minsize)) | | `--pg_minsize <number>` | (R или N+K) минус число разрешённых отказов без остановки пула ([подробнее](../config/pool.ru.md#pg_minsize)) |
| `--failure_domain host` | Домен отказа: host, osd или другой из placement_levels. По умолчанию: host | | `--failure_domain host` | Домен отказа: host, osd или другой из placement_levels. По умолчанию: host |
| `--root_node <node>` | Использовать для пула только дочерние OSD этого узла дерева размещения | | `--root_node <node>` | Использовать для пула только дочерние OSD этого узла дерева размещения |
@ -287,7 +291,7 @@ vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
| `--pg_stripe_size <number>` | Увеличить блок группировки объектов по PG | | `--pg_stripe_size <number>` | Увеличить блок группировки объектов по PG |
| `--max_osd_combinations 10000` | Максимальное число случайных комбинаций OSD для ЛП-солвера | | `--max_osd_combinations 10000` | Максимальное число случайных комбинаций OSD для ЛП-солвера |
| `--wait` | Подождать, пока новый пул будет активирован | | `--wait` | Подождать, пока новый пул будет активирован |
| `-f|--force` | Не проверять, что в кластере достаточно доменов отказа для создания пула | | `-f` или `--force` | Не проверять, что в кластере достаточно доменов отказа для создания пула |
Подробно о параметрах см. [Конфигурация пулов](../config/pool.ru.md). Подробно о параметрах см. [Конфигурация пулов](../config/pool.ru.md).
@ -339,8 +343,10 @@ vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
Показать список пулов. Если передан(ы) шаблон(ы) `<glob>`, то только с именами, Показать список пулов. Если передан(ы) шаблон(ы) `<glob>`, то только с именами,
соответствующими одному из шаблонов (стандартные ФС-шаблоны с * и ?). соответствующими одному из шаблонов (стандартные ФС-шаблоны с * и ?).
| `-l|--long` | Вывести также статистику ввода-вывода | | <!-- --> | <!-- --> |
| `--detail` | Максимально подробный вывод в виде списка (а не таблицы) | |-----------------------|------------------------------------------------------------|
| `--sort FIELD` | Сортировать по заданному полю (поля см. в выводе с --json) | | `-l` или `--long` | Вывести также статистику ввода-вывода |
| `-r|--reverse` | Сортировать в обратном порядке | | `--detail` | Максимально подробный вывод в виде списка (а не таблицы) |
| `-n|--count N` | Выводить только первые N записей | | `--sort FIELD` | Сортировать по заданному полю (поля см. в выводе с --json) |
| `-r` или `--reverse` | Сортировать в обратном порядке |
| `-n` или `--count N` | Выводить только первые N записей |

26
docs/usage/nfs.en.md
View File

@ -125,7 +125,7 @@ Use regular `umount <MOUNTPOINT>` to unmount the FS.
The server will be automatically stopped when the FS is unmounted. The server will be automatically stopped when the FS is unmounted.
| `-o|--options <OPT>` | Pass additional NFS mount options (ex.: -o async). | - `-o|--options <OPT>` - Pass additional NFS mount options (ex.: -o async).
### start ### start
@ -133,17 +133,21 @@ The server will be automatically stopped when the FS is unmounted.
Start network NFS server. Options: Start network NFS server. Options:
| `--bind <IP>` | bind service to <IP> address (default 0.0.0.0) | | <!-- --> | <!-- --> |
| `--port <PORT>` | use port <PORT> for NFS services (default is 2049) | |-----------------|------------------------------------------------------------|
| `--bind <IP>` | bind service to \<IP> address (default 0.0.0.0) |
| `--port <PORT>` | use port \<PORT> for NFS services (default is 2049) |
| `--portmap 0` | do not listen on port 111 (portmap/rpcbind, requires root) | | `--portmap 0` | do not listen on port 111 (portmap/rpcbind, requires root) |
## Common options ## Common options
| `--fs <NAME>` | use VitastorFS with metadata in image <NAME> | | <!-- --> | <!-- --> |
| `--block` | use pseudo-FS presenting images as files | |--------------------|----------------------------------------------------------|
| `--pool <POOL>` | use <POOL> as default pool for new files | | `--fs <NAME>` | use VitastorFS with metadata in image \<NAME> |
| `--subdir <DIR>` | export <DIR> instead of root directory | | `--block` | use pseudo-FS presenting images as files |
| `--nfspath <PATH>` | set NFS export path to <PATH> (default is /) | | `--pool <POOL>` | use \<POOL> as default pool for new files |
| `--pidfile <FILE>` | write process ID to the specified file | | `--subdir <DIR>` | export \<DIR> instead of root directory (pseudo-FS only) |
| `--logfile <FILE>` | log to the specified file | | `--nfspath <PATH>` | set NFS export path to \<PATH> (default is /) |
| `--foreground 1` | stay in foreground, do not daemonize | | `--pidfile <FILE>` | write process ID to the specified file |
| `--logfile <FILE>` | log to the specified file |
| `--foreground 1` | stay in foreground, do not daemonize |

26
docs/usage/nfs.ru.md
View File

@ -131,7 +131,7 @@ JSON-формате :-). Для инспекции содержимого БД
Сервер автоматически останавливается при отмонтировании ФС. Сервер автоматически останавливается при отмонтировании ФС.
| `-o|--options <OPT>` | Передать дополнительные опции монтирования NFS (пример: -o async). | - `-o|--options <OPT>` - Передать дополнительные опции монтирования NFS (пример: -o async).
### start ### start
@ -139,17 +139,21 @@ JSON-формате :-). Для инспекции содержимого БД
Запустить сетевой NFS-сервер. Опции: Запустить сетевой NFS-сервер. Опции:
| `--bind <IP>` | принимать соединения по адресу <IP> (по умолчанию 0.0.0.0 - на всех) | | <!-- --> | <!-- --> |
| `--port <PORT>` | использовать порт <PORT> для NFS-сервисов (по умолчанию 2049) | |-----------------|-----------------------------------------------------------------------|
| `--bind <IP>` | принимать соединения по адресу \<IP> (по умолчанию 0.0.0.0 - на всех) |
| `--port <PORT>` | использовать порт \<PORT> для NFS-сервисов (по умолчанию 2049) |
| `--portmap 0` | отключить сервис portmap/rpcbind на порту 111 (по умолчанию включён и требует root привилегий) | | `--portmap 0` | отключить сервис portmap/rpcbind на порту 111 (по умолчанию включён и требует root привилегий) |
## Общие опции ## Общие опции
| `--fs <NAME>` | использовать VitastorFS с метаданными в образе <NAME> | | <!-- --> | <!-- --> |
| `--block` | использовать псевдо-ФС для доступа к блочным образам | |--------------------|---------------------------------------------------------|
| `--pool <POOL>` | использовать пул <POOL> для новых файлов (обязательно, если пул в кластере не один) | | `--fs <NAME>` | использовать VitastorFS с метаданными в образе \<NAME> |
| `--subdir <DIR>` | экспортировать подкаталог <DIR>, а не корень ФС | | `--block` | использовать псевдо-ФС для доступа к блочным образам |
| `--nfspath <PATH>` | установить путь NFS-экспорта в <PATH> (по умолчанию /) | | `--pool <POOL>` | использовать пул \<POOL> для новых файлов (обязательно, если пул в кластере не один) |
| `--pidfile <FILE>` | записать ID процесса в заданный файл | | `--subdir <DIR>` | экспортировать подкаталог \<DIR>, а не корень (только для псевдо-ФС) |
| `--logfile <FILE>` | записывать логи в заданный файл | | `--nfspath <PATH>` | установить путь NFS-экспорта в \<PATH> (по умолчанию /) |
| `--foreground 1` | не уходить в фон после запуска | | `--pidfile <FILE>` | записать ID процесса в заданный файл |
| `--logfile <FILE>` | записывать логи в заданный файл |
| `--foreground 1` | не уходить в фон после запуска |

2
src/nfs_proxy.cpp
View File

@ -74,7 +74,7 @@ static const char* help_text =
" --fs <NAME> use VitastorFS with metadata in image <NAME>\n" " --fs <NAME> use VitastorFS with metadata in image <NAME>\n"
" --block use pseudo-FS presenting images as files\n" " --block use pseudo-FS presenting images as files\n"
" --pool <POOL> use <POOL> as default pool for new files\n" " --pool <POOL> use <POOL> as default pool for new files\n"
" --subdir <DIR> export <DIR> instead of root directory\n" " --subdir <DIR> export <DIR> instead of root directory (pseudo-FS only)\n"
" --nfspath <PATH> set NFS export path to <PATH> (default is /)\n" " --nfspath <PATH> set NFS export path to <PATH> (default is /)\n"
" --pidfile <FILE> write process ID to the specified file\n" " --pidfile <FILE> write process ID to the specified file\n"
" --logfile <FILE> log to the specified file\n" " --logfile <FILE> log to the specified file\n"