docs: обновлена документация проекта

- Удален тестовый скрипт runner/test-config-generation.sh - Обновлен docs/overview.md: - Добавлена информация о гибкой конфигурации коллекторов - Добавлена информация о командах обновления - Обновлено описание структуры runner/ - Добавлена ссылка на docs/ansible_groups.md - Обновлен docs/deploy.md: - Убраны ссылки на устаревшие -raw папки - Добавлена информация о командах обновления - Добавлен раздел о гибкой конфигурации коллекторов - Добавлены примеры развертывания на конкретных группах - Исправлен порядок команд в Makefile (перенесены в правильное место) Автор: Сергей Антропов Сайт: https://devops.org.ru
2025-09-15 14:58:41 +03:00 · 2025-09-15 14:58:41 +03:00 · d1da51d875
commit d1da51d875
parent 330397f331
4 changed files with 62 additions and 111 deletions
--- a/31
+++ b/31
@ -150,6 +150,22 @@ delete-service:
 	docker run --rm -e ANSIBLE_HOST_KEY_CHECKING=False -v $$PWD:/workspace -v $$HOME/.ssh:/root/.ssh:ro -w /workspace cytopia/ansible:latest-tools \
 	ansible-playbook -i runner/inventory.ini runner/delete/playbook.yml -e ansible_ssh_private_key_file=/root/.ssh/id_rsa -e ansible_become=true -e ansible_become_method=sudo

+# Обновление сервиса (удаление + развертывание через systemd)
+update-service:
+	# Обновление systemd-сервиса: остановка, удаление, развертывание
+	@echo "🔄 Обновление systemd-сервиса..."
+	@$(MAKE) delete-service
+	@$(MAKE) deploy-service
+	@echo "✅ Обновление systemd-сервиса завершено"
+
+# Обновление агента (удаление + развертывание без systemd)
+update:
+	# Обновление агента: удаление, развертывание
+	@echo "🔄 Обновление агента..."
+	@$(MAKE) delete
+	@$(MAKE) deploy
+	@echo "✅ Обновление агента завершено"
+
 	

 test:
@ -191,19 +207,4 @@ kafka-once:
 kafka-consume:
 	@docker run --rm edenhill/kcat:1.7.1 -b 10.99.0.90:9092 -t sensus.metrics -o -5 -C -q -J | cat

-# Обновление сервиса (удаление + развертывание через systemd)
-update-service:
-	# Обновление systemd-сервиса: остановка, удаление, развертывание
-	@echo "🔄 Обновление systemd-сервиса..."
-	@$(MAKE) delete-service
-	@$(MAKE) deploy-service
-	@echo "✅ Обновление systemd-сервиса завершено"
-
-# Обновление агента (удаление + развертывание без systemd)
-update:
-	# Обновление агента: удаление, развертывание
-	@echo "🔄 Обновление агента..."
-	@$(MAKE) delete
-	@$(MAKE) deploy
-	@echo "✅ Обновление агента завершено"

--- a/docs/deploy.md
+++ b/docs/deploy.md
@ -4,8 +4,9 @@

 Варианты развертывания:
 - Docker Compose: файл `docker-compose.yml`
- Systemd сервис: через raw-роль `runner/deploy-service-raw` (юнит находится в `runner/sensusagent.service` при необходимости)
- Ansible-плейбуки (без Python на целевом хосте): `runner/deploy-raw`, `runner/delete-raw`, а также service-варианты `*-raw`
+- Systemd сервис: через роль `runner/deploy-service` (юнит находится в `runner/sensusagent.service` при необходимости)
+- Ansible-плейбуки (без Python на целевом хосте): `runner/deploy`, `runner/delete`, а также service-варианты
+- Гибкая конфигурация коллекторов через Ansible группы

 Подготовка удаленного хоста:
 - Доступ по SSH (ключ находится у оператора)
@ -25,16 +26,25 @@ make deploy
 make delete
 ```

-Деплой и запуск через systemd (raw):
+Деплой и запуск через systemd:
 ```bash
 make deploy-service
 ```

-Остановка и очистка systemd-варианта (raw):
+Остановка и очистка systemd-варианта:
 ```bash
 make delete-service
 ```

+Обновление агента:
+```bash
+# Обновление systemd-сервиса (рекомендуется)
+make update-service
+
+# Обновление агента без systemd
+make update
+```
+
 Прямое использование systemd юнита:
 Разместите юнит-файл по пути `/etc/systemd/system/sensusagent.service` со следующим содержимым:
 ```ini
@ -74,3 +84,31 @@ sudo journalctl -u sensusagent -f
 Инвентори:
 - Файл `runner/inventory.ini` определяет целевые хосты и параметры подключения

