vitalif
/
vitastor
5
4
Fork 9
Code Issues 1 Pull Requests 2 Actions Releases 69 Wiki Activity
vitastor/docs/usage/cli.ru.md

19 KiB
Raw Permalink Blame History

Документация → Использование → Консольный интерфейс Vitastor

Read in English

Консольный интерфейс Vitastor

vitastor-cli - интерфейс командной строки для административных задач, таких, как управление образами дисков.

Поддерживаются следующие команды:

Глобальные опции:

--config_file FILE   Путь к файлу конфигурации Vitastor
--etcd_address URL   Адрес соединения с etcd
--iodepth N          Отправлять параллельно N операций на каждый OSD (по умолчанию 32)
--parallel_osds M    Работать параллельно с M OSD (по умолчанию 4)
--progress 1|0       Печатать прогресс выполнения (по умолчанию 1)
--cas 1|0            Для команд flatten, merge, rm - использовать CAS при записи (по умолчанию - решение принимается автоматически)
--no-color           Отключить цветной вывод
--json               Включить JSON-вывод

status

vitastor-cli status

Показать состояние кластера.

Пример вывода:

  cluster:
    etcd: 1 / 1 up, 1.8 M database size
    mon:  1 up, master stump
    osd:  8 / 12 up

  data:
    raw:   498.5 G used, 301.2 G / 799.7 G available, 399.8 G down
    state: 156.6 G clean, 97.6 G misplaced
    pools: 2 / 3 active
    pgs:   30 active
           34 active+has_misplaced
           32 offline

  io:
    client:    0 B/s rd, 0 op/s rd, 0 B/s wr, 0 op/s wr
    rebalance: 989.8 M/s, 7.9 K op/s

df

vitastor-cli df

Показать список пулов и занятое место.

Пример вывода:

NAME      SCHEME  PGS  TOTAL    USED    AVAILABLE  USED%   EFFICIENCY
testpool  2/1     32   100 G    34.2 G  60.7 G     39.23%  100%
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 выключены.

ls

vitastor-cli ls [-l] [-p POOL] [--sort FIELD] [-r] [-n N] [<glob> ...]

Показать список образов, если передан(ы) шаблон(ы) <glob>, то только с именами, соответствующими одному из шаблонов (стандартные ФС-шаблоны с * и ?).

Опции:

-p|--pool POOL  Фильтровать образы по пулу (ID или имени)
-l|--long       Также выводить статистику занятого места и ввода-вывода
--del           Также выводить статистику операций удаления
--sort FIELD    Сортировать по заданному полю (name, size, used_size, <read|write|delete>_<iops|bps|lat|queue>)
-r|--reverse    Сортировать в обратном порядке
-n|--count N    Показывать только первые N записей

Пример вывода:

NAME                 POOL      SIZE  USED    READ   IOPS  QUEUE  LAT   WRITE  IOPS  QUEUE  LAT   FLAGS  PARENT
debian9              testpool  20 G  12.3 G  0 B/s  0     0      0 us  0 B/s  0     0      0 us     RO
pve/vm-100-disk-0    testpool  20 G  0 B     0 B/s  0     0      0 us  0 B/s  0     0      0 us      -  debian9
pve/base-101-disk-0  testpool  20 G  0 B     0 B/s  0     0      0 us  0 B/s  0     0      0 us     RO  debian9
pve/vm-102-disk-0    testpool  32 G  36.4 M  0 B/s  0     0      0 us  0 B/s  0     0      0 us      -  pve/base-101-disk-0
debian9-test         testpool  20 G  36.6 M  0 B/s  0     0      0 us  0 B/s  0     0      0 us      -  debian9
bench                testpool  10 G  10 G    0 B/s  0     0      0 us  0 B/s  0     0      0 us      -
bench-kaveri         kaveri    10 G  10 G    0 B/s  0     0      0 us  0 B/s  0     0      0 us      -

create

vitastor-cli create -s|--size <size> [-p|--pool <id|name>] [--parent <parent_name>[@<snapshot>]] <name>

Создать образ. Для размера <size> можно использовать суффиксы K/M/G/T (килобайт-мегабайт-гигабайт-терабайт). Если указана опция --parent, создаётся клон образа. Родитель <parent_name>[@<snapshot>] должен быть снимком (или просто немодифицируемым образом). Пул обязательно указывать, если в кластере больше одного пула.

