From a950889976c33c54e2b8e700a99f3cb0c041a3f2 Mon Sep 17 00:00:00 2001 From: Vitaliy Filippov Date: Sun, 16 Mar 2025 12:29:22 +0300 Subject: [PATCH] Add missing docs for discard_on_start --- docs/config/osd.en.md | 19 +++++++++++++++++-- docs/config/osd.ru.md | 19 +++++++++++++++++-- docs/config/src/osd.en.md | 4 ++-- docs/config/src/osd.ru.md | 4 ++-- docs/config/src/osd.yml | 9 +++++++++ docs/installation/s3.en.md | 6 ++++++ docs/installation/s3.ru.md | 6 ++++++ 7 files changed, 59 insertions(+), 8 deletions(-) diff --git a/docs/config/osd.en.md b/docs/config/osd.en.md index d762206a..1b0262cb 100644 --- a/docs/config/osd.en.md +++ b/docs/config/osd.en.md @@ -7,8 +7,8 @@ # Runtime OSD Parameters These parameters only apply to OSDs, are not fixed at the moment of OSD drive -initialization and can be changed - either with an OSD restart or, for some of -them, even without restarting by updating configuration in etcd. +initialization and can be changed - in /etc/vitastor/vitastor.conf or [vitastor-disk update-sb](../usage/disk.en.md#update-sb) +with an OSD restart or, for some of them, even without restarting by updating configuration in etcd. - [osd_iothread_count](#osd_iothread_count) - [etcd_report_interval](#etcd_report_interval) @@ -61,6 +61,8 @@ them, even without restarting by updating configuration in etcd. - [recovery_tune_agg_interval](#recovery_tune_agg_interval) - [recovery_tune_sleep_min_us](#recovery_tune_sleep_min_us) - [recovery_tune_sleep_cutoff_us](#recovery_tune_sleep_cutoff_us) +- [discard_on_start](#discard_on_start) +- [min_discard_size](#min_discard_size) ## osd_iothread_count @@ -629,3 +631,16 @@ are changed to 0. Maximum possible value for auto-tuned recovery_sleep_us. Higher values are treated as outliers and ignored in aggregation. + +## discard_on_start + +- Type: boolean + +Discard (SSD TRIM) unused data device blocks on every OSD startup. + +## min_discard_size + +- Type: integer +- Default: 1048576 + +Minimum consecutive block size to TRIM it. diff --git a/docs/config/osd.ru.md b/docs/config/osd.ru.md index a70a743b..eed8691a 100644 --- a/docs/config/osd.ru.md +++ b/docs/config/osd.ru.md @@ -8,8 +8,8 @@ Данные параметры используются только OSD, но, в отличие от дисковых параметров, не фиксируются в момент инициализации дисков OSD и могут быть изменены в любой -момент с помощью перезапуска OSD, а некоторые и без перезапуска, с помощью -изменения конфигурации в etcd. +момент с перезапуском OSD в /etc/vitastor/vitastor.conf или [vitastor-disk update-sb](../usage/disk.ru.md#update-sb), +а некоторые и без перезапуска, с помощью изменения конфигурации в etcd. - [osd_iothread_count](#osd_iothread_count) - [etcd_report_interval](#etcd_report_interval) @@ -62,6 +62,8 @@ - [recovery_tune_agg_interval](#recovery_tune_agg_interval) - [recovery_tune_sleep_min_us](#recovery_tune_sleep_min_us) - [recovery_tune_sleep_cutoff_us](#recovery_tune_sleep_cutoff_us) +- [discard_on_start](#discard_on_start) +- [min_discard_size](#min_discard_size) ## osd_iothread_count @@ -660,3 +662,16 @@ EC (кодов коррекции ошибок) с более, чем 1 диск Максимальное возможное значение авто-подстроенного recovery_sleep_us. Большие значения считаются случайными выбросами и игнорируются в усреднении. + +## discard_on_start + +- Тип: булево (да/нет) + +Освобождать (SSD TRIM) неиспользуемые блоки диска данных при каждом запуске OSD. + +## min_discard_size + +- Тип: целое число +- Значение по умолчанию: 1048576 + +Минимальный размер последовательного блока данных, чтобы освобождать его через TRIM. diff --git a/docs/config/src/osd.en.md b/docs/config/src/osd.en.md index dfc2caf0..146642f5 100644 --- a/docs/config/src/osd.en.md +++ b/docs/config/src/osd.en.md @@ -1,5 +1,5 @@ # Runtime OSD Parameters These parameters only apply to OSDs, are not fixed at the moment of OSD drive -initialization and can be changed - either with an OSD restart or, for some of -them, even without restarting by updating configuration in etcd. +initialization and can be changed - in /etc/vitastor/vitastor.conf or [vitastor-disk update-sb](../usage/disk.en.md#update-sb) +with an OSD restart or, for some of them, even without restarting by updating configuration in etcd. diff --git a/docs/config/src/osd.ru.md b/docs/config/src/osd.ru.md index 41a68af6..fa953eaf 100644 --- a/docs/config/src/osd.ru.md +++ b/docs/config/src/osd.ru.md @@ -2,5 +2,5 @@ Данные параметры используются только OSD, но, в отличие от дисковых параметров, не фиксируются в момент инициализации дисков OSD и могут быть изменены в любой -момент с помощью перезапуска OSD, а некоторые и без перезапуска, с помощью -изменения конфигурации в etcd. +момент с перезапуском OSD в /etc/vitastor/vitastor.conf или [vitastor-disk update-sb](../usage/disk.ru.md#update-sb), +а некоторые и без перезапуска, с помощью изменения конфигурации в etcd. diff --git a/docs/config/src/osd.yml b/docs/config/src/osd.yml index 24206fa1..fae18dce 100644 --- a/docs/config/src/osd.yml +++ b/docs/config/src/osd.yml @@ -765,3 +765,12 @@ Максимальное возможное значение авто-подстроенного recovery_sleep_us. Большие значения считаются случайными выбросами и игнорируются в усреднении. +- name: discard_on_start + type: bool + info: Discard (SSD TRIM) unused data device blocks on every OSD startup. + info_ru: Освобождать (SSD TRIM) неиспользуемые блоки диска данных при каждом запуске OSD. +- name: min_discard_size + type: int + default: 1048576 + info: Minimum consecutive block size to TRIM it. + info_ru: Минимальный размер последовательного блока данных, чтобы освобождать его через TRIM. diff --git a/docs/installation/s3.en.md b/docs/installation/s3.en.md index 8114715c..5788bd15 100644 --- a/docs/installation/s3.en.md +++ b/docs/installation/s3.en.md @@ -1,3 +1,9 @@ +[Documentation](../../README.md#documentation) → Installation → S3 for Vitastor + +----- + +[Читать на русском](s3.ru.md) + # S3 for Vitastor The moment has come - Vitastor S3 implementation based on Zenko CloudServer is released. diff --git a/docs/installation/s3.ru.md b/docs/installation/s3.ru.md index e0926ece..6314df31 100644 --- a/docs/installation/s3.ru.md +++ b/docs/installation/s3.ru.md @@ -1,3 +1,9 @@ +[Документация](../../README-ru.md#документация) → Установка → S3 на базе Vitastor + +----- + +[Read in English](s3.en.md) + # S3 на базе Vitastor Итак, свершилось - реализация Vitastor S3 на базе Zenko CloudServer достигла