+## Гибкая конфигурация коллекторов
+
+Проект поддерживает гибкую настройку коллекторов через Ansible группы:
+
+### Группы хостов:
+- **`proxmox`** - Proxmox ноды (коллекторы: `proxcluster`, `proxnode`, `proxvms`, `uptime`)
+- **`proxvms`** - VM/контейнеры Proxmox (коллекторы: `proxvmsystem`, `uptime`)
+- **`standalone`** - автономные серверы (коллекторы: `system`, `hba`, `sensors`, `uptime`)
+
+### Развертывание на конкретной группе:
+```bash
+# Только на Proxmox нодах
+make deploy-service --limit proxmox
+
+# Только на VM/контейнерах
+make deploy-service --limit proxvms
+
+# Только на автономных серверах
+make deploy-service --limit standalone
+```
+
+### Конфигурация групп:
+- Переменные групп: `runner/group_vars/`
+- Шаблоны конфигурации: `runner/templates/`
+- Автоматическая генерация `config.yaml` на основе группы
+
+Подробнее см. `docs/ansible_groups.md`
+
--- a/docs/overview.md
+++ b/docs/overview.md
@ -10,12 +10,14 @@ SensusAgent — модульный агент сбора метрик и инв
 - Гибкая конфигурация через `bin/agent/config.yaml` и переменные окружения
 - Кроссплатформенная сборка через Docker и Makefile (без локальной Go-сборки)
 - Деплой и удаление через Ansible (`make deploy`, `make delete`, а также варианты с systemd)
+- Гибкая конфигурация коллекторов через Ansible группы
+- Команды обновления (`make update-service`, `make update`)

 Архитектура и компоненты репозитория:
 - `src/core/*` — ядро агента (конфигурация, реестр коллекторов, раннер, логирование, вывод)
 - `src/collectors/*` — исходники Go-коллекторов (сборка в `bin/agent/collectors`)
 - `bin/agent` — исполняемые файлы и конфиги агента (`config.yaml`, собранные коллекторы)
- `runner/*` — сценарии Ansible для деплоя/удаления (и для systemd)
+- `runner/*` — сценарии Ansible для деплоя/удаления (и для systemd), групповые переменные и шаблоны
 - `docs/*` — документация проекта

 Поток выполнения:
@ -44,3 +46,4 @@ SensusAgent — модульный агент сбора метрик и инв
 - Коллекторы: `docs/collectors.md`
 - Сборка/запуск: `docs/build_and_run.md`
 - Деплой: `docs/deploy.md`
+- Гибкая конфигурация коллекторов: `docs/ansible_groups.md`
--- a/runner/test-config-generation.sh
+++ b/runner/test-config-generation.sh
@ -1,91 +0,0 @@
-#!/bin/bash
-# Скрипт для тестирования генерации конфигурации коллекторов
-# Автор: Сергей Антропов
-# Сайт: https://devops.org.ru
-
-set -e
-
-echo "🔧 Тестирование генерации конфигурации коллекторов"
-echo "=================================================="
-
-# Функция для тестирования группы
-test_group() {
-    local group_name=$1
-    echo ""
-    echo "📋 Тестирование группы: $group_name"
-    echo "----------------------------------------"
-    
-    # Создаем временный inventory файл
-    cat > /tmp/test_inventory.ini << EOF
-[$group_name]
-test-host ansible_host=127.0.0.1 ansible_user=test
-EOF
-    
-    # Запускаем ansible для генерации конфигурации
-    ansible-playbook -i /tmp/test_inventory.ini \
-        -e "tmp_dir=/tmp/sensusagent_test" \
-        --check \
-        --diff \
-        test-config-generation.yml
-    
-    echo "✅ Группа $group_name протестирована"
-}
-
-# Создаем тестовый playbook
-cat > test-config-generation.yml << 'EOF'
---
- hosts: all
-  gather_facts: no
-  vars:
-    tmp_dir: /tmp/sensusagent_test
-  tasks:
-    - name: Create temp directory
-      ansible.builtin.file:
-        path: "{{ tmp_dir }}"
-        state: directory
-        mode: '0755'
-      delegate_to: localhost
-      run_once: true
-
-    - name: Generate config.yaml from template
-      ansible.builtin.template:
-        src: templates/config.yaml.j2
-        dest: "{{ tmp_dir }}/config.yaml"
-        mode: '0644'
-      delegate_to: localhost
-      run_once: true
-
-    - name: Display generated config
-      ansible.builtin.debug:
-        msg: "Generated config for group {{ group_names[0] }}"
-      run_once: true
-
-    - name: Show config content
-      ansible.builtin.shell: cat "{{ tmp_dir }}/config.yaml"
-      delegate_to: localhost
-      run_once: true
-      register: config_content
-
-    - name: Display config content
-      ansible.builtin.debug:
-        var: config_content.stdout_lines
-      run_once: true
-EOF
-
-echo "🧪 Тестируем все группы..."
-
-# Тестируем каждую группу
-test_group "proxmox"
-test_group "proxvms" 
-test_group "standalone"
-
-# Очистка
-rm -f /tmp/test_inventory.ini
-rm -f test-config-generation.yml
-rm -rf /tmp/sensusagent_test
-
-echo ""
-echo "🎉 Все тесты завершены успешно!"
-echo ""
-echo "📝 Для применения изменений используйте:"
-echo "   make delete-service && make deploy-service"