vitastor-cli create --snapshot <snapshot> [-p|--pool <id|name>] <image>
vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>

Создать снимок образа <name> (можно использовать любую форму команды). Снимок можно создавать без остановки клиентов, если пишущий клиент максимум 1.

Смотрите также информацию о том, как экспортировать снимки.

modify

vitastor-cli modify <name> [--rename <new-name>] [--resize <size>] [--readonly | --readwrite] [-f|--force] [--down-ok]

Изменить размер, имя образа или флаг "только для чтения". Снимать флаг "только для чтения" и уменьшать размер образов, у которых есть дочерние клоны, без --force нельзя.

Если новый размер меньше старого, "лишние" данные будут удалены, поэтому перед уменьшением образа сначала уменьшите файловую систему в нём.

  • -f|--force - Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны.
  • --down-ok - Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD.

rm

vitastor-cli rm <from> [<to>] [--writers-stopped] [--down-ok]

Удалить образ <from> или все слои от <from> до <to> (<to> должен быть дочерним образом <from>), одновременно меняя родительские образы их клонов (если таковые есть).

--writers-stopped позволяет чуть более эффективно удалять образы в частом случае, когда у удаляемой цепочки есть только один дочерний образ, содержащий небольшой объём данных. В этом случае дочерний образ вливается в родительский и удаляется, а родительский переименовывается в дочерний.

В других случаях родительские слои вливаются в дочерние.

Другие опции:

  • --down-ok - Продолжать удаление/слияние, даже если часть данных останется неудалённой на недоступных OSD.

flatten

vitastor-cli flatten <layer>

Сделай образ <layer> плоским, то есть, скопировать в него данные и разорвать его соединение с родительскими.

rm-data

vitastor-cli rm-data --pool <pool> --inode <inode> [--wait-list] [--min-offset <offset>]

Удалить данные инода, не меняя метаданные образов.

--wait-list   Сначала запросить полный листинг объектов, а потом начать удалять.
              Требует больше памяти, но позволяет правильно печатать прогресс удаления.
--min-offset  Удалять только данные, начиная с заданного смещения.

merge-data

vitastor-cli merge-data <from> <to> [--target <target>]

Слить данные слоёв, не меняя метаданные. Вливает данные из слоёв от <from> до <to> в целевой образ <target>. <to> должен быть дочерним образом <from>, а <target> должен быть одним из слоёв между <from> и <to>, включая сами <from> и <to>.

describe

vitastor-cli describe [ОПЦИИ]

Описать состояние "грязных" объектов в кластере, то есть таких объектов, копии или части которых хранятся на наборе OSD, не равном целевому. Опции:

--osds <osds>
    Перечислять только объекты с первичных OSD из списка <osds>.
--object-state <состояния>
    Перечислять только объекты в указанных состояниях. Возможные состояния
    объектов:
    - degraded - деградированная избыточность
    - misplaced - перемещённый
    - incomplete - нечитаемый из-за потери большего числа частей, чем допустимо
    - corrupted - с одной или более повреждённой частью
    - inconsistent - неконсистентный, с неоднозначным расхождением копий/частей
--pool <имя или ID пула>
    Перечислять только объекты из заданного пула.
--pg <номер PG>
    Перечислять только объекты из заданной PG пула.
--inode, --min-inode, --max-inode
    Перечислять только объекты из указанных номеров инодов (образов).
--min-offset, --max-offset
    Перечислять только объекты с заданных смещений внутри образов.

fix

vitastor-cli fix [--objects <объекты>] [--bad-osds <osds>] [--part <номер>] [--check no]

Исправить неконсистентные (неоднозначные) объекты путём удаления части копий.

--objects <объекты>
    Объекты для исправления - в простом текстовом или JSON формате. Если опция
    не указана, список объектов читается со стандартного ввода в тех же форматах.
    Простой формат: 0x<инод>:0x<смещение> <любой разделитель> 0x<инод>:0x<смещение> ...
    Формат JSON: [{"inode":"0x<инод>","stripe":"0x<смещение>"},...]
--bad-osds <osds>
    Удалить неконсистентные копии/части объектов с данных OSD, таким образом
    признавая потерю этих копий и позволяя Vitastor-у восстановить объекты из
    других копий.
