Перейти к содержимому
DWE DWE v0.5.0

Справочник конфигурации

Обзор всех конфигурационных файлов в системе DWE.

Впервые сталкиваетесь с DWE? Начните с Getting started, чтобы пройти сценарий от начала до конца, а затем возвращайтесь сюда за пофайловым справочником.

Содержание

Заголовок раздела «Содержание»

Инвентарь файлов

Заголовок раздела «Инвентарь файлов»
ФайлТрекаетсяЗагрузчикНазначение
workspace.ymlдаслой 1Идентификация проекта и структура сервисов
workspace/defaults.ymlдаслой 2Версионированные значения по умолчанию: runtime, экспорты, переключатели enabled сервисов
workspace/local.ymlнет (gitignored)слой 3Переопределения на пользователя: состояние, переключатели enabled сервисов
workspace/services/<name>/service.ymlдаотдельныйДекларация сервиса (dirs, cli, configs, порты)
workspace/deploy.ymlдаотдельныйDeploy-пайплайн оркестратора (фазы + шаги)
workspace/services/<name>/deploy.ymlдаотдельныйDeploy-пайплайны на каждый сервис
workspace/reset.ymlдаотдельныйReset-пайплайн
workspace/lifecycle.ymlдаотдельныйПайплайны run / stop (драйверы для dwe run/stop/restart)
workspace/docker.ymlдаотдельныйПолитика выполнения compose
workspace/docker.local.ymlнет (gitignored)сливается с docker.ymlЛокальные переопределения политики compose
workspace/styles.ymlдаотдельныйASCII header, цветовая палитра, разделитель
workspace/info.ymlдаотдельныйСекции info-дашборда
workspace/commands/даотдельныйДекларативные определения команд (по группе на файл)
workspace/validate.ymlдаотдельныйПроверки готовности проекта (preflight + dwe validate)
workspace/snapshot.ymlдаотдельныйSnapshot-workflow’ы: create / restore / remove (dwe snapshot)
workspace/tests/<scenario>.ymlдаотдельныйСценарии интеграционных тестов: изолированный деплой + шаги-проверки (dwe test)
workspace/i18n/*.ymlдаотдельныйПереводы пользовательских команд и UI-строк (опционально; один файл на язык)

Runtime-артефакты

Заголовок раздела «Runtime-артефакты»

Директория .dwe/ содержит управляемые DWE артефакты и gitignored:

  • .dwe/logs/ — логи пайплайнов (deploy, reset, lifecycle run/stop)
  • .dwe/deploy/deploy.lock — lock-файл деплоя (только Unix; предотвращает параллельные деплои)
  • .dwe/deploy/state.yml — журнал состояния деплоя (отслеживает deploy-статус и хэши сервисов)
  • .dwe/snapshots/snapshot.lock — snapshot lock-файл (только Unix; сериализует изменения снапшотов и совместно захватывается lifecycle-командами деплоя)
  • .dwe/snapshots/current — указатель текущего снапшота (последний созданный или восстановленный)
  • .dwe/snapshots/.pre-restore-backup/ — резервная копия workspace/local.yml + .dwe/deploy/state.yml, снимаемая перед каждым restore; используется для ручного восстановления при сбое restore
  • .dwe/tests/runs/<scenario>/, .dwe/tests/locks/<scenario>.lock, .dwe/tests/manifests/<scenario>-<run-id>.yml, .dwe/tests/reports/<scenario>/ — копии сценариев dwe test, per-scenario flock’и, durable-манифесты запусков и артефакты отчётов об ошибках (собираются только при сбое)

Добавьте .dwe/ в .gitignore проекта, если ещё не добавлено.

Топология загрузчиков

Заголовок раздела «Топология загрузчиков»
flowchart LR
  subgraph merged["Слияние трёх слоёв — DweConfig"]
    direction TB
    A[workspace.yml] --> B[workspace/defaults.yml] --> C[workspace/local.yml]
  end

  S["workspace/services/&lt;name&gt;/service.yml"] -. подставляется в Raw .-> merged

  merged --> R[(DweConfig.Raw<br/>+ типизированные структуры)]

  subgraph standalone["Отдельные загрузчики"]
    direction TB
    D[workspace/deploy.yml]
    DS["workspace/services/&lt;name&gt;/deploy.yml"]
    RS[workspace/reset.yml]
    L[workspace/lifecycle.yml]
    DK[workspace/docker.yml<br/>+ docker.local.yml]
    ST[workspace/styles.yml]
    IN[workspace/info.yml]
    CM[workspace/commands/]
  end

  R -. "dot-paths / шаблоны" .-> D
  R -. "dot-paths / шаблоны" .-> DS
  R -. "dot-paths / шаблоны" .-> RS
  R -. "dot-paths / шаблоны" .-> L
  R -. "$#123;...#125; project_name" .-> DK
  R -. "#123;#123;...#125;#125; выражения" .-> IN
  R -. "$#123;...#125; параметры команд" .-> CM

Смерженные vs standalone

Заголовок раздела «Смерженные vs standalone»

Смерженные (трёхслойный конфиг): workspace.yml → workspace/defaults.yml → workspace/local.yml глубоко сливаются на старте. Поздние слои перекрывают предыдущие; map’ы сливаются рекурсивно. Результат — эффективный конфиг, используемый для генерации .env, разрешения топологии и правил экспорта. Каждый workspace/services/<name>/service.yml грузится отдельно и затем подставляется в смерженный raw-map, чтобы dot-пути вроде services.main.container корректно резолвились.

Отдельные: workspace/services/<name>/service.yml, deploy.yml, workspace/services/<name>/deploy.yml, reset.yml, lifecycle.yml, docker.yml (+ docker.local.yml), styles.yml, info.yml и commands/*.yml грузятся выделенными функциями в internal/core/project/config/ и internal/core/usercommands/. Они не участвуют в трёхслойном слиянии, но большинство из них разрешают template-выражения по смерженному конфигу.

Файлы, поддерживающие локальные переопределения

Заголовок раздела «Файлы, поддерживающие локальные переопределения»

На данный момент только docker.local.yml поддерживает вариант .local.yml для кастомизации на разработчика. Паттерн такой:

Docker: workspace/docker.yml (отслеживаемый, общий на весь проект) + workspace/docker.local.yml (gitignored, на разработчика). Локальный файл сливается поверх базового, позволяя разработчикам кастомизировать политику выполнения compose — например, добавить дополнительные volume’ы, смонтировать локальные директории с исходниками или переопределить platform/args, не задевая коллег.

Почему только docker? Docker-настройки по своей природе персональные — они зависят от локального окружения разработчика (доступные бинарники, монтирование volume’ов, различия платформ). Другие конфиги вроде lifecycle.yml, info.yml и styles.yml общие на весь проект и не выигрывают от переопределений на разработчика.

Подробнее о семантике и примерах docker.local.yml см. docker.yml.

Страницы

Заголовок раздела «Страницы»
  • workspace / defaults / local — трёхслойный смерженный конфиг: порядок слияния, приоритет, разрешение dot-путей, справочник полей
  • vars — команда dwe vars: перечисление/чтение/редактирование/трассировка песочницы vars:, запись с сохранением комментариев, статическое сканирование использований, allowlist контейнерной записи bridge.vars_writable
  • services//service.yml — декларации сервисов, extends, dirs, cli-конфиг
  • deploy.yml / reset.yml — deploy- и reset-пайплайны, шаги, билтины, file-логирование, идемпотентный деплой
  • state.yml — отслеживание состояния деплоя, таблица skip-решений, хэширование, lock-файл, восстановление после падений
  • lifecycle.yml — пайплайны run/stop, проба обновлений, hook-фазы, гейт обязательных сервисов
  • Условия и действия — типизированные условия для when:, типизированные действия для check: и тел шагов, различие predicate vs engine-builtin
  • docker.yml — политика выполнения Compose, имя проекта, env-триггеры
  • styles.yml — ASCII header, цветовая палитра, разделитель
  • info.yml — секции info-дашборда, template-выражения
  • commands/ — декларативные команды: типы, параметры, контекст, файлы, workflow’ы, шаблоны
  • validate.yml — проверки готовности проекта: env-пробы, декларативные проверки, билтины, стадии, preflight
  • snapshot.yml — snapshot-workflow’ы: блоки create/restore/remove, варианты, неймспейс ${snapshot.*}, manifest, взаимодействие с lock, безопасность архивов
  • tests/ — сценарии интеграционных тестов: схема, auto-порты, модель изоляции, teardown, dwe test run/list/clean, отчёты об ошибках, коды выхода
  • Локализация (i18n) — переводы пользовательских команд и UI-строк: разрешение локали, формат файла, справочник ключей, валидация
  • Пользовательский конфиг — пользовательские настройки: расположение файла, синтаксис, переопределения бинарей, язык, тема mermaid
  • Уведомления — desktop-уведомления на уровне пользователя: расположение конфиг-файлов, ключи, матрица условий, env-переопределения
  • UI — конфигурация интерактивного браузера команд: глубина, collapse, бэйджи, хоткеи, лестница фолбэков
  • Шаблоны — Go-шаблоны, shorthand ${...}, sprout-хелперы (общие для info, commands, пайплайнов, render-паков)

Связанные команды

Заголовок раздела «Связанные команды»
  • dwe render env — генерирует .env из правил экспорта смерженного конфига
  • dwe render ide — генерирует IDE-конфиги
  • dwe render ai — генерирует hub-level AGENTS.md и симлинки CLAUDE.md
  • dwe render git — генерирует shell-хуки git в <svc.Dir>/src/.git/hooks/
  • dwe info — рендерит info-дашборд из info.yml
  • dwe deploy plan — показывает итоговый deploy-пайплайн
  • dwe compose files — показывает список активных compose-файлов (диагностика)
  • dwe status apps — показывает app-сервисы с health и deploy-статусом
  • dwe status tools — показывает таблицу tool-сервисов (read-only)
  • dwe status infra — показывает таблицу infra-сервисов (read-only)
  • dwe test run — запускает изолированные сценарии интеграционных тестов на одноразовой копии проекта
  • dwe test list — список доступных сценариев интеграционных тестов
  • dwe test clean — убирает сохранённые/оставшиеся окружения интеграционных тестов и сообщает (никогда не удаляет автоматически) об осиротевших compose-проектах (на основе манифестов; --dry-run, [scenario...])