feat: Создана полная документация проекта с централизованным хранением
- Создан новый README.md с полной документацией проекта - Перемещены все MD файлы в папку /docs - Создана структура документации: - docs/universal-lab.md - руководство по лаборатории - docs/presets.md - описание всех 21 пресета - docs/roles.md - структура и создание Ansible ролей - docs/examples.md - практические примеры использования - docs/troubleshooting.md - решение проблем - docs/api.md - справочник по API Основные возможности документации: - Полное описание всех возможностей лаборатории - 21 готовый пресет для различных сценариев - Подробные инструкции по использованию - Примеры создания собственных пресетов - Руководство по созданию Ansible ролей - Troubleshooting для решения проблем - API Reference для всех команд и параметров Структура проекта: - README.md - основная документация с ссылками - docs/ - централизованное хранение документации - molecule/presets/ - 21 готовый пресет - files/ - файлы для ролей и playbooks - scripts/ - скрипты для управления лабораторией Автор: Сергей Антропов Сайт: https://devops.org.ru
This commit is contained in:
572
docs/api.md
Normal file
572
docs/api.md
Normal file
@@ -0,0 +1,572 @@
|
||||
# API Reference
|
||||
|
||||
## Автор
|
||||
Сергей Антропов
|
||||
Сайт: https://devops.org.ru
|
||||
|
||||
## Описание
|
||||
|
||||
Этот документ содержит справочник по API универсальной лаборатории, включая все доступные команды, параметры и конфигурации.
|
||||
|
||||
## Содержание
|
||||
|
||||
- [Makefile команды](#makefile-команды)
|
||||
- [Пресеты API](#пресеты-api)
|
||||
- [Kubernetes API](#kubernetes-api)
|
||||
- [Docker API](#docker-api)
|
||||
- [Molecule API](#molecule-api)
|
||||
- [Отчеты API](#отчеты-api)
|
||||
- [Скрипты API](#скрипты-api)
|
||||
|
||||
## Makefile команды
|
||||
|
||||
### Основные команды
|
||||
|
||||
| Команда | Описание | Параметры |
|
||||
|---------|----------|-----------|
|
||||
| `make lab-up` | Поднять контроллер | - |
|
||||
| `make lab-down` | Погасить контроллер | - |
|
||||
| `make lab-sh` | Войти в контроллер | - |
|
||||
| `make lab-test` | Полный цикл Molecule | `SCENARIO=universal` |
|
||||
| `make lab-create` | Создать инфраструктуру | - |
|
||||
| `make lab-converge` | Запустить роли | - |
|
||||
| `make lab-verify` | Проверить работу | - |
|
||||
| `make lab-destroy` | Уничтожить инфраструктуру | - |
|
||||
| `make lab-reset` | Полный сброс | - |
|
||||
|
||||
### Kubernetes команды
|
||||
|
||||
| Команда | Описание | Параметры |
|
||||
|---------|----------|-----------|
|
||||
| `make kube-sh` | Shell с kubectl | - |
|
||||
| `make kube-cmd` | Выполнить kubectl команду | `CLUSTER=lab CMD="get pods"` |
|
||||
| `make kube-enter` | Войти в кластер | `CLUSTER=lab` |
|
||||
| `make kiali-port-forward` | Port-forward Kiali | `CLUSTER=lab` |
|
||||
| `make istio-gw-port-forward` | Port-forward Istio Gateway | `CLUSTER=lab` |
|
||||
| `make grafana-port-forward` | Port-forward Grafana | `CLUSTER=lab` |
|
||||
| `make prom-port-forward` | Port-forward Prometheus | `CLUSTER=lab` |
|
||||
| `make kube-pf-stop` | Остановить все port-forward | - |
|
||||
|
||||
### Отчеты и мониторинг
|
||||
|
||||
| Команда | Описание | Параметры |
|
||||
|---------|----------|-----------|
|
||||
| `make lab-report` | Сгенерировать HTML отчет | - |
|
||||
| `make lab-snapshot` | Сохранить снапшот | - |
|
||||
| `make lab-restore` | Восстановить из снапшота | - |
|
||||
| `make lab-cleanup` | Очистить лабораторию | - |
|
||||
| `make bookinfo-url` | Получить URL Bookinfo | - |
|
||||
| `make grafana-open` | Открыть Grafana | - |
|
||||
|
||||
### Pre-commit команды
|
||||
|
||||
| Команда | Описание | Параметры |
|
||||
|---------|----------|-----------|
|
||||
| `make pre-commit-install` | Установить pre-commit хуки | - |
|
||||
| `make pre-commit-run` | Запустить pre-commit | - |
|
||||
|
||||
## Пресеты API
|
||||
|
||||
### Структура пресета
|
||||
|
||||
```yaml
|
||||
---
|
||||
# ПРЕСЕТ: Название (количество машин)
|
||||
#
|
||||
# Описание: Подробное описание пресета
|
||||
#
|
||||
# Использование: make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/your-preset.yml
|
||||
#
|
||||
# Автор: Ваше имя
|
||||
# Сайт: https://your-site.com
|
||||
|
||||
# Сеть для лаборатории
|
||||
docker_network: labnet
|
||||
|
||||
# Kind кластеры (опционально)
|
||||
kind_clusters:
|
||||
- name: cluster-name
|
||||
workers: 2
|
||||
api_port: 6443
|
||||
addons:
|
||||
ingress_nginx: true
|
||||
metrics_server: true
|
||||
istio: true
|
||||
kiali: true
|
||||
prometheus_stack: true
|
||||
ingress_host_http_port: 8081
|
||||
ingress_host_https_port: 8443
|
||||
|
||||
# Образы для разных семейств ОС
|
||||
images:
|
||||
debian: "ghcr.io/ansible-community/molecule-ubuntu-systemd:jammy"
|
||||
rhel: "quay.io/centos/centos:stream9-systemd"
|
||||
|
||||
# Настройки по умолчанию для systemd контейнеров
|
||||
systemd_defaults:
|
||||
privileged: true
|
||||
command: "/sbin/init"
|
||||
volumes:
|
||||
- "/sys/fs/cgroup:/sys/fs/cgroup:ro"
|
||||
tmpfs:
|
||||
- "/run"
|
||||
- "/run/lock"
|
||||
capabilities:
|
||||
- "SYS_ADMIN"
|
||||
|
||||
# Определение хостов лаборатории
|
||||
hosts:
|
||||
- name: host-name
|
||||
family: debian|rhel
|
||||
type: systemd|dind|dood
|
||||
group: group-name
|
||||
publish:
|
||||
- "host-port:container-port"
|
||||
env:
|
||||
KEY: value
|
||||
volumes:
|
||||
- "host-path:container-path"
|
||||
tmpfs:
|
||||
- "/tmp"
|
||||
capabilities:
|
||||
- "SYS_ADMIN"
|
||||
```
|
||||
|
||||
### Параметры хостов
|
||||
|
||||
| Параметр | Тип | Описание | Обязательный |
|
||||
|----------|-----|----------|--------------|
|
||||
| `name` | string | Имя хоста | Да |
|
||||
| `family` | string | Семейство ОС (debian/rhel) | Нет |
|
||||
| `type` | string | Тип контейнера (systemd/dind/dood) | Нет |
|
||||
| `group` | string | Группа хоста | Нет |
|
||||
| `publish` | array | Публикация портов | Нет |
|
||||
| `env` | object | Переменные окружения | Нет |
|
||||
| `volumes` | array | Монтирование томов | Нет |
|
||||
| `tmpfs` | array | Временные файловые системы | Нет |
|
||||
| `capabilities` | array | Capabilities | Нет |
|
||||
|
||||
### Параметры Kind кластеров
|
||||
|
||||
| Параметр | Тип | Описание | Обязательный |
|
||||
|----------|-----|----------|--------------|
|
||||
| `name` | string | Имя кластера | Да |
|
||||
| `workers` | integer | Количество worker узлов | Нет |
|
||||
| `api_port` | integer | Порт API сервера | Нет |
|
||||
| `addons` | object | Включенные аддоны | Нет |
|
||||
| `ingress_host_http_port` | integer | HTTP порт для ingress | Нет |
|
||||
| `ingress_host_https_port` | integer | HTTPS порт для ingress | Нет |
|
||||
|
||||
### Аддоны Kind кластеров
|
||||
|
||||
| Аддон | Тип | Описание |
|
||||
|-------|-----|----------|
|
||||
| `ingress_nginx` | boolean | Ingress NGINX контроллер |
|
||||
| `metrics_server` | boolean | Metrics Server для метрик |
|
||||
| `istio` | boolean | Istio service mesh |
|
||||
| `kiali` | boolean | Kiali для визуализации |
|
||||
| `prometheus_stack` | boolean | Prometheus + Grafana |
|
||||
|
||||
## Kubernetes API
|
||||
|
||||
### kubectl команды
|
||||
|
||||
```bash
|
||||
# Получить информацию о кластере
|
||||
kubectl cluster-info
|
||||
|
||||
# Получить ноды
|
||||
kubectl get nodes
|
||||
|
||||
# Получить поды
|
||||
kubectl get pods -A
|
||||
|
||||
# Получить сервисы
|
||||
kubectl get svc -A
|
||||
|
||||
# Получить события
|
||||
kubectl get events --sort-by=.metadata.creationTimestamp
|
||||
|
||||
# Описать ресурс
|
||||
kubectl describe pod <pod-name>
|
||||
|
||||
# Логи пода
|
||||
kubectl logs <pod-name>
|
||||
|
||||
# Войти в под
|
||||
kubectl exec -it <pod-name> -- /bin/sh
|
||||
```
|
||||
|
||||
### Port-forward команды
|
||||
|
||||
```bash
|
||||
# Port-forward сервиса
|
||||
kubectl port-forward svc/<service-name> <local-port>:<remote-port>
|
||||
|
||||
# Port-forward пода
|
||||
kubectl port-forward pod/<pod-name> <local-port>:<remote-port>
|
||||
|
||||
# Port-forward в фоне
|
||||
kubectl port-forward svc/<service-name> <local-port>:<remote-port> &
|
||||
|
||||
# Остановить все port-forward
|
||||
pkill -f "kubectl .* port-forward"
|
||||
```
|
||||
|
||||
### Istio команды
|
||||
|
||||
```bash
|
||||
# Проверить Istio
|
||||
istioctl version
|
||||
|
||||
# Установить Istio
|
||||
istioctl install --set profile=demo
|
||||
|
||||
# Удалить Istio
|
||||
istioctl uninstall --purge
|
||||
|
||||
# Проверить статус
|
||||
istioctl proxy-status
|
||||
|
||||
# Получить конфигурацию
|
||||
istioctl proxy-config cluster <pod-name>
|
||||
```
|
||||
|
||||
## Docker API
|
||||
|
||||
### Docker команды
|
||||
|
||||
```bash
|
||||
# Список контейнеров
|
||||
docker ps
|
||||
|
||||
# Список образов
|
||||
docker images
|
||||
|
||||
# Список сетей
|
||||
docker network ls
|
||||
|
||||
# Список томов
|
||||
docker volume ls
|
||||
|
||||
# Информация о контейнере
|
||||
docker inspect <container-name>
|
||||
|
||||
# Логи контейнера
|
||||
docker logs <container-name>
|
||||
|
||||
# Войти в контейнер
|
||||
docker exec -it <container-name> /bin/sh
|
||||
```
|
||||
|
||||
### Docker Compose команды
|
||||
|
||||
```bash
|
||||
# Запустить стек
|
||||
docker-compose up -d
|
||||
|
||||
# Остановить стек
|
||||
docker-compose down
|
||||
|
||||
# Логи стека
|
||||
docker-compose logs
|
||||
|
||||
# Масштабирование
|
||||
docker-compose up --scale service=3
|
||||
```
|
||||
|
||||
### Docker Swarm команды
|
||||
|
||||
```bash
|
||||
# Инициализировать Swarm
|
||||
docker swarm init
|
||||
|
||||
# Присоединиться к Swarm
|
||||
docker swarm join --token <token> <manager-ip>:2377
|
||||
|
||||
# Список нод
|
||||
docker node ls
|
||||
|
||||
# Создать сервис
|
||||
docker service create --name <service-name> <image>
|
||||
|
||||
# Масштабировать сервис
|
||||
docker service scale <service-name>=3
|
||||
```
|
||||
|
||||
## Molecule API
|
||||
|
||||
### Molecule команды
|
||||
|
||||
```bash
|
||||
# Создать сценарий
|
||||
molecule init scenario <scenario-name>
|
||||
|
||||
# Создать роль
|
||||
molecule init role <role-name>
|
||||
|
||||
# Проверить синтаксис
|
||||
molecule syntax
|
||||
|
||||
# Проверить конфигурацию
|
||||
molecule lint
|
||||
|
||||
# Валидация
|
||||
molecule validate
|
||||
|
||||
# Создать инфраструктуру
|
||||
molecule create
|
||||
|
||||
# Запустить роли
|
||||
molecule converge
|
||||
|
||||
# Проверить работу
|
||||
molecule verify
|
||||
|
||||
# Уничтожить инфраструктуру
|
||||
molecule destroy
|
||||
|
||||
# Полный цикл
|
||||
molecule test
|
||||
```
|
||||
|
||||
### Конфигурация molecule.yml
|
||||
|
||||
```yaml
|
||||
---
|
||||
driver:
|
||||
name: docker
|
||||
|
||||
platforms:
|
||||
- name: instance
|
||||
image: "ghcr.io/ansible-community/molecule-ubuntu-systemd:jammy"
|
||||
privileged: true
|
||||
pre_build_image: true
|
||||
command: "/sbin/init"
|
||||
volumes:
|
||||
- "/sys/fs/cgroup:/sys/fs/cgroup:ro"
|
||||
capabilities:
|
||||
- "SYS_ADMIN"
|
||||
tmpfs:
|
||||
- "/run"
|
||||
- "/run/lock"
|
||||
|
||||
provisioner:
|
||||
name: ansible
|
||||
config_options:
|
||||
defaults:
|
||||
stdout_callback: default
|
||||
callbacks_enabled: profile_tasks
|
||||
env:
|
||||
ANSIBLE_STDOUT_CALLBACK: default
|
||||
|
||||
dependency:
|
||||
name: galaxy
|
||||
enabled: false
|
||||
|
||||
verifier:
|
||||
name: ansible
|
||||
|
||||
lint: |-
|
||||
set -e
|
||||
ansible-lint
|
||||
```
|
||||
|
||||
## Отчеты API
|
||||
|
||||
### HTML отчет
|
||||
|
||||
```bash
|
||||
# Генерация отчета
|
||||
python3 scripts/report_html.py <input.json> <output.html>
|
||||
|
||||
# Параметры
|
||||
# input.json - JSON файл с данными
|
||||
# output.html - HTML файл для вывода
|
||||
```
|
||||
|
||||
### JSON структура
|
||||
|
||||
```json
|
||||
{
|
||||
"timestamp": "2024-01-01T00:00:00Z",
|
||||
"idempotence_raw": "changed=0",
|
||||
"haproxy_select1": "1",
|
||||
"helm_ingress_toolbox_raw": "ingress ready",
|
||||
"istio_kiali_raw": "istio-system pods running",
|
||||
"istio_bookinfo_raw": "bookinfo deployed",
|
||||
"k8s_overview_raw": "nodes ready"
|
||||
}
|
||||
```
|
||||
|
||||
### HTML структура
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
<html lang="ru">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Lab Report</title>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<style>
|
||||
/* CSS стили */
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<div class="hdr">
|
||||
<h1>Ansible Lab Report</h1>
|
||||
<div class="time">generated: timestamp</div>
|
||||
</div>
|
||||
<div class="grid">
|
||||
<!-- Отчеты -->
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
## Скрипты API
|
||||
|
||||
### snapshot.sh
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
# Создание снапшотов лаборатории
|
||||
|
||||
# Параметры
|
||||
OUT_DIR="snapshots"
|
||||
|
||||
# Создать директорию
|
||||
mkdir -p "$OUT_DIR"
|
||||
|
||||
# Получить ID контейнеров
|
||||
ids=$(docker ps -q --filter "label=ansible.lab=true")
|
||||
|
||||
# Создать снапшоты
|
||||
for id in $ids; do
|
||||
name=$(docker inspect --format '{{.Name}}' "$id" | sed 's#^/##')
|
||||
img="lab-snap-$name:latest"
|
||||
echo "[snapshot] $name -> $img"
|
||||
docker commit "$id" "$img" >/dev/null
|
||||
echo "$img" > "$OUT_DIR/$name.image"
|
||||
done
|
||||
```
|
||||
|
||||
### restore.sh
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
# Восстановление из снапшотов
|
||||
|
||||
# Параметры
|
||||
IN_DIR="snapshots"
|
||||
|
||||
# Проверить директорию
|
||||
[ -d "$IN_DIR" ] || { echo "No snapshots dir"; exit 1; }
|
||||
|
||||
# Восстановить контейнеры
|
||||
for f in "$IN_DIR"/*.image; do
|
||||
[ -f "$f" ] || continue
|
||||
name=$(basename "$f" .image)
|
||||
img=$(cat "$f")
|
||||
echo "[restore] $name from $img"
|
||||
docker rm -f "$name" >/dev/null 2>&1 || true
|
||||
docker run -d --name "$name" "$img" >/dev/null
|
||||
done
|
||||
```
|
||||
|
||||
### cleanup.sh
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
# Очистка лаборатории
|
||||
|
||||
echo "[cleanup] removing lab containers/volumes/networks"
|
||||
|
||||
# Удалить контейнеры
|
||||
docker ps -aq --filter "label=ansible.lab=true" | xargs -r docker rm -f
|
||||
|
||||
# Удалить тома
|
||||
docker volume ls -q --filter "name=_docker$" | xargs -r docker volume rm
|
||||
|
||||
# Удалить сеть
|
||||
docker network rm labnet >/dev/null 2>&1 || true
|
||||
|
||||
echo "done."
|
||||
```
|
||||
|
||||
## Переменные окружения
|
||||
|
||||
### Основные переменные
|
||||
|
||||
| Переменная | Описание | Значение по умолчанию |
|
||||
|------------|----------|----------------------|
|
||||
| `LAB_SPEC` | Путь к пресету | `molecule/presets/minimal.yml` |
|
||||
| `SCENARIO` | Сценарий Molecule | `universal` |
|
||||
| `COMPOSE` | Docker Compose команда | `docker compose` |
|
||||
| `ROLES_DIR` | Директория с ролями | `./roles` |
|
||||
| `LAB_PAUSE_MINUTES` | Пауза для ручной проверки | `10` |
|
||||
|
||||
### Kubernetes переменные
|
||||
|
||||
| Переменная | Описание | Значение по умолчанию |
|
||||
|------------|----------|----------------------|
|
||||
| `KUBECONFIG` | Путь к kubeconfig | `~/.kube/config` |
|
||||
| `KUBE_CONTEXT` | Контекст Kubernetes | `kind-lab` |
|
||||
| `ISTIO_VERSION` | Версия Istio | `1.22.1` |
|
||||
| `KIND_VERSION` | Версия Kind | `v0.23.0` |
|
||||
|
||||
### Docker переменные
|
||||
|
||||
| Переменная | Описание | Значение по умолчанию |
|
||||
|------------|----------|----------------------|
|
||||
| `DOCKER_HOST` | Docker daemon адрес | `unix:///var/run/docker.sock` |
|
||||
| `DOCKER_TLS_CERTDIR` | Директория TLS сертификатов | `""` |
|
||||
| `DOCKER_BUILDKIT` | Использовать BuildKit | `1` |
|
||||
|
||||
## Конфигурационные файлы
|
||||
|
||||
### docker-compose.yaml
|
||||
|
||||
```yaml
|
||||
version: "3.9"
|
||||
|
||||
services:
|
||||
ansible-controller:
|
||||
image: quay.io/ansible/creator-ee:latest
|
||||
container_name: ansible-controller
|
||||
privileged: true
|
||||
command: sleep infinity
|
||||
environment:
|
||||
DOCKER_HOST: unix:///var/run/docker.sock
|
||||
ANSIBLE_VAULT_PASSWORD_FILE: /ansible/vault-password.txt
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- ./molecule:/ansible/molecule
|
||||
- ./files:/ansible/files
|
||||
- ./vault-password.txt:/ansible/vault-password.txt
|
||||
- ${ROLES_DIR:-./roles}:/ansible/roles:ro
|
||||
working_dir: /ansible
|
||||
```
|
||||
|
||||
### .pre-commit-config.yaml
|
||||
|
||||
```yaml
|
||||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.4.0
|
||||
hooks:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- id: check-yaml
|
||||
- id: check-added-large-files
|
||||
- repo: https://github.com/ansible/ansible-lint
|
||||
rev: v6.17.2
|
||||
hooks:
|
||||
- id: ansible-lint
|
||||
```
|
||||
|
||||
## Заключение
|
||||
|
||||
Этот справочник содержит все необходимые API для работы с универсальной лабораторией. Для получения дополнительной информации обратитесь к [основной документации](universal-lab.md) и [примерам использования](examples.md).
|
||||
462
docs/examples.md
Normal file
462
docs/examples.md
Normal file
@@ -0,0 +1,462 @@
|
||||
# Примеры использования
|
||||
|
||||
## Автор
|
||||
Сергей Антропов
|
||||
Сайт: https://devops.org.ru
|
||||
|
||||
## Описание
|
||||
|
||||
Этот документ содержит практические примеры использования универсальной лаборатории для различных сценариев тестирования Ansible ролей.
|
||||
|
||||
## Содержание
|
||||
|
||||
- [Базовые примеры](#базовые-примеры)
|
||||
- [Kubernetes примеры](#kubernetes-примеры)
|
||||
- [Docker примеры](#docker-примеры)
|
||||
- [Смешанные примеры](#смешанные-примеры)
|
||||
- [Мониторинг и отчеты](#мониторинг-и-отчеты)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
|
||||
## Базовые примеры
|
||||
|
||||
### Пример 1: Тестирование веб-сервера
|
||||
|
||||
```bash
|
||||
# Запустить веб-приложение пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/webapp.yml
|
||||
|
||||
# Проверить статус
|
||||
make lab-verify
|
||||
|
||||
# Посмотреть отчет
|
||||
make lab-report
|
||||
```
|
||||
|
||||
### Пример 2: Тестирование базы данных
|
||||
|
||||
```bash
|
||||
# Запустить пресет с базой данных
|
||||
make lab-test LAB_SPEC=molecule/presets/ha.yml
|
||||
|
||||
# Проверить подключение к БД
|
||||
make kube-cmd CLUSTER=lab CMD="exec -it postgres-0 -- psql -U postgres -c 'SELECT 1;'"
|
||||
```
|
||||
|
||||
### Пример 3: Тестирование микросервисов
|
||||
|
||||
```bash
|
||||
# Запустить микросервисный пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/microservices.yml
|
||||
|
||||
# Проверить API Gateway
|
||||
curl http://localhost:8000/health
|
||||
```
|
||||
|
||||
## Kubernetes примеры
|
||||
|
||||
### Пример 1: Простой Kubernetes кластер
|
||||
|
||||
```bash
|
||||
# Запустить одиночный Kind кластер
|
||||
make lab-test LAB_SPEC=molecule/presets/k8s-single.yml
|
||||
|
||||
# Войти в кластер
|
||||
make kube-sh
|
||||
|
||||
# Проверить ноды
|
||||
kubectl get nodes
|
||||
|
||||
# Проверить поды
|
||||
kubectl get pods -A
|
||||
```
|
||||
|
||||
### Пример 2: Мульти-кластерная конфигурация
|
||||
|
||||
```bash
|
||||
# Запустить мульти-кластер
|
||||
make lab-test LAB_SPEC=molecule/presets/k8s-multi.yml
|
||||
|
||||
# Переключиться между кластерами
|
||||
kubectl config use-context kind-dev
|
||||
kubectl get nodes
|
||||
|
||||
kubectl config use-context kind-staging
|
||||
kubectl get nodes
|
||||
|
||||
kubectl config use-context kind-prod
|
||||
kubectl get nodes
|
||||
```
|
||||
|
||||
### Пример 3: Istio Service Mesh
|
||||
|
||||
```bash
|
||||
# Запустить полный Istio стек
|
||||
make lab-test LAB_SPEC=molecule/presets/k8s-istio-full.yml
|
||||
|
||||
# Port-forward Kiali
|
||||
make kiali-port-forward CLUSTER=istio-full
|
||||
|
||||
# Port-forward Istio Gateway
|
||||
make istio-gw-port-forward CLUSTER=istio-full
|
||||
|
||||
# Открыть Kiali
|
||||
open http://localhost:20001
|
||||
|
||||
# Открыть Bookinfo
|
||||
open http://localhost:8082/productpage
|
||||
```
|
||||
|
||||
### Пример 4: Мониторинг Kubernetes
|
||||
|
||||
```bash
|
||||
# Port-forward Grafana
|
||||
make grafana-port-forward CLUSTER=istio-full
|
||||
|
||||
# Port-forward Prometheus
|
||||
make prom-port-forward CLUSTER=istio-full
|
||||
|
||||
# Открыть Grafana
|
||||
open http://localhost:3000
|
||||
|
||||
# Открыть Prometheus
|
||||
open http://localhost:9090
|
||||
```
|
||||
|
||||
## Docker примеры
|
||||
|
||||
### Пример 1: Docker-in-Docker
|
||||
|
||||
```bash
|
||||
# Запустить DinD пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/dind-simple.yml
|
||||
|
||||
# Войти в DinD контейнер
|
||||
docker exec -it dind1 sh
|
||||
|
||||
# Внутри контейнера проверить Docker
|
||||
docker ps
|
||||
docker images
|
||||
```
|
||||
|
||||
### Пример 2: Docker Swarm
|
||||
|
||||
```bash
|
||||
# Запустить Docker Swarm пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/dind-swarm.yml
|
||||
|
||||
# Войти в manager
|
||||
docker exec -it swarm-manager sh
|
||||
|
||||
# Инициализировать Swarm
|
||||
docker swarm init
|
||||
|
||||
# Присоединить workers
|
||||
docker node ls
|
||||
```
|
||||
|
||||
### Пример 3: Docker Compose
|
||||
|
||||
```bash
|
||||
# Запустить Compose пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/dind-compose.yml
|
||||
|
||||
# Войти в compose контейнер
|
||||
docker exec -it compose-web sh
|
||||
|
||||
# Создать docker-compose.yml
|
||||
cat > docker-compose.yml << EOF
|
||||
version: '3.8'
|
||||
services:
|
||||
web:
|
||||
image: nginx:alpine
|
||||
ports:
|
||||
- "80:80"
|
||||
api:
|
||||
image: node:alpine
|
||||
ports:
|
||||
- "3000:3000"
|
||||
EOF
|
||||
|
||||
# Запустить стек
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Пример 4: Docker-outside-of-Docker
|
||||
|
||||
```bash
|
||||
# Запустить DOoD пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/dood-simple.yml
|
||||
|
||||
# Войти в DOoD контейнер
|
||||
docker exec -it dood1 sh
|
||||
|
||||
# Проверить доступ к Docker daemon хоста
|
||||
docker ps
|
||||
docker images
|
||||
```
|
||||
|
||||
## Смешанные примеры
|
||||
|
||||
### Пример 1: Kubernetes + DinD
|
||||
|
||||
```bash
|
||||
# Запустить смешанный пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/mixed-k8s-dind.yml
|
||||
|
||||
# Проверить Kubernetes
|
||||
make kube-cmd CLUSTER=hybrid CMD="get nodes"
|
||||
|
||||
# Проверить DinD
|
||||
docker exec -it dind-dev sh
|
||||
docker ps
|
||||
```
|
||||
|
||||
### Пример 2: Kubernetes + DOoD
|
||||
|
||||
```bash
|
||||
# Запустить смешанный пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/mixed-k8s-dood.yml
|
||||
|
||||
# Проверить Kubernetes
|
||||
make kube-cmd CLUSTER=hybrid CMD="get pods -A"
|
||||
|
||||
# Проверить DOoD
|
||||
docker exec -it dood-web sh
|
||||
docker ps
|
||||
```
|
||||
|
||||
### Пример 3: Полная гибридная конфигурация
|
||||
|
||||
```bash
|
||||
# Запустить полный смешанный пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/mixed-full.yml
|
||||
|
||||
# Проверить все компоненты
|
||||
make kube-cmd CLUSTER=full-stack CMD="get nodes"
|
||||
docker exec -it dind-dev sh
|
||||
docker exec -it dood-web sh
|
||||
```
|
||||
|
||||
## Мониторинг и отчеты
|
||||
|
||||
### Пример 1: Генерация HTML отчета
|
||||
|
||||
```bash
|
||||
# Запустить тест
|
||||
make lab-test LAB_SPEC=molecule/presets/enterprise.yml
|
||||
|
||||
# Сгенерировать отчет
|
||||
make lab-report
|
||||
|
||||
# Открыть отчет
|
||||
open reports/lab-report.html
|
||||
```
|
||||
|
||||
### Пример 2: Снапшоты
|
||||
|
||||
```bash
|
||||
# Создать снапшот
|
||||
make lab-snapshot
|
||||
|
||||
# Восстановить из снапшота
|
||||
make lab-restore
|
||||
|
||||
# Очистить лабораторию
|
||||
make lab-cleanup
|
||||
```
|
||||
|
||||
### Пример 3: Мониторинг в реальном времени
|
||||
|
||||
```bash
|
||||
# Port-forward всех сервисов мониторинга
|
||||
make grafana-port-forward CLUSTER=lab
|
||||
make prom-port-forward CLUSTER=lab
|
||||
make kiali-port-forward CLUSTER=lab
|
||||
|
||||
# Открыть все дашборды
|
||||
open http://localhost:3000 # Grafana
|
||||
open http://localhost:9090 # Prometheus
|
||||
open http://localhost:20001 # Kiali
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Пример 1: Проблемы с портами
|
||||
|
||||
```bash
|
||||
# Проверить занятые порты
|
||||
netstat -tulpn | grep :8080
|
||||
|
||||
# Остановить все port-forward
|
||||
make kube-pf-stop
|
||||
|
||||
# Перезапустить лабораторию
|
||||
make lab-reset
|
||||
```
|
||||
|
||||
### Пример 2: Проблемы с Docker
|
||||
|
||||
```bash
|
||||
# Проверить Docker daemon
|
||||
docker ps
|
||||
|
||||
# Перезапустить Docker
|
||||
sudo systemctl restart docker
|
||||
|
||||
# Очистить Docker
|
||||
docker system prune -a
|
||||
```
|
||||
|
||||
### Пример 3: Проблемы с Kubernetes
|
||||
|
||||
```bash
|
||||
# Проверить Kind кластеры
|
||||
kind get clusters
|
||||
|
||||
# Удалить проблемный кластер
|
||||
kind delete cluster --name lab
|
||||
|
||||
# Пересоздать кластер
|
||||
make lab-create
|
||||
```
|
||||
|
||||
### Пример 4: Проблемы с ресурсами
|
||||
|
||||
```bash
|
||||
# Проверить использование ресурсов
|
||||
docker stats
|
||||
|
||||
# Ограничить ресурсы
|
||||
docker run --memory=512m --cpus=1.0 your-image
|
||||
|
||||
# Очистить неиспользуемые ресурсы
|
||||
make lab-cleanup
|
||||
```
|
||||
|
||||
## Продвинутые примеры
|
||||
|
||||
### Пример 1: Создание собственного пресета
|
||||
|
||||
```bash
|
||||
# Создать новый пресет
|
||||
cat > molecule/presets/my-custom.yml << EOF
|
||||
---
|
||||
# ПРЕСЕТ: Мой кастомный пресет
|
||||
#
|
||||
# Описание: Кастомная конфигурация для моих нужд
|
||||
#
|
||||
# Использование: make lab-test LAB_SPEC=molecule/presets/my-custom.yml
|
||||
|
||||
docker_network: labnet
|
||||
|
||||
images:
|
||||
debian: "ghcr.io/ansible-community/molecule-ubuntu-systemd:jammy"
|
||||
rhel: "quay.io/centos/centos:stream9-systemd"
|
||||
|
||||
systemd_defaults:
|
||||
privileged: true
|
||||
command: "/sbin/init"
|
||||
volumes:
|
||||
- "/sys/fs/cgroup:/sys/fs/cgroup:ro"
|
||||
tmpfs:
|
||||
- "/run"
|
||||
- "/run/lock"
|
||||
capabilities:
|
||||
- "SYS_ADMIN"
|
||||
|
||||
hosts:
|
||||
- name: my-web
|
||||
family: debian
|
||||
group: webservers
|
||||
publish:
|
||||
- "8080:80"
|
||||
|
||||
- name: my-db
|
||||
family: rhel
|
||||
group: databases
|
||||
publish:
|
||||
- "5432:5432"
|
||||
EOF
|
||||
|
||||
# Протестировать пресет
|
||||
make lab-test LAB_SPEC=molecule/presets/my-custom.yml
|
||||
```
|
||||
|
||||
### Пример 2: Создание собственной роли
|
||||
|
||||
```bash
|
||||
# Создать структуру роли
|
||||
mkdir -p roles/my-role/{tasks,handlers,templates,files,vars,defaults,meta}
|
||||
|
||||
# Создать основной task
|
||||
cat > roles/my-role/tasks/main.yml << EOF
|
||||
---
|
||||
- name: Install nginx
|
||||
package:
|
||||
name: nginx
|
||||
state: present
|
||||
|
||||
- name: Start nginx
|
||||
service:
|
||||
name: nginx
|
||||
state: started
|
||||
enabled: true
|
||||
EOF
|
||||
|
||||
# Создать playbook
|
||||
cat > files/playbooks/my-playbook.yml << EOF
|
||||
---
|
||||
- name: Deploy my role
|
||||
hosts: webservers
|
||||
become: true
|
||||
roles:
|
||||
- my-role
|
||||
EOF
|
||||
|
||||
# Протестировать роль
|
||||
make lab-test LAB_SPEC=molecule/presets/webapp.yml
|
||||
```
|
||||
|
||||
### Пример 3: Интеграция с CI/CD
|
||||
|
||||
```bash
|
||||
# Создать GitHub Actions workflow
|
||||
cat > .github/workflows/test.yml << EOF
|
||||
name: Test Ansible Roles
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Docker
|
||||
run: |
|
||||
docker-compose up -d
|
||||
|
||||
- name: Run tests
|
||||
run: |
|
||||
make lab-test LAB_SPEC=molecule/presets/minimal.yml
|
||||
|
||||
- name: Generate report
|
||||
run: |
|
||||
make lab-report
|
||||
|
||||
- name: Upload report
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: lab-report
|
||||
path: reports/lab-report.html
|
||||
EOF
|
||||
```
|
||||
|
||||
## Заключение
|
||||
|
||||
Эти примеры демонстрируют основные возможности универсальной лаборатории. Для получения дополнительной информации обратитесь к [основной документации](universal-lab.md) и [описанию пресетов](presets.md).
|
||||
196
docs/presets.md
Normal file
196
docs/presets.md
Normal file
@@ -0,0 +1,196 @@
|
||||
# Пресеты универсальной лаборатории
|
||||
|
||||
## Автор
|
||||
Сергей Антропов
|
||||
Сайт: https://devops.org.ru
|
||||
|
||||
## Описание
|
||||
|
||||
Этот каталог содержит готовые пресеты для различных сценариев тестирования Ansible ролей. Каждый пресет оптимизирован для определенного типа инфраструктуры и количества машин.
|
||||
|
||||
## Доступные пресеты
|
||||
|
||||
### 🏗️ Классические пресеты (systemd контейнеры)
|
||||
|
||||
#### 1. Минимальная лаборатория (1-3 машины)
|
||||
**Файл:** `minimal.yml`
|
||||
**Описание:** Базовая конфигурация для простых тестов Ansible ролей
|
||||
**Компоненты:** 1 контроллер, 1 веб-сервер, 1 база данных
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/minimal.yml`
|
||||
|
||||
### 2. Веб-приложение (3-5 машин)
|
||||
**Файл:** `webapp.yml`
|
||||
**Описание:** Классическая архитектура веб-приложения
|
||||
**Компоненты:** 2 веб-сервера, 1 БД, 1 кэш, 1 балансировщик
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/webapp.yml`
|
||||
|
||||
### 3. Микросервисы (5-8 машин)
|
||||
**Файл:** `microservices.yml`
|
||||
**Описание:** Архитектура микросервисов с разделением ответственности
|
||||
**Компоненты:** API Gateway, микросервисы, БД, кэш, очередь, мониторинг
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/microservices.yml`
|
||||
|
||||
### 4. Высокая доступность (6-10 машин)
|
||||
**Файл:** `ha.yml`
|
||||
**Описание:** Кластер высокой доступности с репликацией
|
||||
**Компоненты:** 2 веб-сервера, 2 БД, 2 кэша, балансировщик, мониторинг
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/ha.yml`
|
||||
|
||||
### 5. Kubernetes кластер (8-12 машин)
|
||||
**Файл:** `k8s-cluster.yml`
|
||||
**Описание:** Полноценный Kubernetes кластер с различными ролями
|
||||
**Компоненты:** 3 master, 3 worker, 3 etcd, ingress, мониторинг
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/k8s-cluster.yml`
|
||||
|
||||
### 6. CI/CD пайплайн (10-15 машин)
|
||||
**Файл:** `cicd.yml`
|
||||
**Описание:** Полноценный CI/CD пайплайн с различными инструментами
|
||||
**Компоненты:** Git, Jenkins, Nexus, Docker Registry, среды, мониторинг, ELK
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/cicd.yml`
|
||||
|
||||
### 7. Big Data кластер (12-18 машин)
|
||||
**Файл:** `bigdata.yml`
|
||||
**Описание:** Кластер для обработки больших данных
|
||||
**Компоненты:** Hadoop, Spark, Kafka, Zookeeper, Elasticsearch, Kibana
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/bigdata.yml`
|
||||
|
||||
### 8. Service Mesh (15-20 машин)
|
||||
**Файл:** `servicemesh.yml`
|
||||
**Описание:** Полноценный service mesh с Istio и множественными сервисами
|
||||
**Компоненты:** Istio, Frontend, Backend, БД, кэш, мониторинг, трассировка
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/servicemesh.yml`
|
||||
|
||||
### 9. Enterprise (18-20 машин)
|
||||
**Файл:** `enterprise.yml`
|
||||
**Описание:** Полноценная enterprise инфраструктура с высокой доступностью
|
||||
**Компоненты:** LB, Web, API Gateway, App, БД, кэш, очереди, поиск, мониторинг, логи, backup
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/enterprise.yml`
|
||||
|
||||
### 10. Максимальный (20 машин)
|
||||
**Файл:** `maximum.yml`
|
||||
**Описание:** Максимально сложная инфраструктура для экстремальных условий
|
||||
**Компоненты:** Все компоненты enterprise + трассировка + визуализация
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/maximum.yml`
|
||||
|
||||
### ☸️ Kubernetes пресеты
|
||||
|
||||
#### 11. Kubernetes Single Node (1 кластер)
|
||||
**Файл:** `k8s-single.yml`
|
||||
**Описание:** Одиночный Kind кластер для простого тестирования K8s ролей
|
||||
**Компоненты:** 1 Kind кластер с 1 worker, базовые аддоны
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/k8s-single.yml`
|
||||
|
||||
#### 12. Kubernetes Multi-Cluster (3 кластера)
|
||||
**Файл:** `k8s-multi.yml`
|
||||
**Описание:** Несколько Kind кластеров для тестирования мульти-кластерных сценариев
|
||||
**Компоненты:** 3 кластера (dev, staging, prod) с различными конфигурациями
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/k8s-multi.yml`
|
||||
|
||||
#### 13. Kubernetes + Istio Full Stack (1 кластер с полным стеком)
|
||||
**Файл:** `k8s-istio-full.yml`
|
||||
**Описание:** Полноценный Kubernetes кластер с полным стеком Istio
|
||||
**Компоненты:** 1 Kind кластер с 3 workers, Istio, Kiali, Prometheus, Grafana, Jaeger
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/k8s-istio-full.yml`
|
||||
|
||||
### 🐳 Docker-in-Docker (DinD) пресеты
|
||||
|
||||
#### 14. DinD Simple (3 DinD контейнера)
|
||||
**Файл:** `dind-simple.yml`
|
||||
**Описание:** Простая конфигурация DinD для тестирования Docker ролей
|
||||
**Компоненты:** 3 DinD контейнера с изолированными Docker средами
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/dind-simple.yml`
|
||||
|
||||
#### 15. DinD Swarm (5 DinD контейнеров)
|
||||
**Файл:** `dind-swarm.yml`
|
||||
**Описание:** Docker Swarm кластер для тестирования оркестрации
|
||||
**Компоненты:** 1 Manager + 4 Worker узла в Docker Swarm режиме
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/dind-swarm.yml`
|
||||
|
||||
#### 16. DinD Compose (4 DinD контейнера)
|
||||
**Файл:** `dind-compose.yml`
|
||||
**Описание:** DinD контейнеры для тестирования Docker Compose стека
|
||||
**Компоненты:** 4 DinD контейнера с различными стеками
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/dind-compose.yml`
|
||||
|
||||
### 🔗 Docker-outside-of-Docker (DOoD) пресеты
|
||||
|
||||
#### 17. DOoD Simple (3 DOoD контейнера)
|
||||
**Файл:** `dood-simple.yml`
|
||||
**Описание:** Простая конфигурация DOoD для тестирования Docker ролей
|
||||
**Компоненты:** 3 DOoD контейнера с доступом к Docker daemon хоста
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/dood-simple.yml`
|
||||
|
||||
#### 18. DOoD Mixed (5 DOoD + 2 systemd)
|
||||
**Файл:** `dood-mixed.yml`
|
||||
**Описание:** Смешанная конфигурация DOoD и systemd контейнеров
|
||||
**Компоненты:** 5 DOoD контейнеров для Docker операций + 2 systemd для системных ролей
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/dood-mixed.yml`
|
||||
|
||||
### 🔀 Смешанные пресеты
|
||||
|
||||
#### 19. Mixed Kubernetes + DinD (1 K8s + 3 DinD)
|
||||
**Файл:** `mixed-k8s-dind.yml`
|
||||
**Описание:** Смешанная конфигурация Kubernetes и Docker-in-Docker
|
||||
**Компоненты:** 1 Kind кластер + 3 DinD контейнера
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/mixed-k8s-dind.yml`
|
||||
|
||||
#### 20. Mixed Kubernetes + DOoD (1 K8s + 3 DOoD)
|
||||
**Файл:** `mixed-k8s-dood.yml`
|
||||
**Описание:** Смешанная конфигурация Kubernetes и Docker-outside-of-Docker
|
||||
**Компоненты:** 1 Kind кластер + 3 DOoD контейнера
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/mixed-k8s-dood.yml`
|
||||
|
||||
#### 21. Mixed Full Stack (1 K8s + 2 DinD + 2 DOoD + 2 systemd)
|
||||
**Файл:** `mixed-full.yml`
|
||||
**Описание:** Полная смешанная конфигурация для комплексного тестирования
|
||||
**Компоненты:** 1 Kind кластер + 2 DinD + 2 DOoD + 2 systemd контейнера
|
||||
**Использование:** `make lab-test SCENARIO=universal LAB_SPEC=molecule/presets/mixed-full.yml`
|
||||
|
||||
## Использование
|
||||
|
||||
### Быстрый старт
|
||||
```bash
|
||||
# Выбрать пресет
|
||||
export LAB_SPEC=molecule/presets/minimal.yml
|
||||
|
||||
# Запустить тестирование
|
||||
make lab-test
|
||||
```
|
||||
|
||||
### Создание собственного пресета
|
||||
1. Скопировать существующий пресет: `cp minimal.yml my-preset.yml`
|
||||
2. Отредактировать под ваши нужды
|
||||
3. Использовать: `make lab-test LAB_SPEC=molecule/presets/my-preset.yml`
|
||||
|
||||
### Переменные окружения
|
||||
```bash
|
||||
# Установить пресет по умолчанию
|
||||
export LAB_SPEC=molecule/presets/webapp.yml
|
||||
|
||||
# Или использовать в команде
|
||||
make lab-test LAB_SPEC=molecule/presets/ha.yml
|
||||
```
|
||||
|
||||
## Рекомендации
|
||||
|
||||
- **Для начинающих:** используйте `minimal.yml` или `webapp.yml`
|
||||
- **Для микросервисов:** `microservices.yml` или `servicemesh.yml`
|
||||
- **Для Kubernetes:** `k8s-cluster.yml`
|
||||
- **Для enterprise:** `enterprise.yml` или `maximum.yml`
|
||||
- **Для Big Data:** `bigdata.yml`
|
||||
|
||||
## Кастомизация
|
||||
|
||||
Каждый пресет можно настроить под ваши нужды:
|
||||
- Изменить количество машин
|
||||
- Добавить/убрать группы
|
||||
- Изменить семейства ОС (debian/rhel)
|
||||
- Настроить порты и переменные
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Если пресет не работает:
|
||||
1. Проверьте доступность Docker образов
|
||||
2. Убедитесь в достаточности ресурсов
|
||||
3. Проверьте логи: `make lab-verify`
|
||||
4. Очистите лабораторию: `make lab-cleanup`
|
||||
420
docs/roles.md
Normal file
420
docs/roles.md
Normal file
@@ -0,0 +1,420 @@
|
||||
# Ansible Роли
|
||||
|
||||
## Автор
|
||||
Сергей Антропов
|
||||
Сайт: https://devops.org.ru
|
||||
|
||||
## Описание
|
||||
|
||||
Этот документ описывает структуру, создание и использование Ansible ролей в универсальной лаборатории.
|
||||
|
||||
## Содержание
|
||||
|
||||
- [Структура роли](#структура-роли)
|
||||
- [Создание роли](#создание-роли)
|
||||
- [Использование роли](#использование-роли)
|
||||
- [Тестирование роли](#тестирование-роли)
|
||||
- [Лучшие практики](#лучшие-практики)
|
||||
- [Примеры ролей](#примеры-ролей)
|
||||
|
||||
## Структура роли
|
||||
|
||||
```
|
||||
roles/
|
||||
└── your_role/
|
||||
├── tasks/ # Основные задачи
|
||||
│ └── main.yml
|
||||
├── handlers/ # Обработчики событий
|
||||
│ └── main.yml
|
||||
├── templates/ # Jinja2 шаблоны
|
||||
│ └── config.j2
|
||||
├── files/ # Статические файлы
|
||||
│ └── config.conf
|
||||
├── vars/ # Переменные роли
|
||||
│ └── main.yml
|
||||
├── defaults/ # Переменные по умолчанию
|
||||
│ └── main.yml
|
||||
├── meta/ # Метаданные роли
|
||||
│ └── main.yml
|
||||
└── tests/ # Тесты роли
|
||||
├── inventory
|
||||
└── test.yml
|
||||
```
|
||||
|
||||
### Описание директорий
|
||||
|
||||
| Директория | Описание | Обязательная |
|
||||
|------------|----------|--------------|
|
||||
| `tasks/` | Основные задачи роли | Да |
|
||||
| `handlers/` | Обработчики событий | Нет |
|
||||
| `templates/` | Jinja2 шаблоны | Нет |
|
||||
| `files/` | Статические файлы | Нет |
|
||||
| `vars/` | Переменные роли | Нет |
|
||||
| `defaults/` | Переменные по умолчанию | Нет |
|
||||
| `meta/` | Метаданные роли | Нет |
|
||||
| `tests/` | Тесты роли | Нет |
|
||||
|
||||
## Создание роли
|
||||
|
||||
### Автоматическое создание
|
||||
|
||||
```bash
|
||||
# Создать роль с помощью ansible-galaxy
|
||||
ansible-galaxy init your_role
|
||||
|
||||
# Создать роль в определенной директории
|
||||
ansible-galaxy init your_role --init-path roles/
|
||||
```
|
||||
|
||||
### Ручное создание
|
||||
|
||||
```bash
|
||||
# Создать структуру роли
|
||||
mkdir -p roles/your_role/{tasks,handlers,templates,files,vars,defaults,meta,tests}
|
||||
|
||||
# Создать основной task
|
||||
cat > roles/your_role/tasks/main.yml << EOF
|
||||
---
|
||||
- name: Install package
|
||||
package:
|
||||
name: "{{ package_name }}"
|
||||
state: present
|
||||
|
||||
- name: Start service
|
||||
service:
|
||||
name: "{{ service_name }}"
|
||||
state: started
|
||||
enabled: true
|
||||
EOF
|
||||
|
||||
# Создать переменные по умолчанию
|
||||
cat > roles/your_role/defaults/main.yml << EOF
|
||||
---
|
||||
package_name: nginx
|
||||
service_name: nginx
|
||||
EOF
|
||||
```
|
||||
|
||||
## Использование роли
|
||||
|
||||
### В playbook
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Deploy web server
|
||||
hosts: webservers
|
||||
become: true
|
||||
roles:
|
||||
- your_role
|
||||
```
|
||||
|
||||
### С переменными
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Deploy web server
|
||||
hosts: webservers
|
||||
become: true
|
||||
roles:
|
||||
- role: your_role
|
||||
vars:
|
||||
package_name: apache2
|
||||
service_name: apache2
|
||||
```
|
||||
|
||||
### С условиями
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Deploy web server
|
||||
hosts: webservers
|
||||
become: true
|
||||
roles:
|
||||
- role: your_role
|
||||
when: ansible_os_family == "Debian"
|
||||
```
|
||||
|
||||
## Тестирование роли
|
||||
|
||||
### Создание тестов
|
||||
|
||||
```bash
|
||||
# Создать тестовый playbook
|
||||
cat > roles/your_role/tests/test.yml << EOF
|
||||
---
|
||||
- name: Test role
|
||||
hosts: all
|
||||
become: true
|
||||
roles:
|
||||
- your_role
|
||||
EOF
|
||||
|
||||
# Создать инвентарь для тестов
|
||||
cat > roles/your_role/tests/inventory << EOF
|
||||
[webservers]
|
||||
localhost ansible_connection=local
|
||||
EOF
|
||||
```
|
||||
|
||||
### Запуск тестов
|
||||
|
||||
```bash
|
||||
# Запустить тест роли
|
||||
ansible-playbook -i roles/your_role/tests/inventory roles/your_role/tests/test.yml
|
||||
|
||||
# Запустить тест с Molecule
|
||||
molecule test
|
||||
```
|
||||
|
||||
## Лучшие практики
|
||||
|
||||
### Структура задач
|
||||
|
||||
```yaml
|
||||
---
|
||||
# tasks/main.yml
|
||||
- name: Install package
|
||||
package:
|
||||
name: "{{ package_name }}"
|
||||
state: present
|
||||
notify: restart service
|
||||
|
||||
- name: Configure service
|
||||
template:
|
||||
src: config.j2
|
||||
dest: /etc/service/config.conf
|
||||
notify: restart service
|
||||
|
||||
- name: Start service
|
||||
service:
|
||||
name: "{{ service_name }}"
|
||||
state: started
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### Обработчики
|
||||
|
||||
```yaml
|
||||
---
|
||||
# handlers/main.yml
|
||||
- name: restart service
|
||||
service:
|
||||
name: "{{ service_name }}"
|
||||
state: restarted
|
||||
```
|
||||
|
||||
### Переменные
|
||||
|
||||
```yaml
|
||||
---
|
||||
# defaults/main.yml
|
||||
package_name: nginx
|
||||
service_name: nginx
|
||||
config_file: /etc/nginx/nginx.conf
|
||||
port: 80
|
||||
|
||||
# vars/main.yml
|
||||
service_user: nginx
|
||||
service_group: nginx
|
||||
```
|
||||
|
||||
### Метаданные
|
||||
|
||||
```yaml
|
||||
---
|
||||
# meta/main.yml
|
||||
galaxy_info:
|
||||
author: Your Name
|
||||
description: Your role description
|
||||
company: Your Company
|
||||
license: MIT
|
||||
min_ansible_version: "2.9"
|
||||
platforms:
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- focal
|
||||
- jammy
|
||||
- name: CentOS
|
||||
versions:
|
||||
- 8
|
||||
- 9
|
||||
galaxy_tags:
|
||||
- web
|
||||
- nginx
|
||||
dependencies: []
|
||||
```
|
||||
|
||||
## Примеры ролей
|
||||
|
||||
### Роль для веб-сервера
|
||||
|
||||
```yaml
|
||||
---
|
||||
# tasks/main.yml
|
||||
- name: Install nginx
|
||||
package:
|
||||
name: nginx
|
||||
state: present
|
||||
|
||||
- name: Configure nginx
|
||||
template:
|
||||
src: nginx.conf.j2
|
||||
dest: /etc/nginx/nginx.conf
|
||||
notify: restart nginx
|
||||
|
||||
- name: Start nginx
|
||||
service:
|
||||
name: nginx
|
||||
state: started
|
||||
enabled: true
|
||||
```
|
||||
|
||||
```yaml
|
||||
---
|
||||
# defaults/main.yml
|
||||
nginx_port: 80
|
||||
nginx_ssl_port: 443
|
||||
nginx_user: www-data
|
||||
nginx_worker_processes: auto
|
||||
```
|
||||
|
||||
### Роль для базы данных
|
||||
|
||||
```yaml
|
||||
---
|
||||
# tasks/main.yml
|
||||
- name: Install PostgreSQL
|
||||
package:
|
||||
name: postgresql
|
||||
state: present
|
||||
|
||||
- name: Start PostgreSQL
|
||||
service:
|
||||
name: postgresql
|
||||
state: started
|
||||
enabled: true
|
||||
|
||||
- name: Create database
|
||||
postgresql_db:
|
||||
name: "{{ db_name }}"
|
||||
state: present
|
||||
|
||||
- name: Create user
|
||||
postgresql_user:
|
||||
name: "{{ db_user }}"
|
||||
password: "{{ db_password }}"
|
||||
state: present
|
||||
```
|
||||
|
||||
### Роль для мониторинга
|
||||
|
||||
```yaml
|
||||
---
|
||||
# tasks/main.yml
|
||||
- name: Install Prometheus
|
||||
package:
|
||||
name: prometheus
|
||||
state: present
|
||||
|
||||
- name: Configure Prometheus
|
||||
template:
|
||||
src: prometheus.yml.j2
|
||||
dest: /etc/prometheus/prometheus.yml
|
||||
notify: restart prometheus
|
||||
|
||||
- name: Start Prometheus
|
||||
service:
|
||||
name: prometheus
|
||||
state: started
|
||||
enabled: true
|
||||
```
|
||||
|
||||
## Интеграция с лабораторией
|
||||
|
||||
### Использование в пресетах
|
||||
|
||||
```yaml
|
||||
---
|
||||
# molecule/presets/webapp.yml
|
||||
hosts:
|
||||
- name: web1
|
||||
group: webservers
|
||||
family: debian
|
||||
publish:
|
||||
- "8080:80"
|
||||
|
||||
- name: db1
|
||||
group: databases
|
||||
family: rhel
|
||||
publish:
|
||||
- "5432:5432"
|
||||
```
|
||||
|
||||
### Playbook для ролей
|
||||
|
||||
```yaml
|
||||
---
|
||||
# files/playbooks/site.yml
|
||||
- name: Deploy web servers
|
||||
hosts: webservers
|
||||
become: true
|
||||
roles:
|
||||
- nginx
|
||||
- ssl
|
||||
|
||||
- name: Deploy databases
|
||||
hosts: databases
|
||||
become: true
|
||||
roles:
|
||||
- postgresql
|
||||
- backup
|
||||
|
||||
- name: Deploy monitoring
|
||||
hosts: monitoring
|
||||
become: true
|
||||
roles:
|
||||
- prometheus
|
||||
- grafana
|
||||
```
|
||||
|
||||
### Тестирование с различными пресетами
|
||||
|
||||
```bash
|
||||
# Тестирование с минимальным пресетом
|
||||
make lab-test LAB_SPEC=molecule/presets/minimal.yml
|
||||
|
||||
# Тестирование с веб-приложением
|
||||
make lab-test LAB_SPEC=molecule/presets/webapp.yml
|
||||
|
||||
# Тестирование с микросервисами
|
||||
make lab-test LAB_SPEC=molecule/presets/microservices.yml
|
||||
```
|
||||
|
||||
## Публикация роли
|
||||
|
||||
### В Ansible Galaxy
|
||||
|
||||
```bash
|
||||
# Установить ansible-galaxy
|
||||
pip install ansible-galaxy
|
||||
|
||||
# Публиковать роль
|
||||
ansible-galaxy import your-username your-role
|
||||
|
||||
# Или через GitHub
|
||||
ansible-galaxy import your-username your-role --github-user your-username
|
||||
```
|
||||
|
||||
### В приватном репозитории
|
||||
|
||||
```bash
|
||||
# Установить роль из Git
|
||||
ansible-galaxy install git+https://github.com/your-username/your-role.git
|
||||
|
||||
# Установить роль из файла
|
||||
ansible-galaxy install your-role.tar.gz
|
||||
```
|
||||
|
||||
## Заключение
|
||||
|
||||
Этот документ описывает основные принципы создания и использования Ansible ролей в универсальной лаборатории. Для получения дополнительной информации обратитесь к [основной документации](universal-lab.md) и [примерам использования](examples.md).
|
||||
652
docs/troubleshooting.md
Normal file
652
docs/troubleshooting.md
Normal file
@@ -0,0 +1,652 @@
|
||||
# Troubleshooting
|
||||
|
||||
## Автор
|
||||
Сергей Антропов
|
||||
Сайт: https://devops.org.ru
|
||||
|
||||
## Описание
|
||||
|
||||
Этот документ содержит решения наиболее распространенных проблем при работе с универсальной лабораторией.
|
||||
|
||||
## Содержание
|
||||
|
||||
- [Общие проблемы](#общие-проблемы)
|
||||
- [Проблемы с Docker](#проблемы-с-docker)
|
||||
- [Проблемы с Kubernetes](#проблемы-с-kubernetes)
|
||||
- [Проблемы с портами](#проблемы-с-портами)
|
||||
- [Проблемы с ресурсами](#проблемы-с-ресурсами)
|
||||
- [Проблемы с сетью](#проблемы-с-сетью)
|
||||
- [Проблемы с Ansible](#проблемы-с-ansible)
|
||||
- [Проблемы с Molecule](#проблемы-с-molecule)
|
||||
- [Проблемы с пресетами](#проблемы-с-пресетами)
|
||||
- [Проблемы с отчетами](#проблемы-с-отчетами)
|
||||
|
||||
## Общие проблемы
|
||||
|
||||
### Проблема: Лаборатория не запускается
|
||||
|
||||
**Симптомы:**
|
||||
- Команда `make lab-up` завершается с ошибкой
|
||||
- Контейнеры не создаются
|
||||
- Ошибки в логах Docker
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить статус Docker
|
||||
docker ps
|
||||
docker version
|
||||
|
||||
# Перезапустить Docker
|
||||
sudo systemctl restart docker
|
||||
|
||||
# Очистить Docker
|
||||
docker system prune -a
|
||||
|
||||
# Перезапустить лабораторию
|
||||
make lab-reset
|
||||
```
|
||||
|
||||
### Проблема: Команды Make не работают
|
||||
|
||||
**Симптомы:**
|
||||
- `make: command not found`
|
||||
- Ошибки в Makefile
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Установить Make
|
||||
# Ubuntu/Debian
|
||||
sudo apt-get install make
|
||||
|
||||
# CentOS/RHEL
|
||||
sudo yum install make
|
||||
|
||||
# macOS
|
||||
brew install make
|
||||
|
||||
# Проверить версию
|
||||
make --version
|
||||
```
|
||||
|
||||
### Проблема: Недостаточно прав
|
||||
|
||||
**Симптомы:**
|
||||
- `Permission denied`
|
||||
- Ошибки доступа к файлам
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить права на файлы
|
||||
ls -la
|
||||
|
||||
# Установить права
|
||||
chmod +x scripts/*.sh
|
||||
chmod 644 *.yml
|
||||
|
||||
# Добавить пользователя в группу docker
|
||||
sudo usermod -aG docker $USER
|
||||
newgrp docker
|
||||
```
|
||||
|
||||
## Проблемы с Docker
|
||||
|
||||
### Проблема: Docker daemon не запущен
|
||||
|
||||
**Симптомы:**
|
||||
- `Cannot connect to the Docker daemon`
|
||||
- `docker: command not found`
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Запустить Docker daemon
|
||||
sudo systemctl start docker
|
||||
sudo systemctl enable docker
|
||||
|
||||
# Проверить статус
|
||||
sudo systemctl status docker
|
||||
|
||||
# Проверить доступ
|
||||
docker ps
|
||||
```
|
||||
|
||||
### Проблема: Недостаточно места на диске
|
||||
|
||||
**Симптомы:**
|
||||
- `No space left on device`
|
||||
- Ошибки создания контейнеров
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить использование диска
|
||||
df -h
|
||||
|
||||
# Очистить Docker
|
||||
docker system prune -a
|
||||
docker volume prune
|
||||
docker network prune
|
||||
|
||||
# Удалить неиспользуемые образы
|
||||
docker image prune -a
|
||||
```
|
||||
|
||||
### Проблема: Конфликты портов
|
||||
|
||||
**Симптомы:**
|
||||
- `Port is already in use`
|
||||
- Ошибки привязки портов
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Найти процесс, использующий порт
|
||||
sudo netstat -tulpn | grep :8080
|
||||
sudo lsof -i :8080
|
||||
|
||||
# Убить процесс
|
||||
sudo kill -9 <PID>
|
||||
|
||||
# Или изменить порт в пресете
|
||||
publish:
|
||||
- "8081:80" # Вместо 8080:80
|
||||
```
|
||||
|
||||
### Проблема: DinD контейнеры не работают
|
||||
|
||||
**Симптомы:**
|
||||
- DinD контейнеры не запускаются
|
||||
- Ошибки Docker-in-Docker
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить privileged режим
|
||||
docker run --privileged -d docker:dind
|
||||
|
||||
# Проверить доступ к Docker socket
|
||||
docker run -v /var/run/docker.sock:/var/run/docker.sock docker:latest ps
|
||||
|
||||
# Перезапустить с правильными параметрами
|
||||
make lab-reset
|
||||
make lab-create
|
||||
```
|
||||
|
||||
## Проблемы с Kubernetes
|
||||
|
||||
### Проблема: Kind кластер не создается
|
||||
|
||||
**Симптомы:**
|
||||
- `kind create cluster` завершается с ошибкой
|
||||
- Кластер не доступен
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить Kind
|
||||
kind version
|
||||
|
||||
# Удалить существующие кластеры
|
||||
kind delete cluster --name lab
|
||||
|
||||
# Очистить Docker
|
||||
docker system prune -a
|
||||
|
||||
# Пересоздать кластер
|
||||
make lab-create
|
||||
```
|
||||
|
||||
### Проблема: kubectl не работает
|
||||
|
||||
**Симптомы:**
|
||||
- `kubectl: command not found`
|
||||
- Ошибки подключения к кластеру
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Установить kubectl
|
||||
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
|
||||
chmod +x kubectl
|
||||
sudo mv kubectl /usr/local/bin/
|
||||
|
||||
# Проверить конфигурацию
|
||||
kubectl config get-contexts
|
||||
|
||||
# Переключиться на правильный контекст
|
||||
kubectl config use-context kind-lab
|
||||
```
|
||||
|
||||
### Проблема: Pods не запускаются
|
||||
|
||||
**Симптомы:**
|
||||
- Pods в состоянии Pending
|
||||
- Ошибки в логах pods
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить статус pods
|
||||
kubectl get pods -A
|
||||
kubectl describe pod <pod-name>
|
||||
|
||||
# Проверить события
|
||||
kubectl get events --sort-by=.metadata.creationTimestamp
|
||||
|
||||
# Проверить ресурсы
|
||||
kubectl top nodes
|
||||
kubectl top pods
|
||||
```
|
||||
|
||||
### Проблема: Istio не устанавливается
|
||||
|
||||
**Симптомы:**
|
||||
- Istio компоненты не запускаются
|
||||
- Ошибки в Istio логах
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить Istio
|
||||
istioctl version
|
||||
|
||||
# Переустановить Istio
|
||||
istioctl uninstall --purge
|
||||
istioctl install --set profile=demo
|
||||
|
||||
# Проверить статус
|
||||
kubectl get pods -n istio-system
|
||||
```
|
||||
|
||||
## Проблемы с портами
|
||||
|
||||
### Проблема: Порт уже используется
|
||||
|
||||
**Симптомы:**
|
||||
- `bind: address already in use`
|
||||
- Ошибки привязки портов
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Найти процесс
|
||||
sudo lsof -i :8080
|
||||
|
||||
# Убить процесс
|
||||
sudo kill -9 <PID>
|
||||
|
||||
# Или изменить порт в пресете
|
||||
publish:
|
||||
- "8081:80"
|
||||
```
|
||||
|
||||
### Проблема: Port-forward не работает
|
||||
|
||||
**Симптомы:**
|
||||
- Port-forward не устанавливается
|
||||
- Ошибки подключения
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Остановить все port-forward
|
||||
make kube-pf-stop
|
||||
|
||||
# Проверить доступность сервиса
|
||||
kubectl get svc -n istio-system
|
||||
|
||||
# Перезапустить port-forward
|
||||
make kiali-port-forward CLUSTER=lab
|
||||
```
|
||||
|
||||
## Проблемы с ресурсами
|
||||
|
||||
### Проблема: Недостаточно памяти
|
||||
|
||||
**Симптомы:**
|
||||
- `Out of memory`
|
||||
- Контейнеры завершаются
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить память
|
||||
free -h
|
||||
docker stats
|
||||
|
||||
# Ограничить ресурсы
|
||||
docker run --memory=512m your-image
|
||||
|
||||
# Или уменьшить количество контейнеров в пресете
|
||||
```
|
||||
|
||||
### Проблема: Недостаточно CPU
|
||||
|
||||
**Симптомы:**
|
||||
- Медленная работа
|
||||
- Высокая нагрузка на CPU
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить CPU
|
||||
top
|
||||
htop
|
||||
|
||||
# Ограничить CPU
|
||||
docker run --cpus=1.0 your-image
|
||||
|
||||
# Или использовать более легкие образы
|
||||
```
|
||||
|
||||
### Проблема: Недостаточно места на диске
|
||||
|
||||
**Симптомы:**
|
||||
- `No space left on device`
|
||||
- Ошибки записи
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить место
|
||||
df -h
|
||||
|
||||
# Очистить Docker
|
||||
docker system prune -a
|
||||
docker volume prune
|
||||
|
||||
# Удалить неиспользуемые образы
|
||||
docker image prune -a
|
||||
```
|
||||
|
||||
## Проблемы с сетью
|
||||
|
||||
### Проблема: Контейнеры не могут связаться
|
||||
|
||||
**Симптомы:**
|
||||
- Ping не работает между контейнерами
|
||||
- Ошибки сети
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить сеть
|
||||
docker network ls
|
||||
docker network inspect labnet
|
||||
|
||||
# Пересоздать сеть
|
||||
docker network rm labnet
|
||||
docker network create labnet
|
||||
|
||||
# Перезапустить лабораторию
|
||||
make lab-reset
|
||||
```
|
||||
|
||||
### Проблема: DNS не работает
|
||||
|
||||
**Симптомы:**
|
||||
- Не удается разрешить имена
|
||||
- Ошибки DNS
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить DNS
|
||||
nslookup google.com
|
||||
|
||||
# Перезапустить Docker
|
||||
sudo systemctl restart docker
|
||||
|
||||
# Проверить resolv.conf
|
||||
cat /etc/resolv.conf
|
||||
```
|
||||
|
||||
## Проблемы с Ansible
|
||||
|
||||
### Проблема: Ansible не найден
|
||||
|
||||
**Симптомы:**
|
||||
- `ansible: command not found`
|
||||
- Ошибки выполнения playbook
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Установить Ansible
|
||||
pip install ansible
|
||||
|
||||
# Или через пакетный менеджер
|
||||
sudo apt-get install ansible
|
||||
|
||||
# Проверить версию
|
||||
ansible --version
|
||||
```
|
||||
|
||||
### Проблема: Ошибки в playbook
|
||||
|
||||
**Симптомы:**
|
||||
- Синтаксические ошибки
|
||||
- Ошибки выполнения задач
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить синтаксис
|
||||
ansible-playbook --syntax-check playbook.yml
|
||||
|
||||
# Запустить в режиме отладки
|
||||
ansible-playbook -vvv playbook.yml
|
||||
|
||||
# Проверить инвентарь
|
||||
ansible-inventory --list
|
||||
```
|
||||
|
||||
### Проблема: Ошибки подключения
|
||||
|
||||
**Симптомы:**
|
||||
- `Connection refused`
|
||||
- Ошибки SSH
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить подключение
|
||||
ansible all -m ping
|
||||
|
||||
# Проверить SSH ключи
|
||||
ssh-keygen -t rsa -b 4096
|
||||
ssh-copy-id user@host
|
||||
|
||||
# Или использовать пароль
|
||||
ansible all -m ping -k
|
||||
```
|
||||
|
||||
## Проблемы с Molecule
|
||||
|
||||
### Проблема: Molecule не найден
|
||||
|
||||
**Симптомы:**
|
||||
- `molecule: command not found`
|
||||
- Ошибки выполнения molecule
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Установить Molecule
|
||||
pip install molecule
|
||||
|
||||
# Или через пакетный менеджер
|
||||
sudo apt-get install molecule
|
||||
|
||||
# Проверить версию
|
||||
molecule --version
|
||||
```
|
||||
|
||||
### Проблема: Ошибки в molecule.yml
|
||||
|
||||
**Симптомы:**
|
||||
- Синтаксические ошибки в конфигурации
|
||||
- Ошибки валидации
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить синтаксис
|
||||
molecule syntax
|
||||
|
||||
# Проверить конфигурацию
|
||||
molecule lint
|
||||
|
||||
# Исправить ошибки
|
||||
molecule validate
|
||||
```
|
||||
|
||||
### Проблема: Ошибки драйвера
|
||||
|
||||
**Симптомы:**
|
||||
- Ошибки Docker драйвера
|
||||
- Проблемы с контейнерами
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить драйвер
|
||||
molecule driver list
|
||||
|
||||
# Установить Docker драйвер
|
||||
pip install molecule-docker
|
||||
|
||||
# Перезапустить Molecule
|
||||
molecule destroy
|
||||
molecule create
|
||||
```
|
||||
|
||||
## Проблемы с пресетами
|
||||
|
||||
### Проблема: Пресет не найден
|
||||
|
||||
**Симптомы:**
|
||||
- `File not found`
|
||||
- Ошибки загрузки пресета
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить путь
|
||||
ls -la molecule/presets/
|
||||
|
||||
# Проверить синтаксис YAML
|
||||
yamllint molecule/presets/your-preset.yml
|
||||
|
||||
# Исправить ошибки
|
||||
molecule validate
|
||||
```
|
||||
|
||||
### Проблема: Ошибки в пресете
|
||||
|
||||
**Симптомы:**
|
||||
- Синтаксические ошибки
|
||||
- Ошибки валидации
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить синтаксис
|
||||
yamllint molecule/presets/your-preset.yml
|
||||
|
||||
# Проверить структуру
|
||||
molecule validate
|
||||
|
||||
# Исправить ошибки
|
||||
molecule syntax
|
||||
```
|
||||
|
||||
## Проблемы с отчетами
|
||||
|
||||
### Проблема: HTML отчет не генерируется
|
||||
|
||||
**Симптомы:**
|
||||
- `File not found`
|
||||
- Ошибки генерации отчета
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить JSON файл
|
||||
ls -la reports/
|
||||
cat reports/lab-health.json
|
||||
|
||||
# Перезапустить верификацию
|
||||
make lab-verify
|
||||
|
||||
# Сгенерировать отчет
|
||||
make lab-report
|
||||
```
|
||||
|
||||
### Проблема: Отчет пустой
|
||||
|
||||
**Симптомы:**
|
||||
- Отчет не содержит данных
|
||||
- Ошибки в JSON
|
||||
|
||||
**Решение:**
|
||||
```bash
|
||||
# Проверить JSON
|
||||
jq . reports/lab-health.json
|
||||
|
||||
# Перезапустить тест
|
||||
make lab-test
|
||||
|
||||
# Проверить логи
|
||||
make lab-verify
|
||||
```
|
||||
|
||||
## Полезные команды для диагностики
|
||||
|
||||
### Общие команды
|
||||
|
||||
```bash
|
||||
# Проверить статус системы
|
||||
docker ps
|
||||
docker images
|
||||
docker network ls
|
||||
docker volume ls
|
||||
|
||||
# Проверить ресурсы
|
||||
free -h
|
||||
df -h
|
||||
top
|
||||
|
||||
# Проверить сеть
|
||||
netstat -tulpn
|
||||
ss -tulpn
|
||||
```
|
||||
|
||||
### Команды для Kubernetes
|
||||
|
||||
```bash
|
||||
# Проверить кластеры
|
||||
kind get clusters
|
||||
kubectl config get-contexts
|
||||
|
||||
# Проверить ресурсы
|
||||
kubectl get nodes
|
||||
kubectl get pods -A
|
||||
kubectl get svc -A
|
||||
|
||||
# Проверить события
|
||||
kubectl get events --sort-by=.metadata.creationTimestamp
|
||||
```
|
||||
|
||||
### Команды для Ansible
|
||||
|
||||
```bash
|
||||
# Проверить инвентарь
|
||||
ansible-inventory --list
|
||||
ansible all -m ping
|
||||
|
||||
# Проверить playbook
|
||||
ansible-playbook --syntax-check playbook.yml
|
||||
ansible-playbook --check playbook.yml
|
||||
```
|
||||
|
||||
## Получение помощи
|
||||
|
||||
Если проблема не решается:
|
||||
|
||||
1. **Проверьте логи:**
|
||||
```bash
|
||||
docker logs <container-name>
|
||||
kubectl logs <pod-name>
|
||||
```
|
||||
|
||||
2. **Создайте issue:**
|
||||
- Опишите проблему
|
||||
- Приложите логи
|
||||
- Укажите версии компонентов
|
||||
|
||||
3. **Обратитесь к сообществу:**
|
||||
- GitHub Discussions
|
||||
- Discord/Slack каналы
|
||||
- Форумы Ansible
|
||||
|
||||
4. **Проверьте документацию:**
|
||||
- [Основная документация](universal-lab.md)
|
||||
- [Примеры использования](examples.md)
|
||||
- [API Reference](api.md)
|
||||
295
docs/universal-lab.md
Normal file
295
docs/universal-lab.md
Normal file
@@ -0,0 +1,295 @@
|
||||
# Универсальная лаборатория для тестирования Ansible ролей
|
||||
|
||||
## Автор
|
||||
Сергей Антропов
|
||||
Сайт: https://devops.org.ru
|
||||
|
||||
## Описание
|
||||
|
||||
Это универсальная лаборатория для тестирования Ansible ролей, созданная на основе предложений ChatGPT. Лаборатория поддерживает:
|
||||
|
||||
- **Docker-in-Docker (DinD)** - полная изоляция контейнеров
|
||||
- **Docker-outside-of-Docker (DOoD)** - использование хостового Docker
|
||||
- **Kind кластеры** - локальные Kubernetes кластеры
|
||||
- **Helm charts** - nginx, prometheus-stack
|
||||
- **Istio service mesh** - с Kiali для мониторинга
|
||||
- **Prometheus + Grafana** - с автопровижинингом дашбордов
|
||||
- **HTML отчеты** - красивые отчеты о результатах тестирования
|
||||
|
||||
## Структура проекта
|
||||
|
||||
```
|
||||
molecule/
|
||||
├── universal/ # Универсальная лаборатория
|
||||
│ ├── molecule.yml # Конфигурация Molecule
|
||||
│ ├── vars.yml # Переменные лаборатории
|
||||
│ ├── create.yml # Создание инфраструктуры
|
||||
│ ├── converge.yml # Запуск ролей
|
||||
│ ├── verify.yml # Проверка работы
|
||||
│ └── destroy.yml # Очистка
|
||||
├── presets/ # Пресеты для разных сценариев
|
||||
│ └── k8s-kind.yml # Пресет для Kubernetes
|
||||
└── default/ # Старый сценарий (для совместимости)
|
||||
|
||||
files/
|
||||
├── requirements.yml # Коллекции Ansible
|
||||
├── playbooks/
|
||||
│ └── site.yml # Основной playbook
|
||||
└── k8s/ # Kubernetes манифесты
|
||||
└── istio/ # Istio конфигурации
|
||||
|
||||
roles/ # Ваши Ansible роли
|
||||
```
|
||||
|
||||
## Использование
|
||||
|
||||
### 1. Подготовка
|
||||
|
||||
```bash
|
||||
# Создать файл с паролем для vault
|
||||
echo "test" > vault-password.txt
|
||||
|
||||
# Создать каталог для ролей
|
||||
mkdir -p roles
|
||||
|
||||
# Скопировать переменные окружения
|
||||
cp env.example .env
|
||||
# Отредактировать .env под ваши нужды
|
||||
```
|
||||
|
||||
### 2. Запуск лаборатории
|
||||
|
||||
```bash
|
||||
# Поднять контроллер
|
||||
make lab-up
|
||||
|
||||
# Создать инфраструктуру
|
||||
make lab-create
|
||||
|
||||
# Запустить роли
|
||||
make lab-converge
|
||||
|
||||
# Проверить работу
|
||||
make lab-verify
|
||||
|
||||
# Сгенерировать HTML отчет
|
||||
make lab-report
|
||||
|
||||
# Уничтожить лабораторию
|
||||
make lab-destroy
|
||||
```
|
||||
|
||||
### 3. Управление лабораторией
|
||||
|
||||
```bash
|
||||
# Полный цикл тестирования
|
||||
make lab-test
|
||||
|
||||
# Снапшоты и восстановление
|
||||
make lab-snapshot # Сохранить состояние
|
||||
make lab-restore # Восстановить из снапшота
|
||||
make lab-cleanup # Очистить все
|
||||
|
||||
# Сброс лаборатории
|
||||
make lab-reset
|
||||
```
|
||||
|
||||
### 4. Пресеты для разных сценариев
|
||||
|
||||
#### 🏗️ Классические пресеты (systemd контейнеры)
|
||||
```bash
|
||||
# Минимальная лаборатория (1-3 машины)
|
||||
make lab-test LAB_SPEC=molecule/presets/minimal.yml
|
||||
|
||||
# Веб-приложение (3-5 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/webapp.yml
|
||||
|
||||
# Микросервисы (5-8 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/microservices.yml
|
||||
|
||||
# Высокая доступность (6-10 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/ha.yml
|
||||
|
||||
# Kubernetes кластер (8-12 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/k8s-cluster.yml
|
||||
|
||||
# CI/CD пайплайн (10-15 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/cicd.yml
|
||||
|
||||
# Big Data кластер (12-18 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/bigdata.yml
|
||||
|
||||
# Service Mesh (15-20 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/servicemesh.yml
|
||||
|
||||
# Enterprise (18-20 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/enterprise.yml
|
||||
|
||||
# Максимальный (20 машин)
|
||||
make lab-test LAB_SPEC=molecule/presets/maximum.yml
|
||||
```
|
||||
|
||||
#### ☸️ Kubernetes пресеты
|
||||
```bash
|
||||
# Kubernetes Single Node (1 кластер)
|
||||
make lab-test LAB_SPEC=molecule/presets/k8s-single.yml
|
||||
|
||||
# Kubernetes Multi-Cluster (3 кластера)
|
||||
make lab-test LAB_SPEC=molecule/presets/k8s-multi.yml
|
||||
|
||||
# Kubernetes + Istio Full Stack (1 кластер с полным стеком)
|
||||
make lab-test LAB_SPEC=molecule/presets/k8s-istio-full.yml
|
||||
```
|
||||
|
||||
#### 🐳 Docker-in-Docker (DinD) пресеты
|
||||
```bash
|
||||
# DinD Simple (3 DinD контейнера)
|
||||
make lab-test LAB_SPEC=molecule/presets/dind-simple.yml
|
||||
|
||||
# DinD Swarm (5 DinD контейнеров)
|
||||
make lab-test LAB_SPEC=molecule/presets/dind-swarm.yml
|
||||
|
||||
# DinD Compose (4 DinD контейнера)
|
||||
make lab-test LAB_SPEC=molecule/presets/dind-compose.yml
|
||||
```
|
||||
|
||||
#### 🔗 Docker-outside-of-Docker (DOoD) пресеты
|
||||
```bash
|
||||
# DOoD Simple (3 DOoD контейнера)
|
||||
make lab-test LAB_SPEC=molecule/presets/dood-simple.yml
|
||||
|
||||
# DOoD Mixed (5 DOoD + 2 systemd)
|
||||
make lab-test LAB_SPEC=molecule/presets/dood-mixed.yml
|
||||
```
|
||||
|
||||
#### 🔀 Смешанные пресеты
|
||||
```bash
|
||||
# Mixed Kubernetes + DinD (1 K8s + 3 DinD)
|
||||
make lab-test LAB_SPEC=molecule/presets/mixed-k8s-dind.yml
|
||||
|
||||
# Mixed Kubernetes + DOoD (1 K8s + 3 DOoD)
|
||||
make lab-test LAB_SPEC=molecule/presets/mixed-k8s-dood.yml
|
||||
|
||||
# Mixed Full Stack (1 K8s + 2 DinD + 2 DOoD + 2 systemd)
|
||||
make lab-test LAB_SPEC=molecule/presets/mixed-full.yml
|
||||
```
|
||||
|
||||
### 3. Работа с Kubernetes
|
||||
|
||||
```bash
|
||||
# Войти в контейнер с kubectl
|
||||
make kube-sh
|
||||
|
||||
# Выполнить команду kubectl
|
||||
make kube-cmd CLUSTER=lab CMD="get pods -A"
|
||||
|
||||
# Войти в toolbox pod
|
||||
make kube-enter CLUSTER=lab
|
||||
|
||||
# Port-forward для Kiali
|
||||
make kiali-port-forward CLUSTER=lab
|
||||
|
||||
# Port-forward для Istio Gateway
|
||||
make istio-gw-port-forward CLUSTER=lab
|
||||
```
|
||||
|
||||
## Конфигурация
|
||||
|
||||
### Переменные лаборатории (molecule/universal/vars.yml)
|
||||
|
||||
```yaml
|
||||
# Сеть для лаборатории
|
||||
docker_network: labnet
|
||||
|
||||
# Образы для разных семейств ОС
|
||||
images:
|
||||
debian: "ghcr.io/ansible-community/molecule-ubuntu-systemd:jammy"
|
||||
rhel: "quay.io/centos/centos:stream9-systemd"
|
||||
|
||||
# Определение хостов
|
||||
hosts:
|
||||
- name: etcd1
|
||||
group: etcd
|
||||
family: debian
|
||||
- name: app-dind
|
||||
group: apps
|
||||
type: dind
|
||||
publish:
|
||||
- "8080:8080"
|
||||
|
||||
# Kind кластеры
|
||||
kind_clusters:
|
||||
- name: lab
|
||||
workers: 2
|
||||
addons:
|
||||
ingress_nginx: true
|
||||
istio: true
|
||||
kiali: true
|
||||
```
|
||||
|
||||
## Особенности
|
||||
|
||||
### 1. Автогенерация инвентаря
|
||||
Инвентарь генерируется автоматически на основе определения хостов в `vars.yml`.
|
||||
|
||||
### 2. Поддержка DinD и DOoD
|
||||
- **DinD**: Полная изоляция, каждый хост имеет свой Docker daemon
|
||||
- **DOoD**: Использование хостового Docker, меньше ресурсов
|
||||
|
||||
### 3. Kubernetes интеграция
|
||||
- Автоматическое создание Kind кластеров
|
||||
- Установка Ingress NGINX, Metrics Server
|
||||
- Поддержка Istio и Kiali
|
||||
- Prometheus Stack с Grafana
|
||||
|
||||
### 4. Мониторинг и отчеты
|
||||
- Автоматическая генерация HTML отчетов
|
||||
- Интеграция с Prometheus и Grafana
|
||||
- Дашборды для Istio
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Проблемы с образами
|
||||
Если возникают проблемы с загрузкой образов, обновите `vars.yml`:
|
||||
|
||||
```yaml
|
||||
images:
|
||||
debian: "ubuntu:22.04" # Используйте стандартные образы
|
||||
rhel: "centos:8"
|
||||
```
|
||||
|
||||
### Проблемы с Docker
|
||||
Убедитесь, что Docker socket доступен:
|
||||
|
||||
```bash
|
||||
ls -la /var/run/docker.sock
|
||||
```
|
||||
|
||||
### Проблемы с Molecule
|
||||
Если возникают проблемы с Molecule, попробуйте:
|
||||
|
||||
```bash
|
||||
# Очистить кэш
|
||||
make lab-reset
|
||||
|
||||
# Проверить конфигурацию
|
||||
docker exec ansible-controller bash -lc 'molecule lint -s universal'
|
||||
```
|
||||
|
||||
## Дальнейшее развитие
|
||||
|
||||
1. **Добавить поддержку Terraform** для создания инфраструктуры
|
||||
2. **Интегрировать с GitLab CI/CD** для автоматического тестирования
|
||||
3. **Добавить поддержку ARM64** для тестирования на Apple Silicon
|
||||
4. **Создать веб-интерфейс** для управления лабораторией
|
||||
5. **Добавить поддержку OpenShift** для enterprise сценариев
|
||||
|
||||
## Лицензия
|
||||
|
||||
MIT License
|
||||
|
||||
## Контакты
|
||||
|
||||
- Автор: Сергей Антропов
|
||||
- Сайт: https://devops.org.ru
|
||||
- Email: [ваш email]
|
||||
Reference in New Issue
Block a user