Skip to content

Commit 38a85bb

Browse files
Enjectionadameat
authored andcommitted
Sync config documentation with implementation (ydb-platform#797)
1 parent 0c1fe2f commit 38a85bb

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

ydb/docs/ru/core/maintenance/manual/dynamic-config-volatile-config.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,38 @@
1010

1111
```bash
1212
# Получить все временные конфигурации загруженные на кластер
13-
{{ ydb-cli }} admin config volatile fetch --all --output-directory <dir>
13+
{{ ydb-cli }} admin volatile-config fetch --all --output-directory <dir>
1414
# Получить временную конфигурацию с id=1
15-
{{ ydb-cli }} admin config volatile fetch --id 1
15+
{{ ydb-cli }} admin volatile-config fetch --id 1
1616
# Применить временную конфигурацию volatile.yaml на кластер
17-
{{ ydb-cli }} admin config volatile add -f volatile.yaml
17+
{{ ydb-cli }} admin volatile-config add -f volatile.yaml
1818
# Удалить временные конфигурации с id=1 и id=3 на кластере
19-
{{ ydb-cli }} admin config volatile drop --id 1 --id 3
19+
{{ ydb-cli }} admin volatile-config drop --id 1 --id 3
2020
# Удалить все временные конфигурации на кластере
21-
{{ ydb-cli }} admin config volatile drop --all
21+
{{ ydb-cli }} admin volatile-config drop --all
2222
```
2323

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

2626
Временное включение настроек журналирования компонента `blobstorage` в `DEBUG` на узле `host1.example.com`:
2727
```bash
2828
# Запрос текущих метаданных, чтобы сформировать корректный заголовок временной конфигурации
29-
$ {{ ydb-cli }} admin config describe --all
29+
$ {{ ydb-cli }} admin config fetch --all
3030
---
3131
kind: MainConfig
3232
cluster: "example-cluster-name"
3333
version: 2
34+
config:
35+
# ...
3436
---
3537
kind: VolatileConfig
3638
cluster: "example-cluster-name"
3739
version: 2
3840
id: 1
41+
selector_config:
42+
# ...
3943
# Загрузка конфигурации с версией 2, именем кластера example-cluster-name и идентификатором 2
40-
$ {{ ydb-cli }} admin config volatile add -f - <<<EOF
44+
$ {{ ydb-cli }} admin volatile-config add -f - <<<EOF
4145
metadata:
4246
kind: VolatileConfig
4347
cluster: "example-cluster-name"
@@ -57,5 +61,5 @@ EOF
5761
# анализ журнала
5862
# ...
5963
# Удаление конфигурации
60-
$ {{ ydb-cli }} admin config volatile drop --id 2
64+
$ {{ ydb-cli }} admin volatile-config drop --id 2
6165
```

ydb/docs/ru/core/reference/ydb-cli/configs.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,10 @@
33
### Общие флаги для команд
44

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

1211

1312
```bash
@@ -21,24 +20,22 @@
2120
{{ ydb-cli }} admin config fetch
2221
# Получить все текущие конфигурационные файлы кластера
2322
{{ ydb-cli }} admin config fetch --all
24-
# Получить метаинформацию о конфигурациях кластера
25-
{{ ydb-cli }} admin config describe
2623
# Сгенерировать все возможные конечные конфигурации для dynconfig.yaml
2724
{{ ydb-cli }} admin config resolve --all -f dynconfig.yaml
2825
# Сгенерировать конечную конфигурацию для dynconfig.yaml при лейблах tenant=/Root/test и canary=true
2926
{{ ydb-cli }} admin config resolve -f dynconfig.yaml --label tenant=/Root/test --label canary=true
3027
# Сгенерировать конечную конфигурацию для dynconfig.yaml для лейблов с узла 1003
3128
{{ ydb-cli }} admin config resolve -f dynconfig.yaml --node-id 1003
3229
# Получить все временные конфигурации кластера
33-
{{ ydb-cli }} admin config volatile fetch --all --output-directory <dir>
30+
{{ ydb-cli }} admin volatile-config fetch --all --output-directory <dir>
3431
# Получить временную конфигурацию с id 1 с кластера
35-
{{ ydb-cli }} admin config volatile fetch --id 1
32+
{{ ydb-cli }} admin volatile-config fetch --id 1
3633
# Применить временную конфигурацию volatile.yaml на кластер
37-
{{ ydb-cli }} admin config volatile add -f volatile.yaml
34+
{{ ydb-cli }} admin volatile-config add -f volatile.yaml
3835
# Удалить временные конфигурации с id 1 и 3 на кластере
39-
{{ ydb-cli }} admin config volatile drop --id 1 --id 3
36+
{{ ydb-cli }} admin volatile-config drop --id 1 --id 3
4037
# Удалить все временные конфигурации на кластере
41-
{{ ydb-cli }} admin config volatile drop --all
38+
{{ ydb-cli }} admin volatile-config drop --all
4239
```
4340

4441
## Сценарии

0 commit comments

Comments
 (0)