From cac5d9415b8c6a8c68447d27182e457f011eb930 Mon Sep 17 00:00:00 2001 From: Innokentii Mokin Date: Fri, 29 Dec 2023 12:44:53 +0300 Subject: [PATCH] Sync config documentation with implementation (#797) --- .../manual/dynamic-config-volatile-config.md | 20 +++++++++++-------- ydb/docs/ru/core/reference/ydb-cli/configs.md | 19 ++++++++---------- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/ydb/docs/ru/core/maintenance/manual/dynamic-config-volatile-config.md b/ydb/docs/ru/core/maintenance/manual/dynamic-config-volatile-config.md index 3fa846b5c3d3..ebfb36c59485 100644 --- a/ydb/docs/ru/core/maintenance/manual/dynamic-config-volatile-config.md +++ b/ydb/docs/ru/core/maintenance/manual/dynamic-config-volatile-config.md @@ -10,15 +10,15 @@ ```bash # Получить все временные конфигурации загруженные на кластер -{{ ydb-cli }} admin config volatile fetch --all --output-directory +{{ ydb-cli }} admin volatile-config fetch --all --output-directory # Получить временную конфигурацию с id=1 -{{ ydb-cli }} admin config volatile fetch --id 1 +{{ ydb-cli }} admin volatile-config fetch --id 1 # Применить временную конфигурацию volatile.yaml на кластер -{{ ydb-cli }} admin config volatile add -f volatile.yaml +{{ ydb-cli }} admin volatile-config add -f volatile.yaml # Удалить временные конфигурации с id=1 и id=3 на кластере -{{ ydb-cli }} admin config volatile drop --id 1 --id 3 +{{ ydb-cli }} admin volatile-config drop --id 1 --id 3 # Удалить все временные конфигурации на кластере -{{ ydb-cli }} admin config volatile drop --all +{{ ydb-cli }} admin volatile-config drop --all ``` ## Пример работы с временной конфигурацией @@ -26,18 +26,22 @@ Временное включение настроек журналирования компонента `blobstorage` в `DEBUG` на узле `host1.example.com`: ```bash # Запрос текущих метаданных, чтобы сформировать корректный заголовок временной конфигурации -$ {{ ydb-cli }} admin config describe --all +$ {{ ydb-cli }} admin config fetch --all --- kind: MainConfig cluster: "example-cluster-name" version: 2 +config: + # ... --- kind: VolatileConfig cluster: "example-cluster-name" version: 2 id: 1 +selector_config: + # ... # Загрузка конфигурации с версией 2, именем кластера example-cluster-name и идентификатором 2 -$ {{ ydb-cli }} admin config volatile add -f - <<` — считать input из файла, `-` для STDIN. Для команд принимающих n файлов (прим. resolve) можно указать несколько раз, тип файла будет определён по полю metadata -* `-k, --directory ` — считать input из директории * `--output-directory ` — сдампить/порезолвить файлы в директорию -* `-o, --output ` — изменить формат вывода, по-умолчанию yaml -* `-s, --strip-metadata` — выкинуть поле metadata из вывода -* `-a, --all` — расширяет вывод команд до всей конфигурации (см. продвинутое конфигурирование) +* `--strip-metadata` — выкинуть поле metadata из вывода +* `--all` — расширяет вывод команд до всей конфигурации (см. продвинутое конфигурирование) +* `--allow-unknown-fields` — позволяет игнорировать неизвестные поля в конфигурации ```bash @@ -21,8 +20,6 @@ {{ ydb-cli }} admin config fetch # Получить все текущие конфигурационные файлы кластера {{ ydb-cli }} admin config fetch --all -# Получить метаинформацию о конфигурациях кластера -{{ ydb-cli }} admin config describe # Сгенерировать все возможные конечные конфигурации для dynconfig.yaml {{ ydb-cli }} admin config resolve --all -f dynconfig.yaml # Сгенерировать конечную конфигурацию для dynconfig.yaml при лейблах tenant=/Root/test и canary=true @@ -30,15 +27,15 @@ # Сгенерировать конечную конфигурацию для dynconfig.yaml для лейблов с узла 1003 {{ ydb-cli }} admin config resolve -f dynconfig.yaml --node-id 1003 # Получить все временные конфигурации кластера -{{ ydb-cli }} admin config volatile fetch --all --output-directory +{{ ydb-cli }} admin volatile-config fetch --all --output-directory # Получить временную конфигурацию с id 1 с кластера -{{ ydb-cli }} admin config volatile fetch --id 1 +{{ ydb-cli }} admin volatile-config fetch --id 1 # Применить временную конфигурацию volatile.yaml на кластер -{{ ydb-cli }} admin config volatile add -f volatile.yaml +{{ ydb-cli }} admin volatile-config add -f volatile.yaml # Удалить временные конфигурации с id 1 и 3 на кластере -{{ ydb-cli }} admin config volatile drop --id 1 --id 3 +{{ ydb-cli }} admin volatile-config drop --id 1 --id 3 # Удалить все временные конфигурации на кластере -{{ ydb-cli }} admin config volatile drop --all +{{ ydb-cli }} admin volatile-config drop --all ``` ## Сценарии