Compare commits
1 Commits
master
...
INFRA-2004
| Author | SHA1 | Date | |
|---|---|---|---|
| 0d1023a84a |
4
.gitignore
vendored
4
.gitignore
vendored
@ -3,6 +3,4 @@
|
||||
CLAUDE.md
|
||||
.env
|
||||
|
||||
tmp
|
||||
.tmp/
|
||||
snapshots/*
|
||||
tmp
|
||||
675
IAC-CATALOG.md
675
IAC-CATALOG.md
@ -1,675 +0,0 @@
|
||||
# Каталог IaC-компонентов и репозиториев
|
||||
|
||||
Карта ответственности: **какой репозиторий за что отвечает** в инфраструктуре `gitlab.sarex.io`
|
||||
и **из чего состоит** этот репозиторий (`infra/iac`).
|
||||
|
||||
- Источники: GitLab-группа `infra` (209 проектов, включая подгруппы) + содержимое `infra/iac`.
|
||||
- Дата среза: **2026-08-05**.
|
||||
- Все ссылки — на `https://gitlab.sarex.io`.
|
||||
|
||||
Пометки достоверности:
|
||||
|
||||
| Знак | Значение |
|
||||
|---|---|
|
||||
| ✅ | структура/назначение проверены — репозиторий открыт и прочитан |
|
||||
| ◻️ | назначение выведено из имени, описания в GitLab и веток; **требует подтверждения** |
|
||||
|
||||
---
|
||||
|
||||
## 1. Слои IaC и где они живут
|
||||
|
||||
```
|
||||
┌─ Железо / VM ─────────────────────────────────────────────────────────────┐
|
||||
│ ansible-playbooks, ansible-patroni-cluster, ansible-minio-cluster, │
|
||||
│ tools/ansible-vm-preparing, astra-linux, hardware, intervpc-vpn-tunnel │
|
||||
├─ Кластер Kubernetes ──────────────────────────────────────────────────────┤
|
||||
│ kubespray, k8s-provision │
|
||||
├─ Облачные и k8s-ресурсы (namespace/БД/S3/секреты/топики) ─────────────────┤
|
||||
│ terraform, terraform-contour, terraform-contour-mirror, │
|
||||
│ sarex-terraform-provider │
|
||||
├─ GitOps: состояние кластеров ─────────────────────────────────────────────┤
|
||||
│ ★ iac (Flux v2, этот репозиторий) iac-gpn (ArgoCD) poc/iac (архив) │
|
||||
├─ Поставка отдельных компонентов через GitLab CI (ветка = контур) ─────────┤
|
||||
│ vault, redis, kafka, postgresql, istio-config, keycloak, … (~60 репо) │
|
||||
├─ Библиотеки чартов ───────────────────────────────────────────────────────┤
|
||||
│ universal-helm-chart, common-charts, chart-museum │
|
||||
├─ Эксплуатация, аудит, наблюдаемость ──────────────────────────────────────┤
|
||||
│ k8s-changelog, cluster-maintenance, k8s-hustler, harvester, backups/* │
|
||||
└───────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Главный водораздел.** В инфраструктуре сосуществуют **две модели доставки**:
|
||||
|
||||
1. **GitOps (Flux)** — `infra/iac`. Один репозиторий, множество кластеров, состояние декларируется
|
||||
в `clusters/<кластер>/`, Flux сам подтягивает изменения.
|
||||
2. **Push-деплой (GitLab CI)** — по репозиторию на компонент, чарт лежит в `.helm/`,
|
||||
**ветка = контур/окружение** (`stage`, `preprod`, `contour`, `infra`, `brusnika-prod`, …).
|
||||
Проверено на [vault](https://gitlab.sarex.io/infra/vault),
|
||||
[redis](https://gitlab.sarex.io/infra/redis),
|
||||
[istio-config](https://gitlab.sarex.io/infra/istio-config),
|
||||
[kube-prometheus-stack](https://gitlab.sarex.io/infra/kube-prometheus-stack),
|
||||
[gitlab-runner](https://gitlab.sarex.io/infra/gitlab-runner). ✅
|
||||
|
||||
Для ряда компонентов (Vault, Redis, Kafka, PostgreSQL, Istio, Keycloak, Zitadel, OpenObserve,
|
||||
Superset, Trino, GoAlert, GlitchTip, argo-*, otel-*) **существуют оба источника**.
|
||||
См. раздел [6. Перекрытия](#6-перекрытия-и-как-выбирать-источник-истины).
|
||||
|
||||
---
|
||||
|
||||
## 2. Ядро IaC — репозитории верхнего уровня
|
||||
|
||||
| Репозиторий | Зона ответственности | Ключевое содержимое |
|
||||
|---|---|---|
|
||||
| ★ [infra/iac](https://gitlab.sarex.io/infra/iac) ✅ | **Основной GitOps-монорепозиторий (Flux v2).** Декларативное состояние 9 кластеров: инфраструктурные компоненты + прикладные сервисы | `clusters/`, `infrastructure/` (36), `apps/` (37), `inventory.yaml`, `docs/apps/` |
|
||||
| [infra/terraform](https://gitlab.sarex.io/infra/terraform) ✅ | **Ресурсы Yandex Cloud и Kubernetes**: namespaces, PostgreSQL БД/пользователи, S3-бакеты, Valkey/Redis-пользователи, Kafka-топики, RabbitMQ, k8s-секреты. Единый источник правды — `infrastructure.yaml`, секреты через SOPS | `live/prod` (Terragrunt), `modules/`: `k8s-namespace`, `k8s-secret`, `k8s-secrets`, `kafka-topics-yc`, `rabbitmq`, `yc-database`, `yc-s3`, `yc-valkey-user` |
|
||||
| [infra/terraform-contour](https://gitlab.sarex.io/infra/terraform-contour) ✅ | Тот же подход **для изолированного контура**: namespaces и секреты из Vault | `live/{namespace,vault-secrets}`, `modules/{k8s-namespace,vault-platform-secrets}` |
|
||||
| [infra/terraform-contour-mirror](https://gitlab.sarex.io/infra/terraform-contour-mirror) ✅ | **Зеркало `infra/terraform` для контура** (ветка `contour`, единственная). Тот же README и структура + `Dockerfile` для запуска в закрытом периметре | `live/`, `modules/`, `scripts/`, `Dockerfile` |
|
||||
| [infra/sarex-terraform-provider](https://gitlab.sarex.io/infra/sarex-terraform-provider) ✅ | **Внутренние Terraform-провайдеры**, генерируемые из OpenAPI-спек продуктовых API (например `workspaces-api`). В публичный реестр не публикуются — ставятся через dev overrides | `providers/`, `internal/`, `examples/`, `Makefile` |
|
||||
| [infra/iac-gpn](https://gitlab.sarex.io/infra/iac-gpn) ✅ | **GitOps-контур ГПН на ArgoCD** (не Flux): `root.yaml` + app-of-apps, конфигмапы бэкендов, образ `terraform-contour-stronghold` | `argocd/{root.yaml,apps}`, `infrastructure/*-configmaps`, `images/` |
|
||||
| [infra/poc/iac](https://gitlab.sarex.io/infra/poc/iac) ✅ | **Предшественник/PoC** текущего Flux-репозитория. Последняя активность 2026-02-16 — считать архивом | `clusters/`, `apps/`, `infra/`, `GUIDE.md` |
|
||||
|
||||
---
|
||||
|
||||
## 3. Провижининг: от железа до кластера
|
||||
|
||||
| Репозиторий | Отвечает за |
|
||||
|---|---|
|
||||
| [infra/kubespray](https://gitlab.sarex.io/infra/kubespray) ✅ | Форк upstream Kubespray — **развёртывание самих кластеров Kubernetes** на VM |
|
||||
| [infra/k8s-provision](https://gitlab.sarex.io/infra/k8s-provision) ✅ | **Первичная обвязка свежего кластера**: `namespaces`, `cert_manager`, `istio` (+`ISTIO.md`), `ingress`, `dashboard`, `prometheus`, `postgres`/`ya_postgres`, `rabbitmq`, `pvc`, `gitlab`, `teamcity`, `migration` |
|
||||
| [infra/ansible-playbooks](https://gitlab.sarex.io/infra/ansible-playbooks) ✅ | Зонтичный Ansible-репозиторий: каталоги `minio/`, `patroni/` |
|
||||
| [infra/ansible-patroni-cluster](https://gitlab.sarex.io/infra/ansible-patroni-cluster) ✅ | **PostgreSQL HA на VM через Patroni** (`site.yml`, `roles/`, `inventory/`, `test.yml`) |
|
||||
| [infra/ansible-minio-cluster](https://gitlab.sarex.io/infra/ansible-minio-cluster) ✅ | **MinIO-кластер на VM** + сценарии проверок `fault-tolerance-test.yml`, `heal-test.yml` |
|
||||
| [infra/tools/ansible-vm-preparing](https://gitlab.sarex.io/infra/tools/ansible-vm-preparing) ✅ | Подготовка VM перед Ansible/Kubespray (Python-обвязка, `uv`). README — шаблонный, назначение по коду |
|
||||
| [infra/hardware](https://gitlab.sarex.io/infra/hardware) ◻️ | Учёт/конфигурация физического оборудования |
|
||||
| [infra/astra-linux](https://gitlab.sarex.io/infra/astra-linux) ◻️ | Сборка/настройка образов Astra Linux для импортозамещённых контуров |
|
||||
| [infra/intervpc-vpn-tunnel](https://gitlab.sarex.io/infra/intervpc-vpn-tunnel) ◻️ | VPN-туннель между VPC |
|
||||
| [infra/cluster-maintenance](https://gitlab.sarex.io/infra/cluster-maintenance) ◻️ | Регламентные операции обслуживания кластеров |
|
||||
|
||||
---
|
||||
|
||||
## 4. Компонентные репозитории (`.helm/` + GitLab CI, ветка = контур)
|
||||
|
||||
Формат ниже: **компонент → репозиторий**. Столбец «в `iac`» показывает, есть ли одноимённый
|
||||
компонент в этом монорепозитории (`infrastructure/<имя>`).
|
||||
|
||||
### 4.1 Сеть, Ingress, Service Mesh
|
||||
|
||||
| Компонент | Репозиторий | в `iac` |
|
||||
|---|---|---|
|
||||
| Istio (base/pilot/gateway) | [infra/istio](https://gitlab.sarex.io/infra/istio) `infra` | ✔ `istio-base`, `istio-pilot`, `istio-gateway` |
|
||||
| Istio: Gateway/VirtualService/AuthPolicy/EnvoyFilter | [infra/istio-config](https://gitlab.sarex.io/infra/istio-config) ✅ ветки `stage`,`preprod`,`contour`,`infra`,`master` | ✔ `istio-config` |
|
||||
| Istio для контура НН | [infra/istio-nn](https://gitlab.sarex.io/infra/istio-nn) ◻️ | — |
|
||||
| cert-manager | [infra/cert-manager](https://gitlab.sarex.io/infra/cert-manager) ◻️ | ✔ `cert-manager` |
|
||||
| nginx (ingress для Django) | [infra/ingress-nginx-django](https://gitlab.sarex.io/infra/ingress-nginx-django) ◻️ | — |
|
||||
| nginx с Kerberos / hardened nginx | [infra/nginx-krb](https://gitlab.sarex.io/infra/nginx-krb), [infra/secure-nginx](https://gitlab.sarex.io/infra/secure-nginx) ◻️ | — |
|
||||
|
||||
### 4.2 Identity, доступ, безопасность
|
||||
|
||||
| Компонент | Репозиторий | в `iac` |
|
||||
|---|---|---|
|
||||
| Keycloak | [infra/keycloak](https://gitlab.sarex.io/infra/keycloak) ◻️ | ✔ `keycloak` |
|
||||
| Zitadel | [infra/zitadel](https://gitlab.sarex.io/infra/zitadel) ◻️ | ✔ `zitadel` |
|
||||
| Zitadel auth proxy | [infra/zitadel-auth-proxy](https://gitlab.sarex.io/infra/zitadel-auth-proxy) ◻️ | — |
|
||||
| OpenLDAP | [infra/openldap](https://gitlab.sarex.io/infra/openldap) `contour` ◻️ | ✔ `openldap` |
|
||||
| HashiCorp Vault | [infra/vault](https://gitlab.sarex.io/infra/vault) ✅ `contour` | ✔ `vault`, `vault-unseal` |
|
||||
| SpiceDB (авторизация) | [infra/spicedb](https://gitlab.sarex.io/infra/spicedb) ◻️ | — |
|
||||
| OAuth2-фасад / gatekeeper | [infra/oauth2-facade](https://gitlab.sarex.io/infra/oauth2-facade), [infra/gogatekeeper](https://gitlab.sarex.io/infra/gogatekeeper) ◻️ | — |
|
||||
| Фильтрация JWKS | [infra/jwks-key-filter](https://gitlab.sarex.io/infra/jwks-key-filter) ◻️ | — |
|
||||
| Django ↔ Keycloak (библиотека) | [infra/django-keycloak](https://gitlab.sarex.io/infra/django-keycloak) ✅ | — |
|
||||
| Сканирование секретов / образов | [infra/gitleaks](https://gitlab.sarex.io/infra/gitleaks), [infra/clair](https://gitlab.sarex.io/infra/clair), [infra/sec/report](https://gitlab.sarex.io/infra/sec/report) ◻️ | — |
|
||||
|
||||
### 4.3 Данные и хранилища
|
||||
|
||||
| Компонент | Репозиторий | в `iac` |
|
||||
|---|---|---|
|
||||
| PostgreSQL | [infra/postgresql](https://gitlab.sarex.io/infra/postgresql) ветки `contour`,`contour-13`,`preprod`,`stronghold` ✅ | ✔ `postgresql` |
|
||||
| PostgreSQL 16 (контур WB) | [infra/wb/postgresql16](https://gitlab.sarex.io/infra/wb/postgresql16) ◻️ | — |
|
||||
| pg_partman / TimescaleDB / CockroachDB | [infra/postgres-pgpartman](https://gitlab.sarex.io/infra/postgres-pgpartman), [infra/timescaledb](https://gitlab.sarex.io/infra/timescaledb), [infra/cockroachdb](https://gitlab.sarex.io/infra/cockroachdb) ◻️ | — |
|
||||
| Redis | [infra/redis](https://gitlab.sarex.io/infra/redis) ✅ `contour` | ✔ `redis` |
|
||||
| MinIO (в k8s) | [infra/minio-standalone](https://gitlab.sarex.io/infra/minio-standalone) `contour` ◻️ | ✔ `minio` |
|
||||
| ClickHouse (+оператор) | [infra/clickhouse](https://gitlab.sarex.io/infra/clickhouse), [infra/clickhouse-operator](https://gitlab.sarex.io/infra/clickhouse-operator) ◻️ | — |
|
||||
| OpenSearch (+оператор) | [infra/opensearch](https://gitlab.sarex.io/infra/opensearch), [infra/opensearch-operator](https://gitlab.sarex.io/infra/opensearch-operator) ◻️ | — |
|
||||
| S3-прокси | — (только в `iac`) | ✔ `s3-proxy` |
|
||||
|
||||
### 4.4 Брокеры и обмен сообщениями
|
||||
|
||||
| Компонент | Репозиторий | в `iac` |
|
||||
|---|---|---|
|
||||
| Kafka | [infra/kafka](https://gitlab.sarex.io/infra/kafka) ветки `stage`,`preprod`,`brusnika-*` ✅ | ✔ `kafka` |
|
||||
| Kafka standalone (контур НН) | [infra/kafka-nn](https://gitlab.sarex.io/infra/kafka-nn) ◻️ | — |
|
||||
| Strimzi/Kafka-оператор | [infra/kafka-operator](https://gitlab.sarex.io/infra/kafka-operator) ◻️ | — |
|
||||
| Kafka exporter | [infra/kafka-exporter](https://gitlab.sarex.io/infra/kafka-exporter) ◻️ | ✔ `kafka-exporter` |
|
||||
| Маршрутизация между Kafka-кластерами | [infra/kafka-router](https://gitlab.sarex.io/infra/kafka-router) ✅ | — |
|
||||
| Kafka → Vector мост | [infra/kafka-vector-bridge](https://gitlab.sarex.io/infra/kafka-vector-bridge) ◻️ | — |
|
||||
| RabbitMQ (+оператор, контур НН) | [infra/rabbitmq](https://gitlab.sarex.io/infra/rabbitmq), [infra/rabbitmq-cluster-operator](https://gitlab.sarex.io/infra/rabbitmq-cluster-operator), [infra/rabbitmq-nn](https://gitlab.sarex.io/infra/rabbitmq-nn) ◻️ | ✔ `rabbitmq` |
|
||||
|
||||
### 4.5 Наблюдаемость
|
||||
|
||||
| Компонент | Репозиторий | в `iac` |
|
||||
|---|---|---|
|
||||
| kube-prometheus-stack | [infra/kube-prometheus-stack](https://gitlab.sarex.io/infra/kube-prometheus-stack) ✅ `infra` | ✔ `prometheus-stack` |
|
||||
| prometheus-stack (описан как «A complete monitoring stack for Kubernetes») | [infra/prometheus-stack](https://gitlab.sarex.io/infra/prometheus-stack) `stage` | ✔ `prometheus-stack` |
|
||||
| Алерты и дашборды для Prometheus/Grafana | [infra/prometheus-stsack-resources](https://gitlab.sarex.io/infra/prometheus-stsack-resources) *(опечатка в имени — так в GitLab)* | — |
|
||||
| VictoriaMetrics stack / cluster | [infra/vm-stack](https://gitlab.sarex.io/infra/vm-stack), [infra/vm-cluster](https://gitlab.sarex.io/infra/vm-cluster) ◻️ | ✔ `vmstack` |
|
||||
| Экспортеры: node / postgres / blackbox | [infra/node-exporter](https://gitlab.sarex.io/infra/node-exporter), [infra/postgres-exporter](https://gitlab.sarex.io/infra/postgres-exporter), [infra/blackbox-exporter](https://gitlab.sarex.io/infra/blackbox-exporter) ◻️ | ✔ `postgres-exporter` |
|
||||
| OpenObserve | [infra/openobserve](https://gitlab.sarex.io/infra/openobserve) ветка `contour/cps` ✅ | ✔ `openobserve` |
|
||||
| Loki / SigNoz | [infra/loki](https://gitlab.sarex.io/infra/loki), [infra/signoz](https://gitlab.sarex.io/infra/signoz) ◻️ | — |
|
||||
| Sentry / GlitchTip | [infra/sentry](https://gitlab.sarex.io/infra/sentry), [infra/glitchtip](https://gitlab.sarex.io/infra/glitchtip) `contour/cps` ◻️ | ✔ `glitchtip` |
|
||||
| GoAlert (+ исходники, + Telegram-релей) | [infra/goalert](https://gitlab.sarex.io/infra/goalert), [infra/goalert-source](https://gitlab.sarex.io/infra/goalert-source), [infra/goalert-telegram-relay](https://gitlab.sarex.io/infra/goalert-telegram-relay) ◻️ | ✔ `goalert` |
|
||||
| OpenTelemetry collector / operator | [infra/opentelemetry-collector](https://gitlab.sarex.io/infra/opentelemetry-collector), [infra/opentelemetry-operator](https://gitlab.sarex.io/infra/opentelemetry-operator) ◻️ | ✔ `opentelemetry-collector`, `opentelemetry-operator` |
|
||||
| eBPF-экспортер OTel | [infra/otel-ebpf-exporter](https://gitlab.sarex.io/infra/otel-ebpf-exporter) ◻️ | — |
|
||||
| Конвейер телеметрии: OTel → Kafka → ClickHouse | [infra/otel-kafka-processor](https://gitlab.sarex.io/infra/otel-kafka-processor), [infra/otel-kafka-clickhouse-worker](https://gitlab.sarex.io/infra/otel-kafka-clickhouse-worker) ◻️ | — |
|
||||
| SDK-обвязки инструментирования | [infra/otel/django-otel-tools](https://gitlab.sarex.io/infra/otel/django-otel-tools), [infra/otel/fastapi-otel-tools](https://gitlab.sarex.io/infra/otel/fastapi-otel-tools), [infra/golang-fiber-otel-tools](https://gitlab.sarex.io/infra/golang-fiber-otel-tools), [infra/golang-net-http-otel-tools](https://gitlab.sarex.io/infra/golang-net-http-otel-tools), [infra/django-instrumented](https://gitlab.sarex.io/infra/django-instrumented), [infra/djano-autoinstrumentation](https://gitlab.sarex.io/infra/djano-autoinstrumentation) ◻️ | — |
|
||||
| PMM, Trickster, отчёты по Prometheus | [infra/pmm](https://gitlab.sarex.io/infra/pmm), [infra/trickster](https://gitlab.sarex.io/infra/trickster), [infra/prometheus-report](https://gitlab.sarex.io/infra/prometheus-report) ◻️ | — |
|
||||
| SIEM-шиппер (+UI) | [infra/siem-shiper](https://gitlab.sarex.io/infra/siem-shiper), [infra/siem-shiper-frontend](https://gitlab.sarex.io/infra/siem-shiper-frontend) ◻️ | — |
|
||||
|
||||
### 4.6 Платформа, аналитика, BPM
|
||||
|
||||
| Компонент | Репозиторий | в `iac` |
|
||||
|---|---|---|
|
||||
| Kubernetes Dashboard | [infra/dashboard](https://gitlab.sarex.io/infra/dashboard) ◻️ | ✔ `dashboard` |
|
||||
| local-path-provisioner | [infra/local-path-provisioner-nn](https://gitlab.sarex.io/infra/local-path-provisioner-nn) ◻️ | ✔ `local-path-provisioner` |
|
||||
| Camunda (+ модели процессов) | [infra/camunda](https://gitlab.sarex.io/infra/camunda) `camunda-prod`, [infra/camunda-processes](https://gitlab.sarex.io/infra/camunda-processes) ◻️ | ✔ `camunda` |
|
||||
| Argo Workflows / Argo Events | [infra/argo-workflows](https://gitlab.sarex.io/infra/argo-workflows), [infra/argo-events](https://gitlab.sarex.io/infra/argo-events) ◻️ | ✔ `argo-workflows`, `argo-events` |
|
||||
| Superset / Trino | [infra/superset](https://gitlab.sarex.io/infra/superset), [infra/trino](https://gitlab.sarex.io/infra/trino) ◻️ | ✔ `superset`, `trino` |
|
||||
| Jupyter, BI-эксперименты, ETL, ГИС | [infra/jupyter-notebook](https://gitlab.sarex.io/infra/jupyter-notebook), [infra/bi-test](https://gitlab.sarex.io/infra/bi-test), [infra/etl](https://gitlab.sarex.io/infra/etl), [infra/sarex-gis](https://gitlab.sarex.io/infra/sarex-gis) ◻️ | — |
|
||||
| Mailer | [infra/mailer](https://gitlab.sarex.io/infra/mailer) ◻️ | — |
|
||||
|
||||
### 4.7 CI/CD и Git-инфраструктура
|
||||
|
||||
| Компонент | Репозиторий |
|
||||
|---|---|
|
||||
| GitLab Runner | [infra/gitlab-runner](https://gitlab.sarex.io/infra/gitlab-runner) ✅ (`.helm` + CI) |
|
||||
| Gitea (Git-зеркала для изолированных контуров) | [infra/gitea](https://gitlab.sarex.io/infra/gitea) ◻️ — см. §5, Flux в закрытых контурах читает `iac` именно из Gitea |
|
||||
| ChartMuseum (реестр Helm-чартов) | [infra/chart-museum](https://gitlab.sarex.io/infra/chart-museum) ◻️ |
|
||||
| Базовые Docker-образы | [infra/base-images](https://gitlab.sarex.io/infra/base-images) ◻️ |
|
||||
| Миграция и утилиты GitLab | [infra/gitlab-migrator](https://gitlab.sarex.io/infra/gitlab-migrator), [infra/gitlab-tools](https://gitlab.sarex.io/infra/gitlab-tools) ◻️ |
|
||||
|
||||
### 4.8 Библиотеки чартов
|
||||
|
||||
| Репозиторий | Отвечает за |
|
||||
|---|---|
|
||||
| [infra/universal-helm-chart](https://gitlab.sarex.io/infra/universal-helm-chart) ✅ | Универсальный чарт (`.helm/`), на который ссылаются HelmRelease в `iac` (`openobserve`, `glitchtip` — `chart: universal-chart`) |
|
||||
| [infra/common-charts](https://gitlab.sarex.io/infra/common-charts) ✅ | Общие чарты, сейчас — `universal-static-site` |
|
||||
| [infra/helm-values-extractor](https://gitlab.sarex.io/infra/helm-values-extractor) ◻️ | Извлечение `values` из работающих релизов (ветка `draft-script`) |
|
||||
| [infra/poc/itworksonmyhelm](https://gitlab.sarex.io/infra/poc/itworksonmyhelm), [infra/wb/helm-of-business](https://gitlab.sarex.io/infra/wb/helm-of-business) ◻️ | Эксперименты/контурные наборы чартов |
|
||||
|
||||
---
|
||||
|
||||
## 5. Что внутри `infra/iac`
|
||||
|
||||
### 5.1 Кластеры и откуда Flux их читает
|
||||
|
||||
Точка входа Flux — `clusters/<кластер>/`. Источник (`gotk-sync.yaml`) различается: кластеры в
|
||||
периметре Yandex Cloud смотрят прямо в GitLab, изолированные контуры — в **зеркало Gitea**.
|
||||
|
||||
| Кластер | Git-источник Flux | Состав |
|
||||
|---|---|---|
|
||||
| `yc-infra-prod` | `gitlab.sarex.io/infra/iac` | argo-workflows, argo-events, postgresql, pg-sanitizer, vault, vault-unseal, yc-pg-dumper |
|
||||
| `yc-k8s-test` | `gitlab.sarex.io/infra/iac` | `bootstrap-jobs`, состав задаётся в `kustomization.yaml` кластера |
|
||||
| `yc-k8s-test-02` | `gitlab.sarex.io/infra/iac` | istio (base/pilot/gateway/config), dashboard, local-path-provisioner, minio, rabbitmq, kafka, redis, camunda, postgresql, zitadel, keycloak, vault |
|
||||
| `yc-cps-prod` | `gitea.cloud.cps.sarex.lonsdaleites.ru/sarex/iac` | vault, istio, gitea-istio |
|
||||
| `yc-ecp` | `gitea.invest.cps.sarex.lonsdaleites.ru/sarex/iac` | cert-manager, istio-config, dashboard, vault; apps: measurements, django, s3-proxy, s3-proxy-bim |
|
||||
| `brusnika-prod` | `gitea.prod.brusnika.sarex.lonsdaleites.ru/sarex/iac` | istio, vault, zitadel, minio, openobserve, vmstack, otel operator/collector, goalert, экспортеры, failed-pod-cleanup |
|
||||
| `brusnika-stage` | `gitea.stage.brusnika.sarex.lonsdaleites.ru/sarex/iac` | то же без minio |
|
||||
| `wb` | `gitea-srx.wb.ru/sarex/iac` | istio-config, openobserve, vmstack, otel, goalert, экспортеры, superset, trino |
|
||||
| `d8-ugmk-prod` | `10.222.255.165:3000/infra/iac` (Gitea) | только `istio-ingress` |
|
||||
| `contour` | — (шаблон: `apps.yaml`, `infrastructure.yaml`, `helm-repositories.yaml`) | эталонная точка входа из README |
|
||||
|
||||
### 5.2 `infrastructure/` — 36 компонентов
|
||||
|
||||
`argo-events` · `argo-workflows` · `camunda` · `cert-manager` · `dashboard` · `example-infra` ·
|
||||
`failed-pod-cleanup` · `glitchtip` · `goalert` · `istio-base` · `istio-config` · `istio-gateway` ·
|
||||
`istio-pilot` · `kafka` · `kafka-exporter` · `keycloak` · `local-path-provisioner` · `minio` ·
|
||||
`openldap` · `openobserve` · `opentelemetry-collector` · `opentelemetry-operator` · `pg-sanitizer` ·
|
||||
`postgres-exporter` · `postgresql` · `prometheus-stack` · `rabbitmq` · `redis` · `s3-proxy` ·
|
||||
`superset` · `trino` · `vault` · `vault-unseal` · `vmstack` · `yc-pg-dumper` · `zitadel`
|
||||
|
||||
Структура компонента: `base/` (namespace + HelmRelease/манифесты) + `patches/` + `kustomization.yaml`.
|
||||
|
||||
### 5.3 `apps/` — 37 прикладных сервисов
|
||||
|
||||
> ⚠️ `apps/` — **только манифесты деплоя**. Исходный код сервисов живёт в других группах GitLab
|
||||
> (`platform`, `pdm`, `proc`, `planning`, `aero`, `generic`) — полная карта в **[§5.3.8](#538-где-лежит-код-приложений)**.
|
||||
> Образы приезжают из одного реестра: `cr.yandex/crp3ccidau046kdj8g9q/<сервис>:<тег>`.
|
||||
|
||||
#### 5.3.1 Единый шаблон приложения
|
||||
|
||||
```
|
||||
apps/<app>/
|
||||
├── base/ # общий для всех кластеров слой
|
||||
│ ├── namespace.yaml # namespace = имя приложения
|
||||
│ ├── <компонент>.yaml # HelmRelease на universal-chart (по одному на процесс)
|
||||
│ └── kustomization.yaml
|
||||
├── <кластер>/ # оверлей: brusnika-prod | brusnika-stage | d8-ugmk-prod |
|
||||
│ └── kustomization.yaml # yc-ecp | yc-k8s-test | dsinv
|
||||
├── .env.example # ─┐
|
||||
├── CONFIGURATION.md # │ «паспорт сервиса» — документация рядом с деплоем
|
||||
├── ENDPOINTS.md # │
|
||||
└── openapi.yaml # ─┘
|
||||
```
|
||||
|
||||
Каждый процесс сервиса — отдельный `HelmRelease` на **общем чарте**:
|
||||
|
||||
```yaml
|
||||
chart: universal-chart # версия 0.1.9 (у 6 приложений осталась 0.1.7)
|
||||
sourceRef: HelmRepository/yc-oci-charts # OCI-реестр cr.yandex, ns flux-system
|
||||
values:
|
||||
global: { env: _default } # ключ окружения
|
||||
services:
|
||||
backend:
|
||||
image: { name: { _default: cr.yandex/…/bim-api:contour_f9f2a39-dirty } }
|
||||
deployment: { replicaCount: {_default: 1}, port: {_default: 8000}, probes: … }
|
||||
service: { name: {_default: backend-svc}, port: {_default: 80} }
|
||||
imagePullSecrets: { name: { _default: regcred } }
|
||||
envs: [ … ]
|
||||
podAnnotations: { _default: { vault.hashicorp.com/*: … } }
|
||||
```
|
||||
|
||||
Особенности, общие почти для всех приложений:
|
||||
|
||||
- **все значения обёрнуты в `_default`** — механизм пер-окруженческих переопределений
|
||||
`universal-chart` (`global.env` выбирает ключ);
|
||||
- **секреты не хранятся в git** — их подставляет **Vault Agent Injector** через
|
||||
`podAnnotations` (§5.3.5);
|
||||
- `traffic.sidecar.istio.io/excludeOutboundPorts: "8200"` — обращение к Vault мимо sidecar Istio;
|
||||
- поля `commitSha`/`gitlabUri`/`gitlabJobUrl`/`owner` в базовом слое пустые — заполняются CI.
|
||||
|
||||
**Исключения:** `resources` и `subscriptions` описаны голыми `Deployment`+`Service`+`ServiceAccount`
|
||||
без `HelmRelease`; у `ams-sync` и `control-interface` в `base/` нет `Namespace`.
|
||||
|
||||
#### 5.3.2 Состав приложений
|
||||
|
||||
Обозначения кластеров: **B** `brusnika-prod` · **S** `brusnika-stage` · **U** `d8-ugmk-prod` ·
|
||||
**E** `yc-ecp` · **T** `yc-k8s-test`. Код в скобках — **оверлей есть, но кластер его не подключает**.
|
||||
|
||||
| Приложение | ns | Компоненты (HelmRelease) | Образы `…/crp3ccidau046kdj8g9q/` | Кластеры |
|
||||
|---|---|---|---|---|
|
||||
| `ams-sync` | — | `ams-sync` | `ams-sync` | S |
|
||||
| `attachments` | `attachments` | `attachments` | `att9` | (B) S U T |
|
||||
| `auth-flow` | `auth-flow` | `frontend` | `auth-flow-frontend` | (B) S U T |
|
||||
| `bim` | `bim` | `backend` | `bim-api` | B S U T |
|
||||
| `cde` | `cde` | **13**: `cde` + `cde-splitpdf`, `cde-flowscallback`, `cde-worker-{alert,copy,copyv2,create-versions,create-versionsv2,markings,markingsv2,sign,signv2,update-bundles}` | `cde`, `orchestrator`, 11 × `*-worker` | (B) (S) U T |
|
||||
| `checklists` | `checklists` | `checklists` | `checklists-backend` | B S U T |
|
||||
| `comparisons` | `comparisons` | `backend`, `frontend` + 2 ConfigMap | `comparisons_backend_prod`, `comparisons-frontend` | (B) (S) U T |
|
||||
| `contracts` | `contracts` | `contracts` | `contracts` | B S U T |
|
||||
| `control-interface` | — | `frontend` | `srx-admin` | B S U T |
|
||||
| `cross-section` | `cross-section` | `cross-section-static` | `cross-section-app` | (B) (S) U T |
|
||||
| `django` | `django` | `backend`, `celery`, `frontend`, `srx-admin-frontend`, `s3-proxy` + Deployment/Service `redis` + ConfigMap `django`/`nginx`/`uwsgi`/`zitadel` | `backend`, `sarex-frontend-dev`, `srx-admin`, `s3-proxy`, `redis` | B S U **E** T |
|
||||
| `document-link` | `document-link` | `frontend` | `document-link-frontend` | B S U (T) |
|
||||
| `documentations` | `documentations` | `documentations-api`, `-filestream`, `-hasher`, `-pdf-markings-amqp`, `pdm-api`, `frontend` + Deployment `redis` | `documentations`, `documentations-api-files`, `hasher`, `pdf-markings-amqp`, `pdmv2`, `documentation-frontend-app`, `redis` | B S U T |
|
||||
| `drawings` | `drawings` | `backend` | `drawings-api` | B S U T |
|
||||
| `eav` | `eav` | `backend` + ConfigMap | `eav` | B S U T |
|
||||
| `faas` | `faas` | `export-reviews` | `export-reviews` | (B) (S) U T |
|
||||
| `flows` | `flows` | `backend`, `celery`, `frontend` | `flows-backend`, `flows-backend_worker`, `flows-frontend` | B S U T |
|
||||
| `iam` | `iam` | `iam-backend` + ConfigMap | `iams` | (B) S U (T) |
|
||||
| `inspections` | `inspections` | `backend` | `sarex-inspections`, `notification:email` | B (S) U T |
|
||||
| `issues` | `issues` | `backend`, `celery`, `frontend` + Deployment/Service `redis` + ConfigMap | `issues`, `contour_issues-frontend`, `redis` | B S U T |
|
||||
| `mapper` | `mapper` | `backend` | `mapper` | B S U T |
|
||||
| `measurements` | `measurements` | `measurements` | `measurements` | B S U **E** T |
|
||||
| `message-hub` | `message-hub` | `message-hub` | `message-hub` | B S U T |
|
||||
| `notes` | `notes` | `backend`, `frontend` + ConfigMap | `notes-backend`, `notes-frontend` | B S U T |
|
||||
| `pm` | `pm` | `backend`, `celery`, `frontend`, `resources-static` + ConfigMap | `pm-backend`, `pm-frontend`, `resources-frontend` | B S U T |
|
||||
| `prescriptions` | `prescriptions` | `frontend` | `prescriptions-frontend` | (B) (S) U T |
|
||||
| `processing` | `processing` | `workflows-api`, `engine`, `engine-low`, `frontend` + Role/RoleBinding | `workflows-api_prod`, `workflows-engine`, `workflows-endigne_prod`, `workflows-frontend` | B S U T |
|
||||
| `projects` | `projects` | `frontend` | `project-frontend-app` | (B) S U T |
|
||||
| `remarks` | `remarks` | `frontend` | `remarks-frontend` | B S U T |
|
||||
| `resources` | `resources` | — *(Deployment + Service + SA + 2 ConfigMap)* | `sarex-resources` | B S T |
|
||||
| `reviews` | `reviews` | `frontend` | `reviews-frontend` | B S U T |
|
||||
| `rfi` | `rfi` | `backend`, `celery`, `frontend` | `rfi-backend`, `rfi-frontend` | B S U T |
|
||||
| `stamp-verification` | `stamp-verification` | `frontend` | `stamp-verification-frontend` | U T |
|
||||
| `subscriptions` | `subscriptions` | — *(Deployment + Service + SA)* | `subscriptions` | B S U T |
|
||||
| `system-log` | `system-log` | `api`, `worker` | `system-log_prod`, `system-log-worker_prod` | B S U T |
|
||||
| `transmittal` | `transmittal` | `backend`, `frontend`, `worker` | `transmittal-api`, `transmittal-frontend` | B S U T |
|
||||
| `workspaces` | `workspaces` | `backend`, `frontend` | `workspaces`, `workspaces-v2-frontend` | B S U T |
|
||||
|
||||
**Как читать состав.** Типовой backend-сервис = `backend` (API) + `celery`/`worker` (асинхронные
|
||||
задачи) + `frontend` (статика). Девять приложений — **чисто фронтендовые**: `auth-flow`,
|
||||
`control-interface`, `cross-section`, `document-link`, `prescriptions`, `projects`, `remarks`,
|
||||
`reviews`, `stamp-verification`. Самое крупное — `cde` (13 релизов: оркестратор + 11 воркеров
|
||||
по типам операций над документами).
|
||||
|
||||
#### 5.3.3 Где приложения реально разворачиваются
|
||||
|
||||
| Кластер | Приложений подключено | Комментарий |
|
||||
|---|---|---|
|
||||
| `d8-ugmk-prod` | **35** | самый полный контур |
|
||||
| `yc-k8s-test` | **34** | тестовый, близок к полному |
|
||||
| `brusnika-stage` | **30** | |
|
||||
| `brusnika-prod` | **26** | |
|
||||
| `yc-ecp` | **2** | только `django` и `measurements` |
|
||||
| `wb`, `yc-cps-prod`, `yc-infra-prod`, `yc-k8s-test-02`, `contour` | **0** | приложений из `apps/` не деплоят: эти кластеры несут только `infrastructure/` |
|
||||
|
||||
**Мёртвые и неподключённые оверлеи** — каталог существует, но ни один
|
||||
`clusters/*/kustomization.yaml` на него не ссылается, то есть Flux его не применяет:
|
||||
|
||||
| Кластер | Неподключённые оверлеи |
|
||||
|---|---|
|
||||
| `brusnika-prod` | `attachments`, `auth-flow`, `cde`, `comparisons`, `cross-section`, `faas`, `iam`, `prescriptions`, `projects` |
|
||||
| `brusnika-stage` | `cde`, `comparisons`, `cross-section`, `faas`, `inspections`, `prescriptions` |
|
||||
| `yc-k8s-test` | `document-link`, `iam` |
|
||||
|
||||
Отдельно **`dsinv/`** — оверлей у **25 приложений**, но **кластера `clusters/dsinv/` не существует**
|
||||
и никто на него не ссылается. Судя по содержимому (готовые `Deployment` с `SERVICE_URL=https://srx.wb.ru`)
|
||||
и по каталогу `snapshots/dsinv/`, это **материализованный снимок живого контура WB**, а не рабочий
|
||||
оверлей. Использовать как справочник «что реально крутится», не как источник деплоя.
|
||||
|
||||
#### 5.3.4 Две несовместимые конвенции оверлеев ⚠️
|
||||
|
||||
| Кластер | Как устроен оверлей | Приложений |
|
||||
|---|---|---|
|
||||
| `d8-ugmk-prod`, `yc-k8s-test`, `dsinv` | ✅ **наследует `base`**: `resources: [../base]` + `patches:` | 35 / 36 / 25 |
|
||||
| `brusnika-prod`, `brusnika-stage`, `yc-ecp` | ⚠️ **самостоятельный**: `base` не подключается, `HelmRelease` скопирован целиком | 35 / 36 / 2 |
|
||||
|
||||
Последствие — **тихий дрейф**. Пример: `apps/bim/base/backend.yaml` использует
|
||||
`universal-chart` **0.1.9**, а его полная копия `apps/bim/brusnika-prod/backend.yaml` — **0.1.7**.
|
||||
Правка в `base/` до контуров Брусники не доедет, и никакой ошибки при этом не возникнет.
|
||||
|
||||
Это же объясняет разнобой версий чарта: 0.1.7 остался у `ams-sync`, `auth-flow`,
|
||||
`control-interface`, `cross-section`, `remarks`, `reviews`.
|
||||
|
||||
#### 5.3.5 Секреты: Vault Agent Injector
|
||||
|
||||
Пароли БД в git не лежат. Под получает их файлом от sidecar-инжектора Vault:
|
||||
|
||||
```yaml
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true" # только init-контейнер, без постоянного sidecar
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: bim # роль = имя приложения
|
||||
vault.hashicorp.com/agent-inject-secret-bim-postgresql: secrets/data/apps/bim/postgres
|
||||
vault.hashicorp.com/agent-inject-template-bim-postgresql: |- # → env-файл
|
||||
POSTGRES_ADDRESS={{ index .Data.data "host" }} …
|
||||
```
|
||||
|
||||
Дальше контейнер стартует как `sh -ec 'set -a; . /vault/secrets/<name>; set +a; exec ./httpserver'`.
|
||||
|
||||
**Соглашение о путях:** `secrets/data/apps/<приложение>/postgres`; нестандартные —
|
||||
`documentations/hasher/{rabbitmq,s3}`, `documentations/marks-s3`.
|
||||
Соответствующие ServiceAccount называются `<app>-vault`.
|
||||
|
||||
Vault используют **26 приложений**. Больше всего инъекций — у `cde` (13), `documentations` (5),
|
||||
`django` и `processing` (по 3). **Не используют** ровно те, у кого нет БД: девять фронтендов
|
||||
(§5.3.2) плюс `ams-sync` и `faas`.
|
||||
|
||||
> Сами БД, пользователи и бакеты, на которые ссылаются эти пути, создаются не здесь,
|
||||
> а в [infra/terraform](https://gitlab.sarex.io/infra/terraform) (`infrastructure.yaml`).
|
||||
|
||||
#### 5.3.6 Документация рядом с манифестами
|
||||
|
||||
Нетипичная и полезная особенность: в каталоге приложения лежит его «паспорт».
|
||||
|
||||
| Файл | Что внутри | Покрытие |
|
||||
|---|---|---|
|
||||
| `CONFIGURATION.md` | все переменные окружения, как они разбираются в коде, и **откуда берутся при каждом способе запуска** (локально / docker-compose / Helm в репозитории приложения / IaC+Vault / GitLab CI); команды и точки входа процессов | 32 / 37 |
|
||||
| `ENDPOINTS.md` | **исходящие** HTTP-вызовы сервиса: библиотека клиента, таймауты, ретраи, проброс JWT, базовые хосты по окружениям, таблица методов и путей | 28 / 37 |
|
||||
| `openapi.yaml` | **входящие** эндпоинты — спецификация того, что сервис предоставляет (от 9 КБ у `mapper` до 101 КБ у `issues`) | 25 / 37 |
|
||||
| `.env.example` | образец переменных с комментариями | 32 / 37 |
|
||||
|
||||
Многокомпонентные приложения используют префиксы вместо одного файла: у `documentations` —
|
||||
`api.*`, `api-v2.*`, `pdm.*`, `frontend.*`, `dps-message-hub.*`; у `processing` —
|
||||
`workflows-api.*`, `workflows-engine.*`, `workflows-frontend.*`; у `workspaces` —
|
||||
`ENDPOINTS-workspaces-frontend.md` и `ENDPOINTS-workspace-v2-frontend.md`.
|
||||
|
||||
**Пробелы в документации:**
|
||||
|
||||
- нет `CONFIGURATION.md`: `control-interface`, `cross-section`, `faas`, `remarks`, `reviews`;
|
||||
- нет `ENDPOINTS.md`: `attachments`, `checklists`, `drawings`, `eav`, `faas`, `measurements`,
|
||||
`resources`, `subscriptions`, `system-log`;
|
||||
- нет диаграммы в `docs/apps/`: `ams-sync`, `auth-flow`, `iam` *(остальные 34 покрыты)*.
|
||||
|
||||
Дополняющий слой — [`docs/apps/`](./docs/apps/README.md): по mermaid-диаграмме на сервис
|
||||
с его зависимостями, сгруппированные по доменам — Платформа/Core, Управление проектом,
|
||||
Документы/CDE, Контроль качества, Полевые данные.
|
||||
|
||||
#### 5.3.7 Внешние маршруты
|
||||
|
||||
Правила Istio живут не в `apps/`, а в `infrastructure/istio-config/<кластер>` и в патчах кластеров.
|
||||
Пример готовой карты маршрутов (`yc-ecp`):
|
||||
|
||||
| Путь | Сервис назначения |
|
||||
|---|---|
|
||||
| `/api`, `/admin/` | `backend-service.django` |
|
||||
| `/media/` | `s3-service.django` |
|
||||
| `/s3/` | `s3-bim-service.django` |
|
||||
| `/eav/api/`, `/eav/admin/` | `eav-service.eav` |
|
||||
| `/bim-gazpromcps/{api,files}/` | `bim-api-gazpromcps-service.bim` |
|
||||
| `/bim2-gazpromcps/api/` | `bim-backend-v2-service.bim` |
|
||||
| `/workflows/api/` | `workflows-backend-service.processing` |
|
||||
| `/projects/static/` | `projects-frontend-static-service.projects` |
|
||||
|
||||
В контурах Брусники и WB прикладной трафик уходит одним правилом на
|
||||
`nginx-service.global-ingress` — пути до конкретных сервисов раскрываются уже там, **вне этого
|
||||
репозитория**. Через Istio там опубликованы только платформенные UI (Gitea, GoAlert, OpenObserve,
|
||||
Superset, Kubernetes Dashboard, Camunda, Jupyter).
|
||||
|
||||
#### 5.3.8 Где лежит код приложений
|
||||
|
||||
Исходники продуктовых сервисов — **вне группы `infra`**: 14 групп верхнего уровня, ~393 проекта.
|
||||
Ориентир по владению:
|
||||
|
||||
| Группа | Домен | Что оттуда деплоится из `apps/` |
|
||||
|---|---|---|
|
||||
| [`platform`](https://gitlab.sarex.io/groups/platform) (95) | платформенное ядро, BIM, workflows, tracking | `bim`, `iam`, `mapper`, `contracts`, `eav`, `system-log`, `processing`, `control-interface`, `resources`, `ams-sync`, `auth-flow`, `cde` |
|
||||
| [`pdm`](https://gitlab.sarex.io/groups/pdm) (41) | документооборот, CDE, PDF | `documentations`, `attachments`, `transmittal`, `workspaces`, `document-link`, `stamp-verification`, `subscriptions`, `comparisons` |
|
||||
| [`proc`](https://gitlab.sarex.io/groups/proc) (24) | процессы и контроль качества | `inspections`, `issues`, `rfi`, `reviews`, `checklists`, `flows`, `remarks`, `prescriptions`, `faas` |
|
||||
| [`planning`](https://gitlab.sarex.io/groups/planning) (10) | планирование | `pm`, `projects`, `message-hub` |
|
||||
| [`aero`](https://gitlab.sarex.io/groups/aero) (50) | гео, полевые данные, обработка съёмки | `measurements`, `drawings`, `notes`, `cross-section` |
|
||||
| [`generic`](https://gitlab.sarex.io/groups/generic) (56) | сквозное: монолит, CI-шаблоны, утилиты | `django` |
|
||||
| [`algorithms`](https://gitlab.sarex.io/groups/algorithms) (82), [`render`](https://gitlab.sarex.io/groups/render) (16) | вычислительные библиотеки, конвертеры, рендер | напрямую не деплоятся — используются джобами и воркерами |
|
||||
| `ai`, `marketing`, `hackathon`, `product`, `algorithms1`, `planning1` | прочее / архив | — |
|
||||
|
||||
**Карта «приложение → репозитории с кодом».** Ключ сопоставления — имя образа
|
||||
`cr.yandex/crp3ccidau046kdj8g9q/<name>` и заголовок `CONFIGURATION.md` / `ENDPOINTS.md`.
|
||||
|
||||
| `apps/` | Компонент (образ) | Репозиторий с кодом |
|
||||
|---|---|---|
|
||||
| `ams-sync` | `ams-sync` | [platform/ams-sync](https://gitlab.sarex.io/platform/ams-sync) ✅ *(смежный: [platform/ams](https://gitlab.sarex.io/platform/ams))* |
|
||||
| `attachments` | `att9` / `attachments` | [pdm/attachments](https://gitlab.sarex.io/pdm/attachments) ✅ |
|
||||
| `auth-flow` | `auth-flow-frontend` | [platform/auth-flow-frontend](https://gitlab.sarex.io/platform/auth-flow-frontend) ✅ |
|
||||
| `bim` | `bim-backend-v2` | [platform/bim-backend-v2](https://gitlab.sarex.io/platform/bim-backend-v2) ✅ |
|
||||
| | `bim-api` (legacy) | [platform/bim](https://gitlab.sarex.io/platform/bim) ◻️ — репозитория с именем `bim-api` нет, привязка по смыслу |
|
||||
| `cde` | `cde`, `orchestrator`, 11 × `*-worker` | [platform/cde-orchestration-demo](https://gitlab.sarex.io/platform/cde-orchestration-demo) ✅ |
|
||||
| | смежные | [pdm/cde-api](https://gitlab.sarex.io/pdm/cde-api), [generic/cde-v2-write-service](https://gitlab.sarex.io/generic/cde-v2-write-service), [generic/level-cde-migration](https://gitlab.sarex.io/generic/level-cde-migration) |
|
||||
| `checklists` | `checklists-backend` | [proc/checklists-backend](https://gitlab.sarex.io/proc/checklists-backend) ✅ |
|
||||
| `comparisons` | `comparisons-backend` | [pdm/comparisons-backend](https://gitlab.sarex.io/pdm/comparisons-backend) ✅, v2 → [pdm/comparisons-api-v2](https://gitlab.sarex.io/pdm/comparisons-api-v2) |
|
||||
| | `comparisons-frontend` | [platform/comparisons-frontend](https://gitlab.sarex.io/platform/comparisons-frontend) ✅ |
|
||||
| | движок сравнения | [platform/comparator](https://gitlab.sarex.io/platform/comparator), [algorithms/comparator-algorithms](https://gitlab.sarex.io/algorithms/comparator-algorithms), [render/comparator-bins](https://gitlab.sarex.io/render/comparator-bins), [algorithms/diff-pdf-algorithm](https://gitlab.sarex.io/algorithms/diff-pdf-algorithm) |
|
||||
| `contracts` | `contracts` | [platform/contracts](https://gitlab.sarex.io/platform/contracts) ✅ + [platform/contracts-frontend](https://gitlab.sarex.io/platform/contracts-frontend) ✅ |
|
||||
| `control-interface` | `srx-admin` | [platform/srx-admin](https://gitlab.sarex.io/platform/srx-admin) ✅ |
|
||||
| `cross-section` | `cross-section-app` | [aero/cross-section](https://gitlab.sarex.io/aero/cross-section) ✅ *(джоба: [aero/cross-secttions-to-dwg-job](https://gitlab.sarex.io/aero/cross-secttions-to-dwg-job))* |
|
||||
| `django` | `backend` | [generic/sarex-backend](https://gitlab.sarex.io/generic/sarex-backend) ✅ |
|
||||
| | `sarex-frontend-dev` | [generic/sarex-frontend](https://gitlab.sarex.io/generic/sarex-frontend) ✅ |
|
||||
| | `s3-proxy` | [generic/s3-proxy](https://gitlab.sarex.io/generic/s3-proxy) ✅ |
|
||||
| | `srx-admin` | [platform/srx-admin](https://gitlab.sarex.io/platform/srx-admin) ✅ |
|
||||
| `document-link` | `document-link-frontend` | [pdm/document-link-frontend](https://gitlab.sarex.io/pdm/document-link-frontend) ✅ |
|
||||
| `documentations` | `documentations` | [pdm/documentation-api](https://gitlab.sarex.io/pdm/documentation-api) ✅ |
|
||||
| | `documentations-api-files` (v2) | [pdm/documentation-api-v2](https://gitlab.sarex.io/pdm/documentation-api-v2) ✅ |
|
||||
| | `hasher` | [pdm/documentation-hasher](https://gitlab.sarex.io/pdm/documentation-hasher) ✅ |
|
||||
| | `pdf-markings-amqp` | [pdm/pdf-markings](https://gitlab.sarex.io/pdm/pdf-markings) ✅ |
|
||||
| | `pdmv2` | [pdm/pdm](https://gitlab.sarex.io/pdm/pdm) ✅ |
|
||||
| | `documentation-frontend-app` | [pdm/documentation-frontend](https://gitlab.sarex.io/pdm/documentation-frontend) ✅ |
|
||||
| | `dps-message-hub` | [pdm/dps_message_hub](https://gitlab.sarex.io/pdm/dps_message_hub) ✅ |
|
||||
| `drawings` | `drawings-api` | [aero/drawings-api](https://gitlab.sarex.io/aero/drawings-api) ✅ |
|
||||
| `eav` | `eav` | [platform/eav_python](https://gitlab.sarex.io/platform/eav_python) ✅ *(gRPC-ветка: [platform/eav](https://gitlab.sarex.io/platform/eav))* |
|
||||
| `faas` | `export-reviews` | [proc/export-reviews](https://gitlab.sarex.io/proc/export-reviews) ✅ *(в GitLab называется `flows-export`)* |
|
||||
| `flows` | `flows-backend`, `flows-backend_worker` | [proc/flows-backend](https://gitlab.sarex.io/proc/flows-backend) ✅ |
|
||||
| | `flows-frontend` | [proc/flows-frontend](https://gitlab.sarex.io/proc/flows-frontend) ✅ |
|
||||
| `iam` | `iams` | [platform/iams-v2](https://gitlab.sarex.io/platform/iams-v2) ✅ *(смежный: [platform/srx-rebac](https://gitlab.sarex.io/platform/srx-rebac))* |
|
||||
| `inspections` | `sarex-inspections` | [proc/inspections-backend](https://gitlab.sarex.io/proc/inspections-backend) ✅ — подтверждено аннотацией `gitlab-uri` |
|
||||
| | фронтенд | [proc/inspections-frontend](https://gitlab.sarex.io/proc/inspections-frontend) ✅ |
|
||||
| | `notification:email` | [generic/jobs/email-notification-task](https://gitlab.sarex.io/generic/jobs/email-notification-task) ✅ |
|
||||
| `issues` | `issues` | [proc/issues-backend](https://gitlab.sarex.io/proc/issues-backend) ✅ |
|
||||
| | `contour_issues-frontend` | [proc/issues-frontend](https://gitlab.sarex.io/proc/issues-frontend) ✅ |
|
||||
| | `crop-issue-pin-area` | [proc/crop-issue-pin-area-task](https://gitlab.sarex.io/proc/crop-issue-pin-area-task) ✅ |
|
||||
| | `docx-to-pdf`, `rendering-template` | [pdm/docx-to-pdf](https://gitlab.sarex.io/pdm/docx-to-pdf), [pdm/rendering-template](https://gitlab.sarex.io/pdm/rendering-template) ✅ |
|
||||
| | `webhook-caller` | [platform/webhook-caller](https://gitlab.sarex.io/platform/webhook-caller) ✅ |
|
||||
| `mapper` | `mapper` | [platform/mapper](https://gitlab.sarex.io/platform/mapper) ✅ |
|
||||
| `measurements` | `measurements` | [aero/measurements](https://gitlab.sarex.io/aero/measurements) ✅ |
|
||||
| `message-hub` | `message-hub` | [planning/message-hub](https://gitlab.sarex.io/planning/message-hub) ✅ |
|
||||
| `notes` | `notes-backend` / `notes-frontend` | [aero/notes-backend](https://gitlab.sarex.io/aero/notes-backend), [aero/notes-frontend](https://gitlab.sarex.io/aero/notes-frontend) ✅ |
|
||||
| `pm` | `pm-backend` / `pm-frontend` | [planning/pm-backend](https://gitlab.sarex.io/planning/pm-backend), [planning/pm-frontend](https://gitlab.sarex.io/planning/pm-frontend) ✅ |
|
||||
| | `resources-frontend` | [planning/resources-frontend](https://gitlab.sarex.io/planning/resources-frontend) ✅ |
|
||||
| `prescriptions` | `prescriptions-frontend` | [proc/prescriptions-frontend](https://gitlab.sarex.io/proc/prescriptions-frontend) ✅ |
|
||||
| `processing` | `workflows-api` | [platform/workflows-api](https://gitlab.sarex.io/platform/workflows-api) ✅ |
|
||||
| | `workflows-engine`, `kubernetes-engine` | [platform/workflows-engine](https://gitlab.sarex.io/platform/workflows-engine) ✅ |
|
||||
| | `workflows-frontend` | [platform/workflows-frontend](https://gitlab.sarex.io/platform/workflows-frontend) ✅ |
|
||||
| | смежные | [platform/workflows-backend](https://gitlab.sarex.io/platform/workflows-backend), [generic/workflows-tools](https://gitlab.sarex.io/generic/workflows-tools), [generic/processing/job_template](https://gitlab.sarex.io/generic/processing/job_template) |
|
||||
| `projects` | `project-frontend-app` / `projects-frontend` | [planning/projects-frontend](https://gitlab.sarex.io/planning/projects-frontend) ✅ *(API: [planning/projects-backend](https://gitlab.sarex.io/planning/projects-backend))* |
|
||||
| `remarks` | `remarks-frontend` | [proc/remarks-frontend](https://gitlab.sarex.io/proc/remarks-frontend) ✅ |
|
||||
| | `remarks-api`, `export-remarks` | ⚠️ [proc/remarks-api](https://gitlab.sarex.io/proc/remarks-api), [proc/export-remarks](https://gitlab.sarex.io/proc/export-remarks) — **помечены `_archived_`** в GitLab, но образы ещё встречаются в манифестах |
|
||||
| `resources` | `sarex-resources` | [platform/sarex-resources](https://gitlab.sarex.io/platform/sarex-resources) ✅ *(старая копия: [generic/sarex-resources1](https://gitlab.sarex.io/generic/sarex-resources1))* |
|
||||
| `reviews` | `reviews-frontend` | [proc/reviews-frontend](https://gitlab.sarex.io/proc/reviews-frontend) ✅ |
|
||||
| `rfi` | `rfi-backend` / `rfi-frontend` | [proc/rfi-backend](https://gitlab.sarex.io/proc/rfi-backend), [proc/rfi-frontend](https://gitlab.sarex.io/proc/rfi-frontend) ✅ |
|
||||
| `stamp-verification` | `stamp-verification-frontend` | [pdm/stamp-verification-frontend](https://gitlab.sarex.io/pdm/stamp-verification-frontend) ✅ |
|
||||
| `subscriptions` | `subscriptions` / `sarex-subscriptions` | [pdm/sarex-subscriptions](https://gitlab.sarex.io/pdm/sarex-subscriptions) ✅ |
|
||||
| `system-log` | `system-log` / `system-log-worker` | [platform/system-log](https://gitlab.sarex.io/platform/system-log), [platform/system-log-worker](https://gitlab.sarex.io/platform/system-log-worker) ✅ |
|
||||
| `transmittal` | `transmittal-api` / `transmittal-frontend` | [pdm/transmittal-api](https://gitlab.sarex.io/pdm/transmittal-api), [pdm/transmittal-frontend](https://gitlab.sarex.io/pdm/transmittal-frontend) ✅ |
|
||||
| `workspaces` | `workspaces` | [pdm/workspaces-api](https://gitlab.sarex.io/pdm/workspaces-api) ✅ |
|
||||
| | `workspaces-frontend-static` | [platform/workspaces-frontend](https://gitlab.sarex.io/platform/workspaces-frontend) ✅ |
|
||||
| | `workspaces-v2-frontend` | [platform/workspace-v2-frontend](https://gitlab.sarex.io/platform/workspace-v2-frontend) ✅ |
|
||||
|
||||
**Как искать самому, если компонента нет в таблице.** Порядок надёжности:
|
||||
|
||||
1. Взять имя образа из `apps/<app>/base/*.yaml` — `cr.yandex/crp3ccidau046kdj8g9q/**<name>**:tag`.
|
||||
В большинстве случаев `<name>` = `path` репозитория.
|
||||
2. Открыть `apps/<app>/CONFIGURATION.md` — в первой строке стоит **настоящее имя проекта**
|
||||
(например `apps/eav` → «Конфигурация проекта eav-python» → `platform/eav_python`).
|
||||
3. Искать по GitLab: `scope: projects`, термин ≥ 3 символов, матч идёт по `path_with_namespace` —
|
||||
поэтому запрос по имени группы (`proc`, `pdm`, `planning`) выдаёт всю группу целиком.
|
||||
4. Если сервис уже работает в кластере — у его `Deployment` есть аннотации
|
||||
`gitlab-uri` и `gitlab-job`, проставляемые CI, с прямой ссылкой на репозиторий и джобу сборки.
|
||||
|
||||
⚠️ Имя образа **не всегда** совпадает с репозиторием: `att9` → `pdm/attachments`,
|
||||
`iams` → `platform/iams-v2`, `pdmv2` → `pdm/pdm`, `export-reviews` → `proc/export-reviews`
|
||||
(в GitLab отображается как `flows-export`), `sarex-inspections` → `proc/inspections-backend`.
|
||||
Суффиксы `_prod`, `contour_`, `-dev` в имени образа — артефакты веток CI, не часть имени проекта.
|
||||
|
||||
Общий CI-конвейер для всех этих репозиториев —
|
||||
[generic/common-ci](https://gitlab.sarex.io/generic/common-ci) (подключается в `.gitlab-ci.yml`
|
||||
каждого сервиса), базовый образ — [generic/base-image](https://gitlab.sarex.io/generic/base-image).
|
||||
|
||||
### 5.4 Вспомогательное в репозитории
|
||||
|
||||
| Путь | Назначение |
|
||||
|---|---|
|
||||
| `inventory.yaml` | Сгенерированный инвентарь prod: namespace → тип ресурса → имена (ConfigMap/Secret/Deployment/Service/EnvoyFilter) |
|
||||
| `snapshots/dsinv/` | Снимки живых манифестов (в `.gitignore`, локальный артефакт) |
|
||||
| `docs/apps/` | Диаграмма и описание по каждому бизнес-сервису |
|
||||
| `gitea-data/` | Локальные данные Gitea — рабочий артефакт, **не коммитить** |
|
||||
|
||||
---
|
||||
|
||||
## 6. Перекрытия и как выбирать источник истины
|
||||
|
||||
Для ~20 компонентов существуют оба источника — каталог в `infra/iac` и отдельный репозиторий.
|
||||
Наблюдаемое правило (по факту содержимого, **стоит подтвердить с владельцами**):
|
||||
|
||||
| Ситуация | Источник истины |
|
||||
|---|---|
|
||||
| Кластер перечислен в §5.1 (`yc-*`, `brusnika-*`, `wb`, `d8-ugmk-prod`) | **`infra/iac`**, ветка `master`. Правки в отдельном репозитории туда не доедут |
|
||||
| Контур деплоится GitLab CI (ветки `stage`, `preprod`, `contour`, `infra`, `contour/cps`, `stronghold`) | **Отдельный репозиторий компонента**, ветка = имя контура |
|
||||
| Контур ГПН | **`infra/iac-gpn`** (ArgoCD), не Flux |
|
||||
| Namespace, БД, S3-бакет, Kafka-топик, пользователь, k8s-секрет | **`infra/terraform`** (`infrastructure.yaml`) — не создавать вручную и не дублировать в Flux |
|
||||
| Изолированный контур без доступа к GitLab | `infra/iac` → зеркало **Gitea** → Flux. Пуш в GitLab обязателен, но недостаточен: нужно, чтобы зеркало обновилось |
|
||||
|
||||
Особые случаи:
|
||||
|
||||
- **`prometheus-stack` vs `kube-prometheus-stack`** — два разных репозитория с пересекающейся зоной;
|
||||
в `iac` компонент один (`prometheus-stack`). Требует ревизии.
|
||||
- **`terraform` vs `terraform-contour-mirror`** — README идентичны, `mirror` живёт только в ветке
|
||||
`contour` и активен (2026-08-04). Расхождение между ними — реальный риск дрейфа.
|
||||
- **`istio-config`** — самый «многоконтурный» репозиторий (7 веток) и одновременно компонент в `iac`.
|
||||
- **`poc/iac`** — архив; не путать с `infra/iac`.
|
||||
|
||||
---
|
||||
|
||||
## 7. Эксплуатация, аудит и данные
|
||||
|
||||
| Репозиторий | Отвечает за |
|
||||
|---|---|
|
||||
| [infra/k8s-changelog](https://gitlab.sarex.io/infra/k8s-changelog) ✅ | Ежедневный снимок всех манифестов кластера в стабильную файловую структуру и коммит в git — **читаемый diff состояния кластера** для аудита и восстановления. Чистит `status`, `managedFields`, значения секретов |
|
||||
| [infra/harvester](https://gitlab.sarex.io/infra/harvester) ✅ | **Резервное копирование данных платформы Sarex** (документация, планирование, замечания, рабочие процессы). Kafka-download/sync приложения, манифесты, mkdocs |
|
||||
| [infra/scripts/extract-kuberntes-manifests-to-s3](https://gitlab.sarex.io/infra/scripts/extract-kuberntes-manifests-to-s3) ◻️ | Выгрузка манифестов кластера в S3 |
|
||||
| [infra/yc-pg-dumper](https://gitlab.sarex.io/infra/yc-pg-dumper) ◻️ (+ компонент `infrastructure/yc-pg-dumper`) | Дампы PostgreSQL в Yandex Cloud |
|
||||
| [infra/backups/*](https://gitlab.sarex.io/infra/backups) ◻️ | `frontend`, `workers`, `sendbox`, `collect-pdm-data-from-postgresql` — подсистема бэкапов |
|
||||
| [infra/postgresql-ddl-extractor](https://gitlab.sarex.io/infra/postgresql-ddl-extractor) ◻️ | Извлечение DDL из PostgreSQL |
|
||||
| [infra/k8s-hustler](https://gitlab.sarex.io/infra/k8s-hustler), [infra/revisor](https://gitlab.sarex.io/infra/revisor), [infra/peeping](https://gitlab.sarex.io/infra/peeping) ◻️ | Утилиты инспекции/ревизии кластера |
|
||||
| [infra/compnay-cleanup-kit](https://gitlab.sarex.io/infra/compnay-cleanup-kit) ◻️ | Очистка данных компании *(опечатка в имени — так в GitLab)* |
|
||||
| [infra/py-s3-size](https://gitlab.sarex.io/infra/py-s3-size), [infra/get_size_SOD](https://gitlab.sarex.io/infra/get_size_SOD), [infra/jobs/object-storage-size-by-project](https://gitlab.sarex.io/infra/jobs/object-storage-size-by-project) ◻️ | Учёт объёмов объектного хранилища |
|
||||
| [infra/s3-replication-poc](https://gitlab.sarex.io/infra/s3-replication-poc) ◻️ | Репликация S3 (PoC) |
|
||||
| [infra/wunderwaffe-operator](https://gitlab.sarex.io/infra/wunderwaffe-operator), [infra/wunderwaffe-tasks](https://gitlab.sarex.io/infra/wunderwaffe-tasks), [infra/wunderwaffe-dumpster](https://gitlab.sarex.io/infra/wunderwaffe-dumpster) ◻️ | Собственный k8s-оператор и его задачи |
|
||||
|
||||
---
|
||||
|
||||
## 8. Контуры заказчиков
|
||||
|
||||
| Подгруппа / репозиторий | Контур | Содержимое |
|
||||
|---|---|---|
|
||||
| [infra/wb/*](https://gitlab.sarex.io/infra/wb) ◻️ | WB | `manifestos-k8s`, `postgresql16`, `helm-of-business`. Кластер `wb` в `iac` синхронизируется из `gitea-srx.wb.ru` |
|
||||
| [infra/gpnt/*](https://gitlab.sarex.io/infra/gpnt) ◻️ | ГПН, OpenShift | UBI-образы: `base`, `backend`, `nginx`, `postgres`, `rabbitmq`, `redis`, `comparator`; `gpnt-os` — «manifest and helm templates for openshift» |
|
||||
| [infra/gpnr/*](https://gitlab.sarex.io/infra/gpnr) ◻️ | ГПН-Р | `docker-packaging-gdal-builder`, `docker-packaging-potree-builder`, `u190001439_skzssrx*` |
|
||||
| [infra/severstal/*](https://gitlab.sarex.io/infra/severstal) ◻️ | Северсталь | UBI-образы + `ingress`, `provision` |
|
||||
| [infra/iac-gpn](https://gitlab.sarex.io/infra/iac-gpn) ✅ | ГПН | ArgoCD-монорепозиторий контура |
|
||||
| [infra/brusnika](https://gitlab.sarex.io/infra/brusnika), [infra/uralchem](https://gitlab.sarex.io/infra/uralchem), [infra/ugok](https://gitlab.sarex.io/infra/ugok), [infra/cps2](https://gitlab.sarex.io/infra/cps2) ◻️ | Брусника, Уралхим, УГОК, ЦПС | Контурные наборы (низкая активность — часть с 2025-01) |
|
||||
|
||||
---
|
||||
|
||||
## 9. Инструменты, скрипты, документация
|
||||
|
||||
| Репозиторий | Отвечает за |
|
||||
|---|---|
|
||||
| [infra/kafka-router](https://gitlab.sarex.io/infra/kafka-router) ✅ | Проксирование сообщений между Kafka-кластерами по `TOPIC_MAPPING`, с фильтрацией по компании (FastStream) |
|
||||
| [infra/tools/sarex-cli-service](https://gitlab.sarex.io/infra/tools/sarex-cli-service) | Python-скрипт подъёма локального окружения разработчика *(описание из GitLab)* |
|
||||
| [infra/tools/sdk-python](https://gitlab.sarex.io/infra/tools/sdk-python) ◻️ | Внутренний Python SDK |
|
||||
| [infra/bash-scripts](https://gitlab.sarex.io/infra/bash-scripts), [infra/python-scripts](https://gitlab.sarex.io/infra/python-scripts), [infra/scripts/*](https://gitlab.sarex.io/infra/scripts), [d.emelin/infra-scripts](https://gitlab.sarex.io/d.emelin/infra-scripts) ◻️ | Разрозненные операционные скрипты |
|
||||
| [infra/transfer-tools](https://gitlab.sarex.io/infra/transfer-tools) ◻️ | Перенос данных между контурами |
|
||||
| [infra/docs/deploy](https://gitlab.sarex.io/infra/docs/deploy), [infra/docs/services](https://gitlab.sarex.io/infra/docs/services), [infra/kb](https://gitlab.sarex.io/infra/kb) ◻️ | Документация по деплою и сервисам, база знаний |
|
||||
| [infra/automations/terraform-deletion_scheduled-454](https://gitlab.sarex.io/infra/automations/terraform-deletion_scheduled-454) ◻️ | Автоматизация; судя по имени — запланированное удаление ресурсов. **Проверить перед любыми действиями** |
|
||||
| [infra/poc/*](https://gitlab.sarex.io/infra/poc) (~30 репозиториев) ◻️ | Песочница: `k8s-teleport`, `k8s-events`, `contour-storage`, `git-server`, `minikube`, `offline-sentry`, `offline-signoz`, `cdc`, `delta`, `trace-viewer`, `streaming-dump`, `system-tests`, `s3-*`, `unity/*` и др. **Не источник истины для прода** |
|
||||
|
||||
---
|
||||
|
||||
## 10. Как пользоваться каталогом
|
||||
|
||||
**Меняю поведение компонента в кластере из §5.1** → `infra/iac`, `infrastructure/<компонент>/patches/`
|
||||
или оверлей кластера; проверка — `flux get kustomizations`, `flux get helmreleases -A`.
|
||||
|
||||
**Меняю поведение компонента в CI-контуре** → соответствующий `infra/<компонент>`, **ветка контура**,
|
||||
каталог `.helm/`.
|
||||
|
||||
**Выкатываю новую версию приложения** → `apps/<app>/`: тег образа в `base/<компонент>.yaml`,
|
||||
если кластер наследует базу (`d8-ugmk-prod`, `yc-k8s-test`), **и отдельно** в
|
||||
`apps/<app>/brusnika-*/`, `apps/<app>/yc-ecp/` — эти оверлеи базу не подключают (§5.3.4).
|
||||
Перед правкой сверься с §5.3.3: возможно, оверлей вообще не подключён к кластеру.
|
||||
|
||||
**Нужен новый секрет для приложения** → положить в Vault по пути `secrets/data/apps/<app>/…`
|
||||
и добавить `vault.hashicorp.com/agent-inject-*` в `podAnnotations` (§5.3.5). В git секрет не кладём.
|
||||
|
||||
**Ищу исходники сервиса по имени namespace или образа** → карта «приложение → репозиторий»
|
||||
в §5.3.8; там же порядок поиска, если компонента в таблице нет.
|
||||
|
||||
**Нужен новый namespace / БД / бакет / топик / секрет** → `infra/terraform`, `infrastructure.yaml`
|
||||
(секреты — через SOPS, см. `SOPS.md`); для контура — `terraform-contour` / `terraform-contour-mirror`.
|
||||
|
||||
**Нужен новый кластер** → `kubespray` → `k8s-provision` → `flux bootstrap --path=clusters/<имя>`
|
||||
в `infra/iac`.
|
||||
|
||||
**Понять, что реально крутится в кластере** → `inventory.yaml` в этом репозитории и
|
||||
`infra/k8s-changelog` (git-история состояния).
|
||||
|
||||
---
|
||||
|
||||
### Открытые вопросы
|
||||
|
||||
1. Привести оверлеи `brusnika-prod`, `brusnika-stage`, `yc-ecp` к наследованию `../base` — сейчас
|
||||
это полные копии, которые молча расходятся с базой (§5.3.4).
|
||||
2. Разобрать 17 неподключённых оверлеев приложений и 25 каталогов `dsinv/`: удалить или
|
||||
подключить (§5.3.3).
|
||||
3. Выровнять версию `universal-chart` — шесть приложений остались на 0.1.7 при базовой 0.1.9.
|
||||
4. Разграничить `prometheus-stack` и `kube-prometheus-stack` — какой из них актуален.
|
||||
5. Зафиксировать регламент синхронизации `terraform` ↔ `terraform-contour-mirror`.
|
||||
6. Для ~60 компонентных репозиториев определить, какие мигрируют в `infra/iac`, а какие остаются
|
||||
на CI-деплое; остальное — архивировать.
|
||||
7. Закрыть пробелы в паспортах сервисов (§5.3.6) и подтвердить назначение репозиториев с ◻️.
|
||||
@ -1,85 +0,0 @@
|
||||
# =============================================================================
|
||||
# AMS-Sync — пример конфигурации (.env)
|
||||
# Версия: 1.0.0
|
||||
# Скопируйте в .env и заполните значения.
|
||||
#
|
||||
# Сервис имеет два режима запуска:
|
||||
# - `run` — демон-потребитель Kafka (CMD контейнера), использует блоки
|
||||
# App / Kafka / Zitadel / Logger / Healthcheck (+ Auth);
|
||||
# - CLI — команды migrate / sync / diff (запускаются вручную),
|
||||
# дополнительно используют блоки Auth / User server / БД sarex.
|
||||
# Значения по умолчанию проставлены там, где они заданы в коде.
|
||||
# =============================================================================
|
||||
|
||||
# --- Приложение (без префикса) ---
|
||||
# LOCAL | STAGE | PREPROD | PRODUCTION
|
||||
ENVIRONMENT=LOCAL
|
||||
# Топик Kafka с событиями пользователей
|
||||
AMS_SYNC_TOPIC=ams-sync
|
||||
# ID организации-хоста в Zitadel (обязателен)
|
||||
HOST_ORGANIZATION_ID=
|
||||
# При True входящие model_created обрабатываются через import_user (с верификацией)
|
||||
VERIFY_USERS=False
|
||||
|
||||
# --- Kafka (префикс KAFKA_) ---
|
||||
# JSON-массив адресов брокеров, напр. ["host:9091"]
|
||||
KAFKA_BOOTSTRAP_SERVERS=
|
||||
KAFKA_SASL_PLAIN_USERNAME=
|
||||
KAFKA_SASL_PLAIN_PASSWORD=
|
||||
# Путь к CA-сертификату для SSL-подключения к Kafka
|
||||
KAFKA_SSL_CAFILE=
|
||||
# PLAINTEXT | SSL | SASL_PLAINTEXT | SASL_SSL
|
||||
KAFKA_SECURITY_PROTOCOL=SASL_SSL
|
||||
# PLAIN | SCRAM-SHA-256 | SCRAM-SHA-512
|
||||
KAFKA_SASL_MECHANISM=SCRAM-SHA-512
|
||||
|
||||
# --- Zitadel / AMS (префикс ZITADEL_) ---
|
||||
# Хост Zitadel (обязателен для адаптера пользователей)
|
||||
ZITADEL_HOST=https://idp.dev.stage.sarex.io
|
||||
# Service-токен доступа к API Zitadel (обязателен)
|
||||
ZITADEL_SERVICE_ACCESS_TOKEN=
|
||||
# ВНИМАНИЕ: переменную читают сразу несколько классов с разным типом
|
||||
# - адаптер пользователей ожидает int (минуты), напр. 10
|
||||
# - адаптеры организаций/грантов ожидают строку, напр. "10m"
|
||||
# Задавайте int, иначе адаптер пользователей упадёт на разборе.
|
||||
ZITADEL_TIMEOUT=10
|
||||
# Максимальный размер пачки при bulk-импорте
|
||||
ZITADEL_MAX_BATCH=2000
|
||||
# Эндпоинты (обычно не переопределяются)
|
||||
ZITADEL_USERS_MANAGEMENT_ENDPOINT=management/v1/users
|
||||
ZITADEL_USERS_ENDPOINT=v2/users
|
||||
|
||||
# --- Логирование (префикс LOG_) ---
|
||||
LOG_LEVEL=INFO
|
||||
# LOG_FORMAT=%(asctime)s [%(levelname)s]: %(message)s
|
||||
|
||||
# --- TCP Healthcheck (префикс HEALTHCHECK_) ---
|
||||
HEALTHCHECK_HOST=0.0.0.0
|
||||
HEALTHCHECK_PORT=8008
|
||||
HEALTHCHECK_MAX_CONNECTIONS=10
|
||||
HEALTHCHECK_REPLY=healthy
|
||||
|
||||
# --- Auth: sarex-backend (префикс AUTH_) ---
|
||||
# Используется для получения JWT под админом (режим run и CLI)
|
||||
AUTH_HOST=https://stage.sarex.io
|
||||
AUTH_ADMIN_USERNAME=
|
||||
AUTH_ADMIN_PASSWORD=
|
||||
AUTH_AUTH_ENDPOINT=api/token/
|
||||
|
||||
# --- Sarex user server (префикс USER_SERVER_, только CLI) ---
|
||||
# Источник метадаты пользователя для миграции/синхронизации
|
||||
USER_SERVER_HOST=https://stage.sarex.io
|
||||
USER_SERVER_USERS_ENDPOINT=api/core/admin/users
|
||||
|
||||
# --- База данных sarex-backend (префикс USER_DB_, только CLI) ---
|
||||
# Источник пользователей/компаний для команд migrate/sync/diff
|
||||
USER_DB_NAME=postgres
|
||||
USER_DB_USER=postgres
|
||||
USER_DB_PASSWORD=password
|
||||
USER_DB_HOST=127.0.0.1
|
||||
USER_DB_PORT=5432
|
||||
# Имена таблиц (обычно не переопределяются)
|
||||
USER_DB_USER_TABLE_NAME=base_baseuser
|
||||
USER_DB_COMPANYUSER_TABLE_NAME=core_companyuser
|
||||
USER_DB_COMPANY_TABLE_NAME=core_company
|
||||
USER_DB_ITER_SIZE=10000
|
||||
@ -1,218 +0,0 @@
|
||||
# Конфигурация проекта ams-sync
|
||||
# Версия: 1.0.0
|
||||
|
||||
Документ описывает все переменные окружения и способы конфигурирования сервиса.
|
||||
|
||||
## Что делает сервис
|
||||
|
||||
`ams-sync` — утилита синхронизации пользователей sarex-backend с системой управления доступом (AMS) на базе **Zitadel**. У сервиса два режима работы:
|
||||
|
||||
- **`run`** — фоновый демон-потребитель Kafka (`src/internal/app/service/sync_service.py`, точка входа `python3 cmd.py run`, это же `CMD` контейнера). Слушает топик событий пользователей и создаёт/обновляет пользователей в Zitadel. Параллельно поднимает TCP-healthcheck.
|
||||
- **CLI-команды** (`migrate` / `sync` / `diff`, реализованы в `src/internal/app/console.py`) — разовые задачи миграции и синхронизации, запускаются вручную. Читают пользователей и компании напрямую из БД sarex-backend.
|
||||
|
||||
## Способы конфигурирования
|
||||
|
||||
Сервис настраивается **только через переменные окружения**. Разбор выполняется библиотекой [`pydantic-settings`](https://docs.pydantic.dev/latest/concepts/pydantic_settings/). В отличие от монолитного `AppSettings`, настройки разбиты на несколько независимых классов, каждый со своим префиксом:
|
||||
|
||||
| Класс | Файл | Префикс |
|
||||
| --- | --- | --- |
|
||||
| `Settings` (приложение) | `src/internal/app/service/settings.py` | *(без префикса)* |
|
||||
| `KafkaSettings` | `src/internal/app/service/settings.py` | `kafka_` |
|
||||
| `Settings` (console) | `src/internal/app/console.py` | *(без префикса)* |
|
||||
| `Settings` (logger) | `src/internal/adapter/logger/logger.py` | `log_` |
|
||||
| `Settings` (healthcheck) | `src/internal/adapter/tcphealthcheck/healthcheck.py` | `healthcheck_` |
|
||||
| `Settings` (auth) | `src/internal/adapter/auth/http/adapter.py` | `auth_` |
|
||||
| `Settings` (user server) | `src/internal/adapter/users/http/adapter.py` | `user_server_` |
|
||||
| `Settings` (zitadel users) | `src/internal/adapter/users/zitadel/adapter.py` | `zitadel_` |
|
||||
| `Settings` (organizations) | `src/internal/adapter/organizations/adapter.py` | `zitadel_` |
|
||||
| `Settings` (grants) | `src/internal/adapter/grants/adapter.py` | `zitadel_` |
|
||||
| `Settings` (user repo) | `src/internal/repository/users/repository.py` | `user_db_` |
|
||||
| `Settings` (company repo) | `src/internal/repository/companies/repository.py` | `user_db_` |
|
||||
|
||||
Особенности разбора (`SettingsConfigDict`):
|
||||
|
||||
- у каждого класса задан `env_file=".env"`, `env_file_encoding="utf-8"` и `extra="ignore"` — при наличии файла `.env` в рабочей директории он загружается автоматически, лишние переменные игнорируются;
|
||||
- вложенного разделителя нет — каждая группа настроек читается отдельным классом по своему префиксу (либо без префикса для классов приложения);
|
||||
- CLI-команды принимают флаг `--env-file=` (по умолчанию `.env`), который прокидывается в конструкторы настроек как `_env_file`; режим `run` всегда читает `.env`.
|
||||
|
||||
Отдельного конфиг-файла (yaml/toml) у приложения нет.
|
||||
|
||||
Источники переменных по способам запуска:
|
||||
|
||||
| Способ запуска | Откуда берутся переменные |
|
||||
| --- | --- |
|
||||
| Локально (CLI) | Файл `.env` (или указанный через `--env-file=`) в директории с `cmd.py` и/или переменные окружения процесса |
|
||||
| Локально (контейнер) | `Dockerfile`: `CMD ["python3", "cmd.py", "run"]`; переменные пробрасываются в окружение контейнера |
|
||||
| Kubernetes (Helm) | `.helm/values.yaml`: блоки `universal-chart.envs` (обычные значения) и `universal-chart.secretEnvs` (значения из k8s-секретов). Базовый чарт — `universal-chart` |
|
||||
| CI/CD (GitLab) | `.gitlab-ci.yml`: переменные пайплайна в `workflow.rules` (`RELEASE_NAME`, `STAND`, `CHART_*`, `IMAGE_NAME`, `HELM_SET_ARGS` и т.п.) |
|
||||
|
||||
Команды CLI (`python3 cmd.py <command>`, см. `README.md`):
|
||||
|
||||
| Команда | Аргументы | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `run` | — | Демон-потребитель Kafka + TCP-healthcheck (режим контейнера) |
|
||||
| `migrate` | `--user-id`, `--with-password/--no-with-password` | Миграция пользователя(ей) из БД sarex-backend в Zitadel. Без `--user-id` мигрируются все (bulk) |
|
||||
| `sync` | `--user-id`, `--company-id` | Синхронизация метадаты пользователя(ей) из БД sarex-backend в Zitadel |
|
||||
| `diff` | — | Сравнение множества пользователей БД и Zitadel, отчёт по отсутствующим |
|
||||
|
||||
## Переменные приложения
|
||||
|
||||
Дефолт `—` означает, что значение обязательно (иначе ошибка старта).
|
||||
|
||||
### App (без префикса)
|
||||
|
||||
Класс `Settings` в `src/internal/app/service/settings.py` (режим `run`) и `Settings` в `console.py` (CLI).
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ENVIRONMENT` | enum | `LOCAL` | Окружение: `LOCAL`/`STAGE`/`PREPROD`/`PRODUCTION` |
|
||||
| `AMS_SYNC_TOPIC` | string | `ams-sync` | Имя топика Kafka с событиями пользователей |
|
||||
| `HOST_ORGANIZATION_ID` | string | — | ID организации-хоста в Zitadel (обязателен и в `run`, и в CLI) |
|
||||
| `VERIFY_USERS` | bool | `False` | При `True` события `model_created` обрабатываются через `import_user` (с верификацией e-mail), иначе через обычный `create` |
|
||||
|
||||
### Kafka (`KAFKA_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `KAFKA_BOOTSTRAP_SERVERS` | list[str] (JSON) | — | Адреса брокеров, напр. `["host:9091"]` |
|
||||
| `KAFKA_SASL_PLAIN_USERNAME` | string | — | Логин SASL |
|
||||
| `KAFKA_SASL_PLAIN_PASSWORD` | string | — | Пароль SASL |
|
||||
| `KAFKA_SSL_CAFILE` | string | — | Путь к CA-сертификату для SSL |
|
||||
| `KAFKA_SECURITY_PROTOCOL` | string | `SASL_SSL` | Протокол безопасности |
|
||||
| `KAFKA_SASL_MECHANISM` | string | `SCRAM-SHA-512` | Механизм SASL |
|
||||
|
||||
### Zitadel / AMS (`ZITADEL_*`)
|
||||
|
||||
Префикс используют три класса (адаптеры пользователей, организаций и грантов). Общие поля:
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ZITADEL_SERVICE_ACCESS_TOKEN` | string | — | Service-токен доступа к API Zitadel (Bearer) |
|
||||
| `ZITADEL_HOST` | string | — (у адаптера пользователей); `https://idp.dev.stage.sarex.io` (у адаптеров организаций/грантов) | Базовый URL Zitadel |
|
||||
| `ZITADEL_TIMEOUT` | int / string | `10` (адаптер пользователей, минуты) / `10m` (организации, гранты) | Таймаут. См. замечание о конфликте типов ниже |
|
||||
| `ZITADEL_MAX_BATCH` | int | `2000` | Максимум пользователей в одной пачке bulk-импорта |
|
||||
| `ZITADEL_USERS_MANAGEMENT_ENDPOINT` | string | `management/v1/users` | Базовый путь management-API |
|
||||
| `ZITADEL_USERS_ENDPOINT` | string | `v2/users` | Базовый путь users-API v2 |
|
||||
|
||||
### Логирование (`LOG_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `LOG_LEVEL` | string | `INFO` | Уровень логирования |
|
||||
| `LOG_FORMAT` | string | `%(asctime)s [%(levelname)s]: %(message)s` | Формат строки лога |
|
||||
|
||||
Логи пишутся в stdout и в файл `latest.log` в рабочей директории.
|
||||
|
||||
### TCP Healthcheck (`HEALTHCHECK_*`)
|
||||
|
||||
Только режим `run`. Поднимает сырой TCP-сокет, отвечающий строкой-ответом на каждое подключение.
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `HEALTHCHECK_HOST` | string | `0.0.0.0` | Адрес прослушивания |
|
||||
| `HEALTHCHECK_PORT` | int | `8008` | Порт |
|
||||
| `HEALTHCHECK_MAX_CONNECTIONS` | int | `10` | Размер очереди подключений (`listen`) |
|
||||
| `HEALTHCHECK_REPLY` | string | `healthy` | Строка-ответ на подключение |
|
||||
|
||||
### Auth: sarex-backend (`AUTH_*`)
|
||||
|
||||
Получение JWT под сервисным админом (используется в обоих режимах — адаптер создаётся и в `run`, и в CLI).
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `AUTH_HOST` | string | — | Базовый URL sarex-backend |
|
||||
| `AUTH_ADMIN_USERNAME` | string | — | Логин админа |
|
||||
| `AUTH_ADMIN_PASSWORD` | string | — | Пароль админа |
|
||||
| `AUTH_AUTH_ENDPOINT` | string | `api/token/` | Путь получения токена |
|
||||
|
||||
### Sarex user server (`USER_SERVER_*`) — только CLI
|
||||
|
||||
Источник метадаты пользователя при миграции/синхронизации.
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `USER_SERVER_HOST` | string | — | Базовый URL сервиса пользователей sarex-backend |
|
||||
| `USER_SERVER_USERS_ENDPOINT` | string | `api/core/admin/users` | Базовый путь эндпоинта пользователей |
|
||||
|
||||
### База данных sarex-backend (`USER_DB_*`) — только CLI
|
||||
|
||||
Один префикс на два репозитория (пользователи и компании). Подключение через `psycopg2`.
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `USER_DB_NAME` | string | — | Имя базы данных |
|
||||
| `USER_DB_USER` | string | — | Пользователь БД |
|
||||
| `USER_DB_PASSWORD` | string | — | Пароль |
|
||||
| `USER_DB_HOST` | string | — | Хост PostgreSQL |
|
||||
| `USER_DB_PORT` | int | — | Порт PostgreSQL |
|
||||
| `USER_DB_USER_TABLE_NAME` | string | `base_baseuser` | Таблица пользователей |
|
||||
| `USER_DB_COMPANYUSER_TABLE_NAME` | string | `core_companyuser` | Таблица связи пользователь↔компания |
|
||||
| `USER_DB_COMPANY_TABLE_NAME` | string | `core_company` | Таблица компаний |
|
||||
| `USER_DB_ITER_SIZE` | int | `10000` | Размер серверного курсора при итерации |
|
||||
|
||||
## Переменные из Helm-чарта (`.helm/values.yaml`)
|
||||
|
||||
Базовый чарт — `universal-chart`. Обычные значения (`universal-chart.envs`) задаются на окружение (`_default`/`stage`/`preprod`/`production`):
|
||||
|
||||
| Переменная | Значения по окружениям |
|
||||
| --- | --- |
|
||||
| `AMS_SYNC_TOPIC` | `ams-sync` |
|
||||
| `ENVIRONMENT` | `STAGE` / `PREPROD` / `PRODUCTION` |
|
||||
| `HOST_ORGANIZATION_ID` | stage `339439562105337368`, preprod `337394329179947547`, production `337555824748561429` |
|
||||
| `USER_SERVER_HOST` | stage `https://stage.sarex.io`, preprod `https://preprod.sarex.io`, production `https://.lk.sarex.io` |
|
||||
| `AUTH_HOST` | stage `https://stage.sarex.io`, preprod `https://preprod.sarex.io`, production `https://lk.sarex.io` |
|
||||
| `KAFKA_SECURITY_PROTOCOL` | `SASL_SSL` |
|
||||
| `KAFKA_SASL_MECHANISM` | `SCRAM-SHA-512` |
|
||||
|
||||
Значения из секретов (`universal-chart.secretEnvs`, монтируются как env через `secretKeyRef`):
|
||||
|
||||
| Переменная | Секрет (`secretName`) | Ключ (`secretKey`) |
|
||||
| --- | --- | --- |
|
||||
| `ZITADEL_HOST` | `zitadel-token-secret` | `zitadel-host` |
|
||||
| `ZITADEL_SERVICE_ACCESS_TOKEN` | `zitadel-token-secret` | `zitadel-access-token` |
|
||||
| `KAFKA_BOOTSTRAP_SERVERS` | `ams-kafka-secret` | `kafka-bootstrap-servers` |
|
||||
| `KAFKA_SASL_PLAIN_USERNAME` | `ams-kafka-secret` | `kafka-username` |
|
||||
| `KAFKA_SASL_PLAIN_PASSWORD` | `ams-kafka-secret` | `kafka-password` |
|
||||
| `KAFKA_SSL_CAFILE` | `ams-kafka-secret` | `kafka-ca-file` |
|
||||
| `AUTH_ADMIN_USERNAME` | `auth-secret` | `admin-username` |
|
||||
| `AUTH_ADMIN_PASSWORD` | `auth-secret` | `admin-password` |
|
||||
| `USER_DB_NAME` | `user-db-secret` | `user-db-name` |
|
||||
| `USER_DB_USER` | `user-db-secret` | `user-db-user` |
|
||||
| `USER_DB_PASSWORD` | `user-db-secret` | `user-db-password` |
|
||||
| `USER_DB_HOST` | `user-db-secret` | `user-db-host` |
|
||||
| `USER_DB_PORT` | `user-db-secret` | `user-db-port` |
|
||||
|
||||
Помимо env, чарт монтирует CA-сертификат Kafka из секрета `ya-ca-secret` в `/etc/ca-certificates/Yandex` (`volumes`/`volumeMounts`) и раздаёт `YandexInternalRootCA.crt` через configMap `ya-ca-cert`. Прочие значения чарта (не переменные приложения): `deployment.*` (имя, реплики, ресурсы, порт `8008`), `service.*` (ClusterIP, порт `8008`), `probes.*` (TCP-пробы на `8008`, по умолчанию выключены), `serviceAccount.*`, `imagePullSecrets.*`.
|
||||
|
||||
## Переменные в CI (`.gitlab-ci.yml`)
|
||||
|
||||
Пайплайн подключает общие шаблоны из `generic/common-ci` и переключает окружение по ветке/тегу через `workflow.rules`:
|
||||
|
||||
| Условие | STAND | Namespace |
|
||||
| --- | --- | --- |
|
||||
| ветка `stage` | `stage` | `platform` (`STAGE_NAMESPACE`) |
|
||||
| ветка `master` | `preprod` | `ams-sync-preprod` |
|
||||
| тег (`CI_COMMIT_TAG`) | `prod` | `ams-sync-prod` |
|
||||
|
||||
Ключевые переменные пайплайна: `RELEASE_NAME=ams-sync`, `CHART_NAME=ams-sync`, `CHART_VERSION` (`0.0.1-<stand>`), `IMAGE_NAME`, `IMAGE_PATH=universal-chart.image.name`, `HELM_SET_ARGS`, `DOCKERFILE_PATH=Dockerfile`, флаги `ENABLE_LINTER`/`ENABLE_BUILD_CHART`/`ENABLE_BUILD_IMAGE`/`ENABLE_STATE_UPDATE`/`ENABLE_DEPLOY`.
|
||||
|
||||
## Замечания и потенциальные проблемы
|
||||
|
||||
- **Конфликт `ZITADEL_TIMEOUT`.** Переменную читают три класса с общим префиксом `zitadel_`, но разного типа: адаптер пользователей ожидает `int` (минуты, дефолт `10`), адаптеры организаций и грантов — `str` (дефолт `10m`). Если задать `ZITADEL_TIMEOUT=10m`, инициализация адаптера пользователей упадёт на разборе `int`. Рекомендуется задавать целое число.
|
||||
- **`ZITADEL_HOST` без дефолта у адаптера пользователей.** В `users/zitadel/adapter.py` поле `host` обязательно (дефолта нет), тогда как в адаптерах организаций/грантов есть дефолт `https://idp.dev.stage.sarex.io`. Для режима `run` переменную нужно задать явно (в Helm приходит из секрета `zitadel-token-secret`).
|
||||
- **Режим `run` не использует БД и user-server.** Демон-потребитель (`sync_service.py`) поднимает только logger, healthcheck, auth-провайдер, адаптер Zitadel и Kafka. Переменные `USER_DB_*` и `USER_SERVER_*` требуются только CLI-командам (`migrate`/`sync`/`diff`), хотя в Helm они проброшены для запуска этих команд через `kubectl exec`.
|
||||
- **Приложение загружает `.env` автоматически** (у всех классов задан `env_file`), в отличие от некоторых других сервисов. CLI дополнительно поддерживает `--env-file=` для альтернативного файла.
|
||||
- **TLS-проверка отключена.** Все исходящие HTTP-запросы (Zitadel, sarex-backend) выполняются с `verify=False`. Отдельного флага в конфиге нет.
|
||||
- **Zitadel org-ID захардкожены в коде.** Помимо `HOST_ORGANIZATION_ID`, в use-case зашиты `glorax_org_id` и `dogma_org_id`, в которые распределяются пользователи по доменам e-mail (см. `usecase/migration/usecase.py`, `usecase/user/usecase.py`).
|
||||
|
||||
## Минимальный набор для режима `run` (демон)
|
||||
|
||||
- `ENVIRONMENT`, `HOST_ORGANIZATION_ID`, `AMS_SYNC_TOPIC`
|
||||
- `KAFKA_BOOTSTRAP_SERVERS`, `KAFKA_SASL_PLAIN_USERNAME`, `KAFKA_SASL_PLAIN_PASSWORD`, `KAFKA_SSL_CAFILE` (+ при необходимости `KAFKA_SECURITY_PROTOCOL`, `KAFKA_SASL_MECHANISM`)
|
||||
- `ZITADEL_HOST`, `ZITADEL_SERVICE_ACCESS_TOKEN`
|
||||
- `AUTH_HOST`, `AUTH_ADMIN_USERNAME`, `AUTH_ADMIN_PASSWORD`
|
||||
|
||||
## Дополнительно для CLI (`migrate` / `sync` / `diff`)
|
||||
|
||||
- `USER_SERVER_HOST`
|
||||
- `USER_DB_NAME`, `USER_DB_USER`, `USER_DB_PASSWORD`, `USER_DB_HOST`, `USER_DB_PORT`
|
||||
@ -1,99 +0,0 @@
|
||||
# Интерфейсы сервиса ams-sync
|
||||
# Версия: 1.0.0
|
||||
|
||||
Документ описывает интерфейсную поверхность сервиса: потребляемый топик Kafka, входящий TCP-healthcheck, исходящие HTTP-запросы к внешним сервисам (Zitadel, sarex-backend) и обращения к БД.
|
||||
|
||||
> `ams-sync` — не backend-сервис с REST API, а утилита синхронизации: демон-потребитель Kafka (`run`) плюс набор CLI-команд (`migrate`/`sync`/`diff`). Публичного HTTP API у сервиса нет — единственный входящий сокет отвечает на healthcheck сырой строкой (не HTTP). Поэтому файла `openapi.yaml` для сервиса нет.
|
||||
|
||||
## Как устроено взаимодействие
|
||||
|
||||
Приложение построено по слоям (adapter → repository → usecase → controller). Исходящие вызовы к внешним сервисам выполняются через `requests` (`requests.Session` с ретраями на `5xx`), к БД — через `psycopg2`. Все HTTP-запросы идут с `verify=False` (без проверки TLS). Базовые хосты берутся из переменных окружения (см. `CONFIGURATION.md`): `ZITADEL_HOST`, `AUTH_HOST`, `USER_SERVER_HOST`.
|
||||
|
||||
Аутентификация исходящих запросов:
|
||||
|
||||
- **Zitadel** — заголовок `Authorization: Bearer <ZITADEL_SERVICE_ACCESS_TOKEN>` (service-токен из конфига). Для части операций дополнительно проставляется `x-zitadel-orgid`.
|
||||
- **sarex-backend** — JWT, получаемый под админом (`AUTH_ADMIN_USERNAME`/`AUTH_ADMIN_PASSWORD`) через `POST api/token/`; кешируется и обновляется за 30 секунд до `exp`.
|
||||
|
||||
## Входящие интерфейсы
|
||||
|
||||
### TCP Healthcheck
|
||||
|
||||
Только режим `run`. Сырой TCP-сокет (не HTTP): на каждое подключение отправляет строку `HEALTHCHECK_REPLY` (по умолчанию `healthy`) и закрывает соединение. Слушает `HEALTHCHECK_HOST:HEALTHCHECK_PORT` (по умолчанию `0.0.0.0:8008`). В Helm k8s-пробы настроены на TCP-порт `8008` (по умолчанию отключены).
|
||||
|
||||
### Kafka-потребитель
|
||||
|
||||
Топик — переменная `AMS_SYNC_TOPIC` (по умолчанию `ams-sync`). Параметры консьюмера (`src/internal/controller/sync_service/controller.py`):
|
||||
|
||||
| Параметр | Значение |
|
||||
| --- | --- |
|
||||
| `group_id` | `ams_sync_group` |
|
||||
| `auto_offset_reset` | `earliest` |
|
||||
| `enable_auto_commit` | `True` |
|
||||
| десериализация | JSON (`utf-8`) |
|
||||
|
||||
Формат сообщения — объект с полями `type` и `body`. Диспетчеризация по `type`:
|
||||
|
||||
| `type` сообщения | Тело (`body`) | Обработчик | Действие |
|
||||
| --- | --- | --- | --- |
|
||||
| `model_created` | `SarexUserWithPermissions` | при `VERIFY_USERS=True` — `import_user` UC, иначе `user` UC `create` | Создание пользователя в Zitadel + запись метадаты |
|
||||
| `model_updated` | `Metadata` | `user` UC `update_metadata` | Обновление метадаты существующего пользователя в Zitadel |
|
||||
|
||||
Сообщения без `type` или `body` пропускаются с предупреждением. Ошибки обработки логируются (traceback), сообщение не переотправляется (auto-commit включён).
|
||||
|
||||
## Исходящие HTTP-запросы
|
||||
|
||||
### Zitadel (`ZITADEL_HOST`)
|
||||
|
||||
Адаптеры `users/zitadel/adapter.py` и `organizations/adapter.py`. Итоговый URL = `<ZITADEL_HOST>` + путь.
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| POST | `/v2/users/new` | Создать пользователя (human) |
|
||||
| POST | `/management/v1/users/human/_import` | Импортировать пользователя (заголовок `x-zitadel-orgid`) |
|
||||
| POST | `/admin/v1/import` | Массовый импорт пользователей (bulk, с таймаутом) |
|
||||
| POST | `/v2/users` | Поиск пользователей (по username / email / org) |
|
||||
| GET | `/management/v1/users/{id}` | Получить пользователя по id |
|
||||
| GET | `/management/v1/users/{id}/metadata/{key}` | Получить метадату пользователя по ключу |
|
||||
| POST | `/v2/users/{id}/metadata` | Массово задать метадату пользователя (значения в base64) |
|
||||
| POST | `/v2/users/{id}/deactivate` | Деактивировать пользователя |
|
||||
| DELETE | `/v2/users/{id}` | Удалить пользователя |
|
||||
| POST | `/v2/organizations/_search` | Найти организацию по имени |
|
||||
|
||||
> Пути `/v2/...` частично захардкожены в адаптере, часть базовых путей управляется `ZITADEL_USERS_MANAGEMENT_ENDPOINT` (`management/v1/users`) и `ZITADEL_USERS_ENDPOINT` (`v2/users`). Методы грантов (`grants/adapter.py`) в текущей версии закомментированы.
|
||||
|
||||
### sarex-backend — авторизация (`AUTH_HOST`)
|
||||
|
||||
Адаптер `auth/http/adapter.py`.
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| POST | `{AUTH_AUTH_ENDPOINT}` (по умолчанию `api/token/`) | Получить JWT по логину/паролю админа. Возвращает поле `access` |
|
||||
|
||||
### sarex-backend — сервис пользователей (`USER_SERVER_HOST`), только CLI
|
||||
|
||||
Адаптер `users/http/adapter.py`. Сессия с ретраями на `500/502/503/504` (до 5 попыток).
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| GET | `{USER_SERVER_USERS_ENDPOINT}/{user_id}/metadata` (по умолчанию `api/core/admin/users/{user_id}/metadata`) | Получить метадату пользователя sarex для синхронизации в Zitadel |
|
||||
|
||||
## Обращения к БД sarex-backend (`USER_DB_*`), только CLI
|
||||
|
||||
Репозитории `repository/users` и `repository/companies` читают данные напрямую из PostgreSQL sarex-backend (только чтение, серверный курсор `itersize`).
|
||||
|
||||
| Операция | Таблицы | Назначение |
|
||||
| --- | --- | --- |
|
||||
| Пользователь по id | `base_baseuser` | `migrate --user-id` / `sync --user-id` |
|
||||
| Все пользователи (итерация) | `base_baseuser` | `migrate` / `sync` / `diff` (bulk) |
|
||||
| Пользователи компании | `core_companyuser` ⋈ `base_baseuser` | `sync --company-id` (только с непустым email) |
|
||||
| Компания по id / имени | `core_company` | Вспомогательные запросы |
|
||||
|
||||
## Внешние зависимости (инфраструктура)
|
||||
|
||||
| Зависимость | Режим | Назначение |
|
||||
| --- | --- | --- |
|
||||
| Kafka | `run` | Источник событий пользователей (топик `AMS_SYNC_TOPIC`) |
|
||||
| Zitadel (AMS) | `run` + CLI | Целевая система управления доступом (создание/обновление/удаление пользователей и метадаты) |
|
||||
| sarex-backend (auth) | `run` + CLI | Получение JWT под админом |
|
||||
| sarex-backend (user server) | CLI | Источник метадаты пользователя |
|
||||
| PostgreSQL sarex-backend | CLI | Источник пользователей и компаний для миграции/синхронизации |
|
||||
@ -1,41 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: ams-sync
|
||||
namespace: ams-sync
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
backend:
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/ams-sync:ugok
|
||||
envs:
|
||||
- name: AMS_SYNC_TOPIC
|
||||
value:
|
||||
_default: ams-sync
|
||||
- name: ENVIRONMENT
|
||||
value:
|
||||
_default: PRODUCTION
|
||||
- name: HOST_ORGANIZATION_ID
|
||||
value:
|
||||
_default: '377835910403719938'
|
||||
- name: ALERT_ENABLED
|
||||
value:
|
||||
_default: 'False'
|
||||
- name: USER_SERVER_HOST
|
||||
value:
|
||||
_default: http://backend.django.svc.cluster.local:8000
|
||||
- name: AUTH_HOST
|
||||
value:
|
||||
_default: http://backend.django.svc.cluster.local:8000
|
||||
- name: VERIFY_USERS
|
||||
value:
|
||||
_default: 'True'
|
||||
- name: KAFKA_SECURITY_PROTOCOL
|
||||
value:
|
||||
_default: SSL
|
||||
- name: KAFKA_SASL_MECHANISM
|
||||
value:
|
||||
_default: SCRAM-SHA-512
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: ams-sync
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: backend.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
name: ams-sync
|
||||
@ -1,46 +0,0 @@
|
||||
# =============================================================================
|
||||
# Attachments — пример конфигурации (.env)
|
||||
# Скопируйте в .env и заполните значения.
|
||||
# =============================================================================
|
||||
# --- Приложение (необязательные, есть значения по умолчанию) ---
|
||||
# Версия: 0.11.1
|
||||
|
||||
# API=/api
|
||||
# NAME=Attachments
|
||||
# VERSION=0.0.1
|
||||
# DESCRIPTION=Attachments
|
||||
|
||||
# --- База данных PostgreSQL (обязательные) ---
|
||||
DATABASE_NAME=attachments
|
||||
DATABASE_USER=postgres
|
||||
DATABASE_PASSWORD=change_me
|
||||
DATABASE_HOST=db
|
||||
DATABASE_PORT=5432
|
||||
DATABASE_SSL_MODE=disable
|
||||
|
||||
# Пароль суперпользователя PostgreSQL для контейнера db (docker-compose)
|
||||
POSTGRES_PASSWORD=change_me
|
||||
|
||||
# --- S3 (Yandex Object Storage) ---
|
||||
# Вариант 1: путь к JSON с реквизитами сервисного аккаунта.
|
||||
# Файл должен содержать: {"endpoint": "...", "access_key_id": "...", "secret_access_key": "..."}
|
||||
YANDEX_S3_ACCOUNT_PATH=/etc/sarex/yc-s3-storage/yc-s3-service-account.json
|
||||
|
||||
# Вариант 2: задать реквизиты напрямую (если не используете JSON-файл).
|
||||
# YANDEX_S3_ENDPOINT_URL=storage.yandexcloud.net
|
||||
# YANDEX_S3_ACCESS_KEY_ID=change_me
|
||||
# YANDEX_S3_SECRET_ACCESS_KEY=change_me
|
||||
|
||||
YANDEX_S3_VERIFY=true
|
||||
# YANDEX_S3_USE_SSL=true
|
||||
# YANDEX_S3_REGION=ru-central1
|
||||
BUCKET_NAME=attachments-stage-2
|
||||
|
||||
# --- Логирование (префикс LOG_) ---
|
||||
# LOG_LEVEL=INFO
|
||||
|
||||
# --- Трейсинг / OpenTelemetry (префикс TRACING_) ---
|
||||
# TRACING_USE=false
|
||||
# TRACING_HOST=localhost:4317
|
||||
# TRACING_SERVICE_NAME=attachments
|
||||
# TRACING_INSECURE=false
|
||||
@ -1,129 +0,0 @@
|
||||
# Конфигурация проекта Attachments
|
||||
# Версия: 0.11.1
|
||||
|
||||
Документ описывает все переменные окружения и способы конфигурирования сервиса.
|
||||
|
||||
## Способы конфигурирования
|
||||
|
||||
Настройка сервиса выполняется **только через переменные окружения**. Отдельного файла с настройками (yaml/toml) в приложении нет — за конфигурацию отвечает `internal/config/settings.py` на базе `pydantic.BaseSettings`.
|
||||
|
||||
Источники переменных окружения по способам запуска:
|
||||
|
||||
| Способ запуска | Откуда берутся переменные |
|
||||
| --- | --- |
|
||||
| Локально (docker-compose) | Файл `.env` в корне (`env_file: .env` в `docker-compose.yml`), плюс `POSTGRES_PASSWORD` для контейнера БД |
|
||||
| Kubernetes (Helm) | `.helm/values.yaml`: блок `envs` (обычные значения) и `secretEnvs` (значения из k8s-секретов) |
|
||||
| CI/CD (GitLab) | `.gitlab-ci.yml`: переменные пайплайна и build-args |
|
||||
|
||||
Дополнительно секреты доступа к S3 не задаются напрямую, а читаются из JSON-файла (см. `YANDEX_S3_ACCOUNT_PATH` ниже).
|
||||
|
||||
## Переменные приложения (класс `Settings`)
|
||||
|
||||
Читаются напрямую по имени (регистрозависимо, `case_sensitive = True`). Переменные без значения по умолчанию **обязательны** — без них приложение не стартует.
|
||||
|
||||
| Переменная | Тип | Обязательна | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `API` | str | нет | `/api` | Префикс всех HTTP-роутов |
|
||||
| `NAME` | str | нет | `Attachments` | Имя сервиса (title в FastAPI/OpenAPI) |
|
||||
| `VERSION` | str | нет | `0.0.1` | Версия сервиса |
|
||||
| `DESCRIPTION` | str | нет | `Attachments` | Описание сервиса |
|
||||
| `YANDEX_S3_ENDPOINT_URL` | str | да* | — | Endpoint S3 (без схемы; `https://`/`http://` добавляется в коде по `YANDEX_S3_USE_SSL`) |
|
||||
| `YANDEX_S3_ACCESS_KEY_ID` | str | да* | — | Access Key ID для S3 |
|
||||
| `YANDEX_S3_SECRET_ACCESS_KEY` | str | да* | — | Secret Access Key для S3 |
|
||||
| `YANDEX_S3_USE_SSL` | bool | нет | `True` | Использовать ли HTTPS при обращении к S3 |
|
||||
| `YANDEX_S3_REGION` | str | нет | `ru-central1` | Регион S3 |
|
||||
| `YANDEX_S3_VERIFY` | bool | да | — | Проверять ли SSL-сертификат S3 |
|
||||
| `BUCKET_NAME` | str | да | — | Имя бакета для вложений |
|
||||
| `DATABASE_NAME` | str | да | — | Имя базы данных PostgreSQL |
|
||||
| `DATABASE_USER` | str | да | — | Пользователь БД |
|
||||
| `DATABASE_PASSWORD` | str | да | — | Пароль пользователя БД |
|
||||
| `DATABASE_HOST` | str | да | — | Хост БД |
|
||||
| `DATABASE_PORT` | int | да | — | Порт БД |
|
||||
| `DATABASE_SSL_MODE` | str | да | — | Режим SSL при подключении к БД (напр. `disable`, `require`, `verify-full`) |
|
||||
|
||||
\* Три переменные `YANDEX_S3_ENDPOINT_URL`, `YANDEX_S3_ACCESS_KEY_ID`, `YANDEX_S3_SECRET_ACCESS_KEY` формально обязательны, но при старте приложения они **проставляются автоматически** функцией `json_config_s3_account_settings()` из JSON-файла (см. `YANDEX_S3_ACCOUNT_PATH`). Задавать их вручную не нужно, если задан путь к файлу.
|
||||
|
||||
## Настройки S3 через JSON-файл
|
||||
|
||||
| Переменная | Обязательна | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `YANDEX_S3_ACCOUNT_PATH` | да | Путь к JSON-файлу с реквизитами сервисного аккаунта S3 |
|
||||
|
||||
При старте функция `json_config_s3_account_settings()` читает файл по этому пути и выставляет переменные окружения `YANDEX_S3_ENDPOINT_URL`, `YANDEX_S3_ACCESS_KEY_ID`, `YANDEX_S3_SECRET_ACCESS_KEY`.
|
||||
|
||||
Ожидаемая структура JSON-файла:
|
||||
|
||||
```json
|
||||
{
|
||||
"endpoint": "storage.yandexcloud.net",
|
||||
"access_key_id": "<ключ>",
|
||||
"secret_access_key": "<секрет>"
|
||||
}
|
||||
```
|
||||
|
||||
В Kubernetes файл монтируется из секрета `attachments-s3-secret` (в prod — `yc-s3`) в `/etc/sarex/yc-s3-storage/yc-s3-service-account.json`.
|
||||
|
||||
## Логирование (класс `LoggerSettings`, префикс `LOG_`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `LOG_LEVEL` | str | `INFO` | Уровень логирования (`DEBUG`, `INFO`, `WARNING`, ...). При неизвестном значении откатывается на `INFO` |
|
||||
| `LOG_FORMAT` | str | JSON-шаблон с полями `timestamp`, `level`, `message` | Формат строк лога (используется `pythonjsonlogger`) |
|
||||
|
||||
## Трейсинг / OpenTelemetry (класс `TraceSettings`, префикс `TRACING_`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `TRACING_USE` | bool | `False` | Включает OTEL-трейсинг, логгер и middleware |
|
||||
| `TRACING_HOST` | str | `localhost:4317` | Адрес OTLP-коллектора |
|
||||
| `TRACING_SERVICE_NAME` | str | `attachments` | Имя сервиса в трейсах |
|
||||
| `TRACING_INSECURE` | bool | `False` | Небезопасное (без TLS) подключение к коллектору |
|
||||
|
||||
Трейсинг активируется только при `TRACING_USE=true`.
|
||||
|
||||
## Переменные инфраструктуры и сборки
|
||||
|
||||
Не читаются кодом приложения, но нужны для запуска/сборки/деплоя.
|
||||
|
||||
| Переменная | Где используется | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `POSTGRES_PASSWORD` | `docker-compose.yml` (контейнер `db`) | Пароль суперпользователя PostgreSQL при локальном запуске |
|
||||
| `PIP_EXTRA_INDEX_URL` | `docker/Dockerfile` (build-arg) | Доп. индекс pip для установки приватных пакетов при сборке образа |
|
||||
| `GITLAB_PYPI_EXTRA_INDEX_URL` | `.gitlab-ci.yml` | Значение, пробрасываемое в `PIP_EXTRA_INDEX_URL` при сборке в CI |
|
||||
|
||||
### Переменные CI/CD (`.gitlab-ci.yml`)
|
||||
|
||||
Служебные переменные пайплайна: `SERVICE_NAME`, `DOCKERFILE_PATH`, `BUILD_ARGS`, `CI_TRIGGER_SOURCE`, а также подставляемые по окружениям `STAND`, `NAMESPACE`, `RELEASE_NAME`, `CHART_NAME`, `CHART_VERSION`, `K8S_HUSTLER_BRANCH`, `HELM_SET_ARGS`. Окружение выбирается по ветке/тегу: `stage` → ветка `stage`, `preprod` → ветка `master`, `production` → git-тег.
|
||||
|
||||
## Переменные из Helm-чарта (`.helm/values.yaml`)
|
||||
|
||||
Обычные переменные (`envs`):
|
||||
|
||||
| Переменная | Значение | Примечание |
|
||||
| --- | --- | --- |
|
||||
| `API_ADDRESS` | `0.0.0.0:8000` | Задаётся в чарте, но **кодом приложения не читается** |
|
||||
| `POSTGRES_POOL_SIZE` | `10` | Задаётся в чарте, но **кодом приложения не читается** |
|
||||
| `DATABASE_SSL_MODE` | `verify-full` | |
|
||||
| `YANDEX_S3_VERIFY` | `true` | |
|
||||
| `YANDEX_S3_ACCOUNT_PATH` | `/etc/sarex/yc-s3-storage/yc-s3-service-account.json` | |
|
||||
| `BUCKET_NAME` | `attachments-stage-2` / `attachments-prod-2` | Зависит от окружения |
|
||||
|
||||
Переменные из секретов (`secretEnvs`, секрет `attachments-postgresql-secret` / `ya-pg-secret`):
|
||||
|
||||
| Переменная | Ключ секрета | Примечание |
|
||||
| --- | --- | --- |
|
||||
| `DATABASE_PORT` | `port` | |
|
||||
| `DATABASE_HOST` | `host` | |
|
||||
| `DATABASE_USER` | `username` | |
|
||||
| `DATABASE_PASSWORD` | `password` | |
|
||||
| `DATABASE_NAME` | `database` | |
|
||||
| `YC-PG-CERTIFICATE` | `ca.crt` | CA-сертификат PostgreSQL; также монтируется файлом в `/root/.postgresql/root.crt` |
|
||||
|
||||
## Минимальный набор для локального запуска
|
||||
|
||||
Для запуска через `docker-compose` в файле `.env` достаточно задать (см. `.env.example`):
|
||||
|
||||
- `POSTGRES_PASSWORD` — для контейнера БД
|
||||
- `DATABASE_*` — параметры подключения к БД
|
||||
- `BUCKET_NAME`, `YANDEX_S3_VERIFY`
|
||||
- `YANDEX_S3_ACCOUNT_PATH` **или** напрямую `YANDEX_S3_ENDPOINT_URL` + `YANDEX_S3_ACCESS_KEY_ID` + `YANDEX_S3_SECRET_ACCESS_KEY`
|
||||
@ -49,19 +49,10 @@ spec:
|
||||
[ -f /vault/secrets/attachments-db ] && . /vault/secrets/attachments-db
|
||||
[ -f /vault/secrets/attachments-s3 ] && . /vault/secrets/attachments-s3
|
||||
set +a
|
||||
mkdir -p /etc/sarex/yc-s3-storage
|
||||
cat > /etc/sarex/yc-s3-storage/yc-s3-service-account.json <<EOF
|
||||
{
|
||||
"endpoint": "${YANDEX_S3_ENDPOINT_URL}",
|
||||
"access_key_id": "${YANDEX_S3_ACCESS_KEY_ID}",
|
||||
"secret_access_key": "${YANDEX_S3_SECRET_ACCESS_KEY}",
|
||||
"use_ssl": ${YANDEX_S3_USE_SSL}
|
||||
}
|
||||
EOF
|
||||
exec /opt/attachments/entrypoint.sh
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/att9:dev
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/attachments:feature_6238c882
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
service:
|
||||
@ -85,9 +76,6 @@ spec:
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value:
|
||||
_default: "10"
|
||||
- name: YANDEX_S3_ACCOUNT_PATH
|
||||
value:
|
||||
_default: "/etc/sarex/yc-s3-storage/yc-s3-service-account.json"
|
||||
- name: API_ADDRESS
|
||||
value:
|
||||
_default: 0.0.0.0:8000
|
||||
@ -99,12 +87,12 @@ spec:
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: attachments
|
||||
vault.hashicorp.com/agent-inject-secret-attachments-db: secrets/data/apps/attachments/postgres
|
||||
vault.hashicorp.com/agent-inject-secret-attachments-db: secrets/data/postgresql/apps/attachments
|
||||
vault.hashicorp.com/agent-inject-template-attachments-db: |-
|
||||
{{- with secret "secrets/data/apps/attachments/postgres" -}}
|
||||
DATABASE_HOST={{ index .Data.data "host" }}
|
||||
DATABASE_PORT={{ index .Data.data "port" }}
|
||||
DATABASE_NAME={{ index .Data.data "database" }}
|
||||
{{- with secret "secrets/data/postgresql/apps/attachments" -}}
|
||||
DATABASE_HOST=postgresql.attachments.svc.cluster.local
|
||||
DATABASE_PORT=5432
|
||||
DATABASE_NAME=attachments_db
|
||||
DATABASE_USER={{ index .Data.data "username" }}
|
||||
DATABASE_PASSWORD={{ index .Data.data "password" }}
|
||||
DATABASE_SSL_MODE=disable
|
||||
@ -115,7 +103,7 @@ spec:
|
||||
YANDEX_S3_ENDPOINT_URL=minio.minio:9000
|
||||
YANDEX_S3_ACCESS_KEY_ID={{ index .Data.data "access_key" }}
|
||||
YANDEX_S3_SECRET_ACCESS_KEY={{ index .Data.data "secret_key" }}
|
||||
YANDEX_S3_USE_SSL=true
|
||||
YANDEX_S3_USE_SSL=false
|
||||
YANDEX_S3_REGION=ru-central
|
||||
YANDEX_S3_VERIFY=false
|
||||
BUCKET_NAME=attachments
|
||||
|
||||
@ -3,5 +3,4 @@ apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: attachments
|
||||
resources:
|
||||
- namespace.yaml
|
||||
- helmrelease.yaml
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Namespace
|
||||
metadata:
|
||||
name: attachments
|
||||
labels:
|
||||
istio-injection: enabled
|
||||
security.deckhouse.io/pod-policy: privileged
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: attachments
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: patch.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
name: attachments
|
||||
@ -1,35 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: attachments
|
||||
namespace: attachments
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
attachments:
|
||||
podAnnotations:
|
||||
_default:
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: attachments
|
||||
vault.hashicorp.com/agent-inject-secret-attachments-db: secrets/data/apps/attachments/postgres
|
||||
vault.hashicorp.com/agent-inject-template-attachments-db: |-
|
||||
{{- with secret "secrets/data/apps/attachments/postgres" -}}
|
||||
DATABASE_HOST={{ index .Data.data "host" }}
|
||||
DATABASE_PORT={{ index .Data.data "port" }}
|
||||
DATABASE_NAME={{ index .Data.data "database" }}
|
||||
DATABASE_USER={{ index .Data.data "username" }}
|
||||
DATABASE_PASSWORD={{ index .Data.data "password" }}
|
||||
DATABASE_SSL_MODE=disable
|
||||
{{- end -}}
|
||||
vault.hashicorp.com/agent-inject-secret-attachments-s3: secrets/data/minio/apps/attachments
|
||||
vault.hashicorp.com/agent-inject-template-attachments-s3: |-
|
||||
{{- with secret "secrets/data/minio/apps/attachments" -}}
|
||||
YANDEX_S3_ENDPOINT_URL=s3.uralmine.com
|
||||
YANDEX_S3_ACCESS_KEY_ID={{ index .Data.data "access_key" }}
|
||||
YANDEX_S3_SECRET_ACCESS_KEY={{ index .Data.data "secret_key" }}
|
||||
YANDEX_S3_USE_SSL=true
|
||||
YANDEX_S3_REGION=ru-central
|
||||
YANDEX_S3_VERIFY=false
|
||||
BUCKET_NAME=sarex-attachments-storage
|
||||
{{- end -}}
|
||||
@ -1,44 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: attachments
|
||||
namespace: attachments
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
attachments:
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/attachments:0.0.9
|
||||
envs:
|
||||
- name: DATABASE_HOST
|
||||
value:
|
||||
_default: postgres-service.attachments.svc.cluster.local
|
||||
- name: DATABASE_PORT
|
||||
value:
|
||||
_default: '5432'
|
||||
- name: DATABASE_NAME
|
||||
value:
|
||||
_default: attachments
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value:
|
||||
_default: '10'
|
||||
- name: API_ADDRESS
|
||||
value:
|
||||
_default: 0.0.0.0:8000
|
||||
- name: DATABASE_SSL_MODE
|
||||
value:
|
||||
_default: disable
|
||||
- name: YANDEX_S3_VERIFY
|
||||
value:
|
||||
_default: 'False'
|
||||
- name: YANDEX_S3_USE_SSL
|
||||
value:
|
||||
_default: 'False'
|
||||
- name: YANDEX_S3_ACCOUNT_PATH
|
||||
value:
|
||||
_default: /etc/sarex/yc-s3-storage/yc-s3-service-account.json
|
||||
- name: BUCKET_NAME
|
||||
value:
|
||||
_default: attachments
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: attachments
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: attachments.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
name: attachments
|
||||
@ -9,7 +9,7 @@ spec:
|
||||
chart:
|
||||
spec:
|
||||
chart: postgresql-contour
|
||||
version: "13.0.15"
|
||||
version: "17.0.7"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
@ -44,7 +44,7 @@ spec:
|
||||
image:
|
||||
registry: cr.yandex/crp3ccidau046kdj8g9q
|
||||
repository: contour/postgresql
|
||||
tag: 13.0.15
|
||||
tag: 17.0.7
|
||||
pullPolicy: Always
|
||||
metrics:
|
||||
enabled: false
|
||||
@ -103,7 +103,7 @@ spec:
|
||||
contour:
|
||||
enabled: true
|
||||
adminUser: "postgres"
|
||||
sharedPreloadLibraries: ""
|
||||
sharedPreloadLibraries: "pg_stat_statements"
|
||||
vault:
|
||||
enabled: true
|
||||
role: postgresql
|
||||
@ -116,7 +116,6 @@ spec:
|
||||
user: attachments
|
||||
passwordKey: attachments
|
||||
extensions: []
|
||||
restoreFromDump: true
|
||||
dumpKey: "sanitized_dumps_multi/attachments/288/attachments_company288_20260626T202844Z.tar.gz"
|
||||
restoreFromDump: false
|
||||
s3-proxy:
|
||||
endpointUrl: "s3-proxy-service.postgresql.svc.cluster.local"
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
# auth-flow-frontend — переменные СБОРКИ (build-time), НЕ рантайм-.env.
|
||||
# Приложение не читает .env: значения подставляются в код на этапе сборки
|
||||
# через webpack DefinePlugin (см. webpack.config.ts) или Dockerfile --build-arg / CI BUILD_ARGS.
|
||||
|
||||
# Окружение сборки: local | stage | prod | preprod | contour
|
||||
# local -> mode=development, isDev=true (доступны dev-роуты /login, /logout, /)
|
||||
# остальные -> mode=production
|
||||
ENDPOINT=local
|
||||
|
||||
# Токен приватного npm-реестра @sarex-team (nexus.infra.sarex.io), нужен для `npm i` (.npmrc)
|
||||
NPM_NEXUS_TOKEN=
|
||||
|
||||
# NOTE: IS_DEV вычисляется автоматически (ENDPOINT === 'local'), задавать вручную не нужно.
|
||||
# NOTE: authority и client_id OIDC (Zitadel) НЕ задаются здесь — хостовое приложение
|
||||
# кладёт их в localStorage (STORAGE.AUTHORITY / STORAGE.CLIENT_ID) во время работы.
|
||||
@ -1,162 +0,0 @@
|
||||
# Конфигурация проекта auth-flow-frontend
|
||||
|
||||
Документ описывает способы конфигурирования микрофронтенда аутентификации `auth-flow-frontend` (React + webpack), а также все переменные сборки, деплоя и рантайма.
|
||||
|
||||
## Способы конфигурирования
|
||||
|
||||
В отличие от бэкенд-сервисов, приложение **не читает `.env` и не использует dotenv**. Это статический фронтенд, собираемый webpack, поэтому конфигурация распределена по трём уровням:
|
||||
|
||||
1. **Сборка (build-time).** Переменная `ENDPOINT` определяет окружение. Её значение подставляется в код на этапе сборки через `webpack.DefinePlugin` (`webpack.config.ts`) — заменяет обращения `process.env.ENDPOINT` и `process.env.IS_DEV` на строковые литералы. Выбор режима (`development`/`production`) и флага `isDev` выполняется в `webpack/build.config.ts`.
|
||||
2. **Установка зависимостей.** Пакеты `@sarex-team/*` тянутся из приватного npm-реестра (`.npmrc` → `nexus.infra.sarex.io`). Для доступа нужен токен `NPM_NEXUS_TOKEN`.
|
||||
3. **Рантайм (runtime).** Параметры OIDC-провайдера — `authority` и `client_id` — читаются из `localStorage` (`src/config/zitadel.ts`) по ключам `STORAGE.AUTHORITY` и `STORAGE.CLIENT_ID` из `@sarex-team/sdk-js`. Их задаёт хостовое приложение, а не сборка.
|
||||
|
||||
Источники переменных по способам запуска:
|
||||
|
||||
| Способ запуска | Откуда берутся переменные |
|
||||
| --- | --- |
|
||||
| Локально (dev) | `npm run dev` → `ENDPOINT=local webpack serve`. Dev-сервер на `https://localhost:9000` |
|
||||
| Локально (build) | `npm run build` → `webpack --config webpack.config.ts` (по умолчанию `ENDPOINT=prod`, см. `build.config.ts`) |
|
||||
| Docker | `Dockerfile`: build-args `ENDPOINT` и `NPM_NEXUS_TOKEN`; сборка dist → отдача через nginx |
|
||||
| Kubernetes (Helm) | `.helm/values.yaml` (чарт `universal-chart`): блок `services.frontend`, `global.env` |
|
||||
| CI/CD (GitLab) | `.gitlab-ci.yml`: `workflow.rules` (ветка/тег → `STAND`, `ENDPOINT`, `CHART_VERSION`), `BUILD_ARGS`, `HELM_SET_ARGS` |
|
||||
|
||||
## Переменные сборки (build-time)
|
||||
|
||||
Подставляются в код на этапе сборки; в рантайме это уже константы.
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ENDPOINT` | enum | `prod` (в `build.config.ts`, если не задана) | Окружение сборки: `local`/`stage`/`prod`/`preprod`/`contour`. Определяет `mode` (`development` для `local`, иначе `production`) и `isDev` |
|
||||
| `IS_DEV` | bool | — (вычисляется) | `true`, если `ENDPOINT === 'local'`. Включает dev-роуты (`/login`, `/logout`, `/`). Задаётся автоматически через `DefinePlugin`, вручную указывать не нужно |
|
||||
| `NPM_NEXUS_TOKEN` | string | — | Токен авторизации в приватном npm-реестре `@sarex-team` (`.npmrc`). Обязателен для `npm i` |
|
||||
|
||||
> `mode` по окружениям (`webpack/build.config.ts`): `local` → `development`, `stage`/`prod`/`preprod`/`contour` → `production`. Неизвестное значение `ENDPOINT` приводит к ошибке сборки.
|
||||
|
||||
## Переменные рантайма (localStorage)
|
||||
|
||||
Читаются в браузере во время работы приложения; задаются хостовым приложением, не сборкой.
|
||||
|
||||
| Ключ | Источник | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `STORAGE.AUTHORITY` | `@sarex-team/sdk-js` | URL issuer'а Zitadel (`authority` OIDC). Обязателен — при отсутствии `src/config/zitadel.ts` бросает `Error("Authority or client ID is not set")` |
|
||||
| `STORAGE.CLIENT_ID` | `@sarex-team/sdk-js` | `client_id` OIDC-клиента. Обязателен (та же проверка) |
|
||||
| `sarex_logout` (`LOGOUT_STORAGE_KEY`) | `src/config/logout.ts` | Состояние логаута между вкладками (`{ logoutAt, owner, reason }`). Снимается только валидным токеном в `setTokensInfo` |
|
||||
| access / refresh / id токены | `storage` из `@sarex-team/sdk-js` | Устанавливаются в `setTokensInfo` (`storage.setAccessToken`/`setRefreshToken`/`setIdentityToken`) после успешного колбэка |
|
||||
|
||||
## Конфигурация OIDC (Zitadel)
|
||||
|
||||
Задаётся в `src/config/zitadel.ts` (`configZitadel: ZitadelConfig`), клиент создаётся через `createZitadelAuth`.
|
||||
|
||||
| Параметр | Значение | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `authority` | из `localStorage` (`STORAGE.AUTHORITY`) | Issuer Zitadel |
|
||||
| `client_id` | из `localStorage` (`STORAGE.CLIENT_ID`) | Идентификатор клиента |
|
||||
| `response_type` | `code` | Authorization Code Flow |
|
||||
| `scope` | `openid profile email offline_access urn:zitadel:iam:user:metadata` | Запрашиваемые области |
|
||||
| `redirect_uri` | `${window.location.origin}/auth/callback` | URL возврата после логина |
|
||||
| `post_logout_redirect_uri` | `${window.location.origin}/login` | URL после логаута |
|
||||
| `redirectMethod` | `replace` | Замена записи в истории браузера |
|
||||
| `revokeTokensOnSignout` | `false` | Не отзывать токены при выходе |
|
||||
| `automaticSilentRenew` | `false` | Фоновое обновление токенов выключено |
|
||||
| `validateSubOnSilentRenew` | `false` | — |
|
||||
| `silentRequestTimeoutInSeconds` | `100` | Таймаут silent-запроса |
|
||||
|
||||
## Роуты приложения
|
||||
|
||||
Определены в `src/config/urls.ts`, диспетчеризация в `src/App.tsx`.
|
||||
|
||||
| Роут | Константа | Доступность | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `/auth/callback` | `CALLBACK` | всегда | Обработка OIDC-колбэка (по умолчанию для неизвестных путей) |
|
||||
| `/auth/error` | `ERROR` | всегда | Страница ошибки аутентификации |
|
||||
| `/login` | `LOGIN` | только dev | Dev-страница входа |
|
||||
| `/logout` | `LOGOUT` | только dev | Dev-страница выхода |
|
||||
| `/` | `HOME` | только dev | Dev-навигация |
|
||||
|
||||
> В production разрешены только `/auth/callback` и `/auth/error` (`ALLOWED_PATHS`); в dev дополнительно `/login`, `/logout`, `/` (`ALLOWED_PATHS_DEV`). Неразрешённый путь заменяется на `/auth/callback` (`history.replaceState`).
|
||||
|
||||
## Сборка (webpack)
|
||||
|
||||
`webpack.config.ts` + `webpack/build.config.ts`.
|
||||
|
||||
| Параметр | Значение | Примечание |
|
||||
| --- | --- | --- |
|
||||
| `entry` | `src/index.tsx` | Точка входа |
|
||||
| `output.path` | `dist/` | |
|
||||
| `output.filename` | `index.js` | |
|
||||
| `output.publicPath` | `/` (dev) или `/auth/callback/` (prod) | Зависит от `isDev` |
|
||||
| loader | `esbuild-loader`, target `es2015` | Для `.tsx?/.jsx?` |
|
||||
| `devServer` | `https`, `port: 9000`, `hot`, `historyApiFallback`, `open` | Только dev |
|
||||
| plugins | `HtmlWebpackPlugin` (`public/index.html`), `DefinePlugin` (`ENDPOINT`, `IS_DEV`) | |
|
||||
|
||||
Node-версия для разработки: `v20.0.0` (`.nvmrc`; в `package.json` заявлено `v20.0.0`, реальная база образа — `node:20`).
|
||||
|
||||
## Docker
|
||||
|
||||
`Dockerfile` — двухстадийная сборка.
|
||||
|
||||
| Стадия | База | Действия |
|
||||
| --- | --- | --- |
|
||||
| build | `cr.yandex/crp3ccidau046kdj8g9q/node:20` | `npm i` (с `NPM_NEXUS_TOKEN`), `npm run build` (с `ENDPOINT`) |
|
||||
| runtime | `cr.yandex/crp3ccidau046kdj8g9q/nginx:latest` | Копирует `/app/dist/` → `/dist/`, `nginx/nginx.conf` → `/etc/nginx/nginx.conf` |
|
||||
|
||||
Build-args: `ENDPOINT`, `NPM_NEXUS_TOKEN`.
|
||||
|
||||
## Nginx
|
||||
|
||||
`nginx/nginx.conf` — отдача статики и healthcheck.
|
||||
|
||||
| Локация | Поведение |
|
||||
| --- | --- |
|
||||
| `= /auth/callback/index.js` | `alias /dist/index.js` |
|
||||
| `^~ /auth/callback` | `try_files $uri $uri/ /index.html`; заголовки `Cache-Control: no-store,...`, кеш отключён |
|
||||
| `= /ping` | `200 {"result": "ok"}` (healthcheck) |
|
||||
|
||||
`listen 80`, `root /dist`, логи в stdout/stderr, `gzip on`.
|
||||
|
||||
## Helm-чарт (`.helm/values.yaml`)
|
||||
|
||||
Деплой через зонтичный чарт `universal-chart` (`oci://cr.yandex/crp3ccidau046kdj8g9q/charts`, версия `0.1.7`; `Chart.yaml` приложения — `auth-flow-frontend` `1.0.0`). Значения задаются с ключами по окружениям (`_default`/`stage`/`preprod`/`production`).
|
||||
|
||||
| Параметр | Значение | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `global.env` | `stage` (`_default` в файле) | Активное окружение чарта |
|
||||
| `services.frontend.enabled` | `true` | Включение сервиса |
|
||||
| `deployment.name._default` | `auth-flow-frontend` | Имя деплоймента |
|
||||
| `deployment.replicaCount` | `_default: 1`, `production: 2` | Число реплик |
|
||||
| `deployment.port._default` | `80` | Порт контейнера |
|
||||
| `deployment.revisionHistoryLimit._default` | `5` | Хранимые ревизии |
|
||||
| `deployment.resources.requests` | `memory: 128Mi`, `cpu: 100m` | Реквесты ресурсов |
|
||||
| `deployment.probes.liveness/readiness` | `httpGet` `/` : `80` | Пробы |
|
||||
| `image.name._default` | `cr.yandex/crp3ccidau046kdj8g9q/auth-flow-frontend` | Образ |
|
||||
| `image.pullPolicy._default` | `IfNotPresent` | |
|
||||
| `imagePullSecrets.name._default` | `dockerhub` (enabled `false`) | Секрет реестра |
|
||||
| `service` | `ClusterIP`, port/targetPort `80`, portName `http`, имя `auth-flow-frontend-service` | Service |
|
||||
| `envs` | `[]` | Переменные окружения контейнера (пусто) |
|
||||
| `volumes._default` | `[]` | Тома |
|
||||
| `commitSha`/`gitlabUri`/`gitlabJobUrl`/`owner` | заполняются из CI (`owner` по умолчанию `team-abc`) | Метаданные |
|
||||
|
||||
## CI (`.gitlab-ci.yml`)
|
||||
|
||||
Подключает общие шаблоны `generic/common-ci` (`common-security-scan.yaml`, `universal-pipeline.yaml` ref `apps-business`).
|
||||
|
||||
Базовые переменные: `SERVICE_NAME=auth-flow-frontend`, `DOCKERFILE_PATH=./Dockerfile`, `CI_TRIGGER_SOURCE=app`.
|
||||
|
||||
Переключение окружения по `workflow.rules`:
|
||||
|
||||
| Условие | STAND | ENDPOINT | CHART_VERSION | K8S_HUSTLER_BRANCH |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `merge_request_event` | — | — | — (`ENABLE_BUILD_IMAGE=false`) | — |
|
||||
| ветка `stage` | `stage` | `stage` | `0.0.1-stage` | `universal-chart-stage` |
|
||||
| тег (`CI_COMMIT_TAG`) | `production` | `prod` | `0.0.1-prod` | `universal-chart-production` |
|
||||
|
||||
> Правило для ветки `master` → `preprod` присутствует, но **закомментировано**. `NAMESPACE` для всех окружений — `platform`, `RELEASE_NAME`/`CHART_NAME` — `${SERVICE_NAME}`.
|
||||
|
||||
`BUILD_ARGS` прокидывают `--build-arg ENDPOINT=<env>` и `--build-arg NPM_NEXUS_TOKEN=${NPM_NEXUS_TOKEN}`. `HELM_SET_ARGS` устанавливают `universal-chart.services.frontend.image.name.<env>`, `global.env`, а также `commitSha`, `gitlabUri`, `gitlabJobUrl`, `owner`.
|
||||
|
||||
## Замечания и потенциальные проблемы
|
||||
|
||||
- **Обязательные runtime-параметры.** Если в `localStorage` нет `AUTHORITY` или `CLIENT_ID`, `src/config/zitadel.ts` бросает ошибку при инициализации — приложение не стартует. Эти значения должен положить хостовый сервис до загрузки микрофронтенда.
|
||||
- **Нет `.env`.** Приложение не читает dotenv; `process.env.ENDPOINT`/`IS_DEV` существуют только на этапе сборки (замена через `DefinePlugin`). Значение `ENDPOINT` задаётся только через CLI/`--build-arg`/CI.
|
||||
- **publicPath в prod** — `/auth/callback/`: приложение обслуживается nginx под префиксом `/auth/callback`, что согласовано с `redirect_uri` OIDC.
|
||||
- **`silentRenew` отключён** намеренно (`automaticSilentRenew: false`) — обновление токенов не выполняется в фоне.
|
||||
@ -1,80 +0,0 @@
|
||||
# Эндпоинты, с которыми взаимодействует auth-flow-frontend
|
||||
|
||||
Документ описывает внешние эндпоинты, внутренние роуты и каналы межвкладочной коммуникации микрофронтенда аутентификации `auth-flow-frontend`.
|
||||
|
||||
## Как устроено взаимодействие
|
||||
|
||||
Приложение отвечает только за аутентификацию по протоколу **OIDC (Authorization Code Flow + PKCE)**. Прямых REST-запросов к бэкенд-сервисам Sarex у него **нет** — всё сетевое взаимодействие идёт с провайдером идентификации **Zitadel** через обёртку `@sarex-team/sdk-js/zitadel` (поверх `oidc-client`).
|
||||
|
||||
Клиент создаётся в `src/config/zitadel.ts` (`createZitadelAuth(configZitadel)`). Базовый адрес провайдера (`authority`, issuer) и `client_id` берутся из `localStorage` во время работы, а не задаются сборкой. OIDC-клиент сам находит конкретные эндпоинты issuer'а через discovery-документ `/.well-known/openid-configuration`.
|
||||
|
||||
## Провайдер идентификации (Zitadel) по окружениям
|
||||
|
||||
Фактический `authority` подставляется хостовым приложением через `localStorage` (`STORAGE.AUTHORITY`) — в самом `auth-flow-frontend` хосты не захардкожены. Ниже — известные для платформы Sarex значения (справочно):
|
||||
|
||||
| Окружение | `authority` (issuer) |
|
||||
| --- | --- |
|
||||
| `stage` | `https://idp.dev.stage.sarex.io` |
|
||||
| `prod` | `https://login.sarex.io` |
|
||||
|
||||
## OIDC-эндпоинты провайдера
|
||||
|
||||
Обнаруживаются через discovery и вызываются `oidc-client` относительно `authority`. Итоговые пути определяются метаданными issuer'а.
|
||||
|
||||
| Эндпоинт (метаданные) | Метод | Где инициируется | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `/.well-known/openid-configuration` | GET | инициализация `UserManager` | Discovery метаданных провайдера |
|
||||
| `authorization_endpoint` | GET (redirect) | `LoginPage` → `zitadel.authorize()` | Старт авторизации, редирект на форму входа |
|
||||
| `token_endpoint` | POST | `AuthCallbackPage` → `zitadel.userManager.signinCallback()` | Обмен `code` → access/refresh/id токены |
|
||||
| `jwks_uri` | GET | `oidc-client` | Ключи для проверки подписи токенов |
|
||||
| `userinfo_endpoint` | GET | `oidc-client` (при необходимости) | Профиль пользователя |
|
||||
| `end_session_endpoint` | GET (redirect) | `LogoutPage` → `zitadel.signout()` | Завершение сессии (логаут) |
|
||||
|
||||
Параметры OIDC-запросов (из `configZitadel`):
|
||||
|
||||
- `response_type`: `code`
|
||||
- `scope`: `openid profile email offline_access urn:zitadel:iam:user:metadata`
|
||||
- `redirect_uri`: `${window.location.origin}/auth/callback`
|
||||
- `post_logout_redirect_uri`: `${window.location.origin}/login`
|
||||
- `revokeTokensOnSignout`: `false`, `automaticSilentRenew`: `false`
|
||||
|
||||
## Внутренние роуты приложения
|
||||
|
||||
Диспетчеризация — в `src/App.tsx` по `window.location.pathname` (роуты из `src/config/urls.ts`).
|
||||
|
||||
| Роут | Страница | Метод | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `/auth/callback` | `AuthCallbackPage` | — | Обработка OIDC-колбэка: `signinCallback()`, установка токенов, рассылка события в `login_channel`. Дефолт для неизвестных путей |
|
||||
| `/auth/error` | `AuthErrorPage` | — | Отображение ошибки аутентификации (параметры `error`, `error_description`, `state`, `message` из query) |
|
||||
| `/login` | `LoginPage` (dev) | — | Кнопка входа (`zitadel.authorize()`) |
|
||||
| `/logout` | `LogoutPage` (dev) | — | Кнопка выхода (`zitadel.signout()`) |
|
||||
| `/` | `MainPage` (dev) | — | Dev-навигация (login/logout) |
|
||||
| `/ping` | nginx | GET | Healthcheck, отдаёт `{"result": "ok"}` |
|
||||
|
||||
## Поток аутентификации (кратко)
|
||||
|
||||
1. `LoginPage` вызывает `zitadel.authorize()` → редирект на `authorization_endpoint` Zitadel.
|
||||
2. Провайдер возвращает пользователя на `redirect_uri` = `/auth/callback` с `code`.
|
||||
3. `AuthCallbackPage` вызывает `signinCallback()` → обмен `code` на токены через `token_endpoint`.
|
||||
4. Токены сохраняются (`setTokensInfo` → `storage.setAccessToken/setRefreshToken/setIdentityToken`), снимается флаг логаута.
|
||||
5. Результат рассылается остальным вкладкам, происходит закрытие overlay-окна (`window.opener`) или переход на `/` (`HOME`).
|
||||
6. При ошибке — редирект на `/auth/error` с деталями.
|
||||
|
||||
## Межвкладочная и оконная коммуникация
|
||||
|
||||
| Канал | Ключ / имя | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `BroadcastChannel` | `login_channel` | Сообщения `{ type: "login_success" }` и `{ type: "login_error", reason }` между вкладками |
|
||||
| `localStorage` | `sarex_logout` (`LOGOUT_STORAGE_KEY`) | Состояние логаута между вкладками (`logoutAt`, `owner`, `reason`) |
|
||||
| window events | `setTokensInfoIntoWindowEvents` (`@sarex-team/sdk-js`) | Оповещение хостового приложения об обновлении токенов (`reason: "auth_callback"`) |
|
||||
| `window.opener` | — | Режим overlay: после успешного входа окно закрывается (`window.close()`) |
|
||||
|
||||
## Обработка ошибок
|
||||
|
||||
Логика — в `src/utils/authError.ts`; отображение — `AuthErrorPage`.
|
||||
|
||||
- Параметры ошибки читаются из query-строки колбэка: `error`, `error_description`, `state`, `message` (`parseAuthErrorFromSearch`).
|
||||
- Причина ошибки: `error_description` → `message` → `error` → `"Unknown error"` (`getAuthErrorReason`).
|
||||
- URL страницы ошибки собирается `buildAuthErrorUrl` (query из непустых параметров, иначе просто `/auth/error`).
|
||||
- Если контекста ошибки нет — редирект на `/` (`HOME`).
|
||||
- Пользователю доступны кнопки «Скопировать детали ошибки» (`formatAuthErrorForCopy`) и «Вернуться на форму входа» (`/login`), а также ссылка в поддержку `mailto:support@sarex.io`.
|
||||
33
apps/auth-flow/base/deployment.yaml
Normal file
33
apps/auth-flow/base/deployment.yaml
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: frontend
|
||||
namespace: auth-flow
|
||||
labels:
|
||||
app: frontend
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: frontend
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: frontend
|
||||
version: stable
|
||||
spec:
|
||||
containers:
|
||||
- name: frontend
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/auth-flow-frontend:production_48bec2ff
|
||||
imagePullPolicy: IfNotPresent
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 80
|
||||
protocol: TCP
|
||||
resources:
|
||||
requests:
|
||||
cpu: 25m
|
||||
memory: 100Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
@ -1,94 +0,0 @@
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: frontend
|
||||
namespace: auth-flow
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.7"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
frontend:
|
||||
enabled: true
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/auth-flow-frontend:contour_fe9ea2a3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: frontend
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 80
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 25m
|
||||
memory:
|
||||
_default: 100Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: frontend-svc
|
||||
|
||||
type:
|
||||
_default: ClusterIP
|
||||
|
||||
port:
|
||||
_default: 80
|
||||
|
||||
targetPort:
|
||||
_default: 80
|
||||
|
||||
portName:
|
||||
_default: http
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
@ -4,4 +4,5 @@ kind: Kustomization
|
||||
namespace: auth-flow
|
||||
resources:
|
||||
- namespace.yaml
|
||||
- helmrelease.yaml
|
||||
- deployment.yaml
|
||||
- service.yaml
|
||||
|
||||
@ -1,17 +1,15 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: s3-proxy-service
|
||||
namespace: postgresql
|
||||
labels:
|
||||
app: s3-proxy
|
||||
service: s3proxy
|
||||
name: frontend-svc
|
||||
namespace: reviews
|
||||
spec:
|
||||
type: ClusterIP
|
||||
selector:
|
||||
app: s3-proxy
|
||||
app: frontend
|
||||
ports:
|
||||
- name: http
|
||||
port: 80
|
||||
protocol: TCP
|
||||
targetPort: 80
|
||||
protocol: TCP
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: namespace.yaml
|
||||
target:
|
||||
kind: Namespace
|
||||
name: auth-flow
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Namespace
|
||||
metadata:
|
||||
name: auth-flow
|
||||
labels:
|
||||
istio-injection: enabled
|
||||
security.deckhouse.io/pod-policy: privileged
|
||||
@ -6,5 +6,5 @@ resources:
|
||||
patches: []
|
||||
# - path: replicas.yaml
|
||||
# target:
|
||||
# kind: HelmRelease
|
||||
# kind: Deployment
|
||||
# name: frontend
|
||||
|
||||
@ -1,13 +1,8 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: frontend
|
||||
namespace: auth-flow
|
||||
namespace: reviews
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
frontend:
|
||||
deployment:
|
||||
replicaCount:
|
||||
_default: 1
|
||||
replicas: 1
|
||||
|
||||
@ -1,64 +0,0 @@
|
||||
# App
|
||||
# APP_NAME/APP_VERSION/LOG_LEVEL читаются кодом, но в деплой-envs их обычно не задают
|
||||
APP_NAME='BIM Backend v2'
|
||||
APP_VERSION=local
|
||||
LOG_LEVEL=info
|
||||
# Адрес прослушивания HTTP API (host:port)
|
||||
API_ADDRESS=0.0.0.0:5555
|
||||
|
||||
# Master-кластер PostgreSQL (BIM id <= LAST_MASTER_BIM)
|
||||
POSTGRES_ADDRESS=localhost
|
||||
POSTGRES_PORT=5432
|
||||
POSTGRES_USER=user
|
||||
POSTGRES_PASSWORD=password
|
||||
POSTGRES_DB=bimbackendv2
|
||||
POSTGRES_POOL_SIZE=10
|
||||
DB_CERT_PATH=./.docker/yandex_pg.pem
|
||||
|
||||
# Slave-1 кластер PostgreSQL (шардирование по BIM id)
|
||||
POSTGRES_ADDRESS_2=localhost
|
||||
POSTGRES_PORT_2=5433
|
||||
POSTGRES_USER_2=user
|
||||
POSTGRES_PASSWORD_2=password
|
||||
POSTGRES_DB_2=bimbackendv2
|
||||
POSTGRES_POOL_SIZE_2=10
|
||||
DB_CERT_PATH_2=./.docker/yandex_pg.pem
|
||||
|
||||
# Slave-2 кластер PostgreSQL (шардирование по BIM id)
|
||||
POSTGRES_ADDRESS_3=localhost
|
||||
POSTGRES_PORT_3=5434
|
||||
POSTGRES_USER_3=user
|
||||
POSTGRES_PASSWORD_3=password
|
||||
POSTGRES_DB_3=bimbackendv2
|
||||
POSTGRES_POOL_SIZE_3=10
|
||||
DB_CERT_PATH_3=./.docker/yandex_pg.pem
|
||||
|
||||
# Границы шардирования BIM id между кластерами
|
||||
LAST_MASTER_BIM=10
|
||||
LAST_MASTER_BIM_V3=0
|
||||
LAST_SLAVE_1_BIM=0
|
||||
LAST_SLAVE_1_BIM_V3=0
|
||||
|
||||
# TLS до PostgreSQL (0 — локально, 1 — в облаке)
|
||||
ENABLE_SSL=0
|
||||
# Логировать SQL-запросы (1 — включено)
|
||||
ENABLE_SQL_QUERY=1
|
||||
|
||||
# Внешний Django-бэкенд (проверка прав администратора)
|
||||
DJANGO_HOST=https://stage.sarex.io
|
||||
|
||||
# Режим интеграционных тестов (в этом режиме CheckUserIsAdmin всегда true)
|
||||
INTEGRATION_TESTS=0
|
||||
|
||||
# --- Переменные окружения, не читаемые config.go (инфраструктура/тесты/сборка) ---
|
||||
# Проброс портов и локальная БД в docker-compose
|
||||
# API_PORT=5555
|
||||
# POSTGRES_EXTERNAL_PORT=5432
|
||||
# POSTGRES_EXTERNAL_PORT_2=5433
|
||||
# Значения для контейнеров тестов
|
||||
# TEST_ENV=1
|
||||
# TEST_BIM=1
|
||||
# JWT_TEST=<jwt>
|
||||
# Объявлены в .env, но config.go их не использует
|
||||
# GRPC_ADDRESS=0.0.0.0
|
||||
# GRPC_PORT=50051
|
||||
@ -1,189 +0,0 @@
|
||||
# Конфигурация проекта bim-backend-v2
|
||||
|
||||
Документ описывает все переменные окружения и способы конфигурирования сервиса.
|
||||
|
||||
## Способы конфигурирования
|
||||
|
||||
Сервис настраивается **только через переменные окружения**. Разбор выполняется в `config/config.go` (функция `NewConfig`) через библиотеку [`kelseyhightower/envconfig`](https://github.com/kelseyhightower/envconfig) (структура `Config`).
|
||||
|
||||
Особенности разбора:
|
||||
|
||||
- **Префикса нет** — `envconfig.Process("", &cfg)` вызывается с пустым префиксом, поэтому имена переменных задаются как есть (напр. `POSTGRES_ADDRESS`, `API_ADDRESS`). Имя переменной определяется тегом `envconfig:"..."` у каждого поля.
|
||||
- Типы приводятся автоматически по типу поля Go (`string`, `int`, `bool`, `uint64`). Для `bool` подходят `1`/`0`/`true`/`false`.
|
||||
- Ошибка разбора приводит к `panic` при старте (в `NewConfig` `envconfig.Process` завёрнут в `sync.Once`, ошибка не возвращается, а паникует).
|
||||
- Отсутствующая переменная не является ошибкой — поле получает нулевое значение соответствующего типа (пустая строка, `0`, `false`). Обязательность полей не проверяется.
|
||||
|
||||
В отличие от python-сервисов, приложение **загружает `.env` автоматически**: в `cmd/httpserver/main.go` вызывается `godotenv.Load(".env")` (если файла нет — печатается предупреждение и используются переменные окружения процесса).
|
||||
|
||||
Отдельного конфиг-файла (yaml/toml) у приложения нет.
|
||||
|
||||
Источники переменных по способам запуска:
|
||||
|
||||
| Способ запуска | Откуда берутся переменные |
|
||||
| --- | --- |
|
||||
| Локально (бинарник) | Файл `.env` в рабочем каталоге (`godotenv.Load`) либо переменные окружения процесса |
|
||||
| Локально (контейнеры) | `.docker/docker-compose.yml`: `env_file` → `.docker/.env` + `.docker/.docker.env` |
|
||||
| Kubernetes (Helm, репозиторий приложения) | `.helm/values-<env>.yaml`: блоки `envs` (обычные значения) и `secrets` (из k8s-секретов); шаблон `.helm/templates/api.yaml` |
|
||||
| Kubernetes (IaC, этот репозиторий) | `iac/apps/bim/base/backend-deployment.yaml`: блок `env` и секреты из Vault (аннотации `vault.hashicorp.com/*`, шаблон `bim-postgresql`) |
|
||||
| CI/CD (GitLab) | `.gitlab-ci.yml`: подключение общих пайплайнов `generic/common-ci` и переменные `workflow.rules` по ветке/тегу |
|
||||
|
||||
Способы запуска процессов:
|
||||
|
||||
| Команда | Точка входа | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `httpserver` (`make api` → `go install ./cmd/httpserver`) | `cmd/httpserver/main.go` | HTTP API. При старте применяет миграции (`appmigrations.RunOnStartup`), поднимает `net/http/pprof` на `:8081`, затем запускает API на `API_ADDRESS` |
|
||||
| `migrations` (`go install ./cmd/migrations`) | `cmd/migrations/main.go` | Отдельный запуск миграций БД |
|
||||
|
||||
Порядок запуска в контейнере (`.docker/entrypoint.sh`): запускается `/go/bin/httpserver` (строка запуска миграций закомментирована — миграции выполняются самим приложением на старте). Финальный образ (`.docker/api.dockerfile`) — `scratch` со статически слинкованным бинарником `httpserver` и вшитым CA-сертификатом Postgres (`/root/yandex_pg.pem`).
|
||||
|
||||
## Переменные приложения
|
||||
|
||||
Ниже перечислены все переменные, читаемые кодом (`config/config.go`). Префикса нет. Дефолт — это нулевое значение типа Go, если переменная не задана.
|
||||
|
||||
### App
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `APP_NAME` | string | `""` | Имя приложения (в коде помечено TODO — в deploy-envs не задаётся) |
|
||||
| `APP_VERSION` | string | `""` | Версия приложения (TODO — в deploy-envs не задаётся) |
|
||||
| `LOG_LEVEL` | string | `""` | Уровень логирования, передаётся в `logging.NewLogger` (TODO — в deploy-envs не задаётся) |
|
||||
| `API_ADDRESS` | string | `""` | Адрес прослушивания HTTP API в формате `host:port` (напр. `0.0.0.0:8080`) |
|
||||
| `TEST_ENV` | string | `""` | Служебное поле для тестов |
|
||||
|
||||
### PostgreSQL
|
||||
|
||||
Сервис работает с **тремя** кластерами PostgreSQL (master, slave-1, slave-2). Выбор кластера для конкретного BIM выполняется по его id в `internal/app/http/httpserver.go` (сравнение с `LAST_MASTER_BIM*`/`LAST_SLAVE_1_BIM*`). Строка подключения собирается в `Config.GetPostgresConnectionURL` (`postgres://user:password@addr:port/db`, при `ENABLE_SSL=false` добавляется `?sslmode=disable`).
|
||||
|
||||
Master-кластер:
|
||||
|
||||
| Переменная | Тип | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `POSTGRES_ADDRESS` | string | Хост PostgreSQL (master) |
|
||||
| `POSTGRES_PORT` | string | Порт PostgreSQL (master) |
|
||||
| `POSTGRES_USER` | string | Пользователь БД |
|
||||
| `POSTGRES_PASSWORD` | string | Пароль пользователя БД |
|
||||
| `POSTGRES_DB` | string | Имя базы данных |
|
||||
| `POSTGRES_POOL_SIZE` | int | Размер пула соединений |
|
||||
| `DB_CERT_PATH` | string | Путь к CA-сертификату PostgreSQL (используется при `ENABLE_SSL=1`) |
|
||||
|
||||
Slave-1 кластер — те же поля с суффиксом `_2`:
|
||||
|
||||
| Переменная | Тип | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `POSTGRES_ADDRESS_2` | string | Хост PostgreSQL (slave-1) |
|
||||
| `POSTGRES_PORT_2` | string | Порт |
|
||||
| `POSTGRES_USER_2` | string | Пользователь |
|
||||
| `POSTGRES_PASSWORD_2` | string | Пароль |
|
||||
| `POSTGRES_DB_2` | string | База данных |
|
||||
| `POSTGRES_POOL_SIZE_2` | int | Размер пула |
|
||||
| `DB_CERT_PATH_2` | string | Путь к CA-сертификату |
|
||||
|
||||
Slave-2 кластер — те же поля с суффиксом `_3`:
|
||||
|
||||
| Переменная | Тип | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `POSTGRES_ADDRESS_3` | string | Хост PostgreSQL (slave-2) |
|
||||
| `POSTGRES_PORT_3` | string | Порт |
|
||||
| `POSTGRES_USER_3` | string | Пользователь |
|
||||
| `POSTGRES_PASSWORD_3` | string | Пароль |
|
||||
| `POSTGRES_DB_3` | string | База данных |
|
||||
| `POSTGRES_POOL_SIZE_3` | int | Размер пула |
|
||||
| `DB_CERT_PATH_3` | string | Путь к CA-сертификату |
|
||||
|
||||
### Шардирование BIM по кластерам
|
||||
|
||||
| Переменная | Тип | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `LAST_MASTER_BIM` | uint64 | Верхняя граница id BIM для master-кластера (API v1) |
|
||||
| `LAST_MASTER_BIM_V3` | uint64 | Верхняя граница id BIM для master-кластера (API v2 / BIM v3) |
|
||||
| `LAST_SLAVE_1_BIM` | uint64 | Верхняя граница id BIM для slave-1 (API v1) |
|
||||
| `LAST_SLAVE_1_BIM_V3` | uint64 | Верхняя граница id BIM для slave-1 (API v2 / BIM v3) |
|
||||
|
||||
### Прочее
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ENABLE_SSL` | bool | `false` | Подключение к PostgreSQL по TLS. При `false` в DSN добавляется `sslmode=disable` |
|
||||
| `ENABLE_SQL_QUERY` | bool | `false` | Логировать SQL-запросы |
|
||||
| `DJANGO_HOST` | string | `""` | Базовый URL Django-бэкенда для проверки прав администратора (см. `ENDPOINTS.md`) |
|
||||
| `INTEGRATION_TESTS` | bool | `false` | Режим интеграционных тестов. При `true` `CheckUserIsAdmin` всегда возвращает `true` |
|
||||
|
||||
## Переменные, не читаемые приложением (инфраструктура/сборка/тесты)
|
||||
|
||||
Присутствуют в `.docker/.env`, `.docker/.docker.env`, `docker-compose.yml` или Helm, но `config/config.go` их не разбирает.
|
||||
|
||||
| Переменная | Где используется | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `API_PORT` | `.docker/.env` | Порт API для локального compose |
|
||||
| `POSTGRES_EXTERNAL_PORT`, `POSTGRES_EXTERNAL_PORT_2` | `docker-compose.yml` | Проброс портов контейнеров Postgres |
|
||||
| `POSTGRES_ADDRESS2` | `.docker/.docker.env` | Опечатка/легаси (нет суффикса `_`), кодом не читается |
|
||||
| `GRPC_ADDRESS`, `GRPC_PORT` | `.docker/.env` | Объявлены, но кодом не используются |
|
||||
| `TEST_BIM`, `JWT_TEST` | `.docker/.env`, `.docker/.docker.env` | Данные для интеграционных тестов |
|
||||
| `POSTGRES_*_4`, `DB_CERT_PATH_4` | `.helm/values-*.yaml`, IaC `backend-deployment.yaml` | Четвёртый кластер задаётся в деплое, но `config.go` доходит только до суффикса `_3` |
|
||||
| `LAST_SLAVE_2_BIM(_V3)`, `LAST_SLAVE_3_BIM(_V3)`, `LAST_SLAVE_4_BIM(_V3)` | `.helm/values-*.yaml` | Заданы в values, но кодом не читаются (актуальны только `LAST_MASTER_*` и `LAST_SLAVE_1_*`) |
|
||||
| `CI_COMMIT_SHORT_SHA` | `.gitlab-ci.yml` (build-arg) | Тег/версия сборки образа |
|
||||
|
||||
## Переменные из Helm-чарта приложения (`.helm/values-<env>.yaml`)
|
||||
|
||||
Обычные значения задаются в блоке `envs` для каждого окружения (`stage`/`preprod`/`production`) и содержат те же переменные `POSTGRES_*`, `API_ADDRESS`, `DJANGO_HOST`, `ENABLE_SSL`, `ENABLE_SQL_QUERY`, `LAST_*`, что описаны выше (различаются адресами БД, размерами пула, границами шардирования и доменом Django).
|
||||
|
||||
Значения из секретов (блок `secrets`, монтируются как env через `secretKeyRef`):
|
||||
|
||||
| Переменная | Секрет (`secret_name`) | Ключ (`secret_key`) |
|
||||
| --- | --- | --- |
|
||||
| `POSTGRES_USER` | `bim-v2-database-secret` | `username` |
|
||||
| `POSTGRES_PASSWORD` | `bim-v2-database-secret` | `password` |
|
||||
| `POSTGRES_USER_2` | `bim-v2-database-secret-2` | `username` |
|
||||
| `POSTGRES_PASSWORD_2` | `bim-v2-database-secret-2` | `password` |
|
||||
| `POSTGRES_USER_3` | `bim-v2-database-secret-3` | `username` |
|
||||
| `POSTGRES_PASSWORD_3` | `bim-v2-database-secret-3` | `password` |
|
||||
| `POSTGRES_USER_4` | `bim-v2-database-secret-3` | `username` |
|
||||
| `POSTGRES_PASSWORD_4` | `bim-v2-database-secret-3` | `password` |
|
||||
|
||||
Ключевые не-env значения чарта: `api.name`, `api.image`, `api.version`, `api.port` (`8080`), `api.replicas`, `api.service_name`/`api.service_port` (`80`), `api.service_account`, `api.requests.memory`/`cpu`, `api.api_host`, `api.api_host_prefix` (`/bimv2/api/`), `api.api_path` (`/api/`), `api.internal_path` (`/internal/`), `api.permitted_ns` (namespace'ы, которым разрешён доступ к `/internal/*`), `imagePullSecrets`.
|
||||
|
||||
Сетевой слой (`.helm/templates/mesh-config.yaml`, Istio):
|
||||
|
||||
- `VirtualService` (при `api.virtual_service.enabled`) маршрутизирует `api_host_prefix` → `api_path`, задаёт CORS (`allowOrigins` — `*.sarex.io` и `localhost`, `allowHeaders` включают `Authorization`, `Content-Type`, `Identity`).
|
||||
- `AuthorizationPolicy` `routes-v2`: доступ к `/api/*` разрешён только от istio-ingressgateway при наличии claim `token_type=access`; доступ к `/internal/*` — только из namespace'ов `api.permitted_ns`.
|
||||
|
||||
## Переменные из IaC-репозитория (`iac/apps/bim/`)
|
||||
|
||||
Деплой в этом репозитории (kustomize) устроен иначе, чем чарт приложения:
|
||||
|
||||
- `base/backend-deployment.yaml` — Deployment `backend` в namespace `bim`, образ `bim-api`, `containerPort: 8000`, `API_ADDRESS=0.0.0.0:8000`, health-проба `GET /ping`.
|
||||
- Секреты PostgreSQL инъектируются **из Vault** (аннотации `vault.hashicorp.com/*`, роль `bim`, путь `secrets/data/postgresql/apps/bim`) в файл `/vault/secrets/bim-postgresql`, который экспортируется в окружение перед запуском (`set -a; . /vault/secrets/bim-postgresql; set +a; exec ./httpserver`). Шаблон Vault задаёт `POSTGRES_ADDRESS[_2../_4]`, `POSTGRES_PORT*`, `POSTGRES_DB*` (все указывают на `postgresql.bim.svc.cluster.local:5432`, БД `bim_db`) и `POSTGRES_USER*`/`POSTGRES_PASSWORD*` из Vault.
|
||||
- Прочие env заданы прямо в манифесте: `LAST_MASTER_BIM`, `LAST_MASTER_BIM_V3`, `LAST_SLAVE_1_BIM`, `POSTGRES_POOL_SIZE`, `DB_CERT_PATH_2/3/4`, `DJANGO_HOST` (`http://backend.django.svc.cluster.local:8000`), `ENABLE_SQL_QUERY=0`, `ENABLE_SSL=0`.
|
||||
- Оверлеи `brusnika-prod`, `brusnika-stage`, `yc-k8s-test` патчат base (реплики, образ, postgresql).
|
||||
|
||||
## Переменные в CI (`.gitlab-ci.yml`)
|
||||
|
||||
Пайплайн подключает общие шаблоны `generic/common-ci` (`universal-pipeline-<env>.yaml`, `common-security-scan.yaml`, `common-build.yaml`) и переключает окружение по ветке/тегу через `workflow.rules`:
|
||||
|
||||
| Условие | STAND | Namespace |
|
||||
| --- | --- | --- |
|
||||
| ветка `master` | `preprod` | `bim-api-preprod` |
|
||||
| ветка `stage` | `stage` | `bim-api-stage` |
|
||||
| тег (`CI_COMMIT_TAG`) | `prod` | `bim-api-prod` |
|
||||
|
||||
Общие переменные job'ов: `RELEASE_NAME=bim-backend-v2`, `CHART_NAME=bim-backend-v2`, `CHART_VERSION=0.0.1-<stand>`, `IMAGE_PATH=api.image`, `DOCKERFILE_PATH=.docker/api.dockerfile`, `HELM_SET_ARGS=--set api.image=${IMAGE_NAME}`, `BUILD_ARGS=--build-arg CI_COMMIT_SHORT_SHA=...`, флаги `ENABLE_BUILD_CHART`/`ENABLE_BUILD_IMAGE`/`ENABLE_STATE_UPDATE`/`ENABLE_DEPLOY=true`, `ENABLE_LINTER=false`. Стадии: `linter → test → unittest → prebuild-secscan → build → state-update → deploy`.
|
||||
|
||||
## Замечания и потенциальные проблемы
|
||||
|
||||
- Переменные разбираются **без префикса** (`envconfig.Process("", ...)`) — имена совпадают с тегами `envconfig` полей структуры `Config`.
|
||||
- Обязательность полей не валидируется: отсутствующая переменная молча получает нулевое значение. Например пустой `API_ADDRESS` приведёт к попытке слушать на `":0"`.
|
||||
- В коде объявлены только три кластера (`POSTGRES_*`, `_2`, `_3`), тогда как в деплое присутствует и четвёртый (`_4`). Переменные `_4` и дополнительные `LAST_SLAVE_2/3/4_*` в окружении задаются, но приложением не используются.
|
||||
- Приложение загружает `.env` автоматически (`godotenv.Load(".env")`); при отсутствии файла ошибки нет — берутся переменные процесса.
|
||||
- В `NewConfig` ошибка `envconfig.Process` не возвращается, а вызывает `panic` (обёрнута в `sync.Once`).
|
||||
|
||||
## Минимальный набор для локального запуска
|
||||
|
||||
Postgres поднимается через `docker-compose` (`.docker/docker-compose.yml`), приложение — через `make api` и запуск `httpserver`. Минимально необходимо задать (готовые примеры — в `.env.example`):
|
||||
|
||||
- `API_ADDRESS`
|
||||
- Master-кластер: `POSTGRES_ADDRESS`, `POSTGRES_PORT`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`, `POSTGRES_POOL_SIZE`
|
||||
- Slave-кластеры `_2` и `_3` (те же поля) — сервис создаёт соединения ко всем трём при старте
|
||||
- `ENABLE_SSL=0`, `DB_CERT_PATH*` (при `ENABLE_SSL=1`)
|
||||
- `DJANGO_HOST`
|
||||
- `LAST_MASTER_BIM`, `LAST_MASTER_BIM_V3`, `LAST_SLAVE_1_BIM`, `LAST_SLAVE_1_BIM_V3`
|
||||
- `INTEGRATION_TESTS=0`, `ENABLE_SQL_QUERY` по необходимости
|
||||
@ -1,55 +0,0 @@
|
||||
# Эндпоинты, с которыми взаимодействует bim-backend-v2
|
||||
|
||||
Документ описывает все HTTP-эндпоинты внешних сервисов, к которым обращается сам сервис `bim-backend-v2` (исходящие вызовы). Эндпоинты, которые сервис **предоставляет**, описаны в `openapi.yaml`.
|
||||
|
||||
## Как устроено взаимодействие
|
||||
|
||||
Исходящие вызовы выполняются HTTP-клиентом на базе [`go-resty/resty`](https://github.com/go-resty/resty) в пакете `pkg/django_client` (`DjangoClient`). Клиент создаётся в `NewRestClient`:
|
||||
|
||||
- базовый хост — `SetHostURL(cfg.DjangoHost)` (переменная `DJANGO_HOST`);
|
||||
- таймаут запроса — `SetTimeout(10 * time.Second)`;
|
||||
- число повторов — `SetRetryCount(5)`.
|
||||
|
||||
Аутентификация проксируется: JWT пользователя извлекается из контекста запроса (`auth.JWTFromContext`), при необходимости отбрасывается схема `Bearer `, и токен передаётся во внешний сервис заголовком `Authorization: Bearer <jwt>` (`SetAuthToken` + `SetAuthScheme("Bearer")`). Заголовок `Content-Type: application/json`.
|
||||
|
||||
В режиме интеграционных тестов (`INTEGRATION_TESTS=1`) внешний вызов не выполняется — `CheckUserIsAdmin` возвращает `true`.
|
||||
|
||||
## Базовые хосты по сервисам и окружениям
|
||||
|
||||
Значение берётся из переменной `DJANGO_HOST` (см. `CONFIGURATION.md`). Итоговый URL = `<DJANGO_HOST>` + `path` эндпоинта.
|
||||
|
||||
| Сервис | Назначение | Значение `DJANGO_HOST` |
|
||||
| --- | --- | --- |
|
||||
| `django` (Sarex backend) | Проверка прав пользователя (админ/не админ) | локально/`stage`: `https://stage.sarex.io`; `preprod`: `https://lk.preprod.sarex.io`; `prod`: `https://lk.sarex.io`; контур (IaC): `http://backend.django.svc.cluster.local:8000` |
|
||||
|
||||
## Эндпоинты по сервисам
|
||||
|
||||
### `django` — Sarex backend
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| GET | `api/client/settings/` | Получить настройки текущего пользователя. Используется поле `is_admin` (проверка прав администратора в `CheckUserIsAdmin`) |
|
||||
|
||||
Детали вызова `GET api/client/settings/`:
|
||||
|
||||
| Параметр | Значение |
|
||||
| --- | --- |
|
||||
| Заголовки | `Authorization: Bearer <jwt пользователя>`, `Content-Type: application/json` |
|
||||
| Тело запроса | нет |
|
||||
| Ожидаемый ответ | `{ "is_admin": bool }` (структура `userSettingsFromDjango`) |
|
||||
| Успешные статусы | `200`, `201` |
|
||||
| Поведение при ошибке | Любая ошибка транспорта, `resp == nil` или статус вне `200/201` логируется, метод трактует пользователя как **не администратора** (`false`) |
|
||||
|
||||
## Где используется
|
||||
|
||||
Проверка `CheckUserIsAdmin` вызывается в обработчиках, изменяющих модели статусов (требуют прав администратора). При отсутствии прав такие эндпоинты возвращают `403 No admin rights`:
|
||||
|
||||
- `POST /api/v1/bims/{bim_id}/status_model` — создание модели статусов BIM;
|
||||
- `DELETE /api/v1/bims/{bim_id}/delete_status_model` — удаление модели статусов BIM;
|
||||
- `POST /api/v1/companies/{company_id}/status_model` — создание модели статусов компании;
|
||||
- `DELETE /api/v1/companies/{company_id}/status_model` — удаление модели статусов компании.
|
||||
|
||||
## Замечания
|
||||
|
||||
- Единственная внешняя HTTP-зависимость сервиса — Django-бэкенд (`DJANGO_HOST`). Прочие интеграции (PostgreSQL, pprof) не являются HTTP-вызовами к внешним REST-сервисам.
|
||||
- Подпись JWT самим сервисом не проверяется — проброшенный токен просто пересылается в Django, который и выполняет авторизацию (см. также раздел «Аутентификация» в `openapi.yaml`).
|
||||
108
apps/bim/base/backend-deployment.yaml
Normal file
108
apps/bim/base/backend-deployment.yaml
Normal file
@ -0,0 +1,108 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: backend
|
||||
namespace: bim
|
||||
labels:
|
||||
app: backend
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: backend
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: backend
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: bim
|
||||
vault.hashicorp.com/agent-inject-secret-bim-postgresql: secrets/data/postgresql/apps/bim
|
||||
vault.hashicorp.com/agent-inject-template-bim-postgresql: |-
|
||||
{{- with secret "secrets/data/postgresql/apps/bim" -}}
|
||||
POSTGRES_ADDRESS=postgresql.bim.svc.cluster.local
|
||||
POSTGRES_ADDRESS_2=postgresql.bim.svc.cluster.local
|
||||
POSTGRES_ADDRESS_3=postgresql.bim.svc.cluster.local
|
||||
POSTGRES_ADDRESS_4=postgresql.bim.svc.cluster.local
|
||||
POSTGRES_PORT=5432
|
||||
POSTGRES_PORT_2=5432
|
||||
POSTGRES_PORT_3=5432
|
||||
POSTGRES_PORT_4=5432
|
||||
POSTGRES_DB=bim_db
|
||||
POSTGRES_DB_2=bim_db
|
||||
POSTGRES_DB_3=bim_db
|
||||
POSTGRES_DB_4=bim_db
|
||||
POSTGRES_USER={{ index .Data.data "username" }}
|
||||
POSTGRES_USER_2={{ index .Data.data "username" }}
|
||||
POSTGRES_USER_3={{ index .Data.data "username" }}
|
||||
POSTGRES_USER_4={{ index .Data.data "username" }}
|
||||
POSTGRES_PASSWORD={{ index .Data.data "password" }}
|
||||
POSTGRES_PASSWORD_2={{ index .Data.data "password" }}
|
||||
POSTGRES_PASSWORD_3={{ index .Data.data "password" }}
|
||||
POSTGRES_PASSWORD_4={{ index .Data.data "password" }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
serviceAccountName: bim-vault
|
||||
containers:
|
||||
- name: backend
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/bim-api:contour_3d704fef
|
||||
imagePullPolicy: IfNotPresent
|
||||
command: ["/bin/sh", "-ec"]
|
||||
args:
|
||||
- |
|
||||
set -a
|
||||
[ -f /vault/secrets/bim-postgresql ] && . /vault/secrets/bim-postgresql
|
||||
set +a
|
||||
exec ./httpserver
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: LAST_MASTER_BIM
|
||||
value: "100000"
|
||||
- name: LAST_MASTER_BIM_V3
|
||||
value: "100000"
|
||||
- name: DB_CERT_PATH_4
|
||||
value: /root/yandex_pg.pem
|
||||
- name: DB_CERT_PATH_3
|
||||
value: /root/yandex_pg.pem
|
||||
- name: DB_CERT_PATH_2
|
||||
value: /root/yandex_pg.pem
|
||||
- name: LAST_SLAVE_1_BIM
|
||||
value: "1000000"
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value: "30"
|
||||
- name: API_ADDRESS
|
||||
value: 0.0.0.0:8000
|
||||
- name: DJANGO_HOST
|
||||
value: http://backend.django.svc.cluster.local:8000
|
||||
- name: ENABLE_SQL_QUERY
|
||||
value: "0"
|
||||
- name: ENABLE_SSL
|
||||
value: "0"
|
||||
resources:
|
||||
requests:
|
||||
cpu: 25m
|
||||
memory: 100Mi
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: /ping
|
||||
port: 8000
|
||||
initialDelaySeconds: 10
|
||||
periodSeconds: 60
|
||||
failureThreshold: 10
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /ping
|
||||
port: 8000
|
||||
initialDelaySeconds: 5
|
||||
periodSeconds: 5
|
||||
failureThreshold: 20
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
15
apps/bim/base/backend-service.yaml
Normal file
15
apps/bim/base/backend-service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: backend-svc
|
||||
namespace: bim
|
||||
spec:
|
||||
type: ClusterIP
|
||||
selector:
|
||||
app: backend
|
||||
ports:
|
||||
- name: http
|
||||
port: 80
|
||||
targetPort: 8000
|
||||
protocol: TCP
|
||||
@ -1,222 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: backend
|
||||
namespace: bim
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
backend:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: bim-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/bim-api:contour_f9f2a39-dirty
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: backend
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8000
|
||||
|
||||
command:
|
||||
_default: ["/bin/sh", "-ec"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -a
|
||||
[ -f /vault/secrets/bim-postgresql ] && . /vault/secrets/bim-postgresql
|
||||
set +a
|
||||
exec ./httpserver
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 25m
|
||||
memory:
|
||||
_default: 100Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled:
|
||||
_default: true
|
||||
type:
|
||||
_default: httpGet
|
||||
httpGet:
|
||||
path:
|
||||
_default: /ping
|
||||
port:
|
||||
_default: 8000
|
||||
initialDelaySeconds:
|
||||
_default: 10
|
||||
periodSeconds:
|
||||
_default: 60
|
||||
failureThreshold:
|
||||
_default: 10
|
||||
readiness:
|
||||
enabled:
|
||||
_default: true
|
||||
type:
|
||||
_default: httpGet
|
||||
httpGet:
|
||||
path:
|
||||
_default: /ping
|
||||
port:
|
||||
_default: 8000
|
||||
initialDelaySeconds:
|
||||
_default: 5
|
||||
periodSeconds:
|
||||
_default: 5
|
||||
failureThreshold:
|
||||
_default: 20
|
||||
|
||||
service:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: backend-svc
|
||||
|
||||
type:
|
||||
_default: ClusterIP
|
||||
|
||||
port:
|
||||
_default: 80
|
||||
|
||||
targetPort:
|
||||
_default: 8000
|
||||
|
||||
portName:
|
||||
_default: http
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: LAST_MASTER_BIM
|
||||
value:
|
||||
_default: "100000"
|
||||
|
||||
- name: LAST_MASTER_BIM_V3
|
||||
value:
|
||||
_default: "100000"
|
||||
|
||||
- name: DB_CERT_PATH_4
|
||||
value:
|
||||
_default: "/root/yandex_pg.pem"
|
||||
|
||||
- name: DB_CERT_PATH_3
|
||||
value:
|
||||
_default: "/root/yandex_pg.pem"
|
||||
|
||||
- name: DB_CERT_PATH_2
|
||||
value:
|
||||
_default: "/root/yandex_pg.pem"
|
||||
|
||||
- name: LAST_SLAVE_1_BIM
|
||||
value:
|
||||
_default: "1000000"
|
||||
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value:
|
||||
_default: "30"
|
||||
|
||||
- name: API_ADDRESS
|
||||
value:
|
||||
_default: "0.0.0.0:8000"
|
||||
|
||||
- name: DJANGO_HOST
|
||||
value:
|
||||
_default: "http://backend-svc.django.svc.cluster.local:80"
|
||||
|
||||
- name: ENABLE_SQL_QUERY
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: ENABLE_SSL
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: bim
|
||||
vault.hashicorp.com/agent-inject-secret-bim-postgresql: secrets/data/apps/bim/postgres
|
||||
vault.hashicorp.com/agent-inject-template-bim-postgresql: |-
|
||||
{{- with secret "secrets/data/apps/bim/postgres" -}}
|
||||
POSTGRES_ADDRESS={{ index .Data.data "host" }}
|
||||
POSTGRES_ADDRESS_2={{ index .Data.data "host" }}
|
||||
POSTGRES_ADDRESS_3={{ index .Data.data "host" }}
|
||||
POSTGRES_ADDRESS_4={{ index .Data.data "host" }}
|
||||
POSTGRES_ADDRESS_5={{ index .Data.data "host" }}
|
||||
POSTGRES_PORT={{ index .Data.data "port" }}
|
||||
POSTGRES_PORT_2={{ index .Data.data "port" }}
|
||||
POSTGRES_PORT_3={{ index .Data.data "port" }}
|
||||
POSTGRES_PORT_4={{ index .Data.data "port" }}
|
||||
POSTGRES_PORT_5={{ index .Data.data "port" }}
|
||||
POSTGRES_DB={{ index .Data.data "database" }}
|
||||
POSTGRES_DB_2={{ index .Data.data "database" }}
|
||||
POSTGRES_DB_3={{ index .Data.data "database" }}
|
||||
POSTGRES_DB_4={{ index .Data.data "database" }}
|
||||
POSTGRES_DB_5={{ index .Data.data "database" }}
|
||||
POSTGRES_USER={{ index .Data.data "username" }}
|
||||
POSTGRES_USER_2={{ index .Data.data "username" }}
|
||||
POSTGRES_USER_3={{ index .Data.data "username" }}
|
||||
POSTGRES_USER_4={{ index .Data.data "username" }}
|
||||
POSTGRES_USER_5={{ index .Data.data "username" }}
|
||||
POSTGRES_PASSWORD={{ index .Data.data "password" }}
|
||||
POSTGRES_PASSWORD_2={{ index .Data.data "password" }}
|
||||
POSTGRES_PASSWORD_3={{ index .Data.data "password" }}
|
||||
POSTGRES_PASSWORD_4={{ index .Data.data "password" }}
|
||||
POSTGRES_PASSWORD_5={{ index .Data.data "password" }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
@ -4,4 +4,6 @@ kind: Kustomization
|
||||
namespace: bim
|
||||
resources:
|
||||
- namespace.yaml
|
||||
- backend.yaml
|
||||
- serviceaccount.yaml
|
||||
- backend-deployment.yaml
|
||||
- backend-service.yaml
|
||||
|
||||
5
apps/bim/base/serviceaccount.yaml
Normal file
5
apps/bim/base/serviceaccount.yaml
Normal file
@ -0,0 +1,5 @@
|
||||
apiVersion: v1
|
||||
kind: ServiceAccount
|
||||
metadata:
|
||||
name: bim-vault
|
||||
namespace: bim
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: namespace.yaml
|
||||
target:
|
||||
kind: Namespace
|
||||
name: bim
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Namespace
|
||||
metadata:
|
||||
name: bim
|
||||
labels:
|
||||
istio-injection: enabled
|
||||
security.deckhouse.io/pod-policy: privileged
|
||||
@ -1,98 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: backend
|
||||
namespace: bim
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
backend:
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/bim-backend-v2:1d961a7b125ae0e69bd5717658d927091d8c05cc
|
||||
|
||||
envs:
|
||||
- name: LAST_MASTER_BIM
|
||||
value:
|
||||
_default: "100000"
|
||||
|
||||
- name: LAST_SLAVE_1_BIM
|
||||
value:
|
||||
_default: "94015"
|
||||
|
||||
- name: LAST_MASTER_BIM_V3
|
||||
value:
|
||||
_default: "100000"
|
||||
|
||||
- name: LAST_SLAVE_1_BIM_V3
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: DB_CERT_PATH_3
|
||||
value:
|
||||
_default: "/root/yandex_pg.pem"
|
||||
|
||||
- name: POSTGRES_ADDRESS_3
|
||||
value:
|
||||
_default: "postgres-service"
|
||||
|
||||
- name: POSTGRES_PORT_3
|
||||
value:
|
||||
_default: "5432"
|
||||
|
||||
- name: POSTGRES_DB_3
|
||||
value:
|
||||
_default: "bimapidb"
|
||||
|
||||
- name: DB_CERT_PATH_2
|
||||
value:
|
||||
_default: "/root/yandex_pg.pem"
|
||||
|
||||
- name: POSTGRES_ADDRESS_2
|
||||
value:
|
||||
_default: "postgres-service"
|
||||
|
||||
- name: POSTGRES_PORT_2
|
||||
value:
|
||||
_default: "5432"
|
||||
|
||||
- name: POSTGRES_DB_2
|
||||
value:
|
||||
_default: "bimapidb"
|
||||
|
||||
- name: POSTGRES_ADDRESS
|
||||
value:
|
||||
_default: "postgres-service"
|
||||
|
||||
- name: POSTGRES_PORT
|
||||
value:
|
||||
_default: "5432"
|
||||
|
||||
- name: POSTGRES_DB
|
||||
value:
|
||||
_default: "bimapidb"
|
||||
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value:
|
||||
_default: "30"
|
||||
|
||||
- name: API_ADDRESS
|
||||
value:
|
||||
_default: "0.0.0.0:8000"
|
||||
|
||||
- name: DJANGO_HOST
|
||||
value:
|
||||
_default: "http://backend.django.svc.cluster.local:8000"
|
||||
|
||||
- name: ENABLE_SQL_QUERY
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: ENABLE_SSL
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: DB_CERT_PATH_4
|
||||
value:
|
||||
_default: "/root/yandex_pg.pem"
|
||||
@ -1,172 +0,0 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: bim-api
|
||||
namespace: bim
|
||||
labels:
|
||||
app: bim-api
|
||||
spec:
|
||||
progressDeadlineSeconds: 600
|
||||
replicas: 1
|
||||
revisionHistoryLimit: 10
|
||||
selector:
|
||||
matchLabels:
|
||||
app: bim-api
|
||||
strategy:
|
||||
rollingUpdate:
|
||||
maxSurge: 25%
|
||||
maxUnavailable: 25%
|
||||
type: RollingUpdate
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: bim-api
|
||||
spec:
|
||||
containers:
|
||||
- command:
|
||||
- ./entrypoint_api.sh
|
||||
env:
|
||||
- name: JWT_PUBLIC_KEY_PATH
|
||||
value: /etc/sarex/keys/prod.rsa.pub
|
||||
- name: FEATURE_ENABLE_JWT_AUTH
|
||||
value: 'false'
|
||||
- name: FEATURE_ENABLE_SAREX_AUTH
|
||||
value: 'false'
|
||||
- name: FEATURE_ENABLE_WORKSPACES
|
||||
value: 'true'
|
||||
- name: FEATURE_ENABLE_GCLOUD
|
||||
value: 'false'
|
||||
- name: FEATURE_ENABLE_S3
|
||||
value: 'true'
|
||||
- name: S3_BUCKET
|
||||
value: sarex-bim-storage
|
||||
- name: BIM_CURRENT_STORAGE
|
||||
value: s3
|
||||
- name: AWS_DEFAULT_REGION
|
||||
value: ru-central1
|
||||
- name: FEATURE_ENABLE_PROCESSING
|
||||
value: '1'
|
||||
- name: PROCESSING_API_URL
|
||||
value: http://workflows-service.processing.svc.cluster.local:8000/internal
|
||||
- name: PROCESSING_C2M_VERSION
|
||||
value: stable
|
||||
- name: prometheus_multiproc_dir
|
||||
value: /tmp
|
||||
- name: GOOGLE_APPLICATION_CREDENTIALS
|
||||
value: /etc/sarex/google-storage/service_account.json
|
||||
- name: BUNDLE_VERSION
|
||||
value: v1
|
||||
- name: WORKSPACES_API_URL
|
||||
value: http://workspaces-service.workspaces.svc.cluster.local:8000/internal
|
||||
- name: BIM_API_EXTERNAL_HOST_SCHEMA
|
||||
value: https
|
||||
- name: BIM_API_EXTERNAL_HOST
|
||||
value: sarex.uralchem.com
|
||||
- name: BIM_API_INTERNAL_HOST_SCHEMA
|
||||
value: http
|
||||
- name: BIM_API_INTERNAL_HOST
|
||||
value: bim-api-service.bim.svc.cluster.local:5555
|
||||
- name: DB_HOST
|
||||
value: postgres-service-bim-v1
|
||||
- name: DB_PORT
|
||||
value: '5432'
|
||||
- name: MESH_OPTIMIZER_PATH
|
||||
value: gltfpack
|
||||
- name: DEBUG
|
||||
value: '0'
|
||||
- name: STORAGE_SEGMENT
|
||||
value: sarex-production-storage
|
||||
- name: STORAGE_PROJECT
|
||||
value: sarex-production
|
||||
- name: TMP_DIR
|
||||
value: /tmp
|
||||
- name: WEBHOOK_URL
|
||||
value: http://bim-api-service.bim.svc.cluster.local:5555
|
||||
- name: COMPARATOR_API_URL
|
||||
value: http://comparator-api-service.comparator-prod/internal
|
||||
- name: RABBIT_VHOST
|
||||
value: api
|
||||
- name: RABBIT_HOST
|
||||
value: rabbitmq-service.rabbitmq:5672
|
||||
- name: DISABLE_INSTANCING
|
||||
value: '0'
|
||||
- name: DB_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: username
|
||||
name: postgres-secret-bim-v1
|
||||
- name: DB_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: password
|
||||
name: postgres-secret-bim-v1
|
||||
- name: RABBIT_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: username
|
||||
name: rabbitmq-secret
|
||||
- name: RABBIT_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: password
|
||||
name: rabbitmq-secret
|
||||
- name: AWS_ACCESS_KEY_ID
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: key-id
|
||||
name: s3-cred
|
||||
- name: AWS_SECRET_ACCESS_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: access-key
|
||||
name: s3-cred
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/bim-api:870965d1967cd761965029b0480884ab7fa7c951
|
||||
imagePullPolicy: IfNotPresent
|
||||
name: bim-api
|
||||
ports:
|
||||
- containerPort: 5555
|
||||
name: http
|
||||
protocol: TCP
|
||||
- containerPort: 9000
|
||||
name: prom
|
||||
protocol: TCP
|
||||
resources: {}
|
||||
terminationMessagePath: /dev/termination-log
|
||||
terminationMessagePolicy: File
|
||||
volumeMounts:
|
||||
- mountPath: /tmp
|
||||
name: tmp-volume
|
||||
dnsPolicy: ClusterFirst
|
||||
imagePullSecrets:
|
||||
- name: dockerhub
|
||||
nodeSelector:
|
||||
name: generic
|
||||
restartPolicy: Always
|
||||
schedulerName: default-scheduler
|
||||
securityContext: {}
|
||||
serviceAccount: bim-api-sa
|
||||
serviceAccountName: bim-api-sa
|
||||
terminationGracePeriodSeconds: 30
|
||||
volumes:
|
||||
- emptyDir: {}
|
||||
name: tmp-volume
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: bim-api-service
|
||||
namespace: bim
|
||||
labels: {}
|
||||
spec:
|
||||
externalTrafficPolicy: Cluster
|
||||
ports:
|
||||
- name: http
|
||||
nodePort: 31352
|
||||
port: 5555
|
||||
protocol: TCP
|
||||
targetPort: 5555
|
||||
selector:
|
||||
app: bim-api
|
||||
sessionAffinity: None
|
||||
type: NodePort
|
||||
@ -1,146 +0,0 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: bim-worker
|
||||
namespace: bim
|
||||
labels:
|
||||
app: bim-worker
|
||||
spec:
|
||||
progressDeadlineSeconds: 600
|
||||
replicas: 1
|
||||
revisionHistoryLimit: 10
|
||||
selector:
|
||||
matchLabels:
|
||||
app: bim-worker
|
||||
strategy:
|
||||
rollingUpdate:
|
||||
maxSurge: 25%
|
||||
maxUnavailable: 25%
|
||||
type: RollingUpdate
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: bim-worker
|
||||
spec:
|
||||
containers:
|
||||
- command:
|
||||
- ./entrypoint_worker.sh
|
||||
env:
|
||||
- name: JWT_PUBLIC_KEY_PATH
|
||||
value: /etc/sarex/keys/prod.rsa.pub
|
||||
- name: FEATURE_ENABLE_JWT_AUTH
|
||||
value: 'false'
|
||||
- name: FEATURE_ENABLE_SAREX_AUTH
|
||||
value: 'false'
|
||||
- name: FEATURE_ENABLE_WORKSPACES
|
||||
value: 'true'
|
||||
- name: FEATURE_ENABLE_GCLOUD
|
||||
value: 'false'
|
||||
- name: FEATURE_ENABLE_S3
|
||||
value: 'true'
|
||||
- name: S3_BUCKET
|
||||
value: sarex-bim-storage
|
||||
- name: BIM_CURRENT_STORAGE
|
||||
value: s3
|
||||
- name: AWS_DEFAULT_REGION
|
||||
value: ru-central1
|
||||
- name: FEATURE_ENABLE_PROCESSING
|
||||
value: '1'
|
||||
- name: PROCESSING_API_URL
|
||||
value: http://workflows-service.processing.svc.cluster.local:8000/internal
|
||||
- name: PROCESSING_C2M_VERSION
|
||||
value: stable
|
||||
- name: prometheus_multiproc_dir
|
||||
value: /tmp
|
||||
- name: GOOGLE_APPLICATION_CREDENTIALS
|
||||
value: /etc/sarex/google-storage/service_account.json
|
||||
- name: BUNDLE_VERSION
|
||||
value: v1
|
||||
- name: WORKSPACES_API_URL
|
||||
value: http://workspaces-service.workspaces.svc.cluster.local:8000/internal
|
||||
- name: BIM_API_EXTERNAL_HOST_SCHEMA
|
||||
value: https
|
||||
- name: BIM_API_EXTERNAL_HOST
|
||||
value: sarex.dsinv.ru
|
||||
- name: BIM_API_INTERNAL_HOST_SCHEMA
|
||||
value: http
|
||||
- name: BIM_API_INTERNAL_HOST
|
||||
value: bim-api-service.bim.svc.cluster.local:5555
|
||||
- name: DB_HOST
|
||||
value: postgres-service-bim-v1
|
||||
- name: DB_PORT
|
||||
value: '5432'
|
||||
- name: MESH_OPTIMIZER_PATH
|
||||
value: gltfpack
|
||||
- name: DEBUG
|
||||
value: '0'
|
||||
- name: STORAGE_SEGMENT
|
||||
value: sarex-production-storage
|
||||
- name: STORAGE_PROJECT
|
||||
value: sarex-production
|
||||
- name: TMP_DIR
|
||||
value: /tmp
|
||||
- name: WEBHOOK_URL
|
||||
value: http://bim-api-service.bim.svc.cluster.local:5555
|
||||
- name: COMPARATOR_API_URL
|
||||
value: http://comparator-api-service.comparator-prod/internal
|
||||
- name: RABBIT_VHOST
|
||||
value: api
|
||||
- name: RABBIT_HOST
|
||||
value: rabbitmq-service.bim:5672
|
||||
- name: DISABLE_INSTANCING
|
||||
value: '0'
|
||||
- name: DB_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: username
|
||||
name: postgres-secret-bim-v1
|
||||
- name: DB_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: password
|
||||
name: postgres-secret-bim-v1
|
||||
- name: RABBIT_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: username
|
||||
name: rabbitmq-secret
|
||||
- name: RABBIT_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: password
|
||||
name: rabbitmq-secret
|
||||
- name: AWS_ACCESS_KEY_ID
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: key-id
|
||||
name: s3-cred
|
||||
- name: AWS_SECRET_ACCESS_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
key: access-key
|
||||
name: s3-cred
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/bim-api:870965d1967cd761965029b0480884ab7fa7c951
|
||||
imagePullPolicy: IfNotPresent
|
||||
name: bim-worker
|
||||
resources: {}
|
||||
terminationMessagePath: /dev/termination-log
|
||||
terminationMessagePolicy: File
|
||||
volumeMounts:
|
||||
- mountPath: /tmp
|
||||
name: tmp-volume
|
||||
dnsPolicy: ClusterFirst
|
||||
imagePullSecrets:
|
||||
- name: dockerhub
|
||||
nodeSelector:
|
||||
name: generic
|
||||
restartPolicy: Always
|
||||
schedulerName: default-scheduler
|
||||
securityContext: {}
|
||||
serviceAccount: bim-worker-sa
|
||||
serviceAccountName: bim-worker-sa
|
||||
terminationGracePeriodSeconds: 30
|
||||
volumes:
|
||||
- emptyDir: {}
|
||||
name: tmp-volume
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: bim
|
||||
resources:
|
||||
- ../base
|
||||
- bim-api.yaml
|
||||
- bim-worker.yaml
|
||||
patches:
|
||||
- path: backend.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
name: backend
|
||||
File diff suppressed because it is too large
Load Diff
@ -7,5 +7,5 @@ resources:
|
||||
patches:
|
||||
- path: replicas.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
kind: Deployment
|
||||
name: backend
|
||||
|
||||
@ -9,7 +9,7 @@ spec:
|
||||
chart:
|
||||
spec:
|
||||
chart: postgresql-contour
|
||||
version: "13.0.15"
|
||||
version: "13.0.8"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
@ -45,7 +45,7 @@ spec:
|
||||
image:
|
||||
registry: cr.yandex/crp3ccidau046kdj8g9q
|
||||
repository: contour/postgresql
|
||||
tag: 13.0.15
|
||||
tag: 13.0.8
|
||||
pullPolicy: Always
|
||||
metrics:
|
||||
enabled: false
|
||||
@ -104,7 +104,7 @@ spec:
|
||||
contour:
|
||||
enabled: true
|
||||
adminUser: "postgres"
|
||||
sharedPreloadLibraries: ""
|
||||
sharedPreloadLibraries: "pg_stat_statements,uuid-ossp,ltree,timescaledb"
|
||||
vault:
|
||||
enabled: true
|
||||
role: postgresql
|
||||
|
||||
@ -1,13 +1,8 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: backend
|
||||
namespace: bim
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
backend:
|
||||
deployment:
|
||||
replicaCount:
|
||||
_default: 1
|
||||
replicas: 1
|
||||
|
||||
@ -1,80 +0,0 @@
|
||||
# =============================================================================
|
||||
# cde-orchestration-demo (Оркестратор) — пример переменных окружения
|
||||
#
|
||||
# Разбор переменных: github.com/sethvargo/go-envconfig.
|
||||
# Файл .env подгружается через godotenv (флаг -env-file, по умолчанию `.env`).
|
||||
# Глобального префикса у переменных НЕТ (в отличие от других сервисов Sarex).
|
||||
# Вложенные секции задаются префиксом в env-тегах (напр. DATABASE_URL).
|
||||
#
|
||||
# Значения ниже — примеры и значения по умолчанию из кода. Секреты (ключи,
|
||||
# пароли, токены) оставлены пустыми — заполните собственными.
|
||||
# Один и тот же .env используется всеми бинарниками (см. docker-compose.yml),
|
||||
# но каждый бинарник читает только нужное ему подмножество (см. CONFIGURATION.md).
|
||||
# =============================================================================
|
||||
|
||||
# --- Общие ---
|
||||
ENVIRONMENT=production
|
||||
LOG_LEVEL=info # cmd/http: default=info; воркеры: default=debug
|
||||
IS_CONTOUR=false
|
||||
|
||||
# --- HTTP-сервер (cmd/http) ---
|
||||
ADDRESS=:8080
|
||||
PROCESS_CACHE_TTL=60
|
||||
PROCESS_CACHE_CLEAR_INTERVAL=60
|
||||
PUBLIC_KEY= # PEM RSA public key для проверки JWT (обязателен для http)
|
||||
OPERATE_URL= # Базовый URL Camunda Operate/REST
|
||||
SAREX_BACKEND_BASE_URL=https://stage.sarex.io
|
||||
|
||||
# --- Camunda ---
|
||||
CAMUNDA_KEYCLOAK_URL=
|
||||
CAMUNDA_CLIENT_ID=operate # только cmd/http
|
||||
CAMUNDA_CLIENT_SECRET=identity-secret-for-components # только cmd/http
|
||||
CAMUNDA_PROCESS_DEFINITION_ID=actionsOnApproval # только cmd/http
|
||||
|
||||
# --- Zeebe ---
|
||||
ZEEBE_GATEWAY=
|
||||
ZEEBE_CLIENT_ID=zeebe
|
||||
ZEEBE_CLIENT_SECRET=identity-secret-for-components
|
||||
ZEEBE_WORKER_JOB_TYPE=markDocuments # у каждого воркера своё значение по умолчанию (см. CONFIGURATION.md)
|
||||
|
||||
# --- Database (PostgreSQL) ---
|
||||
DATABASE_URL=
|
||||
DATABASE_POOL_SIZE=10
|
||||
|
||||
# --- S3 ---
|
||||
S3_ENDPOINT_URL=https://storage.yandexcloud.net
|
||||
S3_ACCESS_KEY_ID=
|
||||
S3_SECRET_ACCESS_KEY=
|
||||
S3_PARTITION_ID=yc
|
||||
S3_SIGNING_REGION=ru-central1
|
||||
|
||||
# --- Auth (без префикса) ---
|
||||
AUTH_HOST=
|
||||
USERNAME=
|
||||
PASSWORD=
|
||||
|
||||
# --- Flows (сервис рабочих процессов) ---
|
||||
FLOWS_URL=
|
||||
FLOWS_INTERNAL_URL=
|
||||
|
||||
# --- Workspaces ---
|
||||
WORKSPACES_URL=
|
||||
|
||||
# --- Workflows (используется воркером split_pdf) ---
|
||||
WORKFLOWS_HOST=
|
||||
WORKFLOWS_IMAGE_TAG=latest
|
||||
|
||||
# --- System log ---
|
||||
SYSTEM_LOG_URL=
|
||||
|
||||
# --- Telegram (алертинг воркеров) ---
|
||||
TELEGRAM_TOKEN=
|
||||
TELEGRAM_ALERT_GROUP_ID=
|
||||
TELEGRAM_DEBUG=false
|
||||
|
||||
# --- AMQP / RabbitMQ (markings v2, copy v2) ---
|
||||
AMQP_HOST=
|
||||
AMQP_PORT=
|
||||
AMQP_USER=
|
||||
AMQP_PASSWORD=
|
||||
AMQP_PATH_API=
|
||||
@ -1,215 +0,0 @@
|
||||
# Конфигурация проекта cde-orchestration-demo (Оркестратор)
|
||||
|
||||
Документ описывает все переменные окружения и способы конфигурирования сервиса.
|
||||
|
||||
## Способы конфигурирования
|
||||
|
||||
Сервис настраивается **только через переменные окружения**. Разбор выполняется библиотекой [`github.com/sethvargo/go-envconfig`](https://github.com/sethvargo/go-envconfig): в каждом бинарнике вызывается `envconfig.Process(ctx, config)` со своей структурой `Config` (см. `internal/app/http/config.go` и `internal/app/worker/*/config.go`).
|
||||
|
||||
Особенности разбора:
|
||||
|
||||
- **Глобального префикса нет** — в отличие от других сервисов Sarex, переменные не имеют общего префикса (напр. просто `LOG_LEVEL`, `DATABASE_URL`).
|
||||
- Вложенные секции задаются тегом `env:", prefix=XXX_"` на поле-структуре. Например поле `Database DatabaseConfig` с `prefix=DATABASE_` и полем `Url` с тегом `env:"URL"` даёт переменную `DATABASE_URL`.
|
||||
- Структура `Auth` **не имеет** тега `prefix`, поэтому её поля читаются без префикса: `AUTH_HOST`, `USERNAME`, `PASSWORD`.
|
||||
- Значения по умолчанию задаются в теге через `default=...`. Отсутствие поля без дефолта не приводит к ошибке `envconfig` (пустое значение), но может привести к падению при инициализации зависимого клиента (напр. пустой `PUBLIC_KEY` вызовет панику при старте http).
|
||||
|
||||
Файл `.env` подгружается через [`github.com/lpernett/godotenv`](https://github.com/lpernett/godotenv): в `main` вызывается `godotenv.Load(*envFileFlag)`, путь задаётся флагом `-env-file` (по умолчанию `.env`). Если файла нет — загрузка пропускается, переменные берутся из окружения процесса.
|
||||
|
||||
Отдельного конфиг-файла (yaml/toml) у приложения нет.
|
||||
|
||||
Источники переменных по способам запуска:
|
||||
|
||||
| Способ запуска | Откуда берутся переменные |
|
||||
| --- | --- |
|
||||
| Локально (бинарник) | Флаг `-env-file` → `.env` (godotenv) и/или переменные окружения процесса |
|
||||
| Локально (docker-compose) | `docker-compose.yml`: у каждого сервиса `env_file: .env` |
|
||||
| Kubernetes (Helm) | `.helm/values.yaml`: блок `envs` (обычные значения) и `secretEnvs` (значения из k8s-секрета `cde-secret`) чарта `universal-chart` |
|
||||
| Kubernetes (kustomize, этот репозиторий) | Vault Agent инжектит секрет `secrets/data/vault/apps/cde` в файл `/vault/secrets/cde-env`, который экспортируется в окружение перед запуском бинарника (`source /vault/secrets/cde-env`) |
|
||||
|
||||
## Бинарники (точки входа)
|
||||
|
||||
| Бинарник | Точка входа | Config | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `http` | `cmd/http/main.go` | `internal/app/http` | HTTP API оркестрации (процессы, подпись, загрузка BPMN) |
|
||||
| `copy` | `cmd/worker/copy/main.go` | `.../worker/copy` | Воркер копирования документов (`copyDocuments`) |
|
||||
| `copyv2` | `cmd/worker/copyv2/main.go` | `.../worker/copyv2` | Копирование документов v2 (`copyDocumentsv2`) |
|
||||
| `create_versions` | `cmd/worker/create_versions/main.go` | `.../worker/create_versions` | Создание версий (`createVersions`) |
|
||||
| `create_versionsv2` | `cmd/worker/create_versionsv2/main.go` | `.../worker/create_versionsv2` | Создание версий v2 (`createVersionsv2`) |
|
||||
| `flows_callback` | `cmd/worker/flows_callback/main.go` | `.../worker/flows_callback` | Обратный вызов в сервис flows (`flowsCallback`) |
|
||||
| `markings` | `cmd/worker/markings/main.go` | `.../worker/markings` | Маркировка документов (`markDocuments`) |
|
||||
| `markingsv2` | `cmd/worker/markingsv2/main.go` | `.../worker/markingsv2` | Маркировка v2 (`markDocumentsv2`) |
|
||||
| `sign` | `cmd/worker/sign/main.go` | `.../worker/sign` | Подпись документов (`signDocuments`) |
|
||||
| `signv2` | `cmd/worker/signv2/main.go` | `.../worker/signv2` | Подпись v2 (`signDocumentsv2`) |
|
||||
| `split_pdf` | `cmd/worker/split_pdf/main.go` | `.../worker/split_pdf` | Разбиение/обработка PDF (`splitPDF`) |
|
||||
| `update_bundles` | `cmd/worker/update_bundles/main.go` | `.../worker/update_bundles` | Обновление бандлов (`updateBundles`) |
|
||||
|
||||
Воркеры — это Zeebe job-workers: они подключаются к Zeebe-gateway и обрабатывают Service Task соответствующего типа (`ZEEBE_WORKER_JOB_TYPE`). HTTP-сервер, помимо приёма запросов, обращается к Camunda Operate/Zeebe (см. `ENDPOINTS.md`).
|
||||
|
||||
## Переменные приложения
|
||||
|
||||
Дефолт `—` означает, что значения по умолчанию нет.
|
||||
|
||||
### Общие (для всех бинарников)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ENVIRONMENT` | string | `production` (у воркеров) | Окружение развёртывания. У `http` не читается |
|
||||
| `LOG_LEVEL` | string | `info` (http) / `debug` (воркеры) | Уровень логирования |
|
||||
| `IS_CONTOUR` | bool | `false` | Режим изолированного контура (влияет на инициализацию S3) |
|
||||
|
||||
### HTTP-сервер (`cmd/http`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ADDRESS` | string | `:8080` | Адрес прослушивания Fiber |
|
||||
| `PROCESS_CACHE_TTL` | int (сек) | `60` | TTL кеша процессов |
|
||||
| `PROCESS_CACHE_CLEAR_INTERVAL` | int (сек) | `60` | Интервал очистки кеша процессов |
|
||||
| `PUBLIC_KEY` | string (PEM) | — | RSA public key для проверки JWT. Обязателен: при пустом/некорректном значении сервис падает при старте |
|
||||
| `OPERATE_URL` | string | — | Базовый URL Camunda Operate/REST |
|
||||
| `SAREX_BACKEND_BASE_URL` | string | — | Базовый URL sarex-backend (проверка MRPA при подписи) |
|
||||
|
||||
### Camunda (`CAMUNDA_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение | Где используется |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `CAMUNDA_KEYCLOAK_URL` | string | — | URL Keycloak для OAuth (Zeebe/Operate) | http + воркеры |
|
||||
| `CAMUNDA_CLIENT_ID` | string | `operate` | Client ID для Operate | только http |
|
||||
| `CAMUNDA_CLIENT_SECRET` | string | `identity-secret-for-components` | Client secret для Operate | только http |
|
||||
| `CAMUNDA_PROCESS_DEFINITION_ID` | string | `actionsOnApproval` | ID определения процесса | только http |
|
||||
|
||||
### Zeebe (`ZEEBE_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ZEEBE_GATEWAY` | string | — | Адрес Zeebe gateway |
|
||||
| `ZEEBE_CLIENT_ID` | string | `zeebe` | Client ID |
|
||||
| `ZEEBE_CLIENT_SECRET` | string | `identity-secret-for-components` | Client secret |
|
||||
| `ZEEBE_WORKER_JOB_TYPE` | string | зависит от воркера | Тип Service Task, который слушает воркер |
|
||||
|
||||
Значения `ZEEBE_WORKER_JOB_TYPE` по умолчанию: `markDocuments` (http/markings), `markDocumentsv2` (markingsv2), `copyDocuments` (copy), `copyDocumentsv2` (copyv2), `createVersions` (create_versions), `createVersionsv2` (create_versionsv2), `flowsCallback` (flows_callback), `signDocuments` (sign), `signDocumentsv2` (signv2), `splitPDF` (split_pdf), `updateBundles` (update_bundles).
|
||||
|
||||
### Database (`DATABASE_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `DATABASE_URL` | string | — | DSN подключения к PostgreSQL (pgx) |
|
||||
| `DATABASE_POOL_SIZE` | int32 | `10` | Размер пула соединений |
|
||||
|
||||
### S3 (`S3_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `S3_ENDPOINT_URL` | string | `https://storage.yandexcloud.net` | Эндпоинт S3 |
|
||||
| `S3_ACCESS_KEY_ID` | string | — | Access key |
|
||||
| `S3_SECRET_ACCESS_KEY` | string | — | Secret key |
|
||||
| `S3_PARTITION_ID` | string | `yc` | Partition ID (aws-sdk-go-v2) |
|
||||
| `S3_SIGNING_REGION` | string | `ru-central1` | Регион для подписи запросов |
|
||||
|
||||
### Auth (без префикса)
|
||||
|
||||
Поле-структура `Auth` не имеет префикса, поэтому переменные читаются напрямую.
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `AUTH_HOST` | string | — | Хост сервиса аутентификации (получение токенов пользователя/админа) |
|
||||
| `USERNAME` | string | — | Логин админ-учётки |
|
||||
| `PASSWORD` | string | — | Пароль админ-учётки |
|
||||
|
||||
### Flows (`FLOWS_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `FLOWS_URL` | string | — | Базовый URL сервиса flows |
|
||||
| `FLOWS_INTERNAL_URL` | string | — | Внутренний URL flows (обновление документов review). Есть только в конфигах `copy`/`copyv2` |
|
||||
|
||||
### Workspaces (`WORKSPACES_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `WORKSPACES_URL` | string | — | URL сервиса рабочих областей (используется воркерами copy/copyv2) |
|
||||
|
||||
### Workflows (`WORKFLOWS_*`)
|
||||
|
||||
Используется воркером `split_pdf`.
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `WORKFLOWS_HOST` | string | — | Хост сервиса workflows |
|
||||
| `WORKFLOWS_IMAGE_TAG` | string | `latest` | Тег docker-образа задач обработки PDF |
|
||||
|
||||
> Container registry (`cr.yandex/crp3ccidau046kdj8g9q`) и флаг `UploadResultsToS3=true` заданы в коде воркера `split_pdf` (`worker.go`), а не через окружение.
|
||||
|
||||
### System log (`SYSTEM_LOG_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `SYSTEM_LOG_URL` | string | — | URL сервиса системных логов (copy, copyv2, create_versions, create_versionsv2) |
|
||||
|
||||
### Telegram (`TELEGRAM_*`)
|
||||
|
||||
Клиент алертинга для воркеров.
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `TELEGRAM_TOKEN` | string | — | Токен бота |
|
||||
| `TELEGRAM_ALERT_GROUP_ID` | int64 | — | ID группы для алертов |
|
||||
| `TELEGRAM_DEBUG` | bool | `false` | Debug-режим бота |
|
||||
|
||||
### AMQP / RabbitMQ (`AMQP_*`)
|
||||
|
||||
Используется воркерами `markingsv2` и `copyv2` (маркировка бандлов через RabbitMQ).
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `AMQP_HOST` | string | — | Хост RabbitMQ |
|
||||
| `AMQP_PORT` | string | — | Порт RabbitMQ |
|
||||
| `AMQP_USER` | string | — | Пользователь |
|
||||
| `AMQP_PASSWORD` | string | — | Пароль |
|
||||
| `AMQP_PATH_API` | string | — | Vhost / путь API в URL подключения |
|
||||
|
||||
## Матрица «переменная → бинарник»
|
||||
|
||||
| Секция | http | copy | copyv2 | create_versions | create_versionsv2 | flows_callback | markings | markingsv2 | sign | signv2 | split_pdf | update_bundles |
|
||||
| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|
||||
| Общие | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
| `ADDRESS`/`PROCESS_CACHE_*` | ✓ | | | | | | | | | | | |
|
||||
| `PUBLIC_KEY`,`OPERATE_URL`,`SAREX_BACKEND_BASE_URL`,`CAMUNDA_CLIENT_*`,`CAMUNDA_PROCESS_DEFINITION_ID` | ✓ | | | | | | | | | | | |
|
||||
| `CAMUNDA_KEYCLOAK_URL`,`ZEEBE_*` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
| `DATABASE_*` | ✓ | ✓ | ✓ | ✓ | ✓ | | ✓ | ✓ | ✓ | ✓ | ✓ | |
|
||||
| `S3_*` | ✓ | ✓ | ✓ | ✓ | ✓ | | | ✓ | ✓ | ✓ | | |
|
||||
| `AUTH_*`/`USERNAME`/`PASSWORD` | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
| `FLOWS_URL` | | ✓ | ✓ | | | ✓ | ✓ | ✓ | ✓ | ✓ | | ✓ |
|
||||
| `FLOWS_INTERNAL_URL` | | ✓ | ✓ | | | | | | | | | |
|
||||
| `WORKSPACES_URL` | | ✓ | ✓ | | | | | | | | | |
|
||||
| `WORKFLOWS_*` | | | | | | | | | | | ✓ | |
|
||||
| `SYSTEM_LOG_URL` | | ✓ | ✓ | ✓ | ✓ | | | | | | | |
|
||||
| `AMQP_*` | | | ✓ | | | | | ✓ | | | | |
|
||||
| `TELEGRAM_*` | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
|
||||
> Матрица построена по структурам `Config` соответствующих бинарников. Наличие поля в структуре не всегда означает, что клиент инициализируется — см. замечания ниже.
|
||||
|
||||
## Переменные в Helm-чарте (`.helm/values.yaml`)
|
||||
|
||||
Обычные значения (блок `envs`):
|
||||
|
||||
| Переменная | Значения по окружениям |
|
||||
| --- | --- |
|
||||
| `SAREX_BACKEND_BASE_URL` | stage: `https://stage.sarex.io`, preprod: `https://preprod.sarex.io`, production: `https://lk.sarex.io` |
|
||||
|
||||
Значения из секрета (блок `secretEnvs`, общий для всех сервисов через якорь `*cde_secret_envs`), берутся из k8s-секрета `cde-secret` одноимёнными ключами: `ENVIRONMENT`, `LOG_LEVEL`, `ZEEBE_GATEWAY`, `DATABASE_URL`, `S3_ENDPOINT_URL`, `S3_ACCESS_KEY_ID`, `S3_SECRET_ACCESS_KEY`, `PUBLIC_KEY`, `PDM_URL`, `FLOWS_URL`, `FLOWS_INTERNAL_URL`, `USERNAME`, `PASSWORD`, `CAMUNDA_PROCESS_DEFINITION_ID`, `OPERATE_URL`, `CAMUNDA_KEYCLOAK_URL`, `CAMUNDA_CLIENT_ID`, `CAMUNDA_CLIENT_SECRET`, `WORKFLOWS_HOST`, `WORKSPACES_URL`, `AUTH_HOST`, `TELEGRAM_ALERT_GROUP_ID`, `TELEGRAM_TOKEN`, `IS_CONTOUR`, `AMQP_HOST`, `AMQP_PORT`, `AMQP_USER`, `AMQP_PASSWORD`, `AMQP_PATH_API`, `SYSTEM_LOG_URL`.
|
||||
|
||||
## Развёртывание через kustomize (этот репозиторий)
|
||||
|
||||
В `iac/apps/cde` секреты доставляются не через `secretEnvs` чарта, а через **Vault Agent Injector**: аннотации подов монтируют секрет `secrets/data/vault/apps/cde` в файл `/vault/secrets/cde-env`, который экспортируется перед запуском (`source /vault/secrets/cde-env`, затем `exec /http` или `/worker`). Дополнительно контейнерам задаётся `S3_IS_CONTOUR=true` (примечание: в коде используется переменная `IS_CONTOUR`).
|
||||
|
||||
Оверлеи: `base` (общие манифесты), `brusnika-stage`, `brusnika-prod`, `yc-k8s-test`.
|
||||
|
||||
## Замечания и потенциальные проблемы
|
||||
|
||||
- **Нет глобального префикса.** Имена переменных короткие (`USERNAME`, `PASSWORD`, `AUTH_HOST`) — легко пересечься с системными; следите за окружением процесса.
|
||||
- **`PUBLIC_KEY` обязателен для `http`** — при пустом/некорректном PEM сервис паникует на старте (`server.go`).
|
||||
- **`PDM_URL`** присутствует в `secretEnvs` Helm, но соответствующий клиент (`internal/adapters/http/pdm`) в текущей сборке нигде не инициализируется — переменная фактически не используется кодом.
|
||||
- **`S3_IS_CONTOUR`** задаётся в kustomize-манифестах, тогда как код читает `IS_CONTOUR` (без префикса `S3_`). Проверьте, что для влияния на поведение выставлен именно `IS_CONTOUR`.
|
||||
- **`FLOWS_INTERNAL_URL`** объявлен только в конфигах `copy`/`copyv2`; в остальных воркерах поля нет, хотя ключ есть в общем секрете.
|
||||
- **Значения по умолчанию для секретов Camunda/Zeebe** (`identity-secret-for-components`) подходят для локального стенда, но должны переопределяться в prod.
|
||||
- Приложение читает `.env` только если файл существует; иначе используются переменные окружения. `make`-целей для генерации `.env` в репозитории нет — используйте этот `.env.example` как шаблон.
|
||||
@ -1,130 +0,0 @@
|
||||
# Эндпоинты внешних сервисов, с которыми взаимодействует cde-orchestration-demo
|
||||
|
||||
Документ описывает все HTTP/AMQP/gRPC-эндпоинты внешних сервисов, к которым обращается оркестратор (сервер `cmd/http` и воркеры). Это исходящие вызовы; описание API, который оркестратор **предоставляет**, — в `openapi.yaml`.
|
||||
|
||||
## Как устроено взаимодействие
|
||||
|
||||
Клиенты внешних сервисов лежат в `internal/adapters/http/*` и `internal/adapters/*`. Базовые URL берутся из переменных окружения (см. `CONFIGURATION.md`). Для HTTP используются два клиента: Fiber `client` (camunda, flows, pdm, workspaces, system_log) и `go-resty` (workflows, sarexbackend). Аутентификация — по-разному в зависимости от сервиса (OAuth client_credentials, Bearer-токен пользователя/админа, Basic).
|
||||
|
||||
## Базовые адреса по сервисам
|
||||
|
||||
| Сервис | Переменная базового адреса | Клиент | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| Camunda Operate / REST | `OPERATE_URL` | Fiber | Управление инстансами процессов, переменными, сообщениями |
|
||||
| Camunda Keycloak | `CAMUNDA_KEYCLOAK_URL` | Fiber | OAuth-токен для Operate |
|
||||
| Zeebe Gateway | `ZEEBE_GATEWAY` | gRPC (SDK) | Деплой BPMN, обработка job'ов воркерами |
|
||||
| Auth (токены) | `AUTH_HOST` | Fiber/resty | Токены пользователя/админа для flows и pdm |
|
||||
| Flows | `FLOWS_URL`, `FLOWS_INTERNAL_URL` | Fiber | Ревью, действия пользователя, обновление бандлов/документов |
|
||||
| PDM | `PDM_URL` | Fiber | Маркировка бандлов *(клиент не подключён — см. примечание)* |
|
||||
| Workflows | `WORKFLOWS_HOST` | resty | Создание workflow обработки PDF |
|
||||
| Workspaces | `WORKSPACES_URL` | Fiber | Создание рабочих областей |
|
||||
| System log | `SYSTEM_LOG_URL` | Fiber | Отправка системных логов |
|
||||
| Sarex backend | `SAREX_BACKEND_BASE_URL` | resty | Получение MRPA по id |
|
||||
| Telegram Bot API | `TELEGRAM_TOKEN` | tgbotapi | Алертинг воркеров |
|
||||
| RabbitMQ (AMQP) | `AMQP_*` | amqp091 | Маркировка бандлов (RPC), вычисление хеш-сумм |
|
||||
|
||||
## Эндпоинты по сервисам
|
||||
|
||||
### Camunda Operate / REST (`OPERATE_URL`, `CAMUNDA_KEYCLOAK_URL`)
|
||||
|
||||
`internal/adapters/http/camunda/client.go`. Все запросы (кроме получения токена) идут с заголовком `Authorization: Bearer <access_token>`.
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| POST | `{CAMUNDA_KEYCLOAK_URL}/auth/realms/camunda-platform/protocol/openid-connect/token` | OAuth-токен (`grant_type=client_credentials`) |
|
||||
| POST | `{OPERATE_URL}/v2/process-instances` | Создать инстанс процесса |
|
||||
| GET | `{OPERATE_URL}/api/process-instances/{key}` | Получить инстанс процесса |
|
||||
| POST | `{OPERATE_URL}/v1/variables/search` | Поиск переменных процесса по имени/значению |
|
||||
| GET | `{OPERATE_URL}/api/process-instances/{key}/variables/{varId}` | Значение конкретной переменной |
|
||||
| POST | `{OPERATE_URL}/api/process-instances/{key}/variables` | Список переменных инстанса (`scopeId`) |
|
||||
| POST | `{OPERATE_URL}/v2/messages/publication` | Публикация сообщения процессу (напр. `signRequest`) |
|
||||
|
||||
### Zeebe Gateway (`ZEEBE_GATEWAY`)
|
||||
|
||||
`internal/adapters/zeebe`. gRPC через официальный SDK `camunda/zeebe/clients/go/v8`. Используется для деплоя определений процессов (`NewProcessDefinition`) и для job-воркеров, которые слушают Service Task типа `ZEEBE_WORKER_JOB_TYPE` и по завершении/ошибке возвращают результат в инстанс процесса.
|
||||
|
||||
### Auth — токены (`AUTH_HOST`)
|
||||
|
||||
Используется адаптерами flows и pdm для получения Bearer-токенов.
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| GET | `{AUTH_HOST}/token/user/{userID}/` | Токен от имени пользователя |
|
||||
| POST | `{AUTH_HOST}/token/` | Токен админа (`username`/`password`) |
|
||||
|
||||
### Flows (`FLOWS_URL`, `FLOWS_INTERNAL_URL`)
|
||||
|
||||
`internal/adapters/http/flows/adapter.go`. Запросы (кроме `update-documents`) идут с `Authorization: Bearer <token>`; часть операций — с ретраями (экспоненциальный backoff).
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| POST | `{FLOWS_URL}/user-actions/` | Добавить действие в историю |
|
||||
| PATCH | `{FLOWS_URL}/reviews/{reviewID}/approve/` | Утвердить review (со статусом/комментарием) |
|
||||
| PATCH | `{FLOWS_URL}/reviews/{reviewID}/update-bundles/` | Обновить бандлы review |
|
||||
| PATCH | `{FLOWS_INTERNAL_URL}/reviews/{reviewID}/update-documents/` | Обновить документы review (внутренний URL, без авторизации) |
|
||||
| GET | `{FLOWS_URL}/reviews/{reviewID}/documents/` | История бандлов документов review |
|
||||
|
||||
### PDM (`PDM_URL`, `AUTH_HOST`) — не подключён
|
||||
|
||||
`internal/adapters/http/pdm/client.go`. Клиент реализован, но в текущей сборке нигде не инициализируется (см. примечание в конце). Для полноты — какие вызовы он делает:
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| GET | `{AUTH_HOST}/token/user/{userID}/` | Токен пользователя (Basic auth логин/пароль) |
|
||||
| PUT | `{PDM_URL}/bundles/{bundleID}/marks` | Проставить маркировки бандлу |
|
||||
|
||||
### Workflows (`WORKFLOWS_HOST`, `AUTH_HOST`)
|
||||
|
||||
`internal/adapters/http/workflows/adapter.go` (resty). Используется воркером `split_pdf`.
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| POST | `{WORKFLOWS_HOST}/internal/v1/companies/{companyID}/workflows` | Создать workflow обработки/оптимизации PDF |
|
||||
|
||||
> Базовый URL resty-клиента установлен в `AUTH_HOST`, а адрес workflows подставляется полным (`WORKFLOWS_HOST`). В параметрах задач передаётся `django_host = AUTH_HOST`.
|
||||
|
||||
### Workspaces (`WORKSPACES_URL`)
|
||||
|
||||
`internal/adapters/http/workspaces/client.go`. Используется воркерами `copy`/`copyv2`.
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| POST | `{WORKSPACES_URL}/internal/v2/workspaces` | Создать рабочую область |
|
||||
|
||||
### System log (`SYSTEM_LOG_URL`)
|
||||
|
||||
`internal/adapters/http/system_log/client.go`. Используется воркерами `copy`, `copyv2`, `create_versions`, `create_versionsv2`.
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| POST | `{SYSTEM_LOG_URL}/api/v0/system_log` | Отправить пакет системных логов |
|
||||
|
||||
### Sarex backend (`SAREX_BACKEND_BASE_URL`)
|
||||
|
||||
`internal/adapters/sarexbackend/client.go` (resty). Используется HTTP-сервером при подписи (проверка MRPA). Токены проксируются из входящего запроса (`Authorization`, опц. `Identity`).
|
||||
|
||||
| Метод | Путь | Назначение |
|
||||
| --- | --- | --- |
|
||||
| GET | `{SAREX_BACKEND_BASE_URL}/api/core/mrpa/{id}/` | Получить MRPA по id |
|
||||
|
||||
### Telegram Bot API (`TELEGRAM_TOKEN`, `TELEGRAM_ALERT_GROUP_ID`)
|
||||
|
||||
`internal/adapters/http/telegram/client.go` через `go-telegram-bot-api`. Отправка алертов в заданную группу при ошибках/паниках в задачах воркеров.
|
||||
|
||||
### RabbitMQ / AMQP (`AMQP_*`)
|
||||
|
||||
Подключение вида `amqp://{USER}:{PASSWORD}@{HOST}:{PORT}/{PATH_API}`.
|
||||
|
||||
| Адаптер | Назначение |
|
||||
| --- | --- |
|
||||
| `internal/adapters/amqp/markings` | Маркировка бандла и получение его хеш-суммы (RPC поверх временной очереди, `correlation_id`). Используется воркерами `markingsv2`/`copyv2` |
|
||||
| `internal/adapters/amqp/rpc` | Общий RPC-клиент RabbitMQ (переподключение, вычисление хеш-сумм объектов) |
|
||||
|
||||
## Обработка ошибок
|
||||
|
||||
Каждый адаптер проверяет `StatusCode()` ответа и оборачивает не-`200 OK` в ошибку с телом ответа (`internal/errors`). Отдельно у sarexbackend маппинг: `404 → ErrNotFound`, `403 → ErrForbidden`, прочие → generic. Адаптеры flows и pdm выполняют ретраи с экспоненциальным backoff (до 5 попыток).
|
||||
|
||||
## Примечания
|
||||
|
||||
- **PDM-клиент не подключён.** `internal/adapters/http/pdm` реализован, а переменная `PDM_URL` присутствует в Helm-секрете, но `pdm.New(...)` не вызывается ни в одном бинарнике. Раздел оставлен для полноты; при фактическом использовании актуализируйте документ.
|
||||
- Пути даны относительно базовых URL из окружения; итоговый URL = `<базовый адрес>` + `путь`.
|
||||
15
apps/cde/base/backend-service.yaml
Normal file
15
apps/cde/base/backend-service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: cde-svc
|
||||
namespace: faas
|
||||
spec:
|
||||
type: ClusterIP
|
||||
selector:
|
||||
app: cde
|
||||
ports:
|
||||
- name: http
|
||||
port: 80
|
||||
targetPort: 8000
|
||||
protocol: TCP
|
||||
@ -1,120 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde-flowscallback
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde-flowscallback
|
||||
service: cde-flowscallback
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde-flowscallback
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde-flowscallback
|
||||
service: cde-flowscallback
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-flowscallback:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/flowscallback-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-flowscallback
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: cde-flowscallback
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/flowscallback-worker:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 1Gi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -1,120 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde-splitpdf
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde-splitpdf
|
||||
service: cde-splitpdf
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde-splitpdf
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde-splitpdf
|
||||
service: cde-splitpdf
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-splitpdf:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/splitpdf-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-splitpdf
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: cde-splitpdf
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/splitpdf-worker:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 1Gi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -1,120 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: cde-worker-alert
|
||||
namespace: cde
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-alert:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/orchestrator:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-alert
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 1Gi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
@ -1,120 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde-worker-copy
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde-worker-copy
|
||||
service: cde-worker-copy
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde-worker-copy
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde-worker-copy
|
||||
service: cde-worker-copy
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-copy:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/copy-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-copy
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: cde-worker-copy
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/copy-worker:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: "1"
|
||||
memory:
|
||||
_default: 1Gi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -1,120 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: cde-worker-copyv2
|
||||
namespace: cde
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-copyv2:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/copyv2-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-copyv2
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: "1"
|
||||
memory:
|
||||
_default: 1Gi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
@ -1,120 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde-worker-create-versions
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde-worker-create-versions
|
||||
service: cde-worker-create-versions
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde-worker-create-versions
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde-worker-create-versions
|
||||
service: cde-worker-create-versions
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-create-versions:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/createversions-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-create-versions
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: cde-worker-create-versions
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/createversions-worker:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -1,120 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: cde-worker-create-versionsv2
|
||||
namespace: cde
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-create-versionsv2:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/createversionsv2-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-create-versionsv2
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
@ -1,120 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde-worker-markings
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde-worker-markings
|
||||
service: cde-worker-markings
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde-worker-markings
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde-worker-markings
|
||||
service: cde-worker-markings
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-markings:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/markings-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-markings
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: cde-worker-markings
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/markings-worker:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -1,120 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: cde-worker-markingsv2
|
||||
namespace: cde
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-markingsv2:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/markingsv2-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-markingsv2
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
@ -1,120 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde-worker-sign
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde-worker-sign
|
||||
service: cde-worker-sign
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde-worker-sign
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde-worker-sign
|
||||
service: cde-worker-sign
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-sign:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/sign-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-sign
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: cde-worker-sign
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/sign-worker:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -1,120 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: cde-worker-signv2
|
||||
namespace: cde
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-signv2:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/signv2-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-signv2
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
@ -1,120 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde-worker-update-bundles
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde-worker-update-bundles
|
||||
service: cde-worker-update-bundles
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde-worker-update-bundles
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde-worker-update-bundles
|
||||
service: cde-worker-update-bundles
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde-worker-update-bundles:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/updatebundles-worker:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-worker-update-bundles
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: cde-worker-update-bundles
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/updatebundles-worker:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /worker
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: false
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -1,139 +1,60 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: cde
|
||||
namespace: cde
|
||||
|
||||
labels:
|
||||
app: cde
|
||||
service: cde
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: cde
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: cde
|
||||
service: cde
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
cde:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: cde-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/cde:preprod_4302d8f3
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8080
|
||||
|
||||
serviceAccountName: cde-vault
|
||||
containers:
|
||||
- name: api
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/cde:prod_9f3c1d2a
|
||||
imagePullPolicy: IfNotPresent
|
||||
command:
|
||||
_default: ["/bin/bash", "-lc"]
|
||||
- /bin/bash
|
||||
- -lc
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /http
|
||||
|
||||
- |
|
||||
set -e
|
||||
source /vault/secrets/cde-env
|
||||
exec /http
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: S3_IS_CONTOUR
|
||||
value: "true"
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 500m
|
||||
memory:
|
||||
_default: 512Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
|
||||
service:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: cde-svc
|
||||
|
||||
type:
|
||||
_default: ClusterIP
|
||||
|
||||
port:
|
||||
_default: 80
|
||||
|
||||
targetPort:
|
||||
_default: 8080
|
||||
|
||||
portName:
|
||||
_default: http
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
envs:
|
||||
- name: SAREX_BACKEND_BASE_URL
|
||||
value:
|
||||
_default: "https://lk.sarex.io"
|
||||
|
||||
- name: S3_IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
- name: IS_CONTOUR
|
||||
value:
|
||||
_default: "true"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: cde
|
||||
vault.hashicorp.com/agent-inject-secret-cde-env: secrets/data/vault/apps/cde
|
||||
vault.hashicorp.com/agent-inject-template-cde-env: |-
|
||||
{{- with secret "secrets/data/vault/apps/cde" -}}
|
||||
{{- range $k, $v := .Data.data }}
|
||||
export {{ $k }}=$(printf '%b' {{ printf "%q" (printf "%v" $v) }})
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
|
||||
@ -4,16 +4,13 @@ kind: Kustomization
|
||||
namespace: cde
|
||||
resources:
|
||||
- namespace.yaml
|
||||
- serviceaccount.yaml
|
||||
- cde.yaml
|
||||
- cde-splitpdf.yaml
|
||||
- backend-service.yaml
|
||||
- cde-flowscallback.yaml
|
||||
- cde-worker-alert.yaml
|
||||
- cde-worker-copy.yaml
|
||||
- cde-worker-copyv2.yaml
|
||||
- cde-worker-create-versions.yaml
|
||||
- cde-worker-create-versionsv2.yaml
|
||||
- cde-worker-markings.yaml
|
||||
- cde-worker-markingsv2.yaml
|
||||
- cde-worker-sign.yaml
|
||||
- cde-worker-signv2.yaml
|
||||
- cde-worker-update-bundles.yaml
|
||||
|
||||
@ -5,4 +5,3 @@ metadata:
|
||||
name: cde
|
||||
labels:
|
||||
istio-injection: enabled
|
||||
security.deckhouse.io/pod-policy: privileged
|
||||
5
apps/cde/base/serviceaccount.yaml
Normal file
5
apps/cde/base/serviceaccount.yaml
Normal file
@ -0,0 +1,5 @@
|
||||
apiVersion: v1
|
||||
kind: ServiceAccount
|
||||
metadata:
|
||||
name: cde-vault
|
||||
namespace: cde
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: namespace.yaml
|
||||
target:
|
||||
kind: Namespace
|
||||
name: cde
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Namespace
|
||||
metadata:
|
||||
name: cde
|
||||
labels:
|
||||
istio-injection: enabled
|
||||
security.deckhouse.io/pod-policy: privileged
|
||||
@ -1,298 +0,0 @@
|
||||
openapi: 3.0.3
|
||||
|
||||
info:
|
||||
title: CDE Orchestration API
|
||||
version: "0.0.0"
|
||||
description: |
|
||||
HTTP API оркестратора **cde-orchestration-demo**
|
||||
(`gitlab.com/sarex-team/cde-orchestration-demo`) — управление процессами
|
||||
согласования/подписи документов в Camunda (Zeebe/Operate).
|
||||
|
||||
Сервис написан на Go (**Fiber v3**), точка входа — `cmd/http/main.go`,
|
||||
сборка приложения — `internal/app/http/server.go`. Все ручки объявлены в
|
||||
`internal/controller/http/v0` и смонтированы под префиксом `/api`.
|
||||
|
||||
### Аутентификация
|
||||
Все эндпоинты проходят через middleware `pkg/http/middleware/auth.go`.
|
||||
Токен передаётся заголовком `Authorization: Bearer <jwt>`. Поддерживаются
|
||||
два режима:
|
||||
|
||||
1. **Sarex** (по умолчанию) — подпись JWT проверяется RSA public key из
|
||||
переменной `PUBLIC_KEY`.
|
||||
2. **Zitadel** — если передан дополнительный заголовок
|
||||
`Identity: Bearer <jwt>`, полезная нагрузка берётся из метаданных
|
||||
этого токена (`urn:zitadel:iam:user:metadata`); подпись основным
|
||||
сервисом не проверяется.
|
||||
|
||||
При отсутствии/некорректности заголовков middleware возвращает `401`.
|
||||
|
||||
### Замечания
|
||||
- Ручка `GET /api/process/{instance_key}` может вернуть `425 Too Early`,
|
||||
если процесс есть в кеше, но ещё не создан в Camunda (идёт обработка).
|
||||
- Тело ответов на запись (`process`, `sign`, `operate`) обычно пустое —
|
||||
значим только HTTP-статус.
|
||||
|
||||
contact:
|
||||
name: cde-orchestration-demo
|
||||
url: https://gitlab.com/sarex-team/cde-orchestration-demo
|
||||
|
||||
servers:
|
||||
- url: http://localhost:8080/api
|
||||
description: Локальный запуск (Fiber, ADDRESS по умолчанию :8080)
|
||||
- url: http://cde-svc.cde.svc.cluster.local/api
|
||||
description: Внутрикластерный адрес (ClusterIP)
|
||||
|
||||
tags:
|
||||
- name: infra
|
||||
description: Служебные эндпоинты
|
||||
- name: process
|
||||
description: Процессы согласования/подписи
|
||||
- name: sign
|
||||
description: Отправка подписей в процесс
|
||||
- name: operate
|
||||
description: Управление определениями процессов (BPMN)
|
||||
|
||||
security:
|
||||
- bearerAuth: []
|
||||
|
||||
paths:
|
||||
/:
|
||||
get:
|
||||
tags: [infra]
|
||||
summary: Проверка доступности
|
||||
description: Возвращает 200 OK. Требует валидной авторизации (middleware).
|
||||
operationId: root
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
"401":
|
||||
description: Не авторизован
|
||||
|
||||
/process/:
|
||||
post:
|
||||
tags: [process]
|
||||
summary: Запустить процесс
|
||||
description: |
|
||||
Создаёт инстанс процесса согласования/подписи в Camunda по документам
|
||||
из `payload`. Если для `flow_id` уже есть активный инстанс — вернётся
|
||||
`400`.
|
||||
operationId: createProcess
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ProcessCreateRequest"
|
||||
responses:
|
||||
"202":
|
||||
description: Процесс принят к обработке
|
||||
"400":
|
||||
description: Ошибка валидации или активный инстанс уже существует
|
||||
"401":
|
||||
description: Не авторизован
|
||||
"500":
|
||||
description: Внутренняя ошибка (ошибка создания инстанса в Camunda)
|
||||
|
||||
/process/{instance_key}:
|
||||
get:
|
||||
tags: [process]
|
||||
summary: Получить состояние процесса
|
||||
description: |
|
||||
Возвращает текущее состояние процесса по `flow_id` (в пути — числовой
|
||||
ключ). Логика: если запись есть в кеше, но нет активного инстанса в
|
||||
Camunda — процесс ещё обрабатывается (`425`).
|
||||
operationId: getProcess
|
||||
parameters:
|
||||
- name: instance_key
|
||||
in: path
|
||||
required: true
|
||||
description: Числовой идентификатор (`flow_id`)
|
||||
schema:
|
||||
type: integer
|
||||
format: uint64
|
||||
responses:
|
||||
"200":
|
||||
description: Состояние процесса
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/GetProcessInstanceResponse"
|
||||
"401":
|
||||
description: Не авторизован
|
||||
"404":
|
||||
description: Процесс не найден
|
||||
"425":
|
||||
description: Too Early — процесс ещё обрабатывается
|
||||
"500":
|
||||
description: Внутренняя ошибка
|
||||
|
||||
/sign/:
|
||||
post:
|
||||
tags: [sign]
|
||||
summary: Отправить подписи в процесс
|
||||
description: |
|
||||
Публикует сообщение `signRequest` в процесс Camunda с подписями из
|
||||
`payload`. Для элементов с `mrpa_id` предварительно проверяется доступ
|
||||
через sarex-backend.
|
||||
operationId: sign
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/SignRequest"
|
||||
responses:
|
||||
"200":
|
||||
description: Подписи приняты, сообщение отправлено в процесс
|
||||
"401":
|
||||
description: Отсутствует токен авторизации
|
||||
"403":
|
||||
description: Нет прав на MRPA
|
||||
"422":
|
||||
description: MRPA не найдена
|
||||
"500":
|
||||
description: Внутренняя ошибка
|
||||
|
||||
/operate/processes:
|
||||
post:
|
||||
tags: [operate]
|
||||
summary: Загрузить определение процесса (BPMN)
|
||||
description: |
|
||||
Принимает BPMN-файл (multipart, поле `definition`) и деплоит его в
|
||||
Zeebe.
|
||||
operationId: deployProcessDefinition
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
required: [definition]
|
||||
properties:
|
||||
definition:
|
||||
type: string
|
||||
format: binary
|
||||
description: BPMN-файл определения процесса
|
||||
responses:
|
||||
"200":
|
||||
description: Определение загружено
|
||||
"400":
|
||||
description: Файл не передан/некорректен
|
||||
"401":
|
||||
description: Не авторизован
|
||||
"500":
|
||||
description: Внутренняя ошибка деплоя
|
||||
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerAuth:
|
||||
type: http
|
||||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
description: |
|
||||
JWT Sarex (проверяется по `PUBLIC_KEY`). Для режима Zitadel
|
||||
дополнительно передаётся заголовок `Identity: Bearer <jwt>`.
|
||||
|
||||
schemas:
|
||||
ProcessCreateRequest:
|
||||
type: object
|
||||
required: [flow_id, author_id]
|
||||
description: Запрос на старт процесса (`internal/dto/http.go`).
|
||||
properties:
|
||||
flow_id:
|
||||
type: integer
|
||||
format: uint64
|
||||
description: Внешний ID процесса (обязателен, != 0)
|
||||
author_id:
|
||||
type: integer
|
||||
format: uint64
|
||||
description: ID автора запроса (обязателен, != 0)
|
||||
company_id:
|
||||
type: integer
|
||||
format: uint64
|
||||
step_id:
|
||||
type: integer
|
||||
format: uint64
|
||||
metadata:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
payload:
|
||||
type: array
|
||||
description: Документы для обработки (произвольные объекты)
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
overwrite_marks:
|
||||
type: boolean
|
||||
mode:
|
||||
type: string
|
||||
description: Режим работы ("original", "copy", "both")
|
||||
use_signature:
|
||||
type: boolean
|
||||
create_copy_on_finish:
|
||||
type: boolean
|
||||
comment:
|
||||
type: string
|
||||
is_last_signer:
|
||||
type: boolean
|
||||
|
||||
GetProcessInstanceResponse:
|
||||
type: object
|
||||
description: Состояние инстанса процесса (`internal/dto/http.go`).
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
use_signature:
|
||||
type: boolean
|
||||
is_finished:
|
||||
type: boolean
|
||||
is_ready_for_sign:
|
||||
type: boolean
|
||||
is_last_signer:
|
||||
type: boolean
|
||||
create_copy_on_finish:
|
||||
type: boolean
|
||||
comment:
|
||||
type: string
|
||||
payload:
|
||||
description: Полезная нагрузка процесса (структура зависит от процесса)
|
||||
nullable: true
|
||||
instance_key:
|
||||
type: integer
|
||||
format: uint64
|
||||
|
||||
SignRequest:
|
||||
type: object
|
||||
required: [flow_id, payload]
|
||||
description: Запрос на подпись документов в процессе (`internal/dto/http.go`).
|
||||
properties:
|
||||
flow_id:
|
||||
type: integer
|
||||
format: uint64
|
||||
metadata:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
payload:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/SignRequestPayloadElem"
|
||||
|
||||
SignRequestPayloadElem:
|
||||
type: object
|
||||
properties:
|
||||
bundle_id:
|
||||
type: string
|
||||
format: uuid
|
||||
author_id:
|
||||
type: integer
|
||||
format: uint64
|
||||
signature:
|
||||
type: string
|
||||
description: Сгенерированная подпись (помещается в p7s)
|
||||
algorithm:
|
||||
type: string
|
||||
mrpa_id:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
description: Если задан — проверяется доступ через sarex-backend
|
||||
@ -1,31 +0,0 @@
|
||||
# Piccolo (обязательно для запуска)
|
||||
PYTHONPATH=src
|
||||
PICCOLO_CONF=db.config
|
||||
|
||||
# App
|
||||
DEBUG=true
|
||||
|
||||
# HTTP app
|
||||
HTTP_APP_HOST=0.0.0.0
|
||||
HTTP_APP_PORT=8000
|
||||
HTTP_APP_ROOT_PATH=""
|
||||
HTTP_APP_WORKERS=1
|
||||
HTTP_APP_ADMIN_ENABLE=true
|
||||
|
||||
# Database
|
||||
DATABASE_HOST=postgres
|
||||
DATABASE_PORT=5432
|
||||
DATABASE_NAME=postgres
|
||||
DATABASE_USER=postgres
|
||||
DATABASE_PASSWORD=postgres
|
||||
|
||||
# OpenTelemetry
|
||||
OTEL_ENABLE=false
|
||||
OTEL_URL=http://signoz-otel-collector-external.signoz.svc.cluster.local:4317
|
||||
OTEL_SERVICE_NAME=checklists-backend.checklists-stage
|
||||
OTEL_INSECURE=true
|
||||
|
||||
# Auth (JWT)
|
||||
# При JWT_AUTH_ENABLE=false middleware отключён и используется дефолтный пользователь
|
||||
JWT_AUTH_ENABLE=false
|
||||
JWT_AUTH_PUBLIC_KEY=key
|
||||
@ -1,171 +0,0 @@
|
||||
# Конфигурация проекта checklists-backend
|
||||
|
||||
Документ описывает все переменные окружения и способы конфигурирования сервиса.
|
||||
|
||||
## Способы конфигурирования
|
||||
|
||||
Сервис настраивается **только через переменные окружения**. Разбор выполняется в `src/config.py` через библиотеку [`pydantic-settings`](https://docs.pydantic.dev/latest/concepts/pydantic_settings/).
|
||||
|
||||
В отличие от единого класса настроек, конфигурация разбита на несколько независимых классов `BaseSettings`, у каждого — **свой** `env_prefix` (плоские имена, без вложенного разделителя):
|
||||
|
||||
| Класс | `env_prefix` | Раздел |
|
||||
| --- | --- | --- |
|
||||
| `Config` | *(нет префикса)* | `debug` |
|
||||
| `HTTPAppConfig` | `HTTP_APP_` | Параметры HTTP-приложения/uvicorn |
|
||||
| `DatabaseConfig` | `DATABASE_` | Подключение к PostgreSQL |
|
||||
| `OTELConfig` | `OTEL_` | Трейсинг/логи OpenTelemetry |
|
||||
| `JWTAuthConfig` | `JWT_AUTH_` | Аутентификация по JWT |
|
||||
|
||||
Подклассы подключаются к корневому `Config` как поля со значениями по умолчанию (`http_app`, `database`, `otel`, `jwt_auth`) и читают окружение в момент импорта. Отдельного конфиг-файла (yaml/toml) у приложения нет.
|
||||
|
||||
Особенности:
|
||||
|
||||
- **`.env` не загружается автоматически** — в `config.py` не задан `env_file`, зависимости `python-dotenv` нет. Файл `.env.template` — это шаблон; переменные нужно экспортировать в окружение самому (напр. `set -a && . ./.env && set +a`) либо задавать через `--env`/манифесты k8s.
|
||||
- Помимо переменных приложения, для запуска нужны две инфраструктурные переменные Piccolo: `PYTHONPATH=src` и `PICCOLO_CONF=db.config` (заданы в `.env.template` и в `Dockerfile`).
|
||||
|
||||
Источники переменных по способам запуска:
|
||||
|
||||
| Способ запуска | Откуда берутся переменные |
|
||||
| --- | --- |
|
||||
| Локально (`make run`) | Переменные окружения процесса. `.env.template` — шаблон, приложение его **не подхватывает** автоматически |
|
||||
| Контейнер | `docker/http/Dockerfile` задаёт `PYTHONPATH`/`PICCOLO_CONF`; прочие переменные пробрасываются при запуске |
|
||||
| Kubernetes (Helm) | `.helm/values.yaml`: блоки `envs` (обычные значения) и `secretEnvs` (значения из k8s-секретов) чарта `universal-chart` |
|
||||
| CI/CD (GitLab) | `.gitlab-ci.yml`: переменные пайплайна (`workflow.rules`) и `HELM_SET_ARGS` |
|
||||
|
||||
Способы запуска (`Makefile`):
|
||||
|
||||
| Команда | Точка входа | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `make run` | `src/cmd/http/main.py` → `uvicorn` (factory `app.http:create_app`) | HTTP API |
|
||||
| `make migrate` | `piccolo migrations forwards all` | Применение миграций БД |
|
||||
| `make migrations` | `piccolo migrations new checklists --auto` | Генерация новой миграции |
|
||||
| `make format` / `make format-check` | `ruff` | Форматирование/линт |
|
||||
|
||||
Порядок запуска в контейнере (`docker/http/entrypoint.sh`): сначала выполняются миграции (`piccolo migrations forwards all`), затем стартует приложение (`src/cmd/http/main.py`). Uvicorn запускается в режиме фабрики; `reload` включается при `DEBUG=true`, число воркеров — из `HTTP_APP_WORKERS`.
|
||||
|
||||
## Переменные приложения
|
||||
|
||||
В столбце «Переменная» указано полное имя (префикс + поле). Дефолт `—` означает, что значение обязательно.
|
||||
|
||||
### App (`Config`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `DEBUG` | bool | `True` | Режим отладки. Влияет на `reload` uvicorn, логирование SQL-запросов Piccolo (`log_queries`/`log_responses`), а также на `production`-флаг и `debug` piccolo-admin |
|
||||
|
||||
### HTTP-приложение (`HTTP_APP_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `HTTP_APP_HOST` | string | `0.0.0.0` | Адрес прослушивания |
|
||||
| `HTTP_APP_PORT` | int | `8000` | Порт |
|
||||
| `HTTP_APP_ROOT_PATH` | string | `""` | Root path (префикс за реверс-прокси; в k8s — `/checklists`) |
|
||||
| `HTTP_APP_WORKERS` | int | `1` | Число воркеров uvicorn |
|
||||
| `HTTP_APP_ADMIN_ENABLE` | bool | `True` | Монтировать ли piccolo-admin по пути `/admin/` |
|
||||
|
||||
### Database (`DATABASE_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `DATABASE_HOST` | string | `postgres` | Хост PostgreSQL |
|
||||
| `DATABASE_PORT` | int | `5432` | Порт PostgreSQL |
|
||||
| `DATABASE_NAME` | string | `postgres` | Имя базы данных |
|
||||
| `DATABASE_USER` | string | `postgres` | Пользователь БД |
|
||||
| `DATABASE_PASSWORD` | string | `postgres` | Пароль пользователя БД |
|
||||
|
||||
Подключение собирается в `src/db/config.py` (`PostgresEngine`). SSL-параметров в настройках нет; в prod TLS обеспечивается на уровне подключения/CA-сертификата (см. `docker/http/ca.crt`).
|
||||
|
||||
### OpenTelemetry (`OTEL_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `OTEL_ENABLE` | bool | `False` | Включить трейсинг/логи OTEL. При `True` подключаются `fastapi-otel-tools` и инструментирование FastAPI |
|
||||
| `OTEL_URL` | string | `http://signoz-otel-collector-external.signoz.svc.cluster.local:4317` | Адрес OTLP-коллектора |
|
||||
| `OTEL_SERVICE_NAME` | string | `checklists-backend.checklists-stage` | Имя сервиса в трейсах |
|
||||
| `OTEL_INSECURE` | bool | `True` | Небезопасное (без TLS) подключение к коллектору |
|
||||
|
||||
> При `OTEL_ENABLE=true` `access_log` uvicorn отключается (логи идут через OTEL-обработчик).
|
||||
|
||||
### Auth (`JWT_AUTH_*`)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `JWT_AUTH_ENABLE` | bool | `False` | Включить `JWTAuthMiddleware`. При `False` middleware не подключается, и в контекст подставляется дефолтный пользователь (для локальной разработки) |
|
||||
| `JWT_AUTH_PUBLIC_KEY` | string | `key` | Публичный RSA-ключ для JWT (алгоритм `RS512`) |
|
||||
|
||||
## Переменные инфраструктуры и сборки
|
||||
|
||||
Не читаются кодом приложения, но участвуют в запуске/сборке.
|
||||
|
||||
| Переменная | Где используется | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `PYTHONPATH` | `.env.template`, `Dockerfile` | Путь к исходникам (`src`) |
|
||||
| `PICCOLO_CONF` | `.env.template`, `Dockerfile` | Путь к конфигу Piccolo (`db.config`) |
|
||||
| `SERVICE_NAME` | `.gitlab-ci.yml` | Имя сервиса (`checklists-backend`) |
|
||||
| `DOCKERFILE_PATH` | `.gitlab-ci.yml` | Путь к Dockerfile (`./docker/http/Dockerfile`) |
|
||||
| `IMAGE_NAME` | `.gitlab-ci.yml` (`HELM_SET_ARGS`) | Имя собираемого образа |
|
||||
| `CHART_NAME` / `CHART_VERSION` / `RELEASE_NAME` | `.gitlab-ci.yml` | Параметры релиза Helm |
|
||||
|
||||
Базовый образ — `python:3.13-slim-bookworm`; менеджер зависимостей — `uv` (`uv sync --locked`). В образ добавляется CA-сертификат Yandex (`docker/http/ca.crt`).
|
||||
|
||||
## Переменные из Helm-чарта (`.helm/values.yaml`)
|
||||
|
||||
Сервис деплоится подключаемым чартом `universal-chart` (OCI-зависимость). Окружение выбирается ключом `universal-chart.global.env` (`stage`/`preprod`/`production`); для каждой переменной значение берётся из блока с ключом текущего окружения либо из `_default`.
|
||||
|
||||
Обычные значения (блок `envs`) переопределяют дефолты кода, в частности:
|
||||
|
||||
| Переменная | Значение в чарте |
|
||||
| --- | --- |
|
||||
| `HTTP_APP_ROOT_PATH` | `/checklists` |
|
||||
| `HTTP_APP_WORKERS` | `3` |
|
||||
| `HTTP_APP_ADMIN_ENABLE` | `true` |
|
||||
| `DATABASE_PORT` | `6432` (PgBouncer) |
|
||||
| `DATABASE_NAME` | `checklists_db` (stage), `checklists` (preprod/production) |
|
||||
| `OTEL_ENABLE` | `true` |
|
||||
| `OTEL_URL` | `http://otel-collector.opentelemetry-collector.svc.cluster.local:4317` |
|
||||
| `OTEL_SERVICE_NAME` | `checklists-backend.proc` (stage), `…checklists-preprod`, `…checklists-prod` |
|
||||
| `JWT_AUTH_ENABLE` | `true` |
|
||||
| `DEBUG` | `false` |
|
||||
|
||||
Значения из секретов (блок `secretEnvs`, монтируются как env через `secretKeyRef`):
|
||||
|
||||
| Переменная | Секрет (`secretName`) | Ключ (`secretKey`) |
|
||||
| --- | --- | --- |
|
||||
| `DATABASE_USER` | `checklists-postgresql-secret` (stage) / `ya-pg-secret` (preprod, production) | `user` |
|
||||
| `DATABASE_PASSWORD` | `checklists-postgresql-secret` / `ya-pg-secret` | `password` |
|
||||
| `DATABASE_HOST` | `checklists-postgresql-secret` / `ya-pg-secret` | `host` |
|
||||
| `JWT_AUTH_PUBLIC_KEY` | `jwt-secret` | `public-key` |
|
||||
|
||||
Прочие значения чарта (не переменные приложения): `deployment.*` (имя, реплики — 1 по умолчанию, 2 в production, ресурсы), `image.*`, `service.*` (ClusterIP, порт `80` → `8000`). Проверки `liveness`/`readiness` отключены.
|
||||
|
||||
## Переменные в CI (`.gitlab-ci.yml`)
|
||||
|
||||
Пайплайн подключает общие шаблоны из `generic/common-ci` (`universal-pipeline.yaml`, `common-security-scan.yaml`) и переключает окружение по ветке/тегу через `workflow.rules`:
|
||||
|
||||
| Условие | STAND | Namespace |
|
||||
| --- | --- | --- |
|
||||
| ветка `stage` | `stage` | `proc` |
|
||||
| ветка `master` | `preprod` | `checklists-preprod` |
|
||||
| тег (`CI_COMMIT_TAG`) | `production` | `checklists-prod` |
|
||||
|
||||
Ключевые переменные пайплайна: `SERVICE_NAME`, `DOCKERFILE_PATH`, `RELEASE_NAME`, `CHART_NAME`, `CHART_VERSION`, `K8S_HUSTLER_BRANCH`, `HELM_SET_ARGS` (проброс `image.name`, `global.env`, метаданных коммита). Job `lint` прогоняет `ruff check`/`ruff format --check` на образе `uv`.
|
||||
|
||||
## Замечания и потенциальные проблемы
|
||||
|
||||
- Приложение **не загружает `.env` автоматически** — переменные нужно экспортировать в окружение вручную либо задавать в манифестах.
|
||||
- Аутентификация JWT в коде выполняет разбор токена с `options={"verify_signature": False}` в обоих режимах (sarex-backend и Zitadel) — подпись фактически не проверяется на уровне приложения, доверие обеспечивается сетевым слоем (Istio). При `JWT_AUTH_ENABLE=false` middleware не подключается и используется дефолтный пользователь из `entity/context.py`.
|
||||
- Внутренние эндпоинты (`/internal/*`) аутентификации на уровне приложения не требуют.
|
||||
- SSL-настроек подключения к БД в коде нет; в prod используется PgBouncer (`DATABASE_PORT=6432`) и CA-сертификат, вшитый в образ.
|
||||
- Piccolo-admin доступен по `/admin/` при `HTTP_APP_ADMIN_ENABLE=true`; в режиме `DEBUG=false` он поднимается в `production`-режиме.
|
||||
|
||||
## Минимальный набор для локального запуска
|
||||
|
||||
Нужен доступный PostgreSQL. Помимо `PYTHONPATH=src` и `PICCOLO_CONF=db.config`, для запуска достаточно значений по умолчанию — обязательных переменных без дефолта нет. Практически стоит задать:
|
||||
|
||||
- `DEBUG` (`true` локально)
|
||||
- `HTTP_APP_HOST`, `HTTP_APP_PORT`
|
||||
- `DATABASE_HOST`, `DATABASE_PORT`, `DATABASE_NAME`, `DATABASE_USER`, `DATABASE_PASSWORD`
|
||||
- `JWT_AUTH_ENABLE` (`false` для локальной разработки — тогда используется дефолтный пользователь)
|
||||
- `OTEL_ENABLE` (`false` локально)
|
||||
|
||||
Готовые значения-примеры приведены в `.env.example`.
|
||||
80
apps/checklists/base/backend-deployment.yaml
Normal file
80
apps/checklists/base/backend-deployment.yaml
Normal file
@ -0,0 +1,80 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: checklists-backend
|
||||
namespace: checklists
|
||||
labels:
|
||||
app: checklists-backend
|
||||
service: api
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: checklists-backend
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: checklists-backend
|
||||
service: checklists-backend
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: checklists
|
||||
vault.hashicorp.com/agent-inject-secret-checklists-db: secrets/data/postgresql/apps/checklists
|
||||
vault.hashicorp.com/agent-inject-template-checklists-db: |-
|
||||
{{- with secret "secrets/data/postgresql/apps/checklists" -}}
|
||||
DATABASE_HOST=postgresql.checklists.svc.cluster.local
|
||||
DATABASE_PORT=5432
|
||||
DATABASE_NAME=checklists_db
|
||||
DATABASE_USER={{ index .Data.data "username" }}
|
||||
DATABASE_PASSWORD={{ index .Data.data "password" }}
|
||||
{{- end -}}
|
||||
vault.hashicorp.com/agent-inject-secret-checklists-jwt-public: secrets/data/vault/common/rsa_keys
|
||||
vault.hashicorp.com/agent-inject-template-checklists-jwt-public: |-
|
||||
{{- with secret "secrets/data/vault/common/rsa_keys" -}}
|
||||
{{ index .Data.data "public_key" }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
serviceAccountName: checklists-vault
|
||||
containers:
|
||||
- name: api
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/checklists-backend:production_68f242cd
|
||||
imagePullPolicy: IfNotPresent
|
||||
command: ["/bin/bash", "-ec"]
|
||||
args:
|
||||
- |
|
||||
set -a
|
||||
[ -f /vault/secrets/checklists-db ] && . /vault/secrets/checklists-db
|
||||
[ -f /vault/secrets/checklists-jwt-public ] && export JWT_AUTH_PUBLIC_KEY="$(cat /vault/secrets/checklists-jwt-public)"
|
||||
set +a
|
||||
exec ./entrypoint.sh
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: HTTP_APP_HOST
|
||||
value: 0.0.0.0
|
||||
- name: HTTP_APP_PORT
|
||||
value: "8000"
|
||||
- name: HTTP_APP_ROOT_PATH
|
||||
value: /checklists
|
||||
- name: HTTP_APP_WORKERS
|
||||
value: "1"
|
||||
- name: HTTP_APP_ADMIN_ENABLE
|
||||
value: "true"
|
||||
- name: JWT_AUTH_ENABLE
|
||||
value: "true"
|
||||
- name: DEBUG
|
||||
value: "false"
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu: "25m"
|
||||
memory: 128Mi
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
15
apps/checklists/base/backend-service.yaml
Normal file
15
apps/checklists/base/backend-service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: rfi-backend-api-svc
|
||||
namespace: checklists
|
||||
spec:
|
||||
type: ClusterIP
|
||||
selector:
|
||||
app: checklists-backend
|
||||
ports:
|
||||
- name: http
|
||||
port: 80
|
||||
targetPort: 8000
|
||||
protocol: TCP
|
||||
@ -1,124 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: checklists
|
||||
namespace: checklists
|
||||
spec:
|
||||
interval: 10m
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
services:
|
||||
checklists:
|
||||
enabled: true
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: checklists-vault
|
||||
deployment:
|
||||
enabled: true
|
||||
name:
|
||||
_default: checklists-backend
|
||||
replicaCount:
|
||||
_default: 1
|
||||
port:
|
||||
_default: 8000
|
||||
command:
|
||||
_default: ["/bin/bash", "-ec"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -a
|
||||
[ -f /vault/secrets/checklists-db ] && . /vault/secrets/checklists-db
|
||||
[ -f /vault/secrets/checklists-jwt-public ] && export JWT_AUTH_PUBLIC_KEY="$(cat /vault/secrets/checklists-jwt-public)"
|
||||
set +a
|
||||
exec ./entrypoint.sh
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 25m
|
||||
memory:
|
||||
_default: 128Mi
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/checklists-backend:production_68f242cd
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
service:
|
||||
enabled: true
|
||||
name:
|
||||
_default: backend-svc
|
||||
type:
|
||||
_default: ClusterIP
|
||||
port:
|
||||
_default: 80
|
||||
targetPort:
|
||||
_default: 8000
|
||||
portName:
|
||||
_default: http
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
envs:
|
||||
- name: HTTP_APP_HOST
|
||||
value:
|
||||
_default: "0.0.0.0"
|
||||
- name: HTTP_APP_PORT
|
||||
value:
|
||||
_default: "8000"
|
||||
- name: HTTP_APP_ROOT_PATH
|
||||
value:
|
||||
_default: /checklists
|
||||
- name: HTTP_APP_WORKERS
|
||||
value:
|
||||
_default: "1"
|
||||
- name: HTTP_APP_ADMIN_ENABLE
|
||||
value:
|
||||
_default: "true"
|
||||
- name: JWT_AUTH_ENABLE
|
||||
value:
|
||||
_default: "true"
|
||||
- name: DEBUG
|
||||
value:
|
||||
_default: "false"
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: checklists
|
||||
vault.hashicorp.com/agent-inject-secret-checklists-db: secrets/data/apps/checklists/postgres
|
||||
vault.hashicorp.com/agent-inject-template-checklists-db: |-
|
||||
{{- with secret "secrets/data/apps/checklists/postgres" -}}
|
||||
DATABASE_HOST={{ index .Data.data "host" }}
|
||||
DATABASE_PORT={{ index .Data.data "port" }}
|
||||
DATABASE_NAME={{ index .Data.data "database" }}
|
||||
DATABASE_USER={{ index .Data.data "username" }}
|
||||
DATABASE_PASSWORD={{ index .Data.data "password" }}
|
||||
{{- end -}}
|
||||
vault.hashicorp.com/agent-inject-secret-checklists-jwt-public: secrets/data/vault/common/rsa_keys
|
||||
vault.hashicorp.com/agent-inject-template-checklists-jwt-public: |-
|
||||
{{- with secret "secrets/data/vault/common/rsa_keys" -}}
|
||||
{{ index .Data.data "public_key" }}
|
||||
{{- end -}}
|
||||
@ -4,4 +4,6 @@ kind: Kustomization
|
||||
namespace: checklists
|
||||
resources:
|
||||
- namespace.yaml
|
||||
- helmrelease.yaml
|
||||
- serviceaccount.yaml
|
||||
- backend-deployment.yaml
|
||||
- backend-service.yaml
|
||||
|
||||
@ -5,4 +5,3 @@ metadata:
|
||||
name: checklists
|
||||
labels:
|
||||
istio-injection: enabled
|
||||
security.deckhouse.io/pod-policy: privileged
|
||||
|
||||
5
apps/checklists/base/serviceaccount.yaml
Normal file
5
apps/checklists/base/serviceaccount.yaml
Normal file
@ -0,0 +1,5 @@
|
||||
apiVersion: v1
|
||||
kind: ServiceAccount
|
||||
metadata:
|
||||
name: checklists-vault
|
||||
namespace: checklists
|
||||
@ -1,6 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: checklists
|
||||
resources:
|
||||
- ../base
|
||||
@ -1,33 +0,0 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: checklists-backend
|
||||
namespace: checklists
|
||||
spec:
|
||||
template:
|
||||
spec:
|
||||
containers:
|
||||
- name: api
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/checklists-backend:production_68f242cd
|
||||
env:
|
||||
- name: HTTP_APP_HOST
|
||||
value: 0.0.0.0
|
||||
- name: HTTP_APP_PORT
|
||||
value: '8000'
|
||||
- name: HTTP_APP_ROOT_PATH
|
||||
value: /checklists
|
||||
- name: HTTP_APP_WORKERS
|
||||
value: '8'
|
||||
- name: HTTP_APP_ADMIN_ENABLE
|
||||
value: 'true'
|
||||
- name: DATABASE_HOST
|
||||
value: postgres-service
|
||||
- name: DATABASE_PORT
|
||||
value: '5432'
|
||||
- name: DATABASE_NAME
|
||||
value: checklists_db
|
||||
- name: JWT_AUTH_ENABLE
|
||||
value: 'true'
|
||||
- name: DEBUG
|
||||
value: 'false'
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: checklists
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: checklists-backend.yaml
|
||||
target:
|
||||
kind: Deployment
|
||||
name: checklists-backend
|
||||
@ -1,963 +0,0 @@
|
||||
openapi: 3.0.3
|
||||
|
||||
info:
|
||||
title: Checklists
|
||||
version: "0.1.0"
|
||||
description: |
|
||||
REST API сервиса **checklists-backend** — управление чек-листами
|
||||
(`Checklist`) и их результатами (`ChecklistResult`).
|
||||
|
||||
Сервис написан на Python (**FastAPI** + ORM **Piccolo**). Приложение
|
||||
собирается фабрикой `create_app` в `src/app/http.py`. Роутинг состоит из
|
||||
двух групп:
|
||||
|
||||
- публичный API — префикс `/api/v1` (`controller/http/api`);
|
||||
- внутренний API — префикс `/internal/v1` (`controller/http/internal_api`),
|
||||
предназначен для вызовов внутри кластера (через ingress не публикуется).
|
||||
|
||||
Интерактивная документация (ReDoc) доступна по `/docs/`, схема —
|
||||
по `/openapi.json/` (с учётом `root_path`). Админ-панель Piccolo монтируется
|
||||
по `/admin/` при `HTTP_APP_ADMIN_ENABLE=true`.
|
||||
|
||||
### Аутентификация
|
||||
Аутентификация включается флагом `JWT_AUTH_ENABLE`. При включённом
|
||||
`JWTAuthMiddleware` (`controller/http/middlewares.py`) публичные эндпоинты
|
||||
требуют заголовок `Authorization: Bearer <jwt>`. Поддерживаются два режима:
|
||||
|
||||
1. **Zitadel** — если передан дополнительный заголовок `identity`
|
||||
(`Identity <jwt>`), полезная нагрузка (`user_id`, `company_ids`) берётся
|
||||
из этого токена (`urn:zitadel:iam:user:metadata`).
|
||||
2. **sarex-backend** — если заголовка `identity` нет, разбирается основной
|
||||
токен (алгоритм `RS512`, ключ `JWT_AUTH_PUBLIC_KEY`).
|
||||
|
||||
В обоих режимах разбор выполняется с `verify_signature=False` — подпись на
|
||||
уровне приложения не проверяется, доверие обеспечивается сетевым слоем.
|
||||
Внутренние эндпоинты (`/internal/*`) и пути `/docs/`, `/openapi.json/`,
|
||||
`/admin/*` аутентификацию пропускают. При `JWT_AUTH_ENABLE=false` middleware
|
||||
не подключается и используется дефолтный пользователь.
|
||||
|
||||
### Пагинация
|
||||
Списочные ответы используют пагинацию limit/offset и оборачиваются в
|
||||
`PaginatedResponse` — `{ count, result }`, где `count` — число объектов в
|
||||
текущем ответе, `result` — сами объекты. Параметры: `limit` (по умолчанию
|
||||
`100`), `offset` (по умолчанию `0`), сортировка — `order_by`/`ascending`.
|
||||
|
||||
### Обработка ошибок
|
||||
Доменные ошибки (`controller/http/errors.py`) возвращаются как
|
||||
`application/json` с телом `{ "detail": "<текст>" }`. Маппинг:
|
||||
|
||||
- `ResourceNotPermittedError` → **403**;
|
||||
- `ResourceNotFoundError` → **404**;
|
||||
- `StateConflictError` → **409**;
|
||||
- `ChecklistResultValidationError` → **422**;
|
||||
- прочее → **500**.
|
||||
|
||||
Ошибки валидации тела/параметров запроса (Pydantic) отдаются FastAPI в
|
||||
стандартном формате `422` (`HTTPValidationError`). Все публичные эндпоинты
|
||||
(`/api/*`) при невалидном/отсутствующем токене возвращают `401`.
|
||||
|
||||
contact:
|
||||
name: checklists-backend
|
||||
url: https://gitlab/proc/checklists-backend
|
||||
|
||||
servers:
|
||||
- url: https://api.sarex.io/checklists
|
||||
description: Production (ingress, root_path=/checklists)
|
||||
- url: https://stage-api.sarex.io/checklists
|
||||
description: Stage (ingress, root_path=/checklists)
|
||||
- url: http://checklists-backend-service.proc.svc.cluster.local
|
||||
description: Внутрикластерный адрес (ClusterIP, порт 80 → 8000). Единственный способ достучаться до /internal/v1
|
||||
- url: http://localhost:8000
|
||||
description: Локальный запуск (Uvicorn, порт по умолчанию 8000)
|
||||
|
||||
tags:
|
||||
- name: Checklists
|
||||
description: Чек-листы — создание, просмотр, поиск, удаление
|
||||
- name: Checklist results
|
||||
description: Результаты чек-листов — создание, просмотр, обновление, удаление
|
||||
- name: internal
|
||||
description: Внутренние эндпоинты (только внутри кластера)
|
||||
|
||||
security:
|
||||
- bearerAuth: []
|
||||
|
||||
paths:
|
||||
# ==========================================================================
|
||||
# Checklists
|
||||
# ==========================================================================
|
||||
/api/v1/checklists/:
|
||||
post:
|
||||
tags: [Checklists]
|
||||
summary: Создать чек-лист
|
||||
operationId: createChecklist
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistCreate'
|
||||
responses:
|
||||
'201':
|
||||
description: Созданный чек-лист
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistReadFull'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'403': { $ref: '#/components/responses/Forbidden' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
get:
|
||||
tags: [Checklists]
|
||||
summary: Список чек-листов
|
||||
operationId: listChecklists
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/OrderByChecklist' }
|
||||
- { $ref: '#/components/parameters/Ascending' }
|
||||
- { $ref: '#/components/parameters/Limit' }
|
||||
- { $ref: '#/components/parameters/Offset' }
|
||||
- name: company_id
|
||||
in: query
|
||||
required: false
|
||||
description: Фильтр по ID компаний
|
||||
schema:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: integer
|
||||
minimum: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Страница чек-листов (компактное представление)
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PaginatedResponse_ChecklistReadCompact'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
|
||||
/api/v1/checklists/filter/:
|
||||
post:
|
||||
tags: [Checklists]
|
||||
summary: Список чек-листов (фильтры в теле)
|
||||
description: Аналог `GET /api/v1/checklists/`, но фильтры и пагинация передаются в теле запроса.
|
||||
operationId: filterChecklists
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistFiltersWithPagination'
|
||||
responses:
|
||||
'200':
|
||||
description: Страница чек-листов (компактное представление)
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PaginatedResponse_ChecklistReadCompact'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
|
||||
/api/v1/checklists/{instance_id}/:
|
||||
get:
|
||||
tags: [Checklists]
|
||||
summary: Чек-лист по id
|
||||
operationId: getChecklist
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/InstanceId' }
|
||||
responses:
|
||||
'200':
|
||||
description: Чек-лист (полное представление)
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistReadFull'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'403': { $ref: '#/components/responses/Forbidden' }
|
||||
'404': { $ref: '#/components/responses/NotFound' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
delete:
|
||||
tags: [Checklists]
|
||||
summary: Удалить чек-лист
|
||||
operationId: deleteChecklist
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/InstanceId' }
|
||||
responses:
|
||||
'204':
|
||||
description: Чек-лист удалён
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'403': { $ref: '#/components/responses/Forbidden' }
|
||||
'404': { $ref: '#/components/responses/NotFound' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
|
||||
# ==========================================================================
|
||||
# Checklist results
|
||||
# ==========================================================================
|
||||
/api/v1/results/:
|
||||
post:
|
||||
tags: [Checklist results]
|
||||
summary: Создать результат чек-листа
|
||||
description: |
|
||||
Создаёт результат по `checklist_id`. Данные чек-листа переносятся бэком
|
||||
автоматически; в теле передаются метаданные и список значений инпутов
|
||||
(`input_values`).
|
||||
operationId: createChecklistResult
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistResultCreate'
|
||||
responses:
|
||||
'201':
|
||||
description: Созданный результат
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistResultRead'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'403': { $ref: '#/components/responses/Forbidden' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
get:
|
||||
tags: [Checklist results]
|
||||
summary: Список результатов чек-листов
|
||||
operationId: listChecklistResults
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/OrderByChecklistResult' }
|
||||
- { $ref: '#/components/parameters/Ascending' }
|
||||
- { $ref: '#/components/parameters/Limit' }
|
||||
- { $ref: '#/components/parameters/Offset' }
|
||||
- { $ref: '#/components/parameters/FilterResultId' }
|
||||
- { $ref: '#/components/parameters/FilterChecklistId' }
|
||||
- { $ref: '#/components/parameters/FilterCreatorId' }
|
||||
- { $ref: '#/components/parameters/FilterIsDraft' }
|
||||
- { $ref: '#/components/parameters/FilterIsLocked' }
|
||||
responses:
|
||||
'200':
|
||||
description: Страница результатов
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PaginatedResponse_ChecklistResultRead'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
|
||||
/api/v1/results/{instance_id}/:
|
||||
get:
|
||||
tags: [Checklist results]
|
||||
summary: Результат чек-листа по id
|
||||
operationId: getChecklistResult
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/InstanceId' }
|
||||
responses:
|
||||
'200':
|
||||
description: Результат чек-листа
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistResultRead'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'403': { $ref: '#/components/responses/Forbidden' }
|
||||
'404': { $ref: '#/components/responses/NotFound' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
patch:
|
||||
tags: [Checklist results]
|
||||
summary: Обновить результат чек-листа
|
||||
description: Частичное обновление значений инпутов и флага черновика.
|
||||
operationId: updateChecklistResult
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/InstanceId' }
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistResultPartialUpdate'
|
||||
responses:
|
||||
'200':
|
||||
description: Обновлённый результат
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistResultRead'
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'403': { $ref: '#/components/responses/Forbidden' }
|
||||
'404': { $ref: '#/components/responses/NotFound' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
delete:
|
||||
tags: [Checklist results]
|
||||
summary: Удалить результат чек-листа
|
||||
operationId: deleteChecklistResult
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/InstanceId' }
|
||||
responses:
|
||||
'204':
|
||||
description: Результат удалён
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'403': { $ref: '#/components/responses/Forbidden' }
|
||||
'404': { $ref: '#/components/responses/NotFound' }
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
|
||||
# ==========================================================================
|
||||
# Internal
|
||||
# ==========================================================================
|
||||
/internal/v1/results/:
|
||||
get:
|
||||
tags: [internal]
|
||||
summary: Список результатов (внутренний)
|
||||
description: Внутрикластерный эндпоинт. Аутентификация на уровне приложения не выполняется.
|
||||
operationId: internalListChecklistResults
|
||||
security: []
|
||||
parameters:
|
||||
- { $ref: '#/components/parameters/OrderByChecklistResult' }
|
||||
- { $ref: '#/components/parameters/Ascending' }
|
||||
- { $ref: '#/components/parameters/Limit' }
|
||||
- { $ref: '#/components/parameters/Offset' }
|
||||
- { $ref: '#/components/parameters/FilterResultId' }
|
||||
- { $ref: '#/components/parameters/FilterChecklistId' }
|
||||
- { $ref: '#/components/parameters/FilterCreatorId' }
|
||||
- { $ref: '#/components/parameters/FilterIsDraft' }
|
||||
- { $ref: '#/components/parameters/FilterIsLocked' }
|
||||
responses:
|
||||
'200':
|
||||
description: Страница результатов
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PaginatedResponse_ChecklistResultRead'
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
|
||||
/internal/v1/results/lock:
|
||||
patch:
|
||||
tags: [internal]
|
||||
summary: Массовое обновление блокировки результатов
|
||||
description: Устанавливает флаг `is_locked` для списка результатов по их id. Внутрикластерный эндпоинт.
|
||||
operationId: internalBulkUpdateLock
|
||||
security: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChecklistResultBulkLockingPartialUpdate'
|
||||
responses:
|
||||
'204':
|
||||
description: Флаги блокировки обновлены
|
||||
'422': { $ref: '#/components/responses/ValidationError' }
|
||||
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerAuth:
|
||||
type: http
|
||||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
description: |
|
||||
JWT в заголовке `Authorization: Bearer <token>`. Алгоритм `RS512`,
|
||||
ключ `JWT_AUTH_PUBLIC_KEY`. Разбор выполняется без проверки подписи
|
||||
(`verify_signature=False`).
|
||||
identityToken:
|
||||
type: apiKey
|
||||
in: header
|
||||
name: identity
|
||||
description: |
|
||||
Опциональный заголовок `identity` (`Identity <jwt>`) для режима Zitadel.
|
||||
При его наличии полезная нагрузка (`user_id`, `company_ids`) берётся из
|
||||
этого токена.
|
||||
|
||||
parameters:
|
||||
InstanceId:
|
||||
name: instance_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
Limit:
|
||||
name: limit
|
||||
in: query
|
||||
required: false
|
||||
description: Максимальное количество объектов
|
||||
schema:
|
||||
type: integer
|
||||
default: 100
|
||||
Offset:
|
||||
name: offset
|
||||
in: query
|
||||
required: false
|
||||
description: Количество пропущенных объектов
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
Ascending:
|
||||
name: ascending
|
||||
in: query
|
||||
required: false
|
||||
description: Сортировка по возрастанию
|
||||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
OrderByChecklist:
|
||||
name: order_by
|
||||
in: query
|
||||
required: false
|
||||
description: Поле для сортировки
|
||||
schema:
|
||||
type: string
|
||||
enum: [id]
|
||||
default: id
|
||||
OrderByChecklistResult:
|
||||
name: order_by
|
||||
in: query
|
||||
required: false
|
||||
description: Поле для сортировки
|
||||
schema:
|
||||
type: string
|
||||
enum: [id]
|
||||
default: id
|
||||
FilterResultId:
|
||||
name: id
|
||||
in: query
|
||||
required: false
|
||||
description: Фильтр по ID результата
|
||||
schema:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: integer
|
||||
minimum: 1
|
||||
FilterChecklistId:
|
||||
name: checklist_id
|
||||
in: query
|
||||
required: false
|
||||
description: Фильтр по ID чек-листа
|
||||
schema:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: integer
|
||||
minimum: 1
|
||||
FilterCreatorId:
|
||||
name: creator_id
|
||||
in: query
|
||||
required: false
|
||||
description: Фильтр по ID создателя результата
|
||||
schema:
|
||||
type: array
|
||||
nullable: true
|
||||
items:
|
||||
type: integer
|
||||
minimum: 1
|
||||
FilterIsDraft:
|
||||
name: is_draft
|
||||
in: query
|
||||
required: false
|
||||
description: Признак «чернового» результата
|
||||
schema:
|
||||
type: boolean
|
||||
nullable: true
|
||||
FilterIsLocked:
|
||||
name: is_locked
|
||||
in: query
|
||||
required: false
|
||||
description: Признак блокировки результата
|
||||
schema:
|
||||
type: boolean
|
||||
nullable: true
|
||||
|
||||
responses:
|
||||
Unauthorized:
|
||||
description: Токен не предоставлен или невалиден
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPError'
|
||||
Forbidden:
|
||||
description: Недостаточно прав
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPError'
|
||||
NotFound:
|
||||
description: Запрошенный ресурс не найден
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPError'
|
||||
Conflict:
|
||||
description: Конфликт состояния
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPError'
|
||||
ValidationError:
|
||||
description: |
|
||||
Ошибка валидации тела/параметров запроса (FastAPI/Pydantic) либо
|
||||
доменная ошибка валидации результата (`{ detail }`).
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPValidationError'
|
||||
|
||||
schemas:
|
||||
# ---- Общие ----
|
||||
HTTPError:
|
||||
type: object
|
||||
properties:
|
||||
detail:
|
||||
type: string
|
||||
description: Описание ошибки
|
||||
required: [detail]
|
||||
|
||||
HTTPValidationError:
|
||||
type: object
|
||||
properties:
|
||||
detail:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
|
||||
ValidationError:
|
||||
type: object
|
||||
properties:
|
||||
loc:
|
||||
type: array
|
||||
items:
|
||||
anyOf:
|
||||
- type: string
|
||||
- type: integer
|
||||
msg:
|
||||
type: string
|
||||
type:
|
||||
type: string
|
||||
required: [loc, msg, type]
|
||||
|
||||
# ---- Ограничения инпутов ----
|
||||
InputChoiceOption:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
description: Уникальный идентификатор опции
|
||||
name:
|
||||
type: string
|
||||
description: Название опции
|
||||
example: "Да"
|
||||
order:
|
||||
type: integer
|
||||
description: Порядковый номер опции
|
||||
example: 1
|
||||
color:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Цвет опции (hex или именованный html-цвет)
|
||||
example: "#00aa00"
|
||||
selected_tip:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Заметка при выборе опции
|
||||
example: 'Рекомендуется добавить комментарий при ответе "Нет"'
|
||||
alt_name:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Название опции для записи в историю
|
||||
example: "Одобрено"
|
||||
required: [id, name, order, selected_tip]
|
||||
|
||||
InputChoiceConstraints:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum: [choice]
|
||||
options:
|
||||
type: array
|
||||
nullable: true
|
||||
description: Список опций для выбора
|
||||
items:
|
||||
$ref: '#/components/schemas/InputChoiceOption'
|
||||
required: [type, options]
|
||||
|
||||
InputStringConstraints:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum: [string]
|
||||
min_length:
|
||||
type: integer
|
||||
minimum: 0
|
||||
default: 0
|
||||
description: Минимально допустимое количество символов
|
||||
max_length:
|
||||
type: integer
|
||||
minimum: 1
|
||||
default: 1000
|
||||
description: Максимально допустимое количество символов
|
||||
required: [type]
|
||||
|
||||
InputConstraints:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/InputChoiceConstraints'
|
||||
- $ref: '#/components/schemas/InputStringConstraints'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
choice: '#/components/schemas/InputChoiceConstraints'
|
||||
string: '#/components/schemas/InputStringConstraints'
|
||||
|
||||
# ---- Чек-лист (создание) ----
|
||||
ChecklistInputCreate:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
maxLength: 1024
|
||||
description: Название
|
||||
example: "Комментарий"
|
||||
order:
|
||||
type: integer
|
||||
description: Порядковый номер
|
||||
is_required:
|
||||
type: boolean
|
||||
description: Обязательное ли поле для заполнения
|
||||
constraints:
|
||||
$ref: '#/components/schemas/InputConstraints'
|
||||
required: [name, order, is_required, constraints]
|
||||
|
||||
ChecklistItemCreate:
|
||||
type: object
|
||||
properties:
|
||||
description:
|
||||
type: string
|
||||
maxLength: 8192
|
||||
description: Описание шага
|
||||
order:
|
||||
type: integer
|
||||
description: Порядковый номер
|
||||
inputs:
|
||||
type: array
|
||||
description: Список элементов ввода
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistInputCreate'
|
||||
required: [description, order, inputs]
|
||||
|
||||
ChecklistCreate:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
maxLength: 250
|
||||
description: Название
|
||||
example: "Чек-лист проверки документов"
|
||||
description:
|
||||
type: string
|
||||
maxLength: 8192
|
||||
description: Описание чек-листа
|
||||
company_id:
|
||||
type: integer
|
||||
minimum: 1
|
||||
description: ID компании
|
||||
example: 1
|
||||
items:
|
||||
type: array
|
||||
description: Список шагов чек-листа
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistItemCreate'
|
||||
required: [name, description, company_id, items]
|
||||
|
||||
# ---- Чек-лист (чтение) ----
|
||||
ChecklistInputRead:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
example: 1
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
name:
|
||||
type: string
|
||||
maxLength: 1024
|
||||
order:
|
||||
type: integer
|
||||
is_required:
|
||||
type: boolean
|
||||
constraints:
|
||||
$ref: '#/components/schemas/InputConstraints'
|
||||
required: [id, created_at, updated_at, name, order, is_required, constraints]
|
||||
|
||||
ChecklistItemRead:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description:
|
||||
type: string
|
||||
maxLength: 8192
|
||||
order:
|
||||
type: integer
|
||||
inputs:
|
||||
type: array
|
||||
description: Список элементов ввода
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistInputRead'
|
||||
required: [id, created_at, updated_at, description, order, inputs]
|
||||
|
||||
ChecklistReadCompact:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
example: 1
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
name:
|
||||
type: string
|
||||
description:
|
||||
type: string
|
||||
company_id:
|
||||
type: integer
|
||||
minimum: 1
|
||||
required: [id, created_at, updated_at, name, description, company_id]
|
||||
|
||||
ChecklistReadFull:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/ChecklistReadCompact'
|
||||
- type: object
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
description: Список шагов чек-листа
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistItemRead'
|
||||
required: [items]
|
||||
|
||||
ChecklistFiltersWithPagination:
|
||||
type: object
|
||||
properties:
|
||||
order_by:
|
||||
type: string
|
||||
enum: [id]
|
||||
default: id
|
||||
ascending:
|
||||
type: boolean
|
||||
default: true
|
||||
limit:
|
||||
type: integer
|
||||
default: 100
|
||||
offset:
|
||||
type: integer
|
||||
default: 0
|
||||
company_id:
|
||||
type: array
|
||||
nullable: true
|
||||
description: Фильтр по ID компаний
|
||||
items:
|
||||
type: integer
|
||||
minimum: 1
|
||||
|
||||
# ---- Результаты чек-листов ----
|
||||
ChecklistResultInputCreate:
|
||||
type: object
|
||||
properties:
|
||||
input_id:
|
||||
type: integer
|
||||
description: ID инпута, для которого устанавливается значение
|
||||
example: 1
|
||||
value:
|
||||
description: 'Значение (тип зависит от инпута: id опции для choice, строка для string)'
|
||||
nullable: true
|
||||
example: "Да"
|
||||
required: [input_id, value]
|
||||
|
||||
ChecklistResultCreate:
|
||||
type: object
|
||||
properties:
|
||||
entity_type:
|
||||
type: string
|
||||
description: Сущность, для которой создан результат
|
||||
example: "review"
|
||||
entity_id:
|
||||
type: string
|
||||
description: ID сущности, для которой создан результат
|
||||
example: "1"
|
||||
checklist_id:
|
||||
type: integer
|
||||
description: ID чек-листа
|
||||
example: 1
|
||||
accessible_by:
|
||||
type: array
|
||||
description: SA ID роли/места/пользователя, которым доступен результат
|
||||
items:
|
||||
type: string
|
||||
format: uuid
|
||||
is_draft:
|
||||
type: boolean
|
||||
description: Является ли результат черновым
|
||||
input_values:
|
||||
type: array
|
||||
description: Список устанавливаемых значений
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistResultInputCreate'
|
||||
required: [entity_type, entity_id, checklist_id, accessible_by, is_draft, input_values]
|
||||
|
||||
ChecklistResultPartialUpdate:
|
||||
type: object
|
||||
properties:
|
||||
input_values:
|
||||
type: array
|
||||
description: Список устанавливаемых значений
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistResultInputCreate'
|
||||
is_draft:
|
||||
type: boolean
|
||||
description: Является ли результат черновым
|
||||
required: [input_values, is_draft]
|
||||
|
||||
ChecklistResultInput:
|
||||
type: object
|
||||
properties:
|
||||
input_id:
|
||||
type: integer
|
||||
description: ID инпута, для которого создан результат
|
||||
name:
|
||||
type: string
|
||||
description: Название
|
||||
order:
|
||||
type: integer
|
||||
description: Порядковый номер
|
||||
value:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Введённое значение (строка или UUID выбранной опции)
|
||||
value_text:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Текстовое представление введённого значения
|
||||
color:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Цвет значения
|
||||
required: [input_id, name, order, value, value_text, color]
|
||||
|
||||
ChecklistResultItem:
|
||||
type: object
|
||||
properties:
|
||||
description:
|
||||
type: string
|
||||
description: Описание шага
|
||||
order:
|
||||
type: integer
|
||||
description: Порядковый номер
|
||||
inputs:
|
||||
type: array
|
||||
description: Список введённых значений
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistResultInput'
|
||||
required: [description, order, inputs]
|
||||
|
||||
ChecklistResultRead:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
example: 1
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
entity_type:
|
||||
type: string
|
||||
example: "review"
|
||||
entity_id:
|
||||
type: string
|
||||
example: "1"
|
||||
checklist_id:
|
||||
type: integer
|
||||
accessible_by:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
format: uuid
|
||||
is_draft:
|
||||
type: boolean
|
||||
company_id:
|
||||
type: integer
|
||||
description: ID компании
|
||||
is_locked:
|
||||
type: boolean
|
||||
description: Заблокирован ли результат для изменений
|
||||
items:
|
||||
type: array
|
||||
description: Список шагов чек-листа
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistResultItem'
|
||||
required:
|
||||
- id
|
||||
- created_at
|
||||
- updated_at
|
||||
- entity_type
|
||||
- entity_id
|
||||
- checklist_id
|
||||
- accessible_by
|
||||
- is_draft
|
||||
- company_id
|
||||
- is_locked
|
||||
- items
|
||||
|
||||
ChecklistResultBulkLockingPartialUpdate:
|
||||
type: object
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
description: Список id результатов, которым нужно обновить флаг
|
||||
items:
|
||||
type: integer
|
||||
example: [1, 2, 3]
|
||||
is_locked:
|
||||
type: boolean
|
||||
description: Заблокирован ли результат для изменений
|
||||
required: [ids, is_locked]
|
||||
|
||||
# ---- Пагинация ----
|
||||
PaginatedResponse_ChecklistReadCompact:
|
||||
type: object
|
||||
properties:
|
||||
count:
|
||||
type: integer
|
||||
description: Количество объектов
|
||||
example: 1
|
||||
result:
|
||||
type: array
|
||||
description: Объекты
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistReadCompact'
|
||||
required: [count, result]
|
||||
|
||||
PaginatedResponse_ChecklistResultRead:
|
||||
type: object
|
||||
properties:
|
||||
count:
|
||||
type: integer
|
||||
description: Количество объектов
|
||||
example: 1
|
||||
result:
|
||||
type: array
|
||||
description: Объекты
|
||||
items:
|
||||
$ref: '#/components/schemas/ChecklistResultRead'
|
||||
required: [count, result]
|
||||
@ -9,7 +9,7 @@ spec:
|
||||
chart:
|
||||
spec:
|
||||
chart: postgresql-contour
|
||||
version: "13.0.15"
|
||||
version: "17.0.7"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
@ -44,7 +44,7 @@ spec:
|
||||
image:
|
||||
registry: cr.yandex/crp3ccidau046kdj8g9q
|
||||
repository: contour/postgresql
|
||||
tag: 13.0.15
|
||||
tag: 17.0.7
|
||||
pullPolicy: Always
|
||||
metrics:
|
||||
enabled: false
|
||||
@ -103,7 +103,7 @@ spec:
|
||||
contour:
|
||||
enabled: true
|
||||
adminUser: "postgres"
|
||||
sharedPreloadLibraries: ""
|
||||
sharedPreloadLibraries: "pg_stat_statements,uuid-ossp"
|
||||
vault:
|
||||
enabled: true
|
||||
role: postgresql
|
||||
@ -115,10 +115,7 @@ spec:
|
||||
- name: checklists_db
|
||||
user: checklists
|
||||
passwordKey: checklists
|
||||
extensions:
|
||||
- pg_stat_statements
|
||||
- uuid-ossp
|
||||
restoreFromDump: true
|
||||
dumpKey: "sanitized_dumps_multi/checklists/288/checklists_company288_20260626T202844Z.tar.gz"
|
||||
extensions: []
|
||||
restoreFromDump: false
|
||||
s3-proxy:
|
||||
endpointUrl: "s3-proxy-service.postgresql.svc.cluster.local"
|
||||
|
||||
@ -1,54 +0,0 @@
|
||||
# Пример переменных окружения для comparisons-backend.
|
||||
# Значения разбираются пакетом kelseyhightower/envconfig (config/config.go, FromEnv).
|
||||
# Префикса нет — имена переменных используются как есть.
|
||||
# Приложение НЕ загружает .env автоматически: переменные нужно экспортировать
|
||||
# в окружение (для локального запуска см. .docker/.env и docker-compose).
|
||||
|
||||
# API
|
||||
API_ADDRESS=0.0.0.0:8080
|
||||
|
||||
# Database (PostgreSQL)
|
||||
POSTGRES_ADDRESS=127.0.0.1
|
||||
POSTGRES_PORT=5432
|
||||
POSTGRES_USER=postgres
|
||||
POSTGRES_PASSWORD=password
|
||||
POSTGRES_DB=comparisons
|
||||
POSTGRES_POOL_SIZE=10
|
||||
# TLS-подключение к БД. При ENABLE_SSL=1 используется YC-PG-CERTIFICATE как CA.
|
||||
ENABLE_SSL=0
|
||||
DB_CERT_PATH=/home/user/.postgresql/root.crt
|
||||
YC-PG-CERTIFICATE=
|
||||
|
||||
# Внешние сервисы (внутрикластерные адреса)
|
||||
DOCUMENTATION_URL=http://documentations-service.documentations-stage/
|
||||
EXTERNAL_DOCUMENTATION_URL=https://stage-api.sarex.io/documentations
|
||||
# Хранилище файлов PDM (multistorage, config/storage.go). Без него сервис
|
||||
# стартует, но с предупреждением — PDM-хранилище будет недоступно.
|
||||
DOCUMENTATION_FILESTREAM_URL=http://documentations-filestream-service.documentations-stage/
|
||||
WORKFLOW_URL=http://workflows-service.processing-stage/
|
||||
WORKSPACE_URL=http://workspaces-service.workspaces-stage/
|
||||
EXTERNAL_WORKSPACE_URL=
|
||||
COMPARISON_URL=http://comparisons-backend-service.comparisons-stage/
|
||||
WORKFLOW_IMAGES_VERSION=develop
|
||||
BIM_V2_INTERNAL_URL=http://bim-backend-v2-service.bim-api-stage/
|
||||
# Используется клиентом workflow (pdf2pdf) как django_host в параметрах задачи.
|
||||
DJANGO_HOST=https://stage.sarex.io
|
||||
|
||||
# Comparisons
|
||||
# Ограничение параллелизма ABAP-сравнения (0 — без ограничения).
|
||||
ABAP_FIXED_CONC=0
|
||||
|
||||
# Sentry / окружение
|
||||
ENVIRONMENT=stage
|
||||
SENTRY_DSN=
|
||||
SENTRY_DEBUG=0
|
||||
|
||||
# Отладка
|
||||
# Логировать SQL-запросы (go-pg query hook).
|
||||
ENABLE_SQL_QUERY=0
|
||||
|
||||
# --- Дополнительно (используются только при локальном запуске / внешними
|
||||
# --- библиотеками, кодом config.Config напрямую не читаются) ---
|
||||
# S3_SERVICE_ACCOUNT=/etc/sarex/yc_s3_doc_account.json
|
||||
# DJANGO_ORIGINATOR=docs_local
|
||||
# NAMESPACE=local
|
||||
@ -1,148 +0,0 @@
|
||||
# Конфигурация проекта comparisons-backend
|
||||
|
||||
Документ описывает все переменные окружения и способы конфигурирования сервиса `comparisons-backend` (Go).
|
||||
|
||||
## Способы конфигурирования
|
||||
|
||||
Сервис настраивается **только через переменные окружения**. Разбор выполняется в `config/config.go` функцией `FromEnv()` через библиотеку [`kelseyhightower/envconfig`](https://github.com/kelseyhightower/envconfig) (структура `Config`).
|
||||
|
||||
Особенности разбора:
|
||||
|
||||
- **префикса нет** — `envconfig.Process("", &cfg)` вызывается с пустым префиксом, поэтому имена переменных совпадают с тегами `envconfig:"..."` (напр. `POSTGRES_ADDRESS`, `API_ADDRESS`);
|
||||
- **вложенности нет** — все переменные плоские (без разделителя секций);
|
||||
- отдельные значения читаются напрямую через `os.Getenv` в обход структуры `Config`: `DOCUMENTATION_FILESTREAM_URL` (`config/storage.go`) и `DJANGO_HOST` (`clients/workflow_cli/pdf2pdf.go`).
|
||||
|
||||
Отдельного конфиг-файла (yaml/toml) у приложения нет. Приложение **не загружает `.env` автоматически** — переменные нужно экспортировать в окружение самому либо задавать через `--env`/`env_file` (docker-compose).
|
||||
|
||||
Источники переменных по способам запуска:
|
||||
|
||||
| Способ запуска | Откуда берутся переменные |
|
||||
| --- | --- |
|
||||
| Локально (бинарник) | Переменные окружения процесса. Собирается через `make api` (`go install ./cmd/api`, `./cmd/migrations`) |
|
||||
| Локально (контейнеры) | `.docker/.env` + `.docker/docker-compose.yml` (`make docker`). Postgres поднимается из этого же compose |
|
||||
| Kubernetes (Helm, репозиторий бэкенда) | `.helm/values-<env>.yaml`: блок `envs` (обычные значения) и `secrets` (значения из k8s-секретов); шаблон `.helm/templates/api.yaml` |
|
||||
| Kubernetes (Kustomize, этот репозиторий infra) | `apps/comparisons/base` + оверлеи; env задаются в `base/backend-deployment.yaml` и патчах оверлеев. **Схема переменных здесь отличается — см. раздел ниже** |
|
||||
| CI/CD (GitLab) | `.gitlab-ci.yml`: подключает шаблоны `generic/common-ci` (stage/preprod/prod), job `unit-tests` (образ `golang:1.21`) |
|
||||
|
||||
Способы запуска процессов (`cmd/*`):
|
||||
|
||||
| Команда | Точка входа | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `api` (`make api`) | `cmd/api/main.go` | HTTP API (gorilla/mux). Перед стартом настраивает Sentry и подключение к Postgres |
|
||||
| `migrations` | `cmd/migrations/main.go` | Миграции БД (`robinjoseph08/go-pg-migrations`). Создание: `go run ./cmd/migrations/main.go create <name>` |
|
||||
|
||||
## Переменные приложения
|
||||
|
||||
Дефолт `—` означает, что явного значения по умолчанию нет (пустая строка / нулевое значение типа Go). Обязательность отдельных переменных проверяется в рантайме при создании клиентов.
|
||||
|
||||
### API
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `API_ADDRESS` | string | — | Адрес и порт прослушивания HTTP-сервера (напр. `0.0.0.0:8080`) |
|
||||
|
||||
### Database (PostgreSQL)
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `POSTGRES_ADDRESS` | string | — | Хост PostgreSQL |
|
||||
| `POSTGRES_PORT` | string | — | Порт PostgreSQL |
|
||||
| `POSTGRES_USER` | string | — | Пользователь БД |
|
||||
| `POSTGRES_PASSWORD` | string | — | Пароль пользователя БД |
|
||||
| `POSTGRES_DB` | string | — | Имя базы данных |
|
||||
| `POSTGRES_POOL_SIZE` | int | — | Размер пула соединений (в коде `main.go` пул жёстко равен `30`; переменная читается, но фактически используется значение из кода) |
|
||||
| `ENABLE_SSL` | bool | `false` | Подключение к БД по TLS. При `true` используется `YC-PG-CERTIFICATE` как корневой сертификат, `ServerName` = `POSTGRES_ADDRESS` |
|
||||
| `DB_CERT_PATH` | string | — | Путь к CA-сертификату PostgreSQL (используется инфраструктурой; в Helm — смонтированный файл) |
|
||||
| `YC-PG-CERTIFICATE` | string | — | Содержимое CA-сертификата для TLS-подключения к БД. Имя с дефисами не соответствует остальным (`envconfig` допускает произвольный тег) |
|
||||
|
||||
### Внешние сервисы
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `DOCUMENTATION_URL` | string | — | Внутренний URL сервиса документаций (обязателен для `documentation_cli`) |
|
||||
| `EXTERNAL_DOCUMENTATION_URL` | string | — | Внешний URL сервиса документаций (обязателен для `documentation_cli`) |
|
||||
| `DOCUMENTATION_FILESTREAM_URL` | string | — | URL PDM-хранилища файлов (`config/storage.go`). Если не задан — сервис стартует, но PDM-хранилище недоступно (лог-warning) |
|
||||
| `WORKFLOW_URL` | string | — | Внутренний URL сервиса workflow (обязателен для `workflow_cli`) |
|
||||
| `WORKSPACE_URL` | string | — | Внутренний URL сервиса workspace (обязателен для `workspace_cli`) |
|
||||
| `EXTERNAL_WORKSPACE_URL` | string | — | Внешний URL сервиса workspace |
|
||||
| `COMPARISON_URL` | string | — | URL самого сервиса сравнений (обязателен для `workflow_cli`) |
|
||||
| `WORKFLOW_IMAGES_VERSION` | string | — | Версия/тег образов задач workflow (обязателен для `workflow_cli`) |
|
||||
| `BIM_V2_INTERNAL_URL` | string | — | Внутренний URL BIM API v2 |
|
||||
| `DJANGO_HOST` | string | — | Хост Django (LK). Передаётся как `django_host` в параметры задачи pdf2pdf (`clients/workflow_cli/pdf2pdf.go`) |
|
||||
|
||||
### Comparisons
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ABAP_FIXED_CONC` | uint64 | `0` | Ограничение параллелизма ABAP-сравнения (`0` — без ограничения) |
|
||||
|
||||
### Sentry и окружение
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ENVIRONMENT` | string | — | Окружение развёртывания (`stage`/`preprod`/`prod`); передаётся в Sentry |
|
||||
| `SENTRY_DSN` | string | — | DSN Sentry |
|
||||
| `SENTRY_DEBUG` | bool | `false` | Debug-режим Sentry |
|
||||
|
||||
### Отладка
|
||||
|
||||
| Переменная | Тип | Значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `ENABLE_SQL_QUERY` | bool | `false` | Логировать SQL-запросы (query hook go-pg) |
|
||||
|
||||
### Дополнительные переменные (не читаются `config.Config`)
|
||||
|
||||
Присутствуют в `.docker/.env` для локального запуска или используются внешними библиотеками (`gotools`), но напрямую структурой `Config` не разбираются:
|
||||
|
||||
| Переменная | Где встречается | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `S3_SERVICE_ACCOUNT` | `.docker/.env` | Путь к JSON сервисного аккаунта S3 |
|
||||
| `DJANGO_ORIGINATOR` | `.docker/.env` | Ориджинатор для интеграции с Django |
|
||||
| `NAMESPACE` | `.docker/.env` | Логическое пространство имён для локального запуска |
|
||||
| `API_ADDRESS_FILE` | `.helm/values-*.yaml` | Адрес file-варианта API (задан в Helm, кодом не используется) |
|
||||
|
||||
## Переменные из Helm-чарта (`.helm/values-<env>.yaml`)
|
||||
|
||||
Обычные значения задаются в блоке `envs` для каждого окружения (`stage`/`preprod`/`production`) и содержат те же переменные приложения, что описаны выше (различаются адресами БД/сервисов, `WORKFLOW_IMAGES_VERSION`, доменом Django и т.п.).
|
||||
|
||||
Значения из секретов (блок `secrets`, монтируются как env через `secretKeyRef`):
|
||||
|
||||
| Переменная | Секрет (`secret_name`) | Ключ (`secret_key`) |
|
||||
| --- | --- | --- |
|
||||
| `POSTGRES_USER` | `ya-pg-secret` | `username` |
|
||||
| `POSTGRES_PASSWORD` | `ya-pg-secret` | `password` |
|
||||
| `YC-PG-CERTIFICATE` | `yc-pg-certificate` | `certificate` |
|
||||
|
||||
Прочие значения чарта (не переменные приложения): `api.*` (имя, образ, порт, реплики, ресурсы, ingress `api_host`/`api_host_prefix`/`api_path`/`internal_path`, `permitted_ns`), `version`, `imagePullSecrets`.
|
||||
|
||||
## Развёртывание через Kustomize (этот репозиторий, `apps/comparisons`)
|
||||
|
||||
Структура: `base` (общие манифесты) и оверлеи `brusnika-stage`, `brusnika-prod`, `yc-k8s-test`. Секреты БД и публичный JWT-ключ подтягиваются из **HashiCorp Vault** (аннотации `vault.hashicorp.com/*` в `base/backend-deployment.yaml`), а не из k8s-секретов.
|
||||
|
||||
> **Важно: расхождение схем переменных.** Манифест `base/backend-deployment.yaml` использует другой (более новый) набор имён переменных, чем Go-код из `comparisons-backend` (`config/config.go`): напр. `HTTP_PORT`, `LOGGER_LOG_LEVEL`, `DATABASE_NAME`, `DOCUMENTATIONS_INTERNAL_HOST`, `DOCUMENTATIONS_EXTERNAL_HOST`, `WORKFLOWS_HOST`, `WORKFLOWS_DJANGO_HOST`, `WORKFLOWS_BIMV2_INTERNAL_HOST`, `WORKSPACES_HOST`, `EAV_HOST`, `APP_NAME`, `AUTH_PUBLIC_KEY`, `WORKFLOWS_CONFIG_FILEPATH` и др., а также `/ping` в health-проверках и образ `comparisons_backend_prod`. Такой схемы нет в Go-репозитории. Перед использованием этих файлов стоит убедиться, какой именно образ бэкенда деплоится оверлеем: если это Go-сервис из `comparisons-backend`, набор env нужно привести к именам из таблиц выше.
|
||||
|
||||
## Переменные в CI (`.gitlab-ci.yml`)
|
||||
|
||||
Пайплайн подключает общие шаблоны `generic/common-ci` и переключает окружение по ветке/тегу:
|
||||
|
||||
| Условие | Шаблон | Окружение |
|
||||
| --- | --- | --- |
|
||||
| ветка `stage` | `gitlab-ci/comparisons-backend/.gitlab-ci-stage.yml` | stage |
|
||||
| ветка `master` | `gitlab-ci/comparisons-backend/.gitlab-ci-preprod.yml` | preprod |
|
||||
| тег (`CI_COMMIT_TAG`) | `gitlab-ci/comparisons-backend/.gitlab-ci-prod.yml` | prod |
|
||||
|
||||
Стадии: `prebuild-secscan`, `dependencies-build`, `unittest`, `build`, `state-update`, `deploy`. Job `unit-tests` (образ `golang:1.21`) выполняет `make unit-tests`.
|
||||
|
||||
## Минимальный набор для локального запуска
|
||||
|
||||
Postgres поднимается через `.docker/docker-compose.yml` (`make docker`). Минимально необходимо задать:
|
||||
|
||||
- `API_ADDRESS`
|
||||
- `POSTGRES_ADDRESS`, `POSTGRES_PORT`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`, `POSTGRES_POOL_SIZE`, `ENABLE_SSL` (`0` локально)
|
||||
- `DOCUMENTATION_URL`, `EXTERNAL_DOCUMENTATION_URL`, `DOCUMENTATION_FILESTREAM_URL`
|
||||
- `WORKFLOW_URL`, `WORKSPACE_URL`, `COMPARISON_URL`, `WORKFLOW_IMAGES_VERSION`
|
||||
- `BIM_V2_INTERNAL_URL`, `DJANGO_HOST`
|
||||
- `ENVIRONMENT`; при использовании Sentry — `SENTRY_DSN`
|
||||
- по желанию: `ENABLE_SQL_QUERY` (`1` для отладки SQL), `ABAP_FIXED_CONC`
|
||||
|
||||
Готовые значения-примеры приведены в `.env.example`.
|
||||
@ -1,77 +0,0 @@
|
||||
# Эндпоинты, с которыми взаимодействует comparisons-frontend
|
||||
|
||||
Документ описывает все HTTP-эндпоинты внешних сервисов, к которым обращается модуль (микрофронтенд `comparisons-frontend`).
|
||||
|
||||
## Как устроено взаимодействие
|
||||
|
||||
Все запросы описаны декларативно в реестре `module/networking/endpoints.ts` (объект `endpoints`). Каждый эндпоинт задаётся структурой `Endpoint`:
|
||||
|
||||
- `service` — логическое имя сервиса (`EServices`, см. таблицу хостов ниже);
|
||||
- `method` — HTTP-метод (`GET`/`POST`/`PUT`/`PATCH`/`DELETE`);
|
||||
- `path(args)` — функция, возвращающая путь запроса (с подстановкой параметров/query);
|
||||
- `body(args)` — опционально, формирование тела запроса.
|
||||
|
||||
Запрос выполняется единой функцией `fetch(endpoint, params)`, которая через `httpService` (`module/httpService/httpService.ts`, поверх `@sarex-team/sdk-js` + `axios`) отправляет запрос на базовый хост сервиса. Базовый хост подставляется `resolveHost(service)` из `module/httpService/hosts.ts` в зависимости от `buildEnv` (`__BUILD_ENV__`, задаётся сборкой; по умолчанию `prod`). Результат возвращается как `{ resp }` либо `{ errMessage }`.
|
||||
|
||||
## Базовые хосты по сервисам и окружениям
|
||||
|
||||
Значения из `module/httpService/hosts.ts` (`allHosts`). Итоговый URL = `<базовый хост сервиса>` + `path` эндпоинта. Хосты берутся из `@sarex-team/sdk-js` (`resolveHost`).
|
||||
|
||||
| Сервис (`EServices`) | Назначение | `stage` | `prod` |
|
||||
| --- | --- | --- | --- |
|
||||
| `comparisons` | Сервис сравнений (comparisons-backend) | `https://stage-api.sarex.io/comparisons` | `https://api.sarex.io/comparisons` |
|
||||
| `documentations` | Сервис документации (диски, документы) | `https://stage-api.sarex.io/documentations` | `https://api.sarex.io/documentations` |
|
||||
| `sarexApi` | Gateway/API Sarex (`/gateway`) | `https://stage-api.sarex.io` | `https://api.sarex.io` |
|
||||
| `sarex` | Локальный сервис данных (`/api/core`) | `""` (относительные пути) | `""` |
|
||||
| `workflows` | Сервис обработки документов | `https://stage-api.sarex.io/workflows` | `https://api.sarex.io/workflows` |
|
||||
| `bimv2` | BIM API v2 | `https://stage-api.sarex.io/bimv2` | `https://api.sarex.io/bimv2` |
|
||||
| `zitadel` | IdP (аутентификация) | `https://idp.dev.stage.sarex.io` | `https://login.sarex.io` |
|
||||
|
||||
> Также определены окружения `local`, `preprod` и `contour`. В `local` сервисы проксируются на `https://localhost:9000/sarex-backend` и `https://localhost:9000/sarex-api-backend/*`. В `contour` используются относительные пути (`/comparisons`, `/documentations`, `/bimv2`, `/workflows`) для изолированного контура. В `preprod` — `https://api.preprod.sarex.io/*`.
|
||||
|
||||
## Эндпоинты по сервисам
|
||||
|
||||
### `comparisons` — Сервис сравнений
|
||||
|
||||
| Ключ | Метод | Путь | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `getTypes` | GET | `/api/v1/types` | Справочник типов сравнений и их параметров |
|
||||
| `createComparison` | POST | `/api/v1/comparisons` | Создать сравнение (тело — параметры сравнения) |
|
||||
| `getComparisons` | GET | `/api/v1/comparisons?workspace_id={workspaceId}` | Список сравнений рабочей области |
|
||||
| `deleteComparison` | DELETE | `/api/v1/comparisons/{id}` | Удалить сравнение |
|
||||
|
||||
### `documentations` — Сервис документации
|
||||
|
||||
| Ключ | Метод | Путь | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `getDisks` | GET | `/api/v1/disks` | Список дисков |
|
||||
| `getDocuments` | GET | `/api/v1/disks/{id}/documents` | Документы диска |
|
||||
| `getNearestNameTemplate` | GET | `/api/v1/documents/{documentId}/name_template` | Ближайший шаблон имени документа |
|
||||
|
||||
### `sarexApi` — Gateway/API Sarex
|
||||
|
||||
| Ключ | Метод | Путь | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `getDocumentsV2` | GET | `/gateway/api/v1/disks/{id}/documents?parent_id=&child_id=&search=&{attributeValue}` | Документы диска с фильтрами (родитель/ребёнок/поиск/атрибуты) |
|
||||
|
||||
### `sarex` — Локальный сервис данных
|
||||
|
||||
| Ключ | Метод | Путь | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `getUsersByIDs` | GET | `/api/core/users/?id={ids}` | Пользователи по списку id |
|
||||
|
||||
### `workflows` — Сервис обработки документов
|
||||
|
||||
| Ключ | Метод | Путь | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `getWorkflow` | GET | `/api/v1/workflows/{workflowId}` | Workflow по id |
|
||||
|
||||
### `bimv2` — BIM API v2
|
||||
|
||||
| Ключ | Метод | Путь | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `getBim` | GET | `/api/v1/bims/{bimId}` | BIM-модель по id |
|
||||
|
||||
## Обработка ошибок
|
||||
|
||||
`fetch` перехватывает исключения запроса и возвращает `{ errMessage }` (строка ошибки) вместо данных; успешный ответ приходит как `{ resp: <data> }`. Явного маппинга кодов ответа в реестре нет — обработка и отображение ошибок выполняются на уровне репозиториев/вью-моделей, использующих `fetch`.
|
||||
136
apps/comparisons/base/backend-deployment.yaml
Normal file
136
apps/comparisons/base/backend-deployment.yaml
Normal file
@ -0,0 +1,136 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: backend
|
||||
namespace: comparisons
|
||||
labels:
|
||||
app: backend
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: backend
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: backend
|
||||
annotations:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: comparisons
|
||||
vault.hashicorp.com/agent-inject-secret-comparisons-db: secrets/data/postgresql/apps/comparisons
|
||||
vault.hashicorp.com/agent-inject-template-comparisons-db: |-
|
||||
{{- with secret "secrets/data/postgresql/apps/comparisons" -}}
|
||||
DATABASE_HOST=postgresql.comparisons.svc.cluster.local
|
||||
DATABASE_PORT=5432
|
||||
DATABASE_DB=comparisons_db
|
||||
DATABASE_USER={{ index .Data.data "username" }}
|
||||
DATABASE_PASSWORD={{ index .Data.data "password" }}
|
||||
POSTGRES_ADDRESS=postgresql.comparisons.svc.cluster.local
|
||||
POSTGRES_PORT=5432
|
||||
POSTGRES_DB=comparisons_db
|
||||
POSTGRES_USER={{ index .Data.data "username" }}
|
||||
POSTGRES_PASSWORD={{ index .Data.data "password" }}
|
||||
{{- end -}}
|
||||
vault.hashicorp.com/agent-inject-secret-comparisons-jwt-public: secrets/data/vault/common/rsa_keys
|
||||
vault.hashicorp.com/agent-inject-template-comparisons-jwt-public: |-
|
||||
{{- with secret "secrets/data/vault/common/rsa_keys" -}}
|
||||
{{ index .Data.data "public_key" }}
|
||||
{{- end -}}
|
||||
spec:
|
||||
serviceAccountName: comparisons-vault
|
||||
volumes:
|
||||
- name: tasks-execution-config
|
||||
configMap:
|
||||
name: tasks-execution-config-comparisons-v2
|
||||
items:
|
||||
- key: tasks-execution-config-comparisons-v2.json
|
||||
path: tasks-execution-config.json
|
||||
containers:
|
||||
- name: backend
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/comparisons_backend_prod:075fc0
|
||||
imagePullPolicy: IfNotPresent
|
||||
command: ["/bin/bash", "-ec"]
|
||||
args:
|
||||
- |
|
||||
set -a
|
||||
[ -f /vault/secrets/comparisons-db ] && . /vault/secrets/comparisons-db
|
||||
[ -f /vault/secrets/comparisons-jwt-public ] && export AUTH_PUBLIC_KEY="$(cat /vault/secrets/comparisons-jwt-public)"
|
||||
set +a
|
||||
exec /app/entrypoint.sh
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: APP_NAME
|
||||
value: comparisons
|
||||
- name: APP_VERSION
|
||||
value: 0.0.1
|
||||
- name: LOGGER_LOG_LEVEL
|
||||
value: info
|
||||
- name: DATABASE_NAME
|
||||
value: postgres
|
||||
- name: ENABLE_SSL
|
||||
value: "false"
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value: "10"
|
||||
- name: HTTP_PORT
|
||||
value: "8000"
|
||||
- name: DOCUMENTATIONS_INTERNAL_HOST
|
||||
value: http://documentations-service.documentations
|
||||
- name: DOCUMENTATIONS_EXTERNAL_HOST
|
||||
value: https://api.sarex.io/documentations
|
||||
- name: DOCUMENTATION_FILESTREAM_URL
|
||||
value: http://backend-filestream-svc.documentations.svc.cluster.local/
|
||||
- name: WORKFLOWS_HOST
|
||||
value: http://workflows-service.processing
|
||||
- name: WORKFLOWS_IMAGE_VERSION
|
||||
value: master
|
||||
- name: WORKFLOWS_DJANGO_HOST
|
||||
value: https://lk.sarex.io
|
||||
- name: WORKFLOWS_BIMV2_INTERNAL_HOST
|
||||
value: http://bim-backend-v2-service.bim-api
|
||||
- name: WORKSPACES_HOST
|
||||
value: http://workspaces-service.workspaces
|
||||
- name: EAV_HOST
|
||||
value: https://api.sarex.io/eav
|
||||
- name: LAST_MASTER_BIM
|
||||
value: "36311"
|
||||
- name: LAST_SLAVE_1_BIM
|
||||
value: "94015"
|
||||
- name: LAST_SLAVE_2_BIM
|
||||
value: "135771"
|
||||
- name: ABAP_FIXED_CONC
|
||||
value: "0"
|
||||
- name: WORKFLOWS_CONFIG_FILEPATH
|
||||
value: /etc/app/tasks-execution-config.json
|
||||
resources:
|
||||
requests:
|
||||
cpu: 25m
|
||||
memory: 100Mi
|
||||
volumeMounts:
|
||||
- name: tasks-execution-config
|
||||
readOnly: true
|
||||
mountPath: /etc/app/tasks-execution-config.json
|
||||
subPath: tasks-execution-config.json
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: /ping
|
||||
port: 8000
|
||||
initialDelaySeconds: 10
|
||||
periodSeconds: 60
|
||||
failureThreshold: 10
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /ping
|
||||
port: 8000
|
||||
initialDelaySeconds: 5
|
||||
periodSeconds: 5
|
||||
failureThreshold: 20
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
15
apps/comparisons/base/backend-service.yaml
Normal file
15
apps/comparisons/base/backend-service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: backend-service
|
||||
namespace: comparisons
|
||||
spec:
|
||||
type: ClusterIP
|
||||
selector:
|
||||
app: backend
|
||||
ports:
|
||||
- name: http
|
||||
port: 8000
|
||||
targetPort: 8000
|
||||
protocol: TCP
|
||||
@ -1,270 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: backend
|
||||
namespace: comparisons
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
backend:
|
||||
enabled: true
|
||||
|
||||
serviceAccount:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: comparisons-vault
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/comparisons_backend_prod:075fc0
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: backend
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 8000
|
||||
|
||||
command:
|
||||
_default: ["/bin/bash", "-ec"]
|
||||
args:
|
||||
_default:
|
||||
- |
|
||||
set -a
|
||||
[ -f /vault/secrets/comparisons-db ] && . /vault/secrets/comparisons-db
|
||||
[ -f /vault/secrets/comparisons-jwt-public ] && export AUTH_PUBLIC_KEY="$(cat /vault/secrets/comparisons-jwt-public)"
|
||||
set +a
|
||||
exec /app/entrypoint.sh
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 25m
|
||||
memory:
|
||||
_default: 100Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled:
|
||||
_default: true
|
||||
type:
|
||||
_default: httpGet
|
||||
httpGet:
|
||||
path:
|
||||
_default: /ping
|
||||
port:
|
||||
_default: 8000
|
||||
initialDelaySeconds:
|
||||
_default: 10
|
||||
periodSeconds:
|
||||
_default: 60
|
||||
failureThreshold:
|
||||
_default: 10
|
||||
readiness:
|
||||
enabled:
|
||||
_default: true
|
||||
type:
|
||||
_default: httpGet
|
||||
httpGet:
|
||||
path:
|
||||
_default: /ping
|
||||
port:
|
||||
_default: 8000
|
||||
initialDelaySeconds:
|
||||
_default: 5
|
||||
periodSeconds:
|
||||
_default: 5
|
||||
failureThreshold:
|
||||
_default: 20
|
||||
|
||||
service:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: backend-service
|
||||
|
||||
type:
|
||||
_default: ClusterIP
|
||||
|
||||
port:
|
||||
_default: 8000
|
||||
|
||||
targetPort:
|
||||
_default: 8000
|
||||
|
||||
portName:
|
||||
_default: http
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
volumes:
|
||||
_default:
|
||||
- name: tasks-execution-config
|
||||
mountPath:
|
||||
_default: /etc/app/tasks-execution-config.json
|
||||
subPath:
|
||||
_default: tasks-execution-config.json
|
||||
readOnly:
|
||||
_default: true
|
||||
configMap:
|
||||
name:
|
||||
_default: tasks-execution-config-comparisons-v2
|
||||
items:
|
||||
- key: tasks-execution-config-comparisons-v2.json
|
||||
path:
|
||||
_default: tasks-execution-config.json
|
||||
|
||||
envs:
|
||||
- name: APP_NAME
|
||||
value:
|
||||
_default: "comparisons"
|
||||
|
||||
- name: APP_VERSION
|
||||
value:
|
||||
_default: "0.0.1"
|
||||
|
||||
- name: LOGGER_LOG_LEVEL
|
||||
value:
|
||||
_default: "info"
|
||||
|
||||
- name: DATABASE_NAME
|
||||
value:
|
||||
_default: "postgres"
|
||||
|
||||
- name: ENABLE_SSL
|
||||
value:
|
||||
_default: "false"
|
||||
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value:
|
||||
_default: "10"
|
||||
|
||||
- name: HTTP_PORT
|
||||
value:
|
||||
_default: "8000"
|
||||
|
||||
- name: DOCUMENTATIONS_INTERNAL_HOST
|
||||
value:
|
||||
_default: "http://documentations-service.documentations"
|
||||
|
||||
- name: DOCUMENTATIONS_EXTERNAL_HOST
|
||||
value:
|
||||
_default: "https://api.sarex.io/documentations"
|
||||
|
||||
- name: DOCUMENTATION_FILESTREAM_URL
|
||||
value:
|
||||
_default: "http://backend-filestream-svc.documentations.svc.cluster.local/"
|
||||
|
||||
- name: WORKFLOWS_HOST
|
||||
value:
|
||||
_default: "http://workflows-service.processing"
|
||||
|
||||
- name: WORKFLOWS_IMAGE_VERSION
|
||||
value:
|
||||
_default: "master"
|
||||
|
||||
- name: WORKFLOWS_DJANGO_HOST
|
||||
value:
|
||||
_default: "https://lk.sarex.io"
|
||||
|
||||
- name: WORKFLOWS_BIMV2_INTERNAL_HOST
|
||||
value:
|
||||
_default: "http://bim-backend-v2-service.bim-api"
|
||||
|
||||
- name: WORKSPACES_HOST
|
||||
value:
|
||||
_default: "http://workspaces-service.workspaces"
|
||||
|
||||
- name: EAV_HOST
|
||||
value:
|
||||
_default: "https://api.sarex.io/eav"
|
||||
|
||||
- name: LAST_MASTER_BIM
|
||||
value:
|
||||
_default: "36311"
|
||||
|
||||
- name: LAST_SLAVE_1_BIM
|
||||
value:
|
||||
_default: "94015"
|
||||
|
||||
- name: LAST_SLAVE_2_BIM
|
||||
value:
|
||||
_default: "135771"
|
||||
|
||||
- name: ABAP_FIXED_CONC
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: WORKFLOWS_CONFIG_FILEPATH
|
||||
value:
|
||||
_default: "/etc/app/tasks-execution-config.json"
|
||||
|
||||
podAnnotations:
|
||||
_default:
|
||||
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
|
||||
vault.hashicorp.com/agent-init-first: "true"
|
||||
vault.hashicorp.com/agent-inject: "true"
|
||||
vault.hashicorp.com/agent-pre-populate-only: "true"
|
||||
vault.hashicorp.com/auth-path: auth/kubernetes
|
||||
vault.hashicorp.com/role: comparisons
|
||||
vault.hashicorp.com/agent-inject-secret-comparisons-db: secrets/data/apps/comparisons/postgres
|
||||
vault.hashicorp.com/agent-inject-template-comparisons-db: |-
|
||||
{{- with secret "secrets/data/apps/comparisons/postgres" -}}
|
||||
DATABASE_HOST={{ index .Data.data "host" }}
|
||||
DATABASE_PORT={{ index .Data.data "port" }}
|
||||
DATABASE_DB={{ index .Data.data "database" }}
|
||||
DATABASE_USER={{ index .Data.data "username" }}
|
||||
DATABASE_PASSWORD={{ index .Data.data "password" }}
|
||||
POSTGRES_ADDRESS={{ index .Data.data "host" }}
|
||||
POSTGRES_PORT={{ index .Data.data "port" }}
|
||||
POSTGRES_DB={{ index .Data.data "database" }}
|
||||
POSTGRES_USER={{ index .Data.data "username" }}
|
||||
POSTGRES_PASSWORD={{ index .Data.data "password" }}
|
||||
{{- end -}}
|
||||
vault.hashicorp.com/agent-inject-secret-comparisons-jwt-public: secrets/data/vault/common/rsa_keys
|
||||
vault.hashicorp.com/agent-inject-template-comparisons-jwt-public: |-
|
||||
{{- with secret "secrets/data/vault/common/rsa_keys" -}}
|
||||
{{ index .Data.data "public_key" }}
|
||||
{{- end -}}
|
||||
|
||||
commitSha: ""
|
||||
gitlabUri: ""
|
||||
gitlabJobUrl: ""
|
||||
owner: ""
|
||||
57
apps/comparisons/base/frontend-deployment.yaml
Normal file
57
apps/comparisons/base/frontend-deployment.yaml
Normal file
@ -0,0 +1,57 @@
|
||||
---
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: frontend
|
||||
namespace: comparisons
|
||||
labels:
|
||||
app: frontend
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: frontend
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: frontend
|
||||
spec:
|
||||
volumes:
|
||||
- name: nginx-configmap
|
||||
configMap:
|
||||
name: nginx-configmap
|
||||
items:
|
||||
- key: nginx.conf
|
||||
path: nginx.conf
|
||||
containers:
|
||||
- name: frontend
|
||||
image: cr.yandex/crp3ccidau046kdj8g9q/comparisons-frontend:prod_6dc6e0c2
|
||||
imagePullPolicy: IfNotPresent
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 80
|
||||
protocol: TCP
|
||||
resources:
|
||||
requests:
|
||||
cpu: 25m
|
||||
memory: 100Mi
|
||||
volumeMounts:
|
||||
- name: nginx-configmap
|
||||
mountPath: /etc/nginx/nginx.conf
|
||||
subPath: nginx.conf
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: /ping
|
||||
port: 80
|
||||
initialDelaySeconds: 10
|
||||
periodSeconds: 10
|
||||
failureThreshold: 10
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /ping
|
||||
port: 80
|
||||
initialDelaySeconds: 10
|
||||
periodSeconds: 10
|
||||
failureThreshold: 20
|
||||
imagePullSecrets:
|
||||
- name: regcred
|
||||
15
apps/comparisons/base/frontend-service.yaml
Normal file
15
apps/comparisons/base/frontend-service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: frontend-service
|
||||
namespace: comparisons
|
||||
spec:
|
||||
type: ClusterIP
|
||||
selector:
|
||||
app: frontend
|
||||
ports:
|
||||
- name: http
|
||||
port: 80
|
||||
targetPort: 80
|
||||
protocol: TCP
|
||||
@ -1,135 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: frontend
|
||||
namespace: comparisons
|
||||
|
||||
spec:
|
||||
interval: 10m
|
||||
|
||||
chart:
|
||||
spec:
|
||||
chart: universal-chart
|
||||
version: "0.1.9"
|
||||
sourceRef:
|
||||
kind: HelmRepository
|
||||
name: yc-oci-charts
|
||||
namespace: flux-system
|
||||
interval: 10m
|
||||
|
||||
install:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
upgrade:
|
||||
remediation:
|
||||
retries: 3
|
||||
|
||||
values:
|
||||
global:
|
||||
env: _default
|
||||
|
||||
services:
|
||||
frontend:
|
||||
enabled: true
|
||||
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/comparisons-frontend:prod_6dc6e0c2
|
||||
pullPolicy:
|
||||
_default: IfNotPresent
|
||||
|
||||
deployment:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: frontend
|
||||
|
||||
replicaCount:
|
||||
_default: 1
|
||||
|
||||
port:
|
||||
_default: 80
|
||||
|
||||
resources:
|
||||
requests:
|
||||
cpu:
|
||||
_default: 25m
|
||||
memory:
|
||||
_default: 100Mi
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled:
|
||||
_default: true
|
||||
type:
|
||||
_default: httpGet
|
||||
httpGet:
|
||||
path:
|
||||
_default: /ping
|
||||
port:
|
||||
_default: 80
|
||||
initialDelaySeconds:
|
||||
_default: 10
|
||||
periodSeconds:
|
||||
_default: 10
|
||||
failureThreshold:
|
||||
_default: 10
|
||||
readiness:
|
||||
enabled:
|
||||
_default: true
|
||||
type:
|
||||
_default: httpGet
|
||||
httpGet:
|
||||
path:
|
||||
_default: /ping
|
||||
port:
|
||||
_default: 80
|
||||
initialDelaySeconds:
|
||||
_default: 10
|
||||
periodSeconds:
|
||||
_default: 10
|
||||
failureThreshold:
|
||||
_default: 20
|
||||
|
||||
service:
|
||||
enabled: true
|
||||
|
||||
name:
|
||||
_default: frontend-service
|
||||
|
||||
type:
|
||||
_default: ClusterIP
|
||||
|
||||
port:
|
||||
_default: 80
|
||||
|
||||
targetPort:
|
||||
_default: 80
|
||||
|
||||
portName:
|
||||
_default: http
|
||||
|
||||
imagePullSecrets:
|
||||
enabled:
|
||||
_default: true
|
||||
name:
|
||||
_default: regcred
|
||||
|
||||
volumes:
|
||||
_default:
|
||||
- name: nginx-configmap
|
||||
mountPath:
|
||||
_default: /etc/nginx/nginx.conf
|
||||
subPath:
|
||||
_default: nginx.conf
|
||||
readOnly:
|
||||
_default: true
|
||||
configMap:
|
||||
name:
|
||||
_default: nginx-configmap
|
||||
items:
|
||||
- key: nginx.conf
|
||||
path:
|
||||
_default: nginx.conf
|
||||
@ -4,7 +4,10 @@ kind: Kustomization
|
||||
namespace: comparisons
|
||||
resources:
|
||||
- namespace.yaml
|
||||
- backend.yaml
|
||||
- frontend.yaml
|
||||
- serviceaccount.yaml
|
||||
- backend-deployment.yaml
|
||||
- backend-service.yaml
|
||||
- frontend-deployment.yaml
|
||||
- frontend-service.yaml
|
||||
- nginx-configmap.yaml
|
||||
- tasks-execution-config.yaml
|
||||
|
||||
5
apps/comparisons/base/serviceaccount.yaml
Normal file
5
apps/comparisons/base/serviceaccount.yaml
Normal file
@ -0,0 +1,5 @@
|
||||
apiVersion: v1
|
||||
kind: ServiceAccount
|
||||
metadata:
|
||||
name: comparisons-vault
|
||||
namespace: comparisons
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: namespace.yaml
|
||||
target:
|
||||
kind: Namespace
|
||||
name: comparisons
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Namespace
|
||||
metadata:
|
||||
name: comparisons
|
||||
labels:
|
||||
istio-injection: enabled
|
||||
security.deckhouse.io/pod-policy: privileged
|
||||
@ -1,134 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: backend
|
||||
namespace: comparisons
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
backend:
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/comparisons-backend:8df50db379f53c35a20fdffd4803883564a11844
|
||||
|
||||
envs:
|
||||
- name: HTTP_PORT
|
||||
value:
|
||||
_default: "8080"
|
||||
|
||||
- name: LAST_MASTER_BIM
|
||||
value:
|
||||
_default: "100_000"
|
||||
|
||||
- name: APP_NAME
|
||||
value:
|
||||
_default: "comparisons-api-v2"
|
||||
|
||||
- name: APP_VERSION
|
||||
value:
|
||||
_default: "0.0.1"
|
||||
|
||||
- name: LOGGER_LOG_LEVEL
|
||||
value:
|
||||
_default: "info"
|
||||
|
||||
- name: DATABASE_HOST
|
||||
value:
|
||||
_default: "postgres-service"
|
||||
|
||||
- name: DATABASE_PORT
|
||||
value:
|
||||
_default: "5432"
|
||||
|
||||
- name: DATABASE_NAME
|
||||
value:
|
||||
_default: "postgres"
|
||||
|
||||
- name: DATABASE_DB
|
||||
value:
|
||||
_default: "comparisons"
|
||||
|
||||
- name: API_ADDRESS
|
||||
value:
|
||||
_default: "0.0.0.0:8080"
|
||||
|
||||
- name: API_ADDRESS_FILE
|
||||
value:
|
||||
_default: "0.0.0.0:8080"
|
||||
|
||||
- name: ENABLE_SQL_QUERY
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: DOCUMENTATIONS_INTERNAL_HOST
|
||||
value:
|
||||
_default: "http://documentations-service.documentations.svc.cluster.local:8080"
|
||||
|
||||
- name: DOCUMENTATIONS_EXTERNAL_HOST
|
||||
value:
|
||||
_default: "http://documentations-service.documentations.svc.cluster.local:8080/"
|
||||
|
||||
- name: DOCUMENTATION_URL
|
||||
value:
|
||||
_default: "http://documentations-service.documentations.svc.cluster.local:8080/"
|
||||
|
||||
- name: DOCUMENTATION_FILESTREAM_URL
|
||||
value:
|
||||
_default: "http://documentations-filestream-service.documentations.svc.cluster.local:8080/"
|
||||
|
||||
- name: WORKFLOWS_HOST
|
||||
value:
|
||||
_default: "http://workflows-service.workflow.svc.cluster.local:8000/"
|
||||
|
||||
- name: EAV_HOST
|
||||
value:
|
||||
_default: "http://eav-service.eav.svc.cluster.local:8000"
|
||||
|
||||
- name: WORKSPACES_HOST
|
||||
value:
|
||||
_default: "http://workspaces-service.workspaces.svc.cluster.local:8000/"
|
||||
|
||||
- name: COMPARISON_URL
|
||||
value:
|
||||
_default: "http://backend-service.comparisons.svc.cluster.local:8080/"
|
||||
|
||||
- name: WORKFLOWS_IMAGE_VERSION
|
||||
value:
|
||||
_default: "master"
|
||||
|
||||
- name: EXTERNAL_DOCUMENTATION_URL
|
||||
value:
|
||||
_default: "http://documentations-service.documentations.svc.cluster.local:8080/"
|
||||
|
||||
- name: WORKFLOWS_BIMV2_INTERNAL_HOST
|
||||
value:
|
||||
_default: "http://backend-service.bim.svc.cluster.local:8000/"
|
||||
|
||||
- name: ENABLE_SSL
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: WORKFLOWS_DJANGO_HOST
|
||||
value:
|
||||
_default: "http://backend.django.svc.cluster.local:8000"
|
||||
|
||||
- name: POSTGRES_POOL_SIZE
|
||||
value:
|
||||
_default: "10"
|
||||
|
||||
- name: LAST_SLAVE_1_BIM
|
||||
value:
|
||||
_default: "94015"
|
||||
|
||||
- name: LAST_SLAVE_2_BIM
|
||||
value:
|
||||
_default: "135771"
|
||||
|
||||
- name: ABAP_FIXED_CONC
|
||||
value:
|
||||
_default: "0"
|
||||
|
||||
- name: WORKFLOWS_CONFIG_FILEPATH
|
||||
value:
|
||||
_default: "/etc/app/tasks-execution-config.json"
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
apiVersion: helm.toolkit.fluxcd.io/v2
|
||||
kind: HelmRelease
|
||||
metadata:
|
||||
name: frontend
|
||||
namespace: comparisons
|
||||
spec:
|
||||
values:
|
||||
services:
|
||||
frontend:
|
||||
image:
|
||||
name:
|
||||
_default: cr.yandex/crp3ccidau046kdj8g9q/comparisons-frontend-static:9c422e6cd514603ea4092ed2430634cf4995039d
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
namespace: comparisons
|
||||
resources:
|
||||
- ../base
|
||||
patches:
|
||||
- path: backend.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
name: backend
|
||||
- path: frontend.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
name: frontend
|
||||
@ -1,793 +0,0 @@
|
||||
openapi: 3.0.3
|
||||
|
||||
info:
|
||||
title: Comparisons Service API
|
||||
version: "1.0.0"
|
||||
description: |
|
||||
REST API сервиса **comparisons-backend** (`pdm/comparisons-backend`) — создание и
|
||||
просмотр сравнений (облако-BIM отклонение/статусы, облако-облако, облако-поверхность,
|
||||
pdf-pdf), их элементов, изменений и фильтров.
|
||||
|
||||
Сервис написан на Go (роутер **gorilla/mux**). Сервер собирается функцией
|
||||
`bootstrapAPI` в `cmd/api/bootstrap.go`. Роутинг состоит из двух групп:
|
||||
|
||||
- публичный API — префикс `/api/v1` (`cmd/api/routes_api.go`);
|
||||
- внутренний API — префикс `/internal/v1` (`cmd/api/routes_internal.go`),
|
||||
предназначен для вызовов внутри кластера (через ingress не публикуется).
|
||||
|
||||
### Аутентификация
|
||||
Публичные эндпоинты (`/api/v1/*`) требуют JWT: middleware `auth.JWTToCtx` +
|
||||
`auth.JWTUserExtractorFromCtx` (`gitlab.com/sarex-team/gotools/auth`). Токен
|
||||
передаётся заголовком `Authorization: Bearer <jwt>`; middleware
|
||||
`auth.DeleteJWTFromQueryMiddleware` дополнительно позволяет передать токен
|
||||
query-параметром `jwt` (он удаляется из запроса после разбора).
|
||||
|
||||
Внутренние эндпоинты (`/internal/v1/*`) аутентификации на уровне приложения
|
||||
не требуют — ограничение доступа обеспечивается сетевым слоем.
|
||||
|
||||
### Обработка ошибок
|
||||
Ошибки возвращаются функцией `httperror.Write` (`gotools/httperror`). Основные
|
||||
статусы: `400` — некорректный запрос/параметры, `404` — сравнение не найдено,
|
||||
`500` — внутренняя ошибка. Идентификатор запроса пробрасывается middleware
|
||||
`reqid`.
|
||||
|
||||
### Замечания (расхождения кода)
|
||||
- `GET /api/v1/comparisons` возвращает данные разной формы в зависимости от
|
||||
query-параметра: `workspace_id` → `{ comparisons: [] }`, `document_id` →
|
||||
`{ results: [] }`, `bundle_id` → одиночный объект сравнения.
|
||||
- `GET /api/v1/filter_fields` и `GET /api/v1/elements` работают только со
|
||||
сравнениями типа `deviation`; для других типов вернётся `400`.
|
||||
- Схема сравнения полиморфна по полю `type` (`deviation`/`c2c`/`c2s`/`abap`/`pdf2pdf`).
|
||||
|
||||
contact:
|
||||
name: comparisons-backend
|
||||
url: https://gitlab.com/sarex-team/comparisons-backend
|
||||
|
||||
servers:
|
||||
- url: https://api.sarex.io/comparisons
|
||||
description: Production (ingress)
|
||||
- url: https://stage-api.sarex.io/comparisons
|
||||
description: Stage (ingress)
|
||||
- url: https://api.preprod.sarex.io/comparisons
|
||||
description: Preprod (ingress)
|
||||
- url: http://comparisons-backend-service.comparisons-stage
|
||||
description: Внутрикластерный адрес (ClusterIP). Единственный способ достучаться до /internal/v1
|
||||
- url: http://localhost:8080
|
||||
description: Локальный запуск (API_ADDRESS по умолчанию 0.0.0.0:8080)
|
||||
|
||||
tags:
|
||||
- name: types
|
||||
description: Справочник типов сравнений
|
||||
- name: comparisons
|
||||
description: Сравнения — создание, просмотр, удаление
|
||||
- name: elements
|
||||
description: Элементы сравнения и их изменения
|
||||
- name: internal
|
||||
description: Внутренние эндпоинты (только внутри кластера)
|
||||
|
||||
security:
|
||||
- bearerAuth: []
|
||||
|
||||
paths:
|
||||
# ==========================================================================
|
||||
# Types
|
||||
# ==========================================================================
|
||||
/api/v1/types:
|
||||
get:
|
||||
tags: [types]
|
||||
summary: Справочник типов сравнений
|
||||
description: Возвращает доступные типы сравнений и их параметры (для построения форм).
|
||||
operationId: getTypes
|
||||
responses:
|
||||
'200':
|
||||
description: Список типов сравнений
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
types:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/CompareType'
|
||||
|
||||
# ==========================================================================
|
||||
# Comparisons
|
||||
# ==========================================================================
|
||||
/api/v1/comparisons:
|
||||
post:
|
||||
tags: [comparisons]
|
||||
summary: Создать сравнение
|
||||
description: |
|
||||
Создаёт сравнение указанного типа. Автор берётся из JWT. Если `parent_doc_id`
|
||||
и `parent_disk_id` не заданы — вычисляются по рабочей области.
|
||||
operationId: createComparison
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/CreateRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Созданное сравнение
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Comparison'
|
||||
'400':
|
||||
description: Некорректный запрос / неизвестный тип сравнения
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
get:
|
||||
tags: [comparisons]
|
||||
summary: Список сравнений
|
||||
description: |
|
||||
Возвращает сравнения по одному из query-параметров. Форма ответа зависит
|
||||
от параметра (см. описание в `info`). Должен быть задан ровно один параметр.
|
||||
operationId: getComparisons
|
||||
parameters:
|
||||
- name: workspace_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
description: "Сравнения рабочей области → ответ `{ comparisons: [] }`"
|
||||
- name: bundle_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
description: Сравнение по бандлу → ответ — одиночный объект
|
||||
- name: document_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
description: "Сравнения документа → ответ `{ results: [] }`"
|
||||
responses:
|
||||
'200':
|
||||
description: Результат (форма зависит от параметра запроса)
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- type: object
|
||||
properties:
|
||||
comparisons:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Comparison'
|
||||
- type: object
|
||||
properties:
|
||||
results:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Comparison'
|
||||
- $ref: '#/components/schemas/Comparison'
|
||||
'400':
|
||||
description: Не задан workspace_id / bundle_id / document_id
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
/api/v1/comparisons/{comparison_id}:
|
||||
parameters:
|
||||
- name: comparison_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
get:
|
||||
tags: [comparisons]
|
||||
summary: Сравнение по id
|
||||
operationId: getComparisonById
|
||||
responses:
|
||||
'200':
|
||||
description: Сравнение
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Comparison'
|
||||
'404':
|
||||
description: Сравнение не найдено
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
delete:
|
||||
tags: [comparisons]
|
||||
summary: Удалить сравнение
|
||||
description: Мягкое удаление сравнения. Автор берётся из JWT.
|
||||
operationId: deleteComparisonById
|
||||
responses:
|
||||
'200':
|
||||
description: Успешно удалено
|
||||
'400':
|
||||
description: Некорректный id
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
/api/v1/filter_fields:
|
||||
get:
|
||||
tags: [comparisons]
|
||||
summary: Поля фильтрации сравнения
|
||||
description: |
|
||||
Возвращает набор полей фильтрации для сравнения типа `deviation` по документу.
|
||||
Для полей отклонения (`deviation`, `deviation_x/y/z`) заполняются `min`/`max`.
|
||||
Если сравнение по документу не найдено — вернётся пустой `results`.
|
||||
operationId: getFilterFields
|
||||
parameters:
|
||||
- name: doc_id
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: Поля фильтрации
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
results:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/FilterFields'
|
||||
'400':
|
||||
description: Не задан doc_id / сравнение не типа deviation
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
/api/v1/tolerance:
|
||||
get:
|
||||
tags: [comparisons]
|
||||
summary: Допуск (tolerance) сравнения
|
||||
description: Возвращает значение допустимого отклонения для сравнения типа `deviation` по бандлу.
|
||||
operationId: getTolerance
|
||||
parameters:
|
||||
- name: bundle_id
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
responses:
|
||||
'200':
|
||||
description: Допуск
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
tolerance:
|
||||
type: number
|
||||
format: double
|
||||
'400':
|
||||
description: Не задан / некорректный bundle_id
|
||||
'404':
|
||||
description: Сравнение не найдено
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
# ==========================================================================
|
||||
# Elements
|
||||
# ==========================================================================
|
||||
/api/v1/elements:
|
||||
get:
|
||||
tags: [elements]
|
||||
summary: Список элементов сравнения
|
||||
description: |
|
||||
Постранично возвращает элементы сравнения типа `deviation` по документу.
|
||||
Параметры отклонения задаются строкой вида `min:max`. Если сравнение не
|
||||
найдено — вернётся пустой `results` с типами по умолчанию.
|
||||
operationId: getListElements
|
||||
parameters:
|
||||
- name: doc_id
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
- name: limit
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
default: 10
|
||||
minimum: 0
|
||||
- name: offset
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
minimum: 0
|
||||
- name: order_by
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [deviation, deviation_x, deviation_y, deviation_z, sarex_id, name]
|
||||
default: sarex_id
|
||||
- name: order
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [asc, desc]
|
||||
default: asc
|
||||
- name: deviation
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Диапазон общего отклонения в формате `min:max`
|
||||
- name: deviation_x
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Диапазон отклонения по X в формате `min:max`
|
||||
- name: deviation_y
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Диапазон отклонения по Y в формате `min:max`
|
||||
- name: deviation_z
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Диапазон отклонения по Z в формате `min:max`
|
||||
- name: deviation_status
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [in_tolerance, out_of_tolerance]
|
||||
- name: view_status
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [viewed, not_viewed]
|
||||
- name: only_with_comment
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
responses:
|
||||
'200':
|
||||
description: Страница элементов
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ListElementsResponse'
|
||||
'400':
|
||||
description: Некорректные параметры запроса
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
/api/v1/elements/{element_id}:
|
||||
parameters:
|
||||
- name: element_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
patch:
|
||||
tags: [elements]
|
||||
summary: Обновить элемент
|
||||
description: |
|
||||
Обновляет один из атрибутов элемента: комментарий, статус отклонения или
|
||||
статус просмотра. Должно быть задано ровно одно из полей. Изменение
|
||||
фиксируется записью в истории изменений.
|
||||
operationId: updateElement
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/UpdateElementRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Успешно обновлено (тело не возвращается)
|
||||
'400':
|
||||
description: Некорректный запрос
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
/api/v1/elements/{element_id}/changes:
|
||||
get:
|
||||
tags: [elements]
|
||||
summary: История изменений элемента
|
||||
operationId: getElementChanges
|
||||
parameters:
|
||||
- name: element_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: Список изменений
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
changes:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Change'
|
||||
'400':
|
||||
description: Некорректный element_id
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
# ==========================================================================
|
||||
# Internal
|
||||
# ==========================================================================
|
||||
/internal/v1/comparisons/{comparison_id}/webhook:
|
||||
post:
|
||||
tags: [internal]
|
||||
summary: Webhook результата сравнения (внутренний)
|
||||
description: |
|
||||
Вызывается после завершения обработки сравнения типа `deviation`. Скачивает
|
||||
`deviation_json` из PDM-хранилища по бандлу, создаёт элементы сравнения и
|
||||
возвращает содержимое `deviation_json`. Аутентификация на уровне приложения
|
||||
не требуется.
|
||||
operationId: comparisonWebhook
|
||||
security: []
|
||||
parameters:
|
||||
- name: comparison_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: Содержимое deviation_json
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DeviationJSON'
|
||||
'404':
|
||||
description: Сравнение не найдено
|
||||
'500':
|
||||
description: Внутренняя ошибка
|
||||
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerAuth:
|
||||
type: http
|
||||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
description: |
|
||||
JWT в заголовке `Authorization: Bearer <jwt>`. Допускается передача
|
||||
query-параметром `jwt` (удаляется middleware после разбора).
|
||||
|
||||
schemas:
|
||||
ComparisonType:
|
||||
type: string
|
||||
enum: [c2c, c2s, deviation, abap, pdf2pdf]
|
||||
|
||||
CompareType:
|
||||
type: object
|
||||
description: Тип сравнения и набор его параметров (для формы создания).
|
||||
properties:
|
||||
name:
|
||||
$ref: '#/components/schemas/ComparisonType'
|
||||
verbose_name:
|
||||
type: string
|
||||
params:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/CompareFormParam'
|
||||
|
||||
CompareFormParam:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
verbose_name:
|
||||
type: string
|
||||
hint:
|
||||
type: string
|
||||
source:
|
||||
type: string
|
||||
enum: [form, viewer]
|
||||
type:
|
||||
type: string
|
||||
description: Тип поля (напр. cloud, bimv2, number, multichoice, choice, array, pdf, surface)
|
||||
options:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
default: {}
|
||||
min:
|
||||
type: number
|
||||
format: double
|
||||
max:
|
||||
type: number
|
||||
format: double
|
||||
|
||||
CreateRequest:
|
||||
type: object
|
||||
required: [name, workspace_id, type, company_id, params]
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
workspace_id:
|
||||
type: string
|
||||
format: uuid
|
||||
parent_doc_id:
|
||||
type: integer
|
||||
format: int64
|
||||
nullable: true
|
||||
parent_disk_id:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
type:
|
||||
$ref: '#/components/schemas/ComparisonType'
|
||||
company_id:
|
||||
type: integer
|
||||
format: int64
|
||||
params:
|
||||
type: object
|
||||
description: Параметры сравнения, зависят от type (см. /api/v1/types).
|
||||
additionalProperties: true
|
||||
|
||||
Comparison:
|
||||
type: object
|
||||
description: |
|
||||
Полиморфное сравнение. Поле `type` определяет набор `params`. Ниже приведён
|
||||
пример для типа `deviation`; для других типов набор params отличается.
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
type:
|
||||
$ref: '#/components/schemas/ComparisonType'
|
||||
created_by:
|
||||
type: integer
|
||||
format: int64
|
||||
name:
|
||||
type: string
|
||||
workspace_id:
|
||||
type: string
|
||||
format: uuid
|
||||
workflow_id:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
document_id:
|
||||
type: integer
|
||||
format: int64
|
||||
nullable: true
|
||||
bundle_id:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
params:
|
||||
$ref: '#/components/schemas/DeviationParams'
|
||||
|
||||
DeviationParams:
|
||||
type: object
|
||||
properties:
|
||||
cloud_bundle_id:
|
||||
type: string
|
||||
format: uuid
|
||||
model_bundle_id:
|
||||
type: string
|
||||
format: uuid
|
||||
down_sample_size:
|
||||
type: number
|
||||
format: double
|
||||
resolution:
|
||||
type: number
|
||||
format: double
|
||||
linear_margin:
|
||||
type: number
|
||||
format: double
|
||||
tolerance:
|
||||
type: number
|
||||
format: double
|
||||
sarex_ids:
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
format: int64
|
||||
transformation:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
format: double
|
||||
applied_statuses:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
crop_margin:
|
||||
type: number
|
||||
format: double
|
||||
nullable: true
|
||||
|
||||
Element:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
sarex_id:
|
||||
type: integer
|
||||
format: int64
|
||||
name:
|
||||
type: string
|
||||
deviation_status:
|
||||
type: string
|
||||
enum: [in_tolerance, out_of_tolerance]
|
||||
view_status:
|
||||
type: string
|
||||
enum: [viewed, not_viewed]
|
||||
deviation:
|
||||
type: number
|
||||
format: double
|
||||
deviation_x:
|
||||
type: number
|
||||
format: double
|
||||
deviation_y:
|
||||
type: number
|
||||
format: double
|
||||
deviation_z:
|
||||
type: number
|
||||
format: double
|
||||
axis_and_angle:
|
||||
type: object
|
||||
description: Ось и угол поворота (utils.AxisAndAngle)
|
||||
additionalProperties: true
|
||||
comment:
|
||||
type: string
|
||||
nullable: true
|
||||
bbox_matrix:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
format: double
|
||||
reg_matrix:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
format: double
|
||||
|
||||
ListElementsResponse:
|
||||
type: object
|
||||
properties:
|
||||
count:
|
||||
type: integer
|
||||
next:
|
||||
type: string
|
||||
nullable: true
|
||||
previous:
|
||||
type: string
|
||||
nullable: true
|
||||
types:
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Option'
|
||||
crop_margin:
|
||||
type: number
|
||||
format: double
|
||||
nullable: true
|
||||
results:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Element'
|
||||
|
||||
UpdateElementRequest:
|
||||
type: object
|
||||
description: |
|
||||
Должно быть задано ровно одно из полей (`comment`, `deviation_status`,
|
||||
`view_status`) — валидатор `required_without_all`.
|
||||
properties:
|
||||
comment:
|
||||
type: string
|
||||
deviation_status:
|
||||
type: string
|
||||
enum: [in_tolerance, out_of_tolerance]
|
||||
view_status:
|
||||
type: string
|
||||
enum: [viewed, not_viewed]
|
||||
|
||||
Change:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
element_id:
|
||||
type: integer
|
||||
format: int64
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
author:
|
||||
type: integer
|
||||
format: int64
|
||||
changed_field:
|
||||
type: string
|
||||
enum: [deviation_status, view_status, comment]
|
||||
old_value:
|
||||
type: string
|
||||
new_value:
|
||||
type: string
|
||||
|
||||
FilterFields:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
enum: [deviation, deviation_x, deviation_y, deviation_z, deviation_status, view_status, only_with_comment]
|
||||
verbose_name:
|
||||
type: string
|
||||
type:
|
||||
type: string
|
||||
enum: [checkbox, selector, slider]
|
||||
options:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Option'
|
||||
min:
|
||||
type: number
|
||||
format: double
|
||||
nullable: true
|
||||
max:
|
||||
type: number
|
||||
format: double
|
||||
nullable: true
|
||||
|
||||
Option:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
verbose_name:
|
||||
type: string
|
||||
|
||||
DeviationJSON:
|
||||
type: object
|
||||
properties:
|
||||
crop_margin:
|
||||
type: number
|
||||
format: double
|
||||
nodes:
|
||||
type: object
|
||||
additionalProperties:
|
||||
$ref: '#/components/schemas/Node'
|
||||
|
||||
Node:
|
||||
type: object
|
||||
properties:
|
||||
bbox_matrix:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
format: double
|
||||
reg_matrix:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
format: double
|
||||
node_name:
|
||||
type: string
|
||||
@ -7,5 +7,5 @@ resources:
|
||||
patches:
|
||||
- path: replicas.yaml
|
||||
target:
|
||||
kind: HelmRelease
|
||||
kind: Deployment
|
||||
name: backend
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user