# Справочник файлов k3s-test

Полный перечень файлов песочницы `k3s-test/` с кратким назначением каждого.
Для понимания **как пользоваться** контуром начните с [обзора test-контура](../) и [статьи «что сделано»](../test-contour-article).
Этот справочник отвечает на вопрос **«что лежит в каком файле»**.

**Документировано файлов:** ~1086 (без vendor/node_modules/dist/.tmp-chart).

## Дерево каталогов

```
k3s-test/
├── README.md, plan-sentry-redmine.md, presentation-practical-guide.md
├── .generated/          # platform-credentials.env, CI SSH keys
├── .images/             # *.tar для import-images-to-vm.sh
├── docs/                  # указатели на VitePress
├── scripts/               # bootstrap, deploy, CI, smoke
├── sova-adminpanel/       # React admin + Gitea CI
├── sova-backend/          # Symfony API + Gitea CI
├── sova-cabinet/          # Symfony ЛК + Gitea CI
├── sova-deploy/           # Helm + ArgoCD GitOps
├── sova-docs/             # VitePress documentation site
├── sova-mocks/            # WireMock + Mailpit
├── sova-platform/         # Terraform k3s bootstrap
└── sova-redmine/          # custom Redmine image (optional)
```

## Разделы справочника

| Раздел | Файлов | Описание |
|--------|--------|----------|
| [Скрипты k3s-test](./scripts) | 38 | `scripts/` |
| [sova-deploy: Helm и ArgoCD](./sova-deploy) | 56 | `sova-deploy/` |
| [sova-platform: Terraform](./sova-platform) | 10 | `sova-platform/` |
| [sova-mocks: WireMock и Mailpit](./sova-mocks) | 19 | `sova-mocks/` |
| [sova-redmine: custom image](./sova-redmine) | 2 | `sova-redmine/` |
| [docs/: указатели](./docs-pointers) | 2 | `docs/` |
| [sova-backend: Symfony API](./sova-backend) | 277 | `sova-backend/` |
| [sova-adminpanel: React admin](./sova-adminpanel) | 129 | `sova-adminpanel/` |
| [sova-cabinet: Symfony ЛК](./sova-cabinet) | 428 | `sova-cabinet/` |
| [sova-docs: сайт документации](./sova-docs-repo) | 114 | `sova-docs/` |
| [Корень и артеfacts](./root-and-artifacts) | 11 | README, `.generated/`, `.images/` |

## Типовые сценарии (какие скрипты вызывать)

| Сценарий | Команды |
|----------|---------|
| **Первый запуск (Multipass)** | `bootstrap-multipass.sh` → `build-images.sh` → `import-images-to-vm.sh` → `deploy-platform.sh` → `deploy-test-stack.sh` |
| **Первый запуск (k3d на Mac)** | `sync-from-monorepo.sh` → `build-images.sh` → `k3d-bootstrap.sh` |
| **Старт/стоп VM** | `multipass start sova-test` / `multipass stop sova-test` → `source scripts/use-kubeconfig.sh` |
| **Релиз приложения** | `scripts/release-tag.sh {backend\|adminpanel\|cabinet\|docs} {tag} test` |
| **Обновить БД test** | `prepare-db-init.sh` → удалить job db-init → redeploy data-test |
| **Redmine** | `deploy-redmine.sh --bootstrap` |
| **Скриншоты для доков** | `capture-platform-screenshots/run.sh` |

## Связанная документация

- [Git-flow](../git-flow) — ветки prod/test/stage
- [Система тегов](../tags) — `{component}-v{semver}-{env}`
- [ArgoCD приложения](../argocd-apps) — sova-root, data-test
- [Gitea CI](./guides/gitea-ci) — pipeline и registry
- [Redmine](./guides/redmine) — issue tracker