From 3d3a28432cd80659203d3d688bd0fbb8c6fb6865 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D0=B5=D1=80=D0=B3=D0=B5=D0=B9=20=D0=90=D0=BD=D1=82?= =?UTF-8?q?=D1=80=D0=BE=D0=BF=D0=BE=D0=B2?= Date: Sun, 26 Oct 2025 01:08:35 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=BF=D0=BE=D0=BB=D0=BD=D0=BE=D0=B5=20?= =?UTF-8?q?=D0=BE=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB=D0=B5=D0=BD=D0=B8=D0=B5=20?= =?UTF-8?q?=D1=80=D0=B0=D0=B7=D0=B4=D0=B5=D0=BB=D0=B0=20'=D0=9E=D1=81?= =?UTF-8?q?=D0=BD=D0=BE=D0=B2=D0=BD=D1=8B=D0=B5=20=D0=BA=D0=BE=D0=BC=D0=B0?= =?UTF-8?q?=D0=BD=D0=B4=D1=8B'=20=D0=B2=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Добавлены все команды из Makefile с подробными описаниями - Организованы команды по категориям: * Управление ролями (list, create, delete, lint, test, deploy) * Управление Preset'ами (list, info, test) * Управление секретами Vault (init, create, edit, show, delete, encrypt, decrypt, rekey, check, scan) * Управление Git (push, pull, new) * Управление Docker образами (build, push, pull, clean, purge, info, update, builder management) * Управление Ansible Controller (build, rebuild, run, stop) * Собственные образы для тестирования (test, check, build) * Автоматизация (update-playbooks, generate-docs, setup-cicd) * Очистка (clean-containers, docker clean/purge) * Справка (help и детальная справка по каждой категории) - Добавлены примеры использования команд - Уточнены описания для каждой команды Автор: Сергей Антропов Сайт: https://devops.org.ru --- README.md | 172 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 157 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4bd4496..4d0bb32 100644 --- a/README.md +++ b/README.md @@ -230,36 +230,178 @@ ansible_ssh_private_key_file=~/.ssh/id_rsa ### Управление ролями ```bash -# Просмотр всех ролей -ls -1 roles/ +# Список всех ролей +make role list # показать все роли +ls -1 roles/ # альтернативный способ -# Проверка синтаксиса -make role lint # все роли -make role lint docker # конкретная роль +# Создание новой роли +make role create # интерактивное создание роли -# Тестирование -make role test # default preset -make role test minimal # minimal preset +# Удаление роли +make role delete # интерактивное удаление роли + +# Проверка синтаксиса (Linting) +make role lint # проверить все роли +make role lint docker # проверить конкретную роль +make role lint ping # пример проверки одной роли + +# Тестирование ролей +make role test # тест с default preset +make role test minimal # тест с minimal preset +make role test all-images # тест со всеми образами +make role test etcd-patroni # тест с кастомным preset + +# Развертывание на продакшн +make role deploy # развернуть роли на реальные серверы ``` -### Управление секретами +### Управление Preset'ами ```bash +# Просмотр доступных preset'ов +make presets list # показать все preset'ы + +# Информация о preset'е +make presets info PRESET=etcd-patroni # подробная информация + +# Тестирование с preset'ом +make presets test PRESET=minimal # запустить тест с preset'ом +``` + +### Управление секретами (Vault) + +```bash +# Инициализация vault +make vault init # создать vault/.vault с паролем + # Создание секретов -make vault create +make vault create # создать новый файл секретов # Редактирование -make vault edit +make vault edit # редактировать существующие секреты # Просмотр -make vault show +make vault show # показать содержимое секретов + +# Удаление +make vault delete # удалить файл секретов + +# Шифрование/расшифровка +make vault encrypt # зашифровать файл +make vault decrypt # расшифровать файл +make vault rekey # сменить пароль шифрования + +# Проверка и аудит +make vault check # проверить vault файлы +make vault scan # поиск потенциальных секретов ``` -### Развертывание +### Управление Git ```bash -# Развертывание на продакшн -make role deploy +# Отправка изменений +make git push # git add . && git commit && git push + +# Получение изменений +make git pull # git pull origin main + +# Создание ветки +make git new # создать новую ветку +``` + +### Управление Docker образами + +```bash +# Подготовка к работе +make docker prepare # показать registry, version, список образов + +# Сборка образов +make docker build # собрать все образы (multi-arch) +make docker build-image IMAGE=centos7 # собрать отдельный образ +make docker rebuild # полная пересборка с очисткой кеша + +# Работа с Docker Hub +make docker push # отправить образы в Docker Hub +make docker pull # загрузить образы из Docker Hub + +# Очистка +make docker clean # удалить локальные образы и кеш +make docker clean-builder # очистка multi-arch builder +make docker purge # ПОЛНАЯ очистка Docker (осторожно!) + +# Информация +make docker info # информация о собранных образах +make docker update # обновить все образы (pull + build + push) + +# Управление builder'ом +make docker setup-builder # настройка multi-arch builder +make docker diagnose # диагностика buildx проблем +make docker reset-builder # сброс buildx builder +``` + +### Управление Ansible Controller + +```bash +# Сборка и запуск +make controller build # собрать ansible-controller (multi-arch) +make controller rebuild # пересобрать с исправлениями +make controller run # запустить ansible-controller +make controller stop # остановить ansible-controller +``` + +### Собственные образы для тестирования + +```bash +# Тестирование с собственными образами +make custom-images test minimal # минимальный тест (4 хоста) +make custom-images test full # полный тест (все образы) +make custom-images test performance # тест производительности (8 хостов) + +# Проверка наличия образов +make custom-images check # проверить наличие собственных образов + +# Сборка образов +make custom-images build # собрать все образы для тестирования +``` + +### Автоматизация + +```bash +# Обновление playbook'ов +make update-playbooks # обновление при добавлении ролей + +# Генерация документации +make generate-docs # генерация документации для ролей + +# Настройка CI/CD +make setup-cicd # настройка CI/CD для всех платформ +``` + +### Очистка + +```bash +# Очистка контейнеров Molecule +make clean-containers # удалить контейнеры Molecule + +# Очистка Docker +make docker clean # удалить образы и кеш +make docker clean-builder # очистить builder +make docker purge # ПОЛНАЯ очистка Docker +``` + +### Справка + +```bash +# Основная справка +make help # показать общую справку + +# Детальная справка по командам +make role # справка по работе с ролями +make presets # справка по preset'ам +make vault # справка по vault +make docker # справка по docker +make controller # справка по controller +make custom-images # справка по собственным образам ``` ## 📖 Документация