--part <номер>
    Удалить только части EC с заданным номером (от 0 до pg_size-1). Нужно только
    в редких граничных случаях, когда один и тот же OSD содержит несколько частей
    одного EC-объекта.
--check no
    Не перепроверять, что заданные объекты действительно в неконсистентном
    состоянии и просто удалять заданные части.

alloc-osd

vitastor-cli alloc-osd

Атомарно выделить новый номер OSD и зарезервировать его, создав в etcd пустой ключ /osd/stats/<n>.

rm-osd

vitastor-cli rm-osd [--force] [--allow-data-loss] [--dry-run] <osd_id> [osd_id...]

Удалить метаданные и конфигурацию для заданных OSD из etcd.

Отказывается удалять OSD с данными без опций --force и --allow-data-loss.

С опцией --dry-run только проверяет, возможно ли удаление без потери данных и деградации избыточности.

create-pool

vitastor-cli create-pool|pool-create <name> (-s <pg_size>|--ec <N>+<K>) -n <pg_count> [OPTIONS]

Создать пул. Обязательные параметры:
-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) минус число разрешённых отказов без остановки пула (подробнее)
--failure_domain host Домен отказа: host, osd или другой из placement_levels. По умолчанию: host
--root_node <node> Использовать для пула только дочерние OSD этого узла дерева размещения
--osd_tags <tag>[,<tag>]... ...только OSD со всеми заданными тегами
--block_size 128k ...только OSD с данным размером блока
--bitmap_granularity 4k ...только OSD с данным размером логического сектора
--immediate_commit none ...только OSD с этим или большим immediate_commit (none < small < all)
--level_placement <rules> Задать правила дополнительных доменов отказа (пример: "dc=112233")
--raw_placement <rules> Задать низкоуровневые правила генерации PG (детали)
--primary_affinity_tags tags Предпочитать OSD со всеми данными тегами для роли первичных
--scrub_interval <time> Включить скрабы с заданным интервалом времени (число + единица s/m/h/d/M/y)
--pg_stripe_size <number> Увеличить блок группировки объектов по PG
--max_osd_combinations 10000 Максимальное число случайных комбинаций OSD для ЛП-солвера
--wait Подождать, пока новый пул будет активирован
-f или --force Не проверять, что в кластере достаточно доменов отказа для создания пула

Подробно о параметрах см. Конфигурация пулов.

Примеры:

vitastor-cli create-pool test_x4 -s 4 -n 32

vitastor-cli create-pool test_ec42 --ec 4+2 -n 32

modify-pool

vitastor-cli modify-pool|pool-modify <id|name> [--name <new_name>] [PARAMETERS...]

Изменить настройки существующего пула. Изменяемые параметры:

[-s|--pg_size <number>] [--pg_minsize <number>] [-n|--pg_count <count>]
[--failure_domain <level>] [--root_node <node>] [--osd_tags <tags>]
[--max_osd_combinations <number>] [--primary_affinity_tags <tags>] [--scrub_interval <time>]

Неизменяемые параметры (их изменение ПРИВЕДЁТ к потере данных):

[--block_size <size>] [--bitmap_granularity <size>]
[--immediate_commit <all|small|none>] [--pg_stripe_size <size>]

Эти параметры можно изменить, только если явно передать опцию -f или --force.

Описания параметров смотрите в create-pool.

Примеры:

vitastor-cli modify-pool pool_A --name pool_B

vitastor-cli modify-pool 2 --pg_size 4 -n 128

rm-pool

vitastor-cli rm-pool|pool-rm [--force] <id|name>

Удалить пул. Отказывается удалять пул, в котором ещё есть образы, без --force.

ls-pools

vitastor-cli ls-pools|pool-ls|ls-pool|pools [-l] [--detail] [--sort FIELD] [-r] [-n N] [--stats] [<glob> ...]

Показать список пулов. Если передан(ы) шаблон(ы) <glob>, то только с именами, соответствующими одному из шаблонов (стандартные ФС-шаблоны с * и ?).
-l или --long Вывести также статистику ввода-вывода
--detail Максимально подробный вывод в виде списка (а не таблицы)
--sort FIELD Сортировать по заданному полю (поля см. в выводе с --json)
-r или --reverse Сортировать в обратном порядке
-n или --count N Выводить только первые N записей