diff --git a/docs/09-ansible-overview.md b/docs/09-ansible-overview.md index fe12508..c0a8eac 100644 --- a/docs/09-ansible-overview.md +++ b/docs/09-ansible-overview.md @@ -3,6 +3,8 @@ ## 🎯 Цель репозитория Автоматизированное развертывание и обслуживание всех сервисов домашнего мультимедиа центра. +Сервер стал полноценной частью семьи: дети смотрят мультфильмы, жена слушает аудиокниги, все общаются через голосовой чат или текстовые сообщения с друзьями. +Данный репозиторий создан для того, чтобы: - В случае непредвиденной ситуации кто-то из близких мог разобраться в конфигурации и продолжить поддержку сервера. - Я сам мог не помнить всех деталей настройки, которые делал несколько лет назад, и быстро находить нужную информацию. @@ -51,22 +53,57 @@ --- ## 📂 Структура репозитория -. -├── arhive_roles/ # Роли, которые не используются активно (сохранены для истории) -├── group_vars/ # Переменные для всех хостов (all.yml) -├── inventories/ # Файлы инвентаря (хосты, группы) -├── roles/ # Основные роли — каждый сервис или задача -├── olimp-deploy.yml # Главный плейбук, включающий все роли -├── README.md # Краткое описание (может быть заменён на главный документ) -└── vault.yml # Зашифрованный файл с секретами (редактируется через ansible-vault) +| Каталог / файл | Описание | +|------------------------------|----------------------------------------------------------------------------------------| +| `arhive_roles/` | Роли, которые не используются активно (сохранены для истории) | +| `group_vars/` | Переменные для всех хостов (файл `all.yml`) | +| `inventories/` | Файлы инвентаря (хосты, группы) | +| `roles/` | Основные роли — каждый сервис или задача | +| `olimp-deploy.yml` | Главный плейбук, включающий все роли | +| `README.md` | Краткое описание (может быть заменён на главный документ) | +| `vault.yml` | Зашифрованный файл с секретами (редактируется через `ansible-vault`) | -Каждая роль имеет типовую структуру: -- `tasks/main.yml` — основные задачи. -- `handlers/main.yml` — обработчики (обычно для перезапуска). -- `templates/*.j2` — шаблоны конфигов. -- `defaults/main.yml` — переменные по умолчанию (для некоторых ролей). -- `files/` — статические файлы (редко). +### Основные роли (`roles/`) + +| Роль | Назначение | +|-----------------------|-------------------------------------------------| +| ampache | Музыкальный стриминг-сервер | +| audiobookshelf | Сервер для аудиокниг и подкастов | +| base_setup | Базовая настройка системы (обновление, пакеты) | +| bitwarden | Менеджер паролей (Vaultwarden) | +| bookstack | Вики / база знаний | +| cadvisor | Мониторинг Docker-контейнеров | +| calibre-web | Веб-интерфейс для библиотеки Calibre | +| docker | Установка Docker и Docker Compose | +| flibusta | Зеркало библиотеки Флибуста (Z-Library) | +| gitlab | GitLab CE | +| grafana | Визуализация метрик (Grafana + VictoriaMetrics) | +| heimdall | Стартовая страница (дашборд) | +| immich | Фотогалерея / альтернатива Google Photos | +| jellyfin | Медиасервер (видео, музыка) | +| loki | Система сбора и хранения логов | +| mealie | Менеджер рецептов | +| meshcentral | Удалённое управление компьютерами | +| minecraft | Игровой сервер Minecraft | +| mumble | Голосовой чат (Mumble) | +| npm | Nginx Proxy Manager | +| promtail | Агент сбора логов для Loki | +| proxmox_base_setup | Базовая настройка хостов Proxmox | +| proxmox_monitoring | Мониторинг Proxmox (pve_exporter) | +| qbittorrent | Торрент-клиент | +| snikket | Коммуникационный сервер (XMPP) | +| system_cleanup | Очистка системы (логи, временные файлы) | +| teamspeak | Голосовой сервер TeamSpeak | +| torrserver | Торрент-стриминг (TorrServer) | + +### Архивные роли (`arhive_roles/`) + +| Роль | Описание | +|---------------------|-----------------------------------------------------| +| dashy | Альтернативный дашборд (не используется) | +| [delete]pve_monitoring | Старая версия мониторинга Proxmox (удалена) | +| matrix | Сервер Matrix (неактивен) | ---