1. База знаний
2. Развёртывание

Документация по Helm-чарту Seatmap

Обзор

Helm-чарт Seatmap разворачивает полный стек приложения Seatmap.pro, включая сервисы Editor, Booking и converter, вместе с необходимыми зависимостями, такими как PostgreSQL и Redis.

• Версия чарта: 1.2.1
• Версия приложения: 1.40.0

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

• Kubernetes 1.19+
• Helm 3.2.0+
• Поддержка провижионера PV в базовой инфраструктуре
• Поддержка LoadBalancer (для ingress)

Зависимости

Чарт включает следующие зависимости Bitnami:

• PostgreSQL (версия 12.x.x)
• Redis (версия 17.x.x)

Установка

Установка из монорепозитория

Helm-чарт находится в deployment/helm/seatmap/ в монорепозитории. Перед развёртыванием убедитесь, что зависимости bitnami разрешены:

helm repo add bitnami https://charts.bitnami.com/bitnami
helm dependency update deployment/helm/seatmap

helm upgrade --install seatmap deployment/helm/seatmap \
  --create-namespace \
  --namespace seatmap \
  --set global.s3.bucket=${S3_BUCKET} \
  --set global.s3.region=${S3_REGION} \
  --set global.s3.endpoint=${S3_ENDPOINT} \
  --set global.mail.host=${MAIL_HOST} \
  --set global.mail.fromAddress=${MAIL_FROM} \
  --set global.mail.port=${MAIL_PORT} \
  --set global.mail.socket.port=${MAIL_SOCKET_PORT} \
  --set-string secrets.s3.accessKey=${S3_ACCESS_KEY} \
  --set-string secrets.s3.secretKey=${S3_SECRET_KEY} \
  --set-string secrets.mail.username=${MAIL_USERNAME} \
  --set-string secrets.mail.password=${MAIL_PASSWORD} \
  --set-string secrets.google.apiKey=${GOOGLE_API_KEY} \
  --set imageCredentials.registry=${REGISTRY} \
  --set-string imageCredentials.username=${REGISTRY_USERNAME} \
  --set-string imageCredentials.password=${REGISTRY_PASSWORD}

Локальное тестирование

Запустите полный тест локального стека с помощью kind:

./deployment/helm/test-local.sh

Конфигурация

Глобальные параметры

Конфигурация хостов

global:
  hosts:
    editor: editor.test-5.seatmap.dev
    booking: booking.test-5.seatmap.dev

Реестр образов

imageCredentials:
  registry: registry.gitlab.com
  username: seatmap
  password: <password>

Конфигурации ресурсов

global:
  resources:
    default:
      requests:
        cpu: '500m'
        memory: '2Gi'
      limits:
        cpu: '1000m'
        memory: '3Gi'
    frontend:
      requests:
        cpu: '100m'
        memory: '128Mi'
      limits:
        cpu: '200m'
        memory: '256Mi'

Конфигурация ingress

Чарт предоставляет конфигурации ingress для сервисов Editor и Booking с отдельными именами хостов.

Глобальные настройки ingress

global:
  ingress:
    className: public
    proxyBodySize: '50m'
    annotations:
      cert-manager.io/cluster-issuer: 'letsencrypt-prod'
  hosts:
    editor: editor.test-5.seatmap.dev
    booking: booking.test-5.seatmap.dev

Ingress для Editor

Ingress сервиса Editor настроен на обработку как веб-, так и API-трафика на своём выделенном домене.

editor:
  ingress:
    enabled: true
    annotations: {} # Additional service-specific annotations
    apiPaths:
      - /api
      - /swagger-ui
      - /preview
      - /ws
      - /webjars
      - /v3

Возможности:

• Хост: editor.{domain} (например, editor.test-5.seatmap.dev)
• TLS включён с сертификатом на основе имени хоста
• Веб-путь по умолчанию (/) направляется на веб-порт
• API-пути направляются на API-порт
• Поддержка WebSocket включена
• Настраиваемый максимальный размер тела запроса

Ingress для Booking

Ingress сервиса Booking настроен на своём собственном выделенном домене.

booking:
  ingress:
    enabled: true
    annotations: {} # Additional service-specific annotations
    apiPaths:
      - /api
      - /swagger-ui
      - /webjars
      - /v3
      - /csrf
      - /oauth2
      - /login
      - /.well-known
      - /actuator

Возможности:

• Хост: booking.{domain} (например, booking.test-5.seatmap.dev)
• TLS включён с сертификатом на основе имени хоста
• Веб-путь по умолчанию (/) направляется на веб-порт
• API-пути направляются на API-порт
• Поддержка WebSocket включена
• Общая конфигурация размера тела прокси с Editor

Общие возможности ingress

Оба ingress включают:

