docs: Обновление документации с новыми функциями
- Добавлена информация об интерактивном управлении ролями - Обновлены разделы быстрого старта - Добавлены примеры использования make role list/create/delete - Обновлена документация по созданию ролей - Добавлена информация о автоматическом обновлении playbook'ов - Обновлен раздел результатов с новыми возможностями
This commit is contained in:
41
README.md
41
README.md
@@ -41,6 +41,9 @@ AnsibleTemplate - это универсальная система для тес
|
|||||||
- **Автоматическое создание** тестовых окружений
|
- **Автоматическое создание** тестовых окружений
|
||||||
- **Поддержка systemd** в контейнерах
|
- **Поддержка systemd** в контейнерах
|
||||||
- **DinD/DOoD** поддержка для Docker функциональности
|
- **DinD/DOoD** поддержка для Docker функциональности
|
||||||
|
- **Интерактивное управление ролями** - создание, удаление, просмотр ролей
|
||||||
|
- **Автоматическое обновление** playbook'ов при добавлении новых ролей
|
||||||
|
- **Комплексное тестирование** всех образов одновременно (all-images preset)
|
||||||
|
|
||||||
### 🔐 Безопасность и секреты
|
### 🔐 Безопасность и секреты
|
||||||
- **Ansible Vault** интеграция
|
- **Ansible Vault** интеграция
|
||||||
@@ -147,7 +150,20 @@ make docker build
|
|||||||
make docker info
|
make docker info
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Тестирование ролей
|
### 3. Управление ролями
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Просмотр всех ролей
|
||||||
|
make role list
|
||||||
|
|
||||||
|
# Создание новой роли (интерактивно)
|
||||||
|
make role create
|
||||||
|
|
||||||
|
# Удаление роли (интерактивно)
|
||||||
|
make role delete
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Тестирование ролей
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Просмотр доступных preset'ов
|
# Просмотр доступных preset'ов
|
||||||
@@ -464,6 +480,22 @@ make role deploy 2>&1 | tee deployment.log
|
|||||||
|
|
||||||
## 🔧 Вспомогательные команды
|
## 🔧 Вспомогательные команды
|
||||||
|
|
||||||
|
### Управление ролями
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Просмотр всех ролей
|
||||||
|
make role list
|
||||||
|
|
||||||
|
# Создание новой роли (интерактивно)
|
||||||
|
make role create
|
||||||
|
|
||||||
|
# Удаление роли (интерактивно)
|
||||||
|
make role delete
|
||||||
|
|
||||||
|
# Проверка синтаксиса ролей
|
||||||
|
make role lint
|
||||||
|
```
|
||||||
|
|
||||||
### Docker команды
|
### Docker команды
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -480,9 +512,6 @@ make docker update
|
|||||||
### Другие команды
|
### Другие команды
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Проверка синтаксиса ролей
|
|
||||||
make role lint
|
|
||||||
|
|
||||||
# Создание секретов
|
# Создание секретов
|
||||||
make vault create
|
make vault create
|
||||||
|
|
||||||
@@ -2104,6 +2133,10 @@ MIT License - см. файл [LICENSE](LICENSE)
|
|||||||
12. ✅ **Собственные Docker образы для различных ОС**
|
12. ✅ **Собственные Docker образы для различных ОС**
|
||||||
13. ✅ **Systemd поддержка в контейнерах**
|
13. ✅ **Systemd поддержка в контейнерах**
|
||||||
14. ✅ **DinD/DOoD поддержка для Docker функциональности**
|
14. ✅ **DinD/DOoD поддержка для Docker функциональности**
|
||||||
|
15. ✅ **Интерактивное управление ролями** - создание, удаление, просмотр ролей
|
||||||
|
16. ✅ **Автоматическое обновление playbook'ов** при добавлении новых ролей
|
||||||
|
17. ✅ **Комплексное тестирование всех образов** одновременно (all-images preset)
|
||||||
|
18. ✅ **Подробная документация по кастомизации deploy.yml** с примерами
|
||||||
|
|
||||||
## 📚 Навигация по документации
|
## 📚 Навигация по документации
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,29 @@
|
|||||||
**Автор:** Сергей Антропов
|
**Автор:** Сергей Антропов
|
||||||
**Сайт:** https://devops.org.ru
|
**Сайт:** https://devops.org.ru
|
||||||
|
|
||||||
|
## 🚀 Быстрый старт
|
||||||
|
|
||||||
|
### Интерактивное управление ролями
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Просмотр всех ролей
|
||||||
|
make role list
|
||||||
|
|
||||||
|
# Создание новой роли (интерактивно)
|
||||||
|
make role create
|
||||||
|
|
||||||
|
# Удаление роли (интерактивно)
|
||||||
|
make role delete
|
||||||
|
```
|
||||||
|
|
||||||
|
### Автоматическое обновление
|
||||||
|
|
||||||
|
При создании или удалении роли система автоматически:
|
||||||
|
- ✅ Обновляет `roles/deploy.yml`
|
||||||
|
- ✅ Создает полную структуру папок
|
||||||
|
- ✅ Генерирует README.md с документацией
|
||||||
|
- ✅ Настраивает метаданные роли
|
||||||
|
|
||||||
## 📁 Структура роли
|
## 📁 Структура роли
|
||||||
|
|
||||||
### Стандартная структура
|
### Стандартная структура
|
||||||
@@ -28,6 +51,21 @@ roles/my-role/
|
|||||||
|
|
||||||
### Создание структуры
|
### Создание структуры
|
||||||
|
|
||||||
|
#### Автоматическое создание (рекомендуется)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Интерактивное создание роли
|
||||||
|
make role create
|
||||||
|
|
||||||
|
# Система автоматически:
|
||||||
|
# - Создаст структуру папок
|
||||||
|
# - Создаст все необходимые файлы
|
||||||
|
# - Обновит roles/deploy.yml
|
||||||
|
# - Создаст README.md с документацией
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Ручное создание
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Создание директории роли
|
# Создание директории роли
|
||||||
mkdir -p roles/my-role/{tasks,handlers,templates,files,vars,defaults,meta}
|
mkdir -p roles/my-role/{tasks,handlers,templates,files,vars,defaults,meta}
|
||||||
|
|||||||
@@ -37,7 +37,20 @@ make docker info
|
|||||||
|
|
||||||
## 🧪 Первое тестирование
|
## 🧪 Первое тестирование
|
||||||
|
|
||||||
### 1. Просмотр доступных preset'ов
|
### 1. Управление ролями
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Просмотр всех ролей
|
||||||
|
make role list
|
||||||
|
|
||||||
|
# Создание новой роли (интерактивно)
|
||||||
|
make role create
|
||||||
|
|
||||||
|
# Удаление роли (интерактивно)
|
||||||
|
make role delete
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Просмотр доступных preset'ов
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Список всех preset'ов
|
# Список всех preset'ов
|
||||||
@@ -47,7 +60,7 @@ make presets list
|
|||||||
make presets info PRESET=default
|
make presets info PRESET=default
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Тестирование роли ping
|
### 3. Тестирование роли ping
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Тестирование с default preset
|
# Тестирование с default preset
|
||||||
|
|||||||
Reference in New Issue
Block a user