bcfb07f547
Чёткое разделение audiences:
- docs/ — consumer-facing only, Diplodoc-built. Public contract для
интеграторов (Альтум, BI, third-party).
- docs-internal/ — operator runbooks, status snapshots, legacy tech pages.
НЕ в Diplodoc build, НЕ публикуются.
Изменения:
- Move docs/{ops,status,tech} → docs-internal/{ops,status,tech}
- docs/toc.yaml: убраны секции Operations, Архитектура (legacy), Status
- docs/index.md: убран tab "оператор / on-call", focus на integrators
- docs/README.md: rewritten — scope только integrator guide, editorial
guidelines (no leak internal architecture, stable API contract)
- .yfm: убран явный ignore status/* (теперь не нужно — папка переехала)
- docs-internal/README.md: index для внутренней документации с rationale
разделения
Scrubbing implementation details из Diplodoc страниц:
- events.md: убраны Strimzi/cluster.142 references, OutboxPoller детали,
internal alert names (OrdinisOutboxLagHigh, OrdinisOutboxDLQNonEmpty),
metric names (nsi_outbox_*). Заменены на consumer-observable contract.
- webhooks.md: убраны metric names (nsi_webhook_ssrf_rejected_total),
alert table (OrdinisWebhookHighFailureRate и т.д.). Retry policy
переписана на user-side perspective.
- errors.md: убран alert name OrdinisReadApiErrorBudgetBurnFast, Tempo
endpoint URL, internal connection details.
- x-references.md: OrphanReferenceScanner → general "Ordinis периодически
детектирует". Убраны metric/alert names. Cascade roadmap без link на
internal design doc.
- auth.md: убран file path ScopeContext.java.
- bundle-cuod.md: убран Maven module path.
- caching.md: cascade design link заменён на text reference.
CI:
- .gitlab-ci.yml: новый job build-docs (stage: build) — Node 20 alpine,
pnpm install --frozen-lockfile + pnpm build, artifact docs/_dist на
неделю. Triggers: auto на docs/**, либо manual web. Готов к follow-up
pages-deploy job когда host решён.
- Новый pattern .docs-changes для rules.
Build verified clean: 13 HTML pages, 6.9M, no broken links/refs.
275 lines
8.9 KiB
YAML
275 lines
8.9 KiB
YAML
# =============================================================
|
||
# Ordinis — build & push images.
|
||
# Path-aware CI: backend и frontend jobs запускаются только когда меняются
|
||
# соответствующие пути. Trigger downstream передаёт BACKEND_IMAGE_TAG и/или
|
||
# FRONTEND_IMAGE_TAG; infra-pipeline применяет helm upgrade с per-service
|
||
# overrides — сервисы которые не пересобирались не катятся.
|
||
# =============================================================
|
||
|
||
stages:
|
||
- test
|
||
- build
|
||
- publish
|
||
- trigger-deploy
|
||
|
||
variables:
|
||
MAVEN_OPTS: "-Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn"
|
||
MAVEN_CLI_OPTS: "-B -ntp --batch-mode"
|
||
IMAGE_TAG: $CI_COMMIT_REF_SLUG-$CI_COMMIT_SHORT_SHA
|
||
REGISTRY: repo.nstart.cloud
|
||
IMAGE_REPO: terravault
|
||
DOCKER_BUILDKIT: "1"
|
||
|
||
cache:
|
||
key:
|
||
files: ["pom.xml"]
|
||
paths:
|
||
- .m2/repository
|
||
|
||
default:
|
||
retry:
|
||
max: 2
|
||
when:
|
||
- runner_system_failure
|
||
- stuck_or_timeout_failure
|
||
- script_failure
|
||
|
||
# Backend changes триггерят maven + docker для всех Java-сервисов + миграции.
|
||
.backend-changes: &backend-changes
|
||
- "ordinis-app/**/*"
|
||
- "ordinis-read-api/**/*"
|
||
- "ordinis-projection-writer/**/*"
|
||
- "ordinis-rest-api/**/*"
|
||
- "ordinis-domain/**/*"
|
||
- "ordinis-validation/**/*"
|
||
- "ordinis-events-api/**/*"
|
||
- "ordinis-outbox/**/*"
|
||
- "ordinis-auth/**/*"
|
||
- "ordinis-cuod-bundle/**/*"
|
||
- "ordinis-migrations/**/*"
|
||
- "pom.xml"
|
||
- ".gitlab-ci.yml"
|
||
|
||
# Frontend changes — только admin-ui.
|
||
.frontend-changes: &frontend-changes
|
||
- "ordinis-admin-ui/**/*"
|
||
|
||
# Documentation changes — Diplodoc-built integrator guide.
|
||
# docs-internal/ исключено явно: оно НЕ build'ится Diplodoc'ом и не должно
|
||
# триггерить docs job.
|
||
.docs-changes: &docs-changes
|
||
- "docs/**/*"
|
||
|
||
# ─── TEST ──────────────────────────────────────
|
||
maven-test:
|
||
stage: test
|
||
image: repo.nstart.cloud/library/maven:3.9.9-eclipse-temurin-21
|
||
script:
|
||
- mvn $MAVEN_CLI_OPTS verify
|
||
artifacts:
|
||
when: always
|
||
reports:
|
||
junit: '**/target/surefire-reports/TEST-*.xml'
|
||
expire_in: 1 week
|
||
rules:
|
||
- changes: *backend-changes
|
||
|
||
# Е2Е тесты через Testcontainers (Postgres+Kafka). Профиль `e2e` в
|
||
# ordinis-app/pom.xml включает их (default surefire excludes e2e директорию).
|
||
# Требует docker:dind service для testcontainers — обычный maven-test runner
|
||
# не имеет Docker.
|
||
maven-e2e:
|
||
stage: test
|
||
image: repo.nstart.cloud/library/maven:3.9.9-eclipse-temurin-21
|
||
services:
|
||
- name: repo.nstart.cloud/library/docker:29.1.2-dind
|
||
alias: docker
|
||
command: ["--tls=false"]
|
||
variables:
|
||
DOCKER_HOST: "tcp://docker:2375"
|
||
DOCKER_TLS_CERTDIR: ""
|
||
TESTCONTAINERS_HOST_OVERRIDE: "docker"
|
||
TESTCONTAINERS_RYUK_DISABLED: "true"
|
||
script:
|
||
- for i in $(seq 1 30); do docker -H tcp://docker:2375 info >/dev/null 2>&1 && break; sleep 1; done
|
||
- mvn $MAVEN_CLI_OPTS -pl ordinis-app -am -P e2e test
|
||
artifacts:
|
||
when: always
|
||
reports:
|
||
junit: '**/target/surefire-reports/TEST-*.xml'
|
||
expire_in: 1 week
|
||
rules:
|
||
- changes: *backend-changes
|
||
# Можно сделать allow_failure: true если e2e будут флакать — пока нет.
|
||
|
||
# ─── BUILD (Maven jars) ────────────────────────
|
||
# maven-package всегда запускается: docker backend jobs нуждаются в jar даже
|
||
# при frontend-only PR (иначе backend образы не пересобрать → ImagePullBackOff
|
||
# в кластере при rolling update). BuildKit layer cache делает повторную сборку
|
||
# идентичных jar'ов ~30 sec.
|
||
maven-package:
|
||
stage: build
|
||
image: repo.nstart.cloud/library/maven:3.9.9-eclipse-temurin-21
|
||
script:
|
||
- mvn $MAVEN_CLI_OPTS package -DskipTests
|
||
artifacts:
|
||
paths:
|
||
- "**/target/*.jar"
|
||
- ordinis-migrations/src/main/resources/db/changelog/**
|
||
expire_in: 1 day
|
||
|
||
# ─── BUILD: Integrator Guide (Diplodoc) ────────
|
||
# Build static HTML documentation для consumers через @diplodoc/cli (yfm).
|
||
# Source — docs/ (Markdown + toc.yaml). Output — docs/_dist/ HTML.
|
||
#
|
||
# Triggers:
|
||
# - auto при изменении docs/**
|
||
# - manual через web UI (для force-rebuild без code changes)
|
||
#
|
||
# Artifact `docs/_dist/` сохраняется неделю — pages-deploy job (TBD,
|
||
# когда host решён — GitLab Pages либо k8s ingress) подхватит из него.
|
||
build-docs:
|
||
stage: build
|
||
image: repo.nstart.cloud/library/node:20-alpine
|
||
before_script:
|
||
- corepack enable
|
||
- corepack prepare pnpm@9.0.0 --activate
|
||
script:
|
||
- cd docs
|
||
- pnpm install --frozen-lockfile
|
||
- pnpm build
|
||
- echo "Built $(find _dist -name '*.html' | wc -l) HTML pages, total size:"
|
||
- du -sh _dist
|
||
artifacts:
|
||
name: "ordinis-docs-$CI_COMMIT_REF_SLUG-$CI_COMMIT_SHORT_SHA"
|
||
paths:
|
||
- docs/_dist
|
||
expire_in: 1 week
|
||
rules:
|
||
- changes: *docs-changes
|
||
- if: '$CI_PIPELINE_SOURCE == "web"'
|
||
when: manual
|
||
|
||
# ─── PUBLISH (Docker images) ───────────────────
|
||
.docker_base:
|
||
stage: publish
|
||
image: repo.nstart.cloud/nstart/docker-cli-buildx:1.0.0
|
||
services:
|
||
- name: repo.nstart.cloud/library/docker:29.1.2-dind
|
||
alias: docker
|
||
command: ["--tls=false"]
|
||
variables:
|
||
DOCKER_HOST: tcp://docker:2375
|
||
DOCKER_TLS_CERTDIR: ""
|
||
DOCKER_BUILDKIT: "1"
|
||
|
||
.publish_script: &publish_script |
|
||
for i in $(seq 1 30); do docker info >/dev/null 2>&1 && break; sleep 1; done
|
||
echo "$REGISTRY_PASSWORD" | docker login "$REGISTRY" -u "$REGISTRY_USER" --password-stdin
|
||
IMG="$REGISTRY/$IMAGE_REPO/$SVC"
|
||
docker build -f "$DOCKERFILE" \
|
||
-t "$IMG:$IMAGE_TAG" -t "$IMG:latest" -t "$IMG:$CI_COMMIT_REF_SLUG" \
|
||
--build-arg BUILDKIT_INLINE_CACHE=1 \
|
||
"$BUILD_CONTEXT"
|
||
docker push "$IMG:$IMAGE_TAG"
|
||
docker push "$IMG:latest"
|
||
docker push "$IMG:$CI_COMMIT_REF_SLUG"
|
||
|
||
docker-app:
|
||
extends: .docker_base
|
||
needs: [maven-package]
|
||
variables:
|
||
SVC: ordinis-app
|
||
DOCKERFILE: ordinis-app/Dockerfile
|
||
BUILD_CONTEXT: .
|
||
script:
|
||
- *publish_script
|
||
|
||
docker-read-api:
|
||
extends: .docker_base
|
||
needs: [maven-package]
|
||
variables:
|
||
SVC: ordinis-read-api
|
||
DOCKERFILE: ordinis-read-api/Dockerfile
|
||
BUILD_CONTEXT: .
|
||
script:
|
||
- *publish_script
|
||
|
||
docker-projection-writer:
|
||
extends: .docker_base
|
||
needs: [maven-package]
|
||
variables:
|
||
SVC: ordinis-projection-writer
|
||
DOCKERFILE: ordinis-projection-writer/Dockerfile
|
||
BUILD_CONTEXT: .
|
||
script:
|
||
- *publish_script
|
||
|
||
docker-migrations:
|
||
extends: .docker_base
|
||
needs: [maven-package]
|
||
variables:
|
||
SVC: ordinis-migrations
|
||
DOCKERFILE: ordinis-migrations/Dockerfile
|
||
BUILD_CONTEXT: ordinis-migrations/
|
||
script:
|
||
- *publish_script
|
||
|
||
docker-admin-ui:
|
||
extends: .docker_base
|
||
needs: []
|
||
variables:
|
||
SVC: ordinis-admin-ui
|
||
DOCKERFILE: ordinis-admin-ui/Dockerfile
|
||
BUILD_CONTEXT: ordinis-admin-ui/
|
||
script:
|
||
- *publish_script
|
||
# Раньше был path-filter, но это создавало дыру: если backend менялся, а
|
||
# frontend нет — резолвили общий тег и helm пытался катить admin-ui:<commit>
|
||
# которого не существовало. Layer-cache делает повторную сборку ~30 sec.
|
||
|
||
# ─── TRIGGER DEPLOY ───────────────────────────
|
||
# Single resolve-tag (always runs) → один UPSTREAM_IMAGE_TAG. Path-filter
|
||
# работает на уровне docker-* jobs (backend skip если бэк не менялся,
|
||
# layers cache hit делает rebuild ~30 sec). Полное per-service splitting
|
||
# через dual dotenv не работает с GitLab trigger var interpolation.
|
||
|
||
resolve-tag:
|
||
stage: trigger-deploy
|
||
image: repo.nstart.cloud/library/alpine:3.20
|
||
script:
|
||
- echo "RESOLVED_IMAGE_TAG=$IMAGE_TAG" > resolved.env
|
||
- cat resolved.env
|
||
artifacts:
|
||
reports:
|
||
dotenv: resolved.env
|
||
rules:
|
||
- if: '$CI_COMMIT_BRANCH == "main"'
|
||
|
||
trigger-deploy-staging:
|
||
stage: trigger-deploy
|
||
needs: [resolve-tag]
|
||
trigger:
|
||
project: 2-6/2-6-4/terravault/ordinis-infra
|
||
branch: main
|
||
strategy: depend
|
||
variables:
|
||
UPSTREAM_IMAGE_TAG: $RESOLVED_IMAGE_TAG
|
||
DEPLOY_ENV: staging
|
||
rules:
|
||
- if: '$CI_COMMIT_BRANCH == "main"'
|
||
|
||
trigger-deploy-prod:
|
||
stage: trigger-deploy
|
||
needs: [resolve-tag]
|
||
trigger:
|
||
project: 2-6/2-6-4/terravault/ordinis-infra
|
||
branch: main
|
||
strategy: depend
|
||
variables:
|
||
UPSTREAM_IMAGE_TAG: $RESOLVED_IMAGE_TAG
|
||
DEPLOY_ENV: prod
|
||
rules:
|
||
- if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
|
||
when: manual
|