Add defrag docs, fix trace message

2024-07-13 00:45:53 +03:00
parent 413959e75a
commit b4e9140755
4 changed files with 80 additions and 14 deletions
@@ -11,6 +11,8 @@
 Команды:
 - [mount](#mount)
 - [start](#start)
+- [upgrade](#upgrade)
+- [defrag](#defrag)

 ## Псевдо-ФС

@@ -88,11 +90,6 @@ JSON-формате :-). Для инспекции содержимого БД
 - Времена модификации (`mtime`) отслеживаются асинхронно (как будто ФС смонтирована с `-o lazytime`)

 Другие недостающие функции, которые нужно добавить в будущем:
- Дефрагментация "общих инодов". На уровне реализации ФС файлы, меньшие, чем размер
-  объекта пула (block_size умножить на число частей данных, если пул EC),
-  упаковываются друг за другом в большие "общие" иноды/тома. Если такие файлы удалять
-  или увеличивать, они перемещаются и оставляют за собой "мусор", вот тут-то и нужен
-  дефрагментатор.
 - Переиспользование номеров инодов. В текущей реализации номера инодов всё время
  увеличиваются, так что в теории вы можете упереться в лимит, если насоздаёте
  и наудаляете больше, чем 2^48 файлов.
@@ -145,6 +142,40 @@ JSON-формате :-). Для инспекции содержимого БД
 | `--port <PORT>` | использовать порт \<PORT> для NFS-сервисов (по умолчанию 2049)        |
 | `--portmap 0`   | отключить сервис portmap/rpcbind на порту 111 (по умолчанию включён и требует root привилегий) |

+### upgrade
+
+`vitastor-nfs --fs <NAME> upgrade`
+
+Обновить метаданные ФС. Можно запускать онлайн (при запущенных серверах NFS), но после выполнения их всё
+же желательно перезапустить.
+
+### defrag
+
+`vitastor-nfs --fs <NAME> defrag [OPTIONS] [--dry-run]`
+
+Дефрагментировать тома, используемые для хранения мелких файлов, в которых более, чем
+<defrag_percent> процентов данных удалено. Можно запускать онлайн.
+
+На уровне реализации ФС файлы, меньшие, чем размер объекта пула (block_size умножить на число
+частей данных, если пул EC), упаковываются друг за другом в большие "тома" / "общие иноды".
+Когда такие файлы удаляются или увеличиваются, они перемещаются и оставляют за собой "мусор".
+
+При дефрагментации мусор удаляется, а всё ещё используемые данные перемещаются в новые тома.
+
+Опции:
+
+| <!-- -->                 | <!-- -->                                                                |
+|--------------------------|------------------------------------------------------------------------ |
+| --volume_untouched 86400 | Дефрагментировать только тома, в которые уже не писали это число секунд |
+| --defrag_percent 50      | Дефрагментировать только тома, в которых этот % данных удалён           |
+| --defrag_block_count 16  | Читать это количество блоков пула за один раз                           |
+| --defrag_iodepth 16      | Перемещать одновременно до этого числа файлов                           |
+| --trace                  | Печатать детальную статистику дефрагментации                            |
+| --dry-run                | Не производить никаких изменений, только описать выполняемые действия   |
+| --recalc-stats           | Пересчитать и сохранить статистику всех томов                           |
+| --include-empty          | Дефрагментировать старые и пустые тома; обязательно перезапустите NFS-сервера после использования этой опции |
+| --no-rm                  | Перемещать, но не удалять данные                                        |
+
 ## Общие опции

 | <!-- -->           | <!-- -->                                                |