From c10c90f6207646cd2e06fe2b6fa21fb5ed84497e Mon Sep 17 00:00:00 2001 From: Vitaliy Filippov Date: Thu, 14 Jul 2022 02:32:43 +0300 Subject: [PATCH] Swap cli.en.md and cli.ru.md contents O_o --- docs/usage/cli.en.md | 100 +++++++++++++++++++------------------------ docs/usage/cli.ru.md | 100 ++++++++++++++++++++++++------------------- 2 files changed, 100 insertions(+), 100 deletions(-) diff --git a/docs/usage/cli.en.md b/docs/usage/cli.en.md index 5328b1ac..cc94bed5 100644 --- a/docs/usage/cli.en.md +++ b/docs/usage/cli.en.md @@ -38,9 +38,9 @@ Global options: `vitastor-cli status` -Показать состояние кластера. +Show cluster status. -Пример вывода: +Example output: ``` cluster: @@ -65,9 +65,9 @@ Global options: `vitastor-cli df` -Показать список пулов и занятое место. +Show pool space statistics. -Пример вывода: +Example output: ``` NAME SCHEME PGS TOTAL USED AVAILABLE USED% EFFICIENCY @@ -76,27 +76,26 @@ size1 1/1 32 199.9 G 10 G 121.5 G 39.23% 100% kaveri 2/1 32 0 B 10 G 0 B 100% 0% ``` -В примере у пула "kaveri" эффективность равна нулю, так как все OSD выключены. +In the example above, "kaveri" pool has "zero" efficiency because all its OSD are down. ## ls `vitastor-cli ls [-l] [-p POOL] [--sort FIELD] [-r] [-n N] [ ...]` -Показать список образов, если переданы шаблоны ``, то только с именами, -соответствующими этим шаблонам (стандартные ФС-шаблоны с * и ?). +List images (only matching `` pattern(s) if passed). -Опции: +Options: ``` --p|--pool POOL Фильтровать образы по пулу (ID или имени) --l|--long Также выводить статистику занятого места и ввода-вывода ---del Также выводить статистику операций удаления ---sort FIELD Сортировать по заданному полю (name, size, used_size, _) --r|--reverse Сортировать в обратном порядке --n|--count N Показывать только первые N записей +-p|--pool POOL Filter images by pool ID or name +-l|--long Also report allocated size and I/O statistics +--del Also include delete operation statistics +--sort FIELD Sort by specified field (name, size, used_size, _) +-r|--reverse Sort in descending order +-n|--count N Only list first N items ``` -Пример вывода: +Example output: ``` NAME POOL SIZE USED READ IOPS QUEUE LAT WRITE IOPS QUEUE LAT FLAGS PARENT @@ -113,94 +112,85 @@ bench-kaveri kaveri 10 G 10 G 0 B/s 0 0 0 us 0 B/s 0 `vitastor-cli create -s|--size [-p|--pool ] [--parent [@]] ` -Создать образ. Для размера `` можно использовать суффиксы K/M/G/T (килобайт-мегабайт-гигабайт-терабайт). -Если указана опция `--parent`, создаётся клон образа. Родитель `[@]` должен быть -снимком (или просто немодифицируемым образом). Пул обязательно указывать, если в кластере больше одного пула. +Create an image. You may use K/M/G/T suffixes for ``. If `--parent` is specified, +a copy-on-write image clone is created. Parent must be a snapshot (readonly image). +Pool must be specified if there is more than one pool. ``` vitastor-cli create --snapshot [-p|--pool ] vitastor-cli snap-create [-p|--pool ] @ ``` -Создать снимок образа `` (можно использовать любую форму команды). Снимок можно создавать без остановки -клиентов, если пишущий клиент максимум 1. +Create a snapshot of image `` (either form can be used). May be used live if only a single writer is active. ## modify `vitastor-cli modify [--rename ] [--resize ] [--readonly | --readwrite] [-f|--force]` -Изменить размер, имя образа или флаг "только для чтения". Снимать флаг "только для чтения" -и уменьшать размер образов, у которых есть дочерние клоны, без `--force` нельзя. - -Если новый размер меньше старого, "лишние" данные будут удалены, поэтому перед уменьшением -образа сначала уменьшите файловую систему в нём. +Rename, resize image or change its readonly status. Images with children can't be made read-write. +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 Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны. +-f|--force Proceed with shrinking or setting readwrite flag even if the image has children. ``` ## rm `vitastor-cli rm [] [--writers-stopped]` -Удалить образ `` или все слои от `` до `` (`` должен быть дочерним -образом ``), одновременно меняя родительские образы их клонов (если таковые есть). - -`--writers-stopped` позволяет чуть более эффективно удалять образы в частом случае, когда -у удаляемой цепочки есть только один дочерний образ, содержащий небольшой объём данных. -В этом случае дочерний образ вливается в родительский и удаляется, а родительский -переименовывается в дочерний. - -В других случаях родительские слои вливаются в дочерние. +Remove `` or all layers between `` and `` (`` must be a child of ``), +rebasing all their children accordingly. --writers-stopped allows merging to be a bit +more effective in case of a single 'slim' read-write child and 'fat' removed parent: +the child is merged into parent and parent is renamed to child in that case. +In other cases parent layers are always merged into children. ## flatten `vitastor-cli flatten ` -Сделай образ `` плоским, то есть, скопировать в него данные и разорвать его -соединение с родительскими. +Flatten a layer, i.e. merge data and detach it from parents. ## rm-data `vitastor-cli rm-data --pool --inode [--wait-list] [--min-offset ]` -Удалить данные инода, не меняя метаданные образов. +Remove inode data without changing metadata. ``` ---wait-list Сначала запросить полный листинг объектов, а потом начать удалять. - Требует больше памяти, но позволяет правильно печатать прогресс удаления. ---min-offset Удалять только данные, начиная с заданного смещения. +--wait-list Retrieve full objects listings before starting to remove objects. + Requires more memory, but allows to show correct removal progress. +--min-offset Purge only data starting with specified offset. ``` ## merge-data `vitastor-cli merge-data [--target ]` -Слить данные слоёв, не меняя метаданные. Вливает данные из слоёв от `` до `` -в целевой образ ``. `` должен быть дочерним образом ``, а `` -должен быть одним из слоёв между `` и ``, включая сами `` и ``. +Merge layer data without changing metadata. Merge ``..`` to ``. +`` must be a child of `` and `` may be one of the layers between +`` and ``, including `` and ``. ## alloc-osd `vitastor-cli alloc-osd` -Атомарно выделить новый номер OSD и зарезервировать его, создав в etcd пустой -ключ `/osd/stats/`. +Allocate a new OSD number and reserve it by creating empty `/osd/stats/` key. ## simple-offsets `vitastor-cli simple-offsets ` -Рассчитать смещения для простого и тупого создания OSD на диске (без суперблока). +Calculate offsets for simple&stupid (no superblock) OSD deployment. -Опции (см. также [Дисковые параметры уровня кластера](../config/layout-cluster.ru.md)): +Options (see also [Cluster-Wide Disk Layout Parameters](../config/layout-cluster.en.md)): ``` ---object_size 128k Размер блока хранилища ---bitmap_granularity 4k Гранулярность битовых карт ---journal_size 32M Размер журнала ---device_block_size 4k Размер блока устройства ---journal_offset 0 Смещение журнала ---device_size 0 Размер устройства ---format text Формат результата: json, options, env или text +--object_size 128k Set blockstore block size +--bitmap_granularity 4k Set bitmap granularity +--journal_size 32M Set journal size +--device_block_size 4k Set device block size +--journal_offset 0 Set journal offset +--device_size 0 Set device size +--format text Result format: json, options, env, or text ``` diff --git a/docs/usage/cli.ru.md b/docs/usage/cli.ru.md index 8fbabdce..e71ba5f1 100644 --- a/docs/usage/cli.ru.md +++ b/docs/usage/cli.ru.md @@ -39,9 +39,9 @@ vitastor-cli - интерфейс командной строки для адм `vitastor-cli status` -Show cluster status. +Показать состояние кластера. -Example output: +Пример вывода: ``` cluster: @@ -66,9 +66,9 @@ Example output: `vitastor-cli df` -Show pool space statistics. +Показать список пулов и занятое место. -Example output: +Пример вывода: ``` NAME SCHEME PGS TOTAL USED AVAILABLE USED% EFFICIENCY @@ -77,26 +77,27 @@ size1 1/1 32 199.9 G 10 G 121.5 G 39.23% 100% kaveri 2/1 32 0 B 10 G 0 B 100% 0% ``` -In the example above, "kaveri" pool has "zero" efficiency because all its OSD are down. +В примере у пула "kaveri" эффективность равна нулю, так как все OSD выключены. ## ls `vitastor-cli ls [-l] [-p POOL] [--sort FIELD] [-r] [-n N] [ ...]` -List images (only matching `` pattern(s) if passed). +Показать список образов, если переданы шаблоны ``, то только с именами, +соответствующими этим шаблонам (стандартные ФС-шаблоны с * и ?). -Options: +Опции: ``` --p|--pool POOL Filter images by pool ID or name --l|--long Also report allocated size and I/O statistics ---del Also include delete operation statistics ---sort FIELD Sort by specified field (name, size, used_size, _) --r|--reverse Sort in descending order --n|--count N Only list first N items +-p|--pool POOL Фильтровать образы по пулу (ID или имени) +-l|--long Также выводить статистику занятого места и ввода-вывода +--del Также выводить статистику операций удаления +--sort FIELD Сортировать по заданному полю (name, size, used_size, _) +-r|--reverse Сортировать в обратном порядке +-n|--count N Показывать только первые N записей ``` -Example output: +Пример вывода: ``` NAME POOL SIZE USED READ IOPS QUEUE LAT WRITE IOPS QUEUE LAT FLAGS PARENT @@ -113,85 +114,94 @@ bench-kaveri kaveri 10 G 10 G 0 B/s 0 0 0 us 0 B/s 0 `vitastor-cli create -s|--size [-p|--pool ] [--parent [@]] ` -Create an image. You may use K/M/G/T suffixes for ``. If `--parent` is specified, -a copy-on-write image clone is created. Parent must be a snapshot (readonly image). -Pool must be specified if there is more than one pool. +Создать образ. Для размера `` можно использовать суффиксы K/M/G/T (килобайт-мегабайт-гигабайт-терабайт). +Если указана опция `--parent`, создаётся клон образа. Родитель `[@]` должен быть +снимком (или просто немодифицируемым образом). Пул обязательно указывать, если в кластере больше одного пула. ``` vitastor-cli create --snapshot [-p|--pool ] vitastor-cli snap-create [-p|--pool ] @ ``` -Create a snapshot of image `` (either form can be used). May be used live if only a single writer is active. +Создать снимок образа `` (можно использовать любую форму команды). Снимок можно создавать без остановки +клиентов, если пишущий клиент максимум 1. ## modify `vitastor-cli modify [--rename ] [--resize ] [--readonly | --readwrite] [-f|--force]` -Rename, resize image or change its readonly status. Images with children can't be made read-write. -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. +Изменить размер, имя образа или флаг "только для чтения". Снимать флаг "только для чтения" +и уменьшать размер образов, у которых есть дочерние клоны, без `--force` нельзя. + +Если новый размер меньше старого, "лишние" данные будут удалены, поэтому перед уменьшением +образа сначала уменьшите файловую систему в нём. ``` --f|--force Proceed with shrinking or setting readwrite flag even if the image has children. +-f|--force Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны. ``` ## rm `vitastor-cli rm [] [--writers-stopped]` -Remove `` or all layers between `` and `` (`` must be a child of ``), -rebasing all their children accordingly. --writers-stopped allows merging to be a bit -more effective in case of a single 'slim' read-write child and 'fat' removed parent: -the child is merged into parent and parent is renamed to child in that case. -In other cases parent layers are always merged into children. +Удалить образ `` или все слои от `` до `` (`` должен быть дочерним +образом ``), одновременно меняя родительские образы их клонов (если таковые есть). + +`--writers-stopped` позволяет чуть более эффективно удалять образы в частом случае, когда +у удаляемой цепочки есть только один дочерний образ, содержащий небольшой объём данных. +В этом случае дочерний образ вливается в родительский и удаляется, а родительский +переименовывается в дочерний. + +В других случаях родительские слои вливаются в дочерние. ## flatten `vitastor-cli flatten ` -Flatten a layer, i.e. merge data and detach it from parents. +Сделай образ `` плоским, то есть, скопировать в него данные и разорвать его +соединение с родительскими. ## rm-data `vitastor-cli rm-data --pool --inode [--wait-list] [--min-offset ]` -Remove inode data without changing metadata. +Удалить данные инода, не меняя метаданные образов. ``` ---wait-list Retrieve full objects listings before starting to remove objects. - Requires more memory, but allows to show correct removal progress. ---min-offset Purge only data starting with specified offset. +--wait-list Сначала запросить полный листинг объектов, а потом начать удалять. + Требует больше памяти, но позволяет правильно печатать прогресс удаления. +--min-offset Удалять только данные, начиная с заданного смещения. ``` ## merge-data `vitastor-cli merge-data [--target ]` -Merge layer data without changing metadata. Merge ``..`` to ``. -`` must be a child of `` and `` may be one of the layers between -`` and ``, including `` and ``. +Слить данные слоёв, не меняя метаданные. Вливает данные из слоёв от `` до `` +в целевой образ ``. `` должен быть дочерним образом ``, а `` +должен быть одним из слоёв между `` и ``, включая сами `` и ``. ## alloc-osd `vitastor-cli alloc-osd` -Allocate a new OSD number and reserve it by creating empty `/osd/stats/` key. +Атомарно выделить новый номер OSD и зарезервировать его, создав в etcd пустой +ключ `/osd/stats/`. ## simple-offsets `vitastor-cli simple-offsets ` -Calculate offsets for simple&stupid (no superblock) OSD deployment. +Рассчитать смещения для простого и тупого создания OSD на диске (без суперблока). -Options (see also [Cluster-Wide Disk Layout Parameters](../config/layout-cluster.en.md)): +Опции (см. также [Дисковые параметры уровня кластера](../config/layout-cluster.ru.md)): ``` ---object_size 128k Set blockstore block size ---bitmap_granularity 4k Set bitmap granularity ---journal_size 32M Set journal size ---device_block_size 4k Set device block size ---journal_offset 0 Set journal offset ---device_size 0 Set device size ---format text Result format: json, options, env, or text +--object_size 128k Размер блока хранилища +--bitmap_granularity 4k Гранулярность битовых карт +--journal_size 32M Размер журнала +--device_block_size 4k Размер блока устройства +--journal_offset 0 Смещение журнала +--device_size 0 Размер устройства +--format text Формат результата: json, options, env или text ```