diff --git a/docs/intro/features.en.md b/docs/intro/features.en.md index 432a5bad..26beaa6c 100644 --- a/docs/intro/features.en.md +++ b/docs/intro/features.en.md @@ -14,7 +14,6 @@ - Basic part: highly-available block storage with symmetric clustering and no SPOF - [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 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) @@ -34,6 +33,7 @@ - [Checksums](../config/layout-osd.en.md#data_csum_type) - [Client write-back cache](../config/client.en.md#client_enable_writeback) - [Intelligent recovery auto-tuning](../config/osd.en.md#recovery_tune_interval) +- [Clustered file system](../usage/nfs.en.md#vitastorfs) ## Plugins and tools diff --git a/docs/intro/features.ru.md b/docs/intro/features.ru.md index 7db765c4..a4a03175 100644 --- a/docs/intro/features.ru.md +++ b/docs/intro/features.ru.md @@ -14,7 +14,6 @@ - Базовая часть - надёжное кластерное блочное хранилище без единой точки отказа - [Производительность](../performance/comparison1.ru.md) ;-D -- [Кластерная файловая система](../usage/nfs.ru.md#vitastorfs) - [Несколько схем отказоустойчивости](../config/pool.ru.md#scheme): репликация, XOR n+1 (1 диск чётности), коды коррекции ошибок Рида-Соломона на основе библиотек jerasure и ISA-L с любым числом дисков данных и чётности в группе - Конфигурация через простые человекочитаемые JSON-структуры в etcd @@ -36,6 +35,7 @@ - [Контрольные суммы](../config/layout-osd.ru.md#data_csum_type) - [Буферизация записи на стороне клиента](../config/client.ru.md#client_enable_writeback) - [Интеллектуальная автоподстройка скорости восстановления](../config/osd.ru.md#recovery_tune_interval) +- [Кластерная файловая система](../usage/nfs.ru.md#vitastorfs) ## Драйверы и инструменты diff --git a/docs/usage/cli.en.md b/docs/usage/cli.en.md index bcf46076..41ed6f47 100644 --- a/docs/usage/cli.en.md +++ b/docs/usage/cli.en.md @@ -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. 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. | -| `--down-ok` | Proceed with shrinking even if some data will be left on unavailable OSDs. | +* `-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. ## rm @@ -156,7 +156,7 @@ In other cases parent layers are always merged into children. 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 @@ -252,12 +252,16 @@ redundancy degradation. 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*/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*/pg_size rounded to a power of 2) | Optional parameters: +| | | +|--------------------------------|----------------------------------------------------------------------------| | `--pg_minsize ` | 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 | | `--root_node ` | Put pool only on child OSDs of this placement tree node | @@ -271,7 +275,7 @@ Optional parameters: | `--pg_stripe_size ` | Increase object grouping stripe | | `--max_osd_combinations 10000` | Maximum number of random combinations for LP solver input | | `--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. @@ -322,8 +326,10 @@ Remove a pool. Refuses to remove pools with images without `--force`. List pools (only matching 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) | -| `-r|--reverse` | Sort in descending order | -| `-n|--count N` | Only list first N items | +| | | +|----------------------|-------------------------------------------------------| +| `-l` or `--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) | +| `-r` or `--reverse` | Sort in descending order | +| `-n` or `--count N` | Only list first N items | diff --git a/docs/usage/cli.ru.md b/docs/usage/cli.ru.md index 71bc22b2..bfc8c3dd 100644 --- a/docs/usage/cli.ru.md +++ b/docs/usage/cli.ru.md @@ -144,8 +144,8 @@ vitastor-cli snap-create [-p|--pool ] @ Если новый размер меньше старого, "лишние" данные будут удалены, поэтому перед уменьшением образа сначала уменьшите файловую систему в нём. -| -f|--force | Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны. | -| --down-ok | Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD. | +* `-f|--force` - Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны. +* `--down-ok` - Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD. ## rm @@ -163,7 +163,7 @@ vitastor-cli snap-create [-p|--pool ] @ Другие опции: -| `--down-ok` | Продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD. | +* `--down-ok` - Продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD. ## flatten @@ -269,12 +269,16 @@ vitastor-cli snap-create [-p|--pool ] @ Создать пул. Обязательные параметры: -| `-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 ` | (R или N+K) минус число разрешённых отказов без остановки пула ([подробнее](../config/pool.ru.md#pg_minsize)) | | `--failure_domain host` | Домен отказа: host, osd или другой из placement_levels. По умолчанию: host | | `--root_node ` | Использовать для пула только дочерние OSD этого узла дерева размещения | @@ -287,7 +291,7 @@ vitastor-cli snap-create [-p|--pool ] @ | `--pg_stripe_size ` | Увеличить блок группировки объектов по PG | | `--max_osd_combinations 10000` | Максимальное число случайных комбинаций OSD для ЛП-солвера | | `--wait` | Подождать, пока новый пул будет активирован | -| `-f|--force` | Не проверять, что в кластере достаточно доменов отказа для создания пула | +| `-f` или `--force` | Не проверять, что в кластере достаточно доменов отказа для создания пула | Подробно о параметрах см. [Конфигурация пулов](../config/pool.ru.md). @@ -339,8 +343,10 @@ vitastor-cli snap-create [-p|--pool ] @ Показать список пулов. Если передан(ы) шаблон(ы) ``, то только с именами, соответствующими одному из шаблонов (стандартные ФС-шаблоны с * и ?). -| `-l|--long` | Вывести также статистику ввода-вывода | -| `--detail` | Максимально подробный вывод в виде списка (а не таблицы) | -| `--sort FIELD` | Сортировать по заданному полю (поля см. в выводе с --json) | -| `-r|--reverse` | Сортировать в обратном порядке | -| `-n|--count N` | Выводить только первые N записей | +| | | +|-----------------------|------------------------------------------------------------| +| `-l` или `--long` | Вывести также статистику ввода-вывода | +| `--detail` | Максимально подробный вывод в виде списка (а не таблицы) | +| `--sort FIELD` | Сортировать по заданному полю (поля см. в выводе с --json) | +| `-r` или `--reverse` | Сортировать в обратном порядке | +| `-n` или `--count N` | Выводить только первые N записей | diff --git a/docs/usage/nfs.en.md b/docs/usage/nfs.en.md index 294e6a58..9fb986e4 100644 --- a/docs/usage/nfs.en.md +++ b/docs/usage/nfs.en.md @@ -125,7 +125,7 @@ Use regular `umount ` to unmount the FS. The server will be automatically stopped when the FS is unmounted. -| `-o|--options ` | Pass additional NFS mount options (ex.: -o async). | +- `-o|--options ` - Pass additional NFS mount options (ex.: -o async). ### start @@ -133,17 +133,21 @@ The server will be automatically stopped when the FS is unmounted. Start network NFS server. Options: -| `--bind ` | bind service to address (default 0.0.0.0) | -| `--port ` | use port for NFS services (default is 2049) | +| | | +|-----------------|------------------------------------------------------------| +| `--bind ` | bind service to \ address (default 0.0.0.0) | +| `--port ` | use port \ for NFS services (default is 2049) | | `--portmap 0` | do not listen on port 111 (portmap/rpcbind, requires root) | ## Common options -| `--fs ` | use VitastorFS with metadata in image | -| `--block` | use pseudo-FS presenting images as files | -| `--pool ` | use as default pool for new files | -| `--subdir ` | export instead of root directory | -| `--nfspath ` | set NFS export path to (default is /) | -| `--pidfile ` | write process ID to the specified file | -| `--logfile ` | log to the specified file | -| `--foreground 1` | stay in foreground, do not daemonize | +| | | +|--------------------|----------------------------------------------------------| +| `--fs ` | use VitastorFS with metadata in image \ | +| `--block` | use pseudo-FS presenting images as files | +| `--pool ` | use \ as default pool for new files | +| `--subdir ` | export \ instead of root directory (pseudo-FS only) | +| `--nfspath ` | set NFS export path to \ (default is /) | +| `--pidfile ` | write process ID to the specified file | +| `--logfile ` | log to the specified file | +| `--foreground 1` | stay in foreground, do not daemonize | diff --git a/docs/usage/nfs.ru.md b/docs/usage/nfs.ru.md index 51d089ff..6b0b397a 100644 --- a/docs/usage/nfs.ru.md +++ b/docs/usage/nfs.ru.md @@ -131,7 +131,7 @@ JSON-формате :-). Для инспекции содержимого БД Сервер автоматически останавливается при отмонтировании ФС. -| `-o|--options ` | Передать дополнительные опции монтирования NFS (пример: -o async). | +- `-o|--options ` - Передать дополнительные опции монтирования NFS (пример: -o async). ### start @@ -139,17 +139,21 @@ JSON-формате :-). Для инспекции содержимого БД Запустить сетевой NFS-сервер. Опции: -| `--bind ` | принимать соединения по адресу (по умолчанию 0.0.0.0 - на всех) | -| `--port ` | использовать порт для NFS-сервисов (по умолчанию 2049) | +| | | +|-----------------|-----------------------------------------------------------------------| +| `--bind ` | принимать соединения по адресу \ (по умолчанию 0.0.0.0 - на всех) | +| `--port ` | использовать порт \ для NFS-сервисов (по умолчанию 2049) | | `--portmap 0` | отключить сервис portmap/rpcbind на порту 111 (по умолчанию включён и требует root привилегий) | ## Общие опции -| `--fs ` | использовать VitastorFS с метаданными в образе | -| `--block` | использовать псевдо-ФС для доступа к блочным образам | -| `--pool ` | использовать пул для новых файлов (обязательно, если пул в кластере не один) | -| `--subdir ` | экспортировать подкаталог , а не корень ФС | -| `--nfspath ` | установить путь NFS-экспорта в (по умолчанию /) | -| `--pidfile ` | записать ID процесса в заданный файл | -| `--logfile ` | записывать логи в заданный файл | -| `--foreground 1` | не уходить в фон после запуска | +| | | +|--------------------|---------------------------------------------------------| +| `--fs ` | использовать VitastorFS с метаданными в образе \ | +| `--block` | использовать псевдо-ФС для доступа к блочным образам | +| `--pool ` | использовать пул \ для новых файлов (обязательно, если пул в кластере не один) | +| `--subdir ` | экспортировать подкаталог \, а не корень (только для псевдо-ФС) | +| `--nfspath ` | установить путь NFS-экспорта в \ (по умолчанию /) | +| `--pidfile ` | записать ID процесса в заданный файл | +| `--logfile ` | записывать логи в заданный файл | +| `--foreground 1` | не уходить в фон после запуска | diff --git a/src/nfs_proxy.cpp b/src/nfs_proxy.cpp index 40ed48b1..dfbc538d 100644 --- a/src/nfs_proxy.cpp +++ b/src/nfs_proxy.cpp @@ -74,7 +74,7 @@ static const char* help_text = " --fs use VitastorFS with metadata in image \n" " --block use pseudo-FS presenting images as files\n" " --pool use as default pool for new files\n" - " --subdir export instead of root directory\n" + " --subdir export instead of root directory (pseudo-FS only)\n" " --nfspath set NFS export path to (default is /)\n" " --pidfile write process ID to the specified file\n" " --logfile log to the specified file\n"