Skip to content

Commit fd87a30

Browse files
committed
adjust ydb-cli reference after merge
1 parent 044c4c3 commit fd87a30

File tree

7 files changed

+33
-32
lines changed

7 files changed

+33
-32
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% note alert %}
22

3-
Команды из этого раздела могут нанести вред вашему кластеру при неправильном использовании. Из-за потенциально опасного характера этих команд ВСЕ глобальные параметры должны быть заданы явно. Профили отключены по умолчанию и используются только при явном указании (--profile <имя-профиля>). Некоторые команды не требуют глобальных опций, которые в противном случае являются обязательными.
3+
Команды из этого раздела могут нанести вред вашему кластеру при неправильном использовании. Из-за потенциально опасного характера этих команд **ВСЕ** глобальные параметры должны быть заданы явно. Профили отключены по умолчанию и используются только при явном указании (`--profile <имя-профиля>`). Некоторые команды не требуют глобальных опций, которые в противном случае являются обязательными.
44

55
{% endnote %}

ydb/docs/ru/core/reference/ydb-cli/commands/configuration/cluster/fetch.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# admin cluster config fetch
22

3-
С помощью команды `admin cluster config fetch` вы можете получить текущую [динамическую](../../../../../maintenance/manual/dynamic-config.md) конфигурацию кластера YDB.
3+
С помощью команды `admin cluster config fetch` вы можете получить текущую [конфигурацию](../../../../../devops/configuration-management/index.md) кластера {{ ydb-short-name }}.
44

55
Общий вид команды:
66

@@ -10,15 +10,15 @@ ydb [global options...] admin cluster config fetch
1010

1111
* `global options` — глобальные параметры.
1212

13-
Посмотрите описание команды получения динамической конфигурации:
13+
Посмотрите описание команды получения конфигурации:
1414

1515
```bash
1616
ydb admin cluster config fetch --help
1717
```
1818

1919
## Примеры {#examples}
2020

21-
Получите текущую динамическую конфигурацию кластера:
21+
Получите текущую конфигурацию кластера:
2222

2323
```bash
2424
ydb --endpoint grpc://localhost:2135 admin cluster config fetch > config.yaml
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# admin cluster config generate
22

3-
С помощью команды `admin cluster config generate` вы можете сгенерировать файл [динамической конфигурацию](../../../../../maintenance/manual/dynamic-config.md) на основе файла [статической конфигурации](../../../../../reference/configuration/index.md) на кластере {{ ydb-short-name }}.
4-
Динамическая конфигурация имеет формат расширенной статической конфигурации, команда автоматизирует процесс преобразования.
3+
С помощью команды `admin cluster config generate` вы можете сгенерировать для кластера {{ ydb-short-name }} [конфигурацию V2](../../../../../devops/configuration-management/configuration-v2/index.md) на основе его текущей [конфигурации V1](../../../../../devops/configuration-management/configuration-v1/index.md). Это один из шагов при [миграции кластера на конфигурацию V2](../../../../../devops/configuration-management/migration/migration-to-v2.md).
54

65
Общий вид команды:
76

@@ -11,34 +10,36 @@ ydb [global options...] admin cluster config generate
1110

1211
* `global options` — глобальные параметры.
1312

14-
Посмотрите описание команды генерации динамической конфигурации:
13+
Посмотрите описание команды генерации конфигурации V2:
1514

1615
```bash
1716
ydb admin cluster config generate --help
1817
```
1918

2019
## Примеры {#examples}
2120

22-
Сгенерируйте динамическую конфигурацию на основе статической конфигурации:
21+
Сгенерируйте конфигурацию V2 на основе конфигурации V1:
2322

2423
```bash
2524
ydb admin cluster config generate > config.yaml
2625
```
2726

28-
После выполнения данный комманды в файле `config.yaml` будет содержаться YAML документ следующего вида:
27+
После выполнения данной команды в файле `config.yaml` будет содержаться YAML-документ следующего вида:
2928

3029
```yaml
3130
metadata:
3231
kind: MainConfig
3332
cluster: ""
3433
version: 0
3534
config:
36-
<статическая конфигурация кластера>
35+
<настройки кластера>
3736
```
3837
39-
## Использование сгенерированной динамической конфигурации
38+
## Использование сгенерированной конфигурации V2
4039
41-
После генерации динамической конфигурации вы можете выполнить следующие шаги:
40+
После генерации конфигурации V2 выполните следующие шаги:
4241
43-
1. Добавить параметры динамической конфигурации в конфигурационный файл.
44-
2. Применить динамическую конфигурацию к кластеру с помощью команды [`admin cluster config replace`](replace.md).
42+
1. Добавьте параметры динамической конфигурации в конфигурационный файл.
43+
2. Примените динамическую конфигурацию к кластеру с помощью команды [`admin cluster config replace`](replace.md).
44+
45+
Если вы используете данную команду для миграции на V2, следуйте указаниям [инструкции](../../../../../devops/configuration-management/migration/migration-to-v2.md).
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Команды управления конфигурацией кластера
22

3-
Команды управления конфигурацией кластера предназначены для работы с конфигурацией на уровне всего кластера YDB. Эти команды позволяют администраторам кластера просматривать, изменять и управлять [настройками](../../../../../reference/configuration/index.md), которые применяются ко всем узлам кластера.
3+
Команды управления конфигурацией кластера предназначены для работы с конфигурацией на уровне всего кластера {{ ydb-short-name }}. Эти команды позволяют администраторам просматривать, изменять и управлять [настройками](../../../../../reference/configuration/index.md), которые применяются ко всем узлам кластера.
44

55
{% include [danger-warning](../_includes/danger-warning.md) %}
66

@@ -10,20 +10,20 @@
1010
ydb [global options] admin cluster config [command options] <subcommand>
1111
```
1212

