Начало работы

Добро пожаловать в документацию по инфраструктуре. Этот сайт является центральным справочником по сборке, развёртыванию и эксплуатации сервисов в нашей инфраструктуре. Независимо от того, проходите ли вы онбординг в команду или ищете конкретную процедуру развёртывания, начните отсюда.

Предварительные требования

Перед началом работы с платформой убедитесь, что у вас есть следующее:

Требование	Подробности
Доступ к GitLab	Учётная запись на gitlab.amzgit.com с доступом к группе meduza
Docker	Docker Desktop или Docker Engine 24+
Nomad CLI	HashiCorp Nomad 1.6+, установленный локально
Node.js	v20 или новее (используется фронтендом platform_hub и инструментарием)
npm / pnpm	Пакетный менеджер для фронтенд-зависимостей

TIP

Если вы работаете на macOS, вы можете установить Nomad с помощью brew install hashicorp/tap/nomad. Для Node.js используйте nvm или fnm для управления версиями.

Разделы документации

Руководство

Концепции верхнего уровня, архитектура и настройка окружений. Начните здесь, если вы новичок.

CI/CD

Конфигурация пайплайнов GitLab CI, общие шаблоны в meduza/infra и сборка Docker-образов.

Инфраструктура

Оркестрация Nomad, маршрутизация Traefik и управление конфигурацией Consul.

Развёртывание

Развёртывание на основе веток — dev, stage и prod — с автоматическими и ручными триггерами.

Разработка

Пошаговые руководства по упаковке сервисов в Docker и деплою через Nomad.

Структура этого сайта

Этот сайт документации построен с помощью VitePress и располагается рядом с исходным кодом платформы. Структура следует простому соглашению:

docs/
├── .vitepress/
│   └── config.mts         # Site configuration, nav, sidebar
├── guide/                 # Getting started, architecture, environments
├── cicd/                  # CI/CD pipeline and templates
├── infrastructure/        # Nomad, Traefik, Consul
├── deployment/            # Dev, stage, prod deployment guides
└── developing/            # Building new tools and services

Каждый раздел соответствует директории верхнего уровня. Навигация боковой панели определена в .vitepress/config.mts и повторяет структуру папок.

WARNING

Храните документацию рядом с кодом, который она описывает. Если у сервиса есть собственный репозиторий, рассмотрите возможность добавления папки docs/ в нём и создания ссылки на неё с этого центрального сайта.

Следующие шаги

1. Прочитайте Обзор архитектуры, чтобы понять, как устроена инфраструктура.
2. Ознакомьтесь с разделом Окружения, чтобы узнать о dev, stage и prod.
3. Настройте локальное окружение для разработки, следуя шагам в руководстве по окружениям.