Skip to content

Commit e00f237

Browse files
authored
[docs/experiment] edit "ru" articles about Ansible (#4909)
1 parent b0b6d2e commit e00f237

File tree

8 files changed

+117
-104
lines changed

8 files changed

+117
-104
lines changed

ydb/docs/en/core/devops/ansible/initial-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For large-scale setups, it is recommended to use at least 9 servers for highly a
1818

1919
{% endnote %}
2020

21-
You can download the repository with example playbooks for installing {{ ydb-short-name }} on the cluster from GitHub`git clone https://github.com/ydb-platform/ydb-ansible-examples.git`. This repository contains a few installation templates for deploying {{ ydb-short-name }} clusters in subfolders, as well as scripts for generating TLS certificates and requirement files for installing necessary Python packages. In this article, we'll use the `3-nodes-mirror-3-dc` subfolder for the most simple setup. Alternatively, you can similarly use `8-nodes-block-4-2` or `9-nodes-mirror-3-dc` if you have the necessary number of suitable servers.
21+
Download the GitHub repository with examples for installing {{ ydb-short-name }} cluster – `git clone https://github.com/ydb-platform/ydb-ansible-examples.git`. This repository contains a few installation templates for deploying {{ ydb-short-name }} clusters in subfolders, as well as scripts for generating TLS certificates and requirement files for installing necessary Python packages. In this article, we'll use the `3-nodes-mirror-3-dc` subfolder for the most simple setup. Alternatively, you can similarly use `8-nodes-block-4-2` or `9-nodes-mirror-3-dc` if you have the necessary number of suitable servers.
2222

2323
{% cut "Repository Structure" %}
2424

ydb/docs/en/core/devops/ansible/restart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ To restart a specific host or subset of hosts, use the `--limit` argument:
4040

4141
```bash
4242
ansible-playbook ydb_platform.ydb.restart --limit='<hostname>'
43-
ansible-playbook ydb_platform.ydb.restart --limit='<hostname-1,hosntname-2>'
43+
ansible-playbook ydb_platform.ydb.restart --limit='<hostname-1,hostname-2>'
4444
```
4545

4646
It can be used together with tags, too:

ydb/docs/ru/core/devops/ansible/initial-deployment.md

Lines changed: 69 additions & 59 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Обеспечение наблюдаемости кластера {{ ydb-short-name }}, развёрнутого с помощью Ansible
22

3-
В этом разделе документации {{ ydb-short-name }} рассматриваются различные темы, связанные с наблюдаемостью (observability), специфичные для кластеров [развёрнутых с помощью Ansible](../initial-deployment.md).
3+
В этом разделе документации {{ ydb-short-name }} рассматриваются различные аспекты наблюдаемости (observability), специфичные для кластеров, [развёрнутых с помощью Ansible](../initial-deployment.md).
44

55
* [{#T}](logging.md)
66

7-
Также есть отдельный раздел с [{#T}](../../../reference/observability/index.md), содержащий статьи, не зависящие от выбранного метода развёртывания кластера.
7+
Также есть отдельный раздел [{#T}](../../../reference/observability/index.md), содержащий статьи, не зависящие от выбранного метода развёртывания кластера.

ydb/docs/ru/core/devops/ansible/observability/logging.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Просмотр логов с помощью Ansible playbook
66

7-
Репозиторий [ydb-ansible](https://github.com/ydb-platform/ydb-ansible) содержит playbook под названием `ydb_platform.ydb.logs`, который можно использовать для просмотра логов со всех узлов {{ ydb-short-name }} кластера. Этот playbook собирает логи с узлов и выводит в `stdout`, что позволяет при необходимости дальше их обработать, например, с помощью команд `grep` или `awk`.
7+
Репозиторий [ydb-ansible](https://github.com/ydb-platform/ydb-ansible) содержит playbook под названием `ydb_platform.ydb.logs`, который можно использовать для просмотра логов со всех узлов кластера {{ ydb-short-name }}. Этот playbook собирает логи с узлов и выводит их в `stdout`, что позволяет при необходимости дальше их обработать, например, с помощью команд `grep` или `awk`.
88

99
### Все логи всех узлов
1010

@@ -18,10 +18,10 @@ ansible-playbook ydb_platform.ydb.logs
1818

1919
В кластере {{ ydb-short-name }} есть два основных типа узлов:
2020

21-
* Storage (также известны как статические)
22-
* Database (также известны как динамические)
21+
* Storage (также известные как статические)
22+
* Database (также известные как динамические)
2323

24-
Задачи в playbook `ydb_platform.ydb.logs` размечены тегами по типам узлов, благодаря чему можно использовать функциональность тегов Ansible для фильтрации логов по типу узла.
24+
Задачи в playbook `ydb_platform.ydb.logs` размечены тегами по типам узлов, благодаря чему можно использовать функциональность тегов Ansible для фильтрации логов по типу узла.
2525

2626
Следующие две команды эквивалентны и будут выводить логи статических узлов:
2727

@@ -39,11 +39,11 @@ ansible-playbook ydb_platform.ydb.logs --tags dynamic
3939

4040
### Фильтрация по имени хоста
4141

42-
Чтобы отобразить логи определенного хоста или подмножества хостов, используйте аргумент `--limit`:
42+
Чтобы отобразить логи определённого хоста или подмножества хостов, используйте аргумент `--limit`:
4343

4444
```bash
4545
ansible-playbook ydb_platform.ydb.logs --limit='<hostname>'
46-
ansible-playbook ydb_platform.ydb.logs --limit='<hostname-1,hosntname-2>'
46+
ansible-playbook ydb_platform.ydb.logs --limit='<hostname-1,hostname-2>'
4747
```
4848

4949
Его также можно использовать вместе с тегами:
@@ -56,13 +56,13 @@ ansible-playbook ydb_platform.ydb.logs --tags database --limit='<hostname>'
5656

5757
Чтобы вручную получить доступ к логам кластера {{ ydb-short-name }} через `ssh`, выполните следующие действия:
5858

59-
1. Сформируйте команду `ssh` для доступа к серверу, на котором запущен узел {{ ydb-short-name }}, для которого вам нужны логи. Базовая версия будет выглядеть как `ssh -i <path-to-ssh-key> <username>@<hostname>`. Возьмите значения для составления этой команды из `inventory/50-inventory.yaml`, который вы использовали для развёртывания:
59+
1. Сформируйте команду `ssh` для доступа к серверу, на котором запущен узел {{ ydb-short-name }}, для которого вам нужны логи. Базовая версия будет выглядеть как `ssh -i <path-to-ssh-key> <username>@<hostname>`. Возьмите значения для составления этой команды из файла `inventory/50-inventory.yaml`, который вы использовали для развёртывания:
6060

6161
* `<path-to-ssh-key>` — это `children.ydb.ansible_ssh_private_key_file`;
6262
* `<username>` — это `children.ydb.ansible_user`;
6363
* `<hostname>` — это один из `children.ydb.hosts`.
6464

65-
2. Выберите логи какого systemd юнита вам нужны. Если вам уже известно название юнита, то этот шаг можно пропустить. После входа на сервер с помощью `ssh` команды, созданной на предыдущем шаге, получите список связанных с {{ ydb-short-name }} systemd юнитов, используя `systemctl list-units | grep ydb`. Как правило там будет один статический узел и несколько динамических узлов.
65+
2. Выберите, логи какого systemd юнита вам нужны. Если вам уже известно название юнита, этот шаг можно пропустить. После входа на сервер с помощью команды `ssh`, созданной на предыдущем шаге, получите список связанных с {{ ydb-short-name }} systemd юнитов, используя `systemctl list-units | grep ydb`. Как правило, там будет один статический узел и несколько динамических узлов.
6666

6767
{% cut "Пример вывода" %}
6868
```bash
@@ -74,4 +74,4 @@ ansible-playbook ydb_platform.ydb.logs --tags database --limit='<hostname>'
7474
```
7575
{% endcut %}
7676

77-
3. Возьмите название systemd юнита из предыдущего шага и используйте его в следующей команде `journalctl -u <systemd-unit>`, чтобы фактически отобразить логи. Вы можете указать `-u` несколько раз, чтобы отобразить логи нескольких юнитов, а также использовать любые другие аргументы из `man journalctl` для настройки вывода команды.
77+
3. Возьмите название systemd юнита из предыдущего шага и используйте его в следующей команде `journalctl -u <systemd-unit>`, чтобы фактически отобразить логи. Вы можете указать `-u` несколько раз, чтобы отобразить логи нескольких юнитов, а также использовать любые другие аргументы из `man journalctl` для настройки вывода команды.

0 commit comments

Comments
 (0)