13-
, где:
13+
где:
1414

15-
- `ydb` команда запуска YDB CLI из командной строки операционной системы;
16-
- `[global options]` глобальные опции, одинаковые для всех команд YDB CLI;
17-
- `admin cluster config` команда управления конфигурацией кластера;
18-
- `[command options]` опции команды, специфичные для каждой команды и подкоманд;
19-
- `<subcommand>` подкоманда.
15+
- `ydb` команда запуска YDB CLI из командной строки операционной системы;
16+
- `[global options]` глобальные опции, одинаковые для всех команд YDB CLI;
17+
- `admin cluster config` команда управления конфигурацией кластера;
18+
- `[command options]` опции команды, специфичные для каждой команды и подкоманды;
19+
- `<subcommand>` подкоманда.
2020

2121
## Команды {#list}
2222

23-
Ниже представлен список доступных подкоманд для управления конфигурацией кластера. Любая команда может быть вызвана в командной строке с опцией `--help` для получения справки по ней.
23+
Ниже представлен список доступных подкоманд для управления конфигурацией кластера. Любую команду можно вызвать с опцией `--help` для получения справки по ней.
2424

2525
Команда / подкоманда | Краткое описание
2626
--- | ---
27-
[admin cluster config fetch](./fetch.md) | Получение текущей динамической конфигурации (псевдонимы: get, dump)
28-
[admin cluster config generate](./generate.md) | Генерация динамической конфигурации из статической конфигурации запуска
27+
[admin cluster config fetch](./fetch.md) | Получение текущей конфигурации (псевдонимы: `get`, `dump`)
2928
[admin cluster config replace](./replace.md) | Замена динамической конфигурации
29+
[admin cluster config generate](./generate.md) | Генерация [конфигурации V2](../../../../../devops/configuration-management/configuration-v2/index.md) из [конфигурации V1](../../../../../devops/configuration-management/configuration-v1/index.md)

ydb/docs/ru/core/reference/ydb-cli/commands/configuration/cluster/replace.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# admin cluster config replace
22

3-
С помощью команды `admin cluster config replace` вы можете загрузить [динамическую конфигурацию](../../../../../maintenance/manual/dynamic-config.md) на кластер {{ ydb-short-name }}.
3+
С помощью команды `admin cluster config replace` вы можете загрузить [конфигурацию](../../../../../devops/configuration-management/configuration-v2/index.md) на кластер {{ ydb-short-name }}.
44

55
{% include [danger-warning](../_includes/danger-warning.md) %}
66

@@ -41,7 +41,7 @@ ydb admin cluster config replace --help
4141
Загрузите файл динамической конфигурации на кластер:
4242

