diff --git a/docs/usage/disk.en.md b/docs/usage/disk.en.md index 54f391ee..076d9bc8 100644 --- a/docs/usage/disk.en.md +++ b/docs/usage/disk.en.md @@ -13,6 +13,7 @@ It supports the following commands: - [prepare](#prepare) - [upgrade-simple](#upgrade-simple) - [resize](#resize) +- [raw-resize](#raw-resize) - [start/stop/restart/enable/disable](#start/stop/restart/enable/disable) - [purge](#purge) - [read-sb](#read-sb) @@ -127,25 +128,49 @@ Requires the `sfdisk` utility. ## resize -`vitastor-disk resize [--iodepth 32]` +`vitastor-disk resize | [OPTIONS]` -Resize data area and/or rewrite/move journal and metadata. +Resize data area and/or move journal and metadata: + +| | | +|---------------------------|----------------------------------------| +| `--move-journal TARGET` | move journal to `TARGET` | +| `--move-meta TARGET` | move metadata to `TARGET` | +| `--journal-size NEW_SIZE` | resize journal to `NEW_SIZE` | +| `--data-size NEW_SIZE` | resize data device to `NEW_SIZE` | +| `--dry-run` | only show new layout, do not apply it | + +`NEW_SIZE` may include k/m/g/t suffixes. + +`TARGET` may be one of: + +| | | +|----------------|--------------------------------------------------------------------------| +| `` | move journal/metadata to an existing GPT partition | +| `` | create a GPT partition on `` and move journal/metadata to it | +| `""` | (empty string) move journal/metadata back to the data device | + +## raw-resize + +`vitastor-disk raw-resize [--iodepth 32]` + +Resize data area and/or rewrite/move journal and metadata (manual format). `ALL_OSD_PARAMETERS` must include all (at least all disk-related) parameters from OSD command line (i.e. from systemd unit or superblock). `NEW_LAYOUT` may include new disk layout parameters: -``` ---new_data_offset SIZE resize data area so it starts at SIZE ---new_data_len SIZE resize data area to SIZE bytes ---new_meta_device PATH use PATH for new metadata ---new_meta_offset SIZE make new metadata area start at SIZE ---new_meta_len SIZE make new metadata area SIZE bytes long ---new_journal_device PATH use PATH for new journal ---new_journal_offset SIZE make new journal area start at SIZE ---new_journal_len SIZE make new journal area SIZE bytes long -``` +| | | +|-----------------------------|-------------------------------------------| +| `--new_data_offset SIZE` | resize data area so it starts at `SIZE` | +| `--new_data_len SIZE` | resize data area to `SIZE` bytes | +| `--new_meta_device PATH` | use `PATH` for new metadata | +| `--new_meta_offset SIZE` | make new metadata area start at `SIZE` | +| `--new_meta_len SIZE` | make new metadata area `SIZE` bytes long | +| `--new_journal_device PATH` | use `PATH` for new journal | +| `--new_journal_offset SIZE` | make new journal area start at `SIZE` | +| `--new_journal_len SIZE` | make new journal area `SIZE` bytes long | SIZE may include k/m/g/t suffixes. If any of the new layout parameter options are not specified, old values will be used. @@ -217,10 +242,14 @@ Intended for use from startup scripts (i.e. from systemd units). ## dump-journal +`vitastor-disk dump-journal [OPTIONS] ` + `vitastor-disk dump-journal [OPTIONS] ` Dump journal in human-readable or JSON (if `--json` is specified) format. +You can specify any OSD device (data, metadata or journal), or the layout manually. + Options: ``` @@ -233,23 +262,35 @@ Options: ## write-journal +`vitastor-disk write-journal ` + `vitastor-disk write-journal ` Write journal from JSON taken from standard input in the same format as produced by `dump-journal --json --format data`. +You can specify any OSD device (data, metadata or journal), or the layout manually. + ## dump-meta +`vitastor-disk dump-meta ` + `vitastor-disk dump-meta ` Dump metadata in JSON format. +You can specify any OSD device (data, metadata or journal), or the layout manually. + ## write-meta +`vitastor-disk write-meta ` + `vitastor-disk write-meta ` Write metadata from JSON taken from standard input in the same format as produced by `dump-meta`. +You can specify any OSD device (data, metadata or journal), or the layout manually. + ## simple-offsets `vitastor-disk simple-offsets ` diff --git a/docs/usage/disk.ru.md b/docs/usage/disk.ru.md index 324cb594..a2170a3b 100644 --- a/docs/usage/disk.ru.md +++ b/docs/usage/disk.ru.md @@ -13,6 +13,7 @@ vitastor-disk - инструмент командной строки для уп - [prepare](#prepare) - [upgrade-simple](#upgrade-simple) - [resize](#resize) +- [raw-resize](#raw-resize) - [start/stop/restart/enable/disable](#start/stop/restart/enable/disable) - [purge](#purge) - [read-sb](#read-sb) @@ -129,27 +130,51 @@ throttle_target_mbs, throttle_target_parallelism, throttle_threshold_us. ## resize -`vitastor-disk resize [--iodepth 32]` +`vitastor-disk resize | [OPTIONS]` -Изменить размер области данных и/или переместить журнал и метаданные. +Изменить размер области данных и/или переместить журнал и метаданные: -В `ALL_OSD_PARAMETERS` нужно указать все относящиеся к диску параметры OSD +| | | +|-------------------------------|------------------------------------------------| +| `--move-journal ЦЕЛЬ` | переместить журнал на `ЦЕЛЬ` | +| `--move-meta ЦЕЛЬ` | переместить метаданные на `ЦЕЛЬ` | +| `--journal-size НОВЫЙ_РАЗМЕР` | изменить размер журнала на `НОВЫЙ_РАЗМЕР` | +| `--data-size НОВЫЙ_РАЗМЕР` | изменить размер диска данных на `НОВЫЙ_РАЗМЕР` | +| `--dry-run` | показать новые параметры, но не применять их | + +`НОВЫЙ_РАЗМЕР` может быть указан с суффиксами k/m/g/t (кило/мега/гига/терабайт). + +`ЦЕЛЬ` может быть одним из: + +| | | +|-----------------|-------------------------------------------------------------------------------------| +| `<раздел>` | переместить журнал/метаданные на существующий GPT-раздел | +| `<полный_диск>` | создать GPT-раздел на диске `<полный_диск>` и переместить журнал/метаданные на него | +| `""` | (пустая строка) переместить журнал/метаданные обратно на диск данных | + +## raw-resize + +`vitastor-disk raw-resize <ВСЕ_ПАРАМЕТРЫ_OSD> <НОВЫЕ_РАЗМЕРЫ> [--iodepth 32]` + +Изменить размер области данных и/или переместить журнал и метаданные (ручной формат). + +В `ВСЕ_ПАРАМЕТРЫ_OSD` нужно указать все относящиеся к диску параметры OSD из суперблока OSD или из файла сервиса systemd (в старых версиях). -В `NEW_LAYOUT` нужно указать новые параметры расположения данных: +В `НОВЫЕ_РАЗМЕРЫ` нужно указать новые параметры расположения данных: -``` ---new_data_offset РАЗМЕР сдвинуть начало области данных на РАЗМЕР байт ---new_data_len РАЗМЕР изменить размер области данных до РАЗМЕР байт ---new_meta_device ПУТЬ использовать ПУТЬ как новое устройство метаданных ---new_meta_offset РАЗМЕР разместить новые метаданные по смещению РАЗМЕР байт ---new_meta_len РАЗМЕР сделать новые метаданные размером РАЗМЕР байт ---new_journal_device ПУТЬ использовать ПУТЬ как новое устройство журнала ---new_journal_offset РАЗМЕР разместить новый журнал по смещению РАЗМЕР байт ---new_journal_len РАЗМЕР сделать новый журнал размером РАЗМЕР байт -``` +| | | +|-------------------------------|-------------------------------------------------------| +| `--new_data_offset РАЗМЕР` | сдвинуть начало области данных на `РАЗМЕР` байт | +| `--new_data_len РАЗМЕР` | изменить размер области данных до `РАЗМЕР` байт | +| `--new_meta_device ПУТЬ` | использовать `ПУТЬ` как новое устройство метаданных | +| `--new_meta_offset РАЗМЕР` | разместить новые метаданные по смещению `РАЗМЕР` байт | +| `--new_meta_len РАЗМЕР` | сделать новые метаданные размером `РАЗМЕР` байт | +| `--new_journal_device ПУТЬ` | использовать `ПУТЬ` как новое устройство журнала | +| `--new_journal_offset РАЗМЕР` | разместить новый журнал по смещению `РАЗМЕР` байт | +| `--new_journal_len РАЗМЕР` | сделать новый журнал размером `РАЗМЕР` байт | -РАЗМЕР может быть указан с суффиксами k/m/g/t. Если любой из новых параметров +`РАЗМЕР` может быть указан с суффиксами k/m/g/t. Если любой из новых параметров расположения не указан, он принимается равным старому значению. ## start/stop/restart/enable/disable @@ -224,10 +249,15 @@ OSD отключены fsync-и. ## dump-journal +`vitastor-disk dump-journal ` + `vitastor-disk dump-journal [OPTIONS] ` Вывести журнал в человекочитаемом или в JSON (с опцией `--json`) виде. +Вы можете указать любой раздел OSD - данных, журнала или метаданных - либо указать все +параметры расположения вручную. + Опции: ``` @@ -240,22 +270,37 @@ OSD отключены fsync-и. ## write-journal +`vitastor-disk write-journal ` + `vitastor-disk write-journal ` Записать журнал из JSON со стандартного ввода в формате, аналогичном `dump-journal --json --format data`. +Вы можете указать любой раздел OSD - данных, журнала или метаданных - либо указать все +параметры расположения вручную. + ## dump-meta +`vitastor-disk dump-meta ` + `vitastor-disk dump-meta ` Вывести метаданные в формате JSON. +Вы можете указать любой раздел OSD - данных, журнала или метаданных - либо указать все +параметры расположения вручную. + ## write-meta +`vitastor-disk write-meta ` + `vitastor-disk write-meta ` Записать метаданные из JSON со стандартного ввода в формате, аналогичном `dump-meta`. +Вы можете указать любой раздел OSD - данных, журнала или метаданных - либо указать все +параметры расположения вручную. + ## simple-offsets `vitastor-disk simple-offsets `