Skip to content

Commit ad5b091

Browse files
committed
add comprehensive documentation for Stands Engine, including application manifests, stand configuration, operations guide, and example scenarios
1 parent 45714be commit ad5b091

5 files changed

Lines changed: 1467 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ Stands Engine разворачивает инфраструктурный сте
44

55
Главная идея Stands Engine - управлять инфраструктурой через модель стенда, а не через набор разрозненных слоев.
66

7+
## Документация
8+
9+
Этот README даёт общий обзор проекта и быстрый старт. Исчерпывающие руководства
10+
собраны в [разделе документации](docs/README.md):
11+
12+
- [описание переиспользуемых приложений](docs/application-manifest.md);
13+
- [полный контракт манифеста стенда](docs/stand-manifest.md);
14+
- [настройка и эксплуатация движка](docs/operations.md).
15+
716
В классической схеме один запуск обычно распадается на несколько инструментов: Terraform/Pulumi создает ресурсы, Ansible или shell-скрипты доводят серверы до нужного состояния, Docker/Kubernetes-манифесты запускают приложения. Связи между этими слоями часто живут в CI, документации или договоренностях команды.
817

918
Stands Engine делает стенд основной единицей описания. В одном YAML-манифесте фиксируются серверы, профили железа, пользователи, приложения, роли, порты, шаблоны конфигурации, хуки и размещение инстансов по узлам. Дальше движок сам раскладывает эту модель на provision, post-provision и application layer.

docs/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Документация Stands Engine
2+
3+
Stands Engine разделяет инфраструктуру на три уровня:
4+
5+
1. **Приложение** — переиспользуемое описание образа, ролей и шаблонов запуска.
6+
2. **Стенд** — конкретный набор серверов, инстансов приложений и их размещение.
7+
3. **Выполнение** — настройка провайдера, создание серверов, запуск и удаление стенда.
8+
9+
Для каждого уровня есть отдельное руководство:
10+
11+
| Задача | Руководство |
12+
|---|---|
13+
| Добавить новое приложение в app registry | [Описание приложений](application-manifest.md) |
14+
| Собрать или изменить `stand.yml` | [Манифест стенда](stand-manifest.md) |
15+
| Настроить окружение и выполнить `create`/`destroy` | [Настройка и эксплуатация](operations.md) |
16+
17+
## Рекомендуемый порядок чтения
18+
19+
Если вы впервые работаете с проектом:
20+
21+
1. Прочитайте общий обзор и быстрый старт в [README проекта](../README.md).
22+
2. Изучите [манифест стенда](stand-manifest.md), чтобы понять связи между
23+
серверами, приложениями и инстансами.
24+
3. Если нужно добавить новый тип приложения, перейдите к
25+
[описанию приложений](application-manifest.md).
26+
4. Перед реальным запуском проверьте требования в
27+
[руководстве по эксплуатации](operations.md).
28+
29+
## Примеры
30+
31+
- [`demo/stand.yml`](../demo/stand.yml) — полный стенд с несколькими приложениями
32+
и нодами.
33+
- [`demo/app-registry`](../demo/app-registry) — готовые описания Redis, MongoDB,
34+
Redpanda, Kafka UI и Dozzle.
35+
- [`demo/cloud-init.yaml.mako`](../demo/cloud-init.yaml.mako) — cloud-init для
36+
поддерживаемого Podman runtime.
37+
38+
> `create` создаёт реальные облачные ресурсы. Перед запуском проверьте provider
39+
> credentials, типы серверов, сеть и стоимость ресурсов.

0 commit comments

Comments
 (0)