From aea5bd3bce2890bc7fa24c4a07b8d9ae9eb8d3b1 Mon Sep 17 00:00:00 2001
From: LeoR156 <277007013+LeoR156@users.noreply.github.com>
Date: Sat, 19 Sep 2026 16:25:00 +0500
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?=
=?UTF-8?q?=D0=BD=20README.md=20=D1=81=20=D0=BE=D0=BF=D0=B8=D1=81=D0=B0?=
=?UTF-8?q?=D0=BD=D0=B8=D0=B5=D0=BC=20=D0=BF=D1=80=D0=BE=D0=B5=D0=BA=D1=82?=
=?UTF-8?q?=D0=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Добавлен README.md с описанием проекта автоматического развертывания кластера мониторинга, включая инструкции по установке и настройке.
---
README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 86 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..686477a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,86 @@
+# Automated Monitoring Stack
+
+
+
+
+
+
+
+
+### Infrastructure-as-Code проект для автоматического развертывания кластера мониторинга с нуля. Позволяет за 5 минут поднять сервера в облаке и накатить на них метрики.
+
+### Стек :hammer_and_wrench::
+* :building_construction: __terraform Terraform v1.16.2 on linux_amd64 - для создания ВМ в облаке Yandex Cloud.__
+* :rocket: __ansible [core 2.20.1] - для автоматической установки нужных компонентов и накатки конфигураций.__
+* :whale: __docker - для изоляции сервисов и запуске на любых машинах.__
+* :memo: __prometheus и node exporters - для опроса и получения метрик с целевых серверов.__
+* :bar_chart: __grafana - для красивой визуализации данных.__
+
+***
+
+## __Краткая архитектура__ 💡
+* Главный сервер (general_server): настраивается в ручную, вписывается первым под группой ` servers ` в inventory и настраивается в файле ` general_server `, который должен быть расположен в папке `host_vars`.
+* terraform идёт в облако Yandex Cloud и поднимает нужное количество серверов (настраивается в variable.tf). После развертывания серверов создает inventory файл с настройками каждой машины в папке `host_vars`, чтобы запустить плейбук можно было без ручного ввода.
+* Ansible получает готовую конфигурацию и идёт на `general_server`, чтобы поднять два контейнера: __prometheus и grafana__. Он динамически подставляет переменные из папки `group_vars`, чтобы контейнеры получили готовую конфигурацию. Затем он идёт на остальные сервера, ставит `node_exporter` с официального репозитория на GitHub, настраивает __systemd__ службу и автозапуск.
+
+## Безопасность :lock::
+* Пароли и логины хранятся в папке `group_vars` в файле `vault.yml`, который в свою очередь зашифрован мастер-паролем хранилища __vault Ansible__.
+* Сразу настраивается __basic_auth__ на всех сервисах: Grafana, Ansible, Node_Exporters
+* Стейт terraform и ключи __игнорируются__ git.
+* Подключение к серверам идёт строго по __ssh ключам__.
+
+ ***
+
+## Быстрый старт:
+### Вам понадобится:
+* Аккаунт Yandex Cloud с ключами. Можно получить тут: Консоль Yandex Cloud. Поместите ключи в папку `terraform-infra/`
+* Операционная система Linux с установленной на ней terraform, ansible и git. Команды для установки (__работает на: ubuntu и debian__): 'sudo apt update && sudo apt install -y ansible terraform git'
+
+### Конкретные действия для развёртывания:
+* Клонируйте и перейдите в скачанный репозиторий командой `git clone https://github.com/LeoR156/metrics-prometheus-grafana && cd metrics-prometheus-grafana/group_vars/all/`
+* Откройте `vault.yml` и сотрите содержимое. Команда `> vault.yml && nano vault.yml`.
+* Напишите туда ваши реальные данные по шаблону c сохранением кавычек:
+```
+grafana_admin_user: "ваш_логин_для_grafana"
+grafana_admin_password: "ваш_пароль_для_grafana"
+
+prom_admin_user: "ваш_логин_для_prometheus"
+prom_admin_password: "ваш_пароль_для_prometheus"
+
+exporter_user: "ваш_логин_для_exportes"
+exporter_password: "ваш_пароль_для_exporters"
+
+```
+* Примените изменения: `ctrl + x`, `y` и `enter`
+* Желательно применить шифрование, команда: `ansible-vault encrypt vault.yml`. Придумайте и введите пароль. ⚠️: __Если шифруете, то запомните пароль, иначе для просмотра нужно будет расшифровать файл командой: `ansible-vault decrypt <путь_и_имя_файла>` __
+* Вернитесь на две папки выше командой `cd ../..` и перейдите в папку `host_vars` командой `cd host_vars/`. Создайте файл `general_server.yml` и введите туда данные командой `nano general_server.yml`. (__с сохранением кавычек__)
+```
+ansible_host: "ваш_IP_главного_сервера"
+ansible_user: "ваш_юзер"
+ansible_ssh_private_key_file: "путь_до_ssh_ключа"
+```
+* Примените изменения: `ctrl + x`, `y` и `enter`
+* Переместитесь в `terraform_infra` командами `cd .. && cd terraform-infra/`
+* ⚠️: __Убедитесь, что файл с ключами яндекса находится именно в этой папке!__
+* Скачайте плагины провайдера командой `terraform init`. Дождитесь полной загрузки. По окончании убедитесь, что установка прошла корректно: сообщение `Terraform has been successfully initialized!`
+* `terraform plan` - предварительно ознакомиться с изменениями. `terraform apply` - команда применить измениня, нужно ввести __yes__. Дождитесь, пока terraform знакончит свою работу.
+* Вернитесь в папку `metrics-prometheus-grafana командой `cd ..` и запустите плейбук командой `ansible-playbook -i terraform-infra/inventory.ini playbook.yml --ask-vault-pass`. __введите пароль, если задавали его ранее__
+* #### Пару-тройку минут и ansible сделает свою работу
+
+### Подключение и первый дашборд:
+* Зайдите на IP general_server, порт 3001. Шаблон: `http://:3001`
+* Введите логин и пароль от `grafana`, который вы задавали ранее в файле `vault.yml`
+* Зайдите на вкладку `dashboards` слева экрана > нажмите `new` справа > нажмите `import dashboards` > вставьте ID 1860 и нажмите `load` > затем снова `import`.
+#### Готово! Метрики настроены.
+
+
+# Планы дальнейшего развитий проекта:
+### * Разбить таски по ролям ansible.
+### * Добавить возможность получения ssl сертификата ради безопасного https соединения.
+### * Прикрутить алерт-менеджер + Telegram Notifications.
+
+
+
+
+
+