• Аннотации NGINX для ограничения размера тела запроса
• Поддержку WebSocket
• Конфигурацию TLS
• Типы путей Implementation-specific для корневых путей
• Типы путей Prefix для API-эндпоинтов

Конфигурации компонентов

PostgreSQL

• Аутентификация управляется через postgresql-secret
• База данных и имя пользователя по умолчанию: seatmap
• Включает инициализацию расширения uuid-ossp

postgresql:
  enabled: true
  auth:
    existingSecret: 'postgresql-secret'
    username: seatmap
    database: seatmap

Redis

• Standalone-архитектура
• Аутентификация включена через redis-secret
• Конфигурация памяти:
  • Максимальная память: 512MB
  • Политика: allkeys-lru

redis:
  enabled: true
  architecture: standalone
  auth:
    enabled: true
    existingSecret: 'redis-secret'
  master:
    persistence:
      enabled: true
      size: 8Gi

Реестр контейнеров

Все образы сервисов размещены в GitLab Container Registry:

Теги образов следуют семантическому версионированию (например, 1.60.0 для релизов, 1.61.0-dev.55-a9130b33 для сборок dev/stage).

Компоненты сервисов

Сервис Editor

editor:
  image:
    repository: registry.gitlab.com/seatmap.pro/seatmap/editor-service
    tag: '1.60.0'
  frontend:
    image:
      repository: registry.gitlab.com/seatmap.pro/seatmap/editor-client
      tag: '1.60.0'

Ключевые конфигурации:

• Настройки пула соединений HikariCP
• Настройки истечения срока токенов
• Поддержка интеграции SSO
• API-пути для ingress

Сервис Booking

booking:
  image:
    repository: registry.gitlab.com/seatmap.pro/seatmap/booking-service
    tag: '1.60.0'
  frontend:
    image:
      repository: registry.gitlab.com/seatmap.pro/seatmap/booking-client
      tag: '1.60.0'

Возможности:

• Конфигурация JPA/Hibernate
• Настройки пула соединений
• Поддержка OAuth2
• Эндпоинты Actuator

Сервис Converter

converter:
  image:
    repository: registry.gitlab.com/seatmap.pro/seatmap/converter-service
    tag: '1.60.0'

Ограничения:

• Максимальная длина контента: 32MB
• Максимальные размеры изображения: 15000x15000 пикселей
• Интеграция с хранилищем S3

Конфигурация внешних сервисов

Хранилище S3

global:
  s3:
    bucket: 'seatmap-storage'
    region: 'us-east-1'
    endpoint: 'https://s3.amazonaws.com'

Почтовый сервер

global:
  mail:
    host: 'smtp.gmail.com'
    port: 587
    socket:
      port: 465
    fromAddress: 'seatmap@seatmap.pro'

Соображения безопасности

Управление секретами

Необходимо предоставить следующие секреты:

• Учётные данные PostgreSQL
• Пароль Redis
• Учётные данные доступа к S3
• Учётные данные почтового сервера
• Ключ Google API

Сетевая безопасность

• Терминация TLS через ingress
• Интеграция с cert-manager для автоматического управления сертификатами
• Раздельные порты API и веб для сервисов

Масштабирование

Горизонтальное автомасштабирование подов

HPA настраивается для всех сервисов с настройками по умолчанию:

global:
  hpa:
    enabled: false
    targetCPUUtilizationPercentage: 80
    targetMemoryUtilizationPercentage: 80

Конфигурации HPA для конкретных сервисов:

• Editor: 2-6 реплик
• Booking: 2-6 реплик
• Converter: 1-4 реплики

Мониторинг и метрики

• Эндпоинты Actuator включены для сервисов Spring Boot
• Метрики Redis отключены по умолчанию
• Настроены кастомные эндпоинты метрик для сервисов editor и booking

Устранение неполадок

Распространённые проблемы

1. Ошибки получения образа

   • Проверьте учётные данные реестра
   • Убедитесь, что теги образов существуют

2. Проблемы с подключением к базе данных

   • Проверьте, что секрет PostgreSQL существует
   • Проверьте настройки пула соединений

3. Проблемы с хранилищем

   • Проверьте учётные данные S3 и доступность бакета
   • Проверьте квоты и ограничения хранилища

Отладка

1. Доступ к логам через:

   kubectl logs -f deployment/seatmap-<component>
   

2. Проверка статуса сервисов:

   kubectl get pods -l app.kubernetes.io/instance=seatmap
   

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

Глобальные переменные

Переменные PostgreSQL

Переменные Redis

Переменные сервиса Editor

Переменные сервиса Booking

Переменные сервиса Converter

Переменные внешних сервисов

Поддержка и обслуживание

• Регулярные обновления через теги версий
• Изменения конфигурации через Helm upgrade
• Управление персистентным хранилищем для PostgreSQL и Redis