Skip to content

Sync config documentation with implementation #797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2023
Merged

Sync config documentation with implementation #797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions ydb/docs/ru/core/maintenance/manual/dynamic-config-volatile-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,38 @@

```bash
# Получить все временные конфигурации загруженные на кластер
{{ ydb-cli }} admin config volatile fetch --all --output-directory <dir>
{{ ydb-cli }} admin volatile-config fetch --all --output-directory <dir>
# Получить временную конфигурацию с 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
```

## Пример работы с временной конфигурацией

Временное включение настроек журналирования компонента `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 - <<<EOF
$ {{ ydb-cli }} admin volatile-config add -f - <<<EOF
metadata:
kind: VolatileConfig
cluster: "example-cluster-name"
Expand All @@ -57,5 +61,5 @@ EOF
# анализ журнала
# ...
# Удаление конфигурации
$ {{ ydb-cli }} admin config volatile drop --id 2
$ {{ ydb-cli }} admin volatile-config drop --id 2
```
19 changes: 8 additions & 11 deletions ydb/docs/ru/core/reference/ydb-cli/configs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@
### Общие флаги для команд

* `-f, --filename <filename.yaml>` — считать input из файла, `-` для STDIN. Для команд принимающих n файлов (прим. resolve) можно указать несколько раз, тип файла будет определён по полю metadata
* `-k, --directory <dir>` — считать input из директории
* `--output-directory <dir>` — сдампить/порезолвить файлы в директорию
* `-o, --output <json-stream|json|yaml>` — изменить формат вывода, по-умолчанию yaml
* `-s, --strip-metadata` — выкинуть поле metadata из вывода
* `-a, --all` — расширяет вывод команд до всей конфигурации (см. продвинутое конфигурирование)
* `--strip-metadata` — выкинуть поле metadata из вывода
* `--all` — расширяет вывод команд до всей конфигурации (см. продвинутое конфигурирование)
* `--allow-unknown-fields` — позволяет игнорировать неизвестные поля в конфигурации


```bash
Expand All @@ -21,24 +20,22 @@
{{ 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
{{ ydb-cli }} admin config resolve -f dynconfig.yaml --label tenant=/Root/test --label canary=true
# Сгенерировать конечную конфигурацию для dynconfig.yaml для лейблов с узла 1003
{{ ydb-cli }} admin config resolve -f dynconfig.yaml --node-id 1003
# Получить все временные конфигурации кластера
{{ ydb-cli }} admin config volatile fetch --all --output-directory <dir>
{{ ydb-cli }} admin volatile-config fetch --all --output-directory <dir>
# Получить временную конфигурацию с 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
```

## Сценарии
Expand Down