4343
```bash
44-
ydb admin cluster config replace --filename сonfig.yaml
44+
ydb admin cluster config replace --filename config.yaml
4545
```
4646

4747
Загрузите файл динамической конфигурации на кластер, игнорируя локальные проверки применимости:
@@ -50,7 +50,7 @@ ydb admin cluster config replace --filename сonfig.yaml
5050
ydb admin cluster config replace -f config.yaml --ignore-local-validation
5151
```
5252

53-
Загрузите файл динамиической конфигурации на кластер, игнорируя проверку конфигурации на неизвестные поля:
53+
Загрузите файл динамической конфигурации на кластер, игнорируя проверку конфигурации на неизвестные поля:
5454

5555
```bash
5656
ydb admin cluster config replace -f config.yaml --allow-unknown-fields

ydb/docs/ru/core/reference/ydb-cli/commands/configuration/node/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Команды управления конфигурацией узла
22

3-
Команды управления конфигурацией узла предназначены для работы с конфигурацией на уровне отдельных узлов кластера YDB. Эти команды позволяют администраторам кластера инициализировать, обновлять и управлять настройками отдельных узлов.
3+
Команды управления конфигурацией узла предназначены для работы с конфигурацией на уровне отдельных узлов кластера {{ ydb-short-name }}. Эти команды позволяют администраторам кластера инициализировать, обновлять и управлять настройками отдельных узлов.
44

55
{% include [danger-warning](../_includes/danger-warning.md) %}
66

ydb/docs/ru/core/reference/ydb-cli/commands/configuration/node/init.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# admin node config init
22

3-
При развертывании нового кластера {{ ydb-short-name }} или добавлении узлов в существующий (расширении), на каждом узле требуется директория для хранения его конфигурации. Команда `admin node config init` создает и подготавливает эту директорию, помещая в нее заданный конфигурационный файл или получая его с другого узла кластера (seed node).
3+
При развёртывании нового кластера {{ ydb-short-name }} или добавлении узлов в существующий (расширении) на каждом узле требуется директория для хранения его конфигурации. Команда `admin node config init` создаёт и подготавливает эту директорию, помещая в неё заданный конфигурационный файл или получая его с другого узла кластера (seed node).
44

55
Общий вид команды:
66

@@ -22,8 +22,8 @@ ydb admin node config init --help
2222
Имя | Описание
2323
---|---
2424
`-d`, `--config-dir` | **Обязательный**. Путь к директории для хранения файла конфигурации.
25-
`-f`, `--from-config` | Путь к файлу с начальной конфигурацией. Необходим при первоначальном развертывание кластера. Можно использовать и при расширении, если файл с актуальной конфигурацией кластера был предварительно доставлен на узел.
26-
`-s`, `--seed-node` | Эндпоинт узла-источника (seed node), с которого будет получена конфигурация. Используется при расширение кластера.
25+
`-f`, `--from-config` | Путь к файлу с начальной конфигурацией. Необходим при первоначальном развёртывании кластера. Можно использовать и при расширении, если файл с актуальной конфигурацией кластера был предварительно доставлен на узел.
26+
`-s`, `--seed-node` | Эндпоинт узла-источника (seed node), с которого будет получена конфигурация. Используется при расширении кластера.
2727

2828
## Примеры {#examples}
2929

@@ -41,6 +41,6 @@ ydb admin node config init --config-dir /opt/ydb/cfg-dir --seed-node <node.ydb.t
4141

4242
## Использование
4343

44-
После успешной инициализации директории для конфигурации узла вы можете запустить процесс `ydbd` на данном узле, добавив параметр `--config-dir` с указанием пути до директории. С этого момента при обновлении конфигурации кластера система автоматически сохраняет обновленный конфиг в указанной директории, что избавляет от необходимости ручного обновления файла конфигурации на узле.
44+
После успешной инициализации директории для конфигурации узла вы можете запустить процесс `ydbd` на данном узле, добавив параметр `--config-dir` с указанием пути до директории. С этого момента при обновлении конфигурации кластера система автоматически актуализирует конфигурационный файл в указанной директории, что избавляет от необходимости ручного обновления файла конфигурации на узле.
4545

4646
При перезапуске узла он автоматически загружает актуальную конфигурацию из этой директории.

0 commit comments

Comments
 (0)