Развёртывание API
API ChurchApps развёртываются как функции AWS Lambda с помощью Serverless Framework. Эта страница описывает процесс сборки, развёртывания и настройки для демо- и продакшен-сред.
Перед началом
- Настройте API локально -- см. Локальная настройка API
- Настройте учётные данные AWS на своём компьютере
- Убедитесь, что у вас есть доступ к нужному аккаунту AWS
Сборка
API собираются для продакшена с помощью отдельной конфигурации TypeScript:
npm run build:prod
Эта команда использует tsconfig.prod.json, чтобы скомпилировать проект для среды выполнения Lambda.
Развёртывание
Развёртывание в демо-среду:
npm run deploy-demo
Развёртывание в продакшен:
npm run deploy-prod
На практике API развёртывается через GitHub Actions: Deploy Demo запускается при каждом push в main, а Deploy Prod запускается вручную (workflow dispatch). Тестовой среды (staging) больше нет.
Миграции базы данных
Deploy Prod применяет ожидающие миграции базы данных как часть развёртывания. Продакшен-базы данных принимают подключения только изнутри VPC, поэтому сразу после serverless deploy workflow вызывает Lambda migrate (api-Prod-migrate), которая выполняет ожидающие миграции всех модулей и возвращает { ok, environment, modules }. Если какой-либо модуль завершился с ошибкой или был отклонён (например, у базы данных нет истории миграций), задача завершается с ошибкой, чтобы схема никогда не отставала от кода. Rollback Prod откатывает только код Lambda; миграции остаются применёнными, поэтому пишите их аддитивными. Проверка статуса или ручной запуск миграций описаны в разделе Server Admin -- Database Migrations.
Что создаётся
Каждое развёртывание API создаёт или обновляет следующие функции AWS Lambda:
| Функция | Назначение |
|---|---|
web | Обработчик HTTP-запросов через API Gateway |
socket | Обработчик WebSocket-соединений |
timer15Min | Запланированная задача, которая выполняется каждые 30 минут (название исторически сохранилось) |
timerMidnight | Запланированная задача, которая выполняется ежедневно в полночь |
migrate | Применяет ожидающие миграции базы данных; вызывается workflow Deploy Prod |
Конфигурация среды
В развёрнутых средах конфигурация читается из AWS SSM Parameter Store, а не из файлов .env. Это позволяет не включать секреты в пакет развёртывания и менять конфигурацию без повторного развёртывания.
Никогда не коммитьте продакшен-учётные данные в репозиторий. Вся конфиденциальная конфигурация должна храниться в AWS SSM Parameter Store и читаться во время выполнения.
Каждый merge в main сначала развёртывается в демо-среду. Проверьте свои изменения там (например, на demo.b1.church), прежде чем запускать Deploy Prod.
Связанные статьи
- Локальная настройка API -- Настройка API для разработки
- Структура модулей -- Архитектура функций Lambda
- Развёртывание веб-приложений -- Развёртывание фронтенд-приложений