From 55326bcb1279cffabbf6d49c3b8f98a8a8150441 Mon Sep 17 00:00:00 2001 From: Pjandro Date: Wed, 21 Oct 2026 21:07:23 +0000 Subject: [PATCH 1/2] =?UTF-8?q?ci:=20=D0=BF=D1=80=D0=BE=D0=B4-=D0=BA=D0=BE?= =?UTF-8?q?=D0=BD=D1=84=D0=B8=D0=B3=D1=83=D1=80=D0=B0=D1=86=D0=B8=D1=8F=20?= =?UTF-8?q?=D1=86=D0=B5=D0=BB=D0=B8=D0=BA=D0=BE=D0=BC=20=D0=B2=20workflow?= =?UTF-8?q?=20=E2=80=94=20job=20deploy=20=D1=80=D0=B5=D0=BD=D0=B4=D0=B5?= =?UTF-8?q?=D1=80=D0=B8=D1=82=20compose/nginx=20=D0=B8=D0=B7=20Variables/S?= =?UTF-8?q?ecrets?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Прод-хост не хранит ни конфигов, ни секретов: docker-compose.yml и nginx.conf генерируются job deploy на каждый деплой (новые Variables WORDPDF_PORT/ PROD_SUBNET/PROD_GW вместо литералов в yml), API-ключ подаётся окружением и на диск не пишется; restart.sh и .env удаляются как наследие ручного setup. Healthcheck app — wget (alpine-jre образ curl не содержит: curl-хелсчек давал вечный unhealthy и висящий up, run 479). Gateway пересоздаётся, а не рестартует. Rollback — retag из .rollback.env + пересоздание app/web/gateway. --- .gitea/workflows/main.yml | 189 ++++++++++++++++++++++++++++++++++---- AGENTS.md | 24 ++--- GITEA-vars.md | 11 ++- 3 files changed, 189 insertions(+), 35 deletions(-) diff --git a/.gitea/workflows/main.yml b/.gitea/workflows/main.yml index ba478d6..8873fdf 100644 --- a/.gitea/workflows/main.yml +++ b/.gitea/workflows/main.yml @@ -112,7 +112,7 @@ jobs: runs-on: ubuntu-latest needs: images steps: - - name: Check deploy vars and secret + - name: Check deploy vars and secrets env: DEPLOY_HOST: ${{ vars.DEPLOY_HOST }} DEPLOY_USER: ${{ vars.DEPLOY_USER }} @@ -120,30 +120,173 @@ jobs: REGISTRY: ${{ vars.REGISTRY }} WORDPDF_MAX_MB: ${{ vars.WORDPDF_MAX_MB }} WORDPDF_MAX_PAGES: ${{ vars.WORDPDF_MAX_PAGES }} + WORDPDF_PORT: ${{ vars.WORDPDF_PORT }} + PROD_SUBNET: ${{ vars.PROD_SUBNET }} + PROD_GW: ${{ vars.PROD_GW }} DEPLOY_SSH_KEY: ${{ secrets.DEPLOY_SSH_KEY }} + REGISTRY_USER: ${{ secrets.REGISTRY_USER }} + REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} + WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} run: | - [ -n "$DEPLOY_HOST" ] && [ -n "$DEPLOY_USER" ] && [ -n "$DEPLOY_DIR" ] && [ -n "$REGISTRY" ] && [ -n "$WORDPDF_MAX_MB" ] && [ -n "$WORDPDF_MAX_PAGES" ] && [ -n "$DEPLOY_SSH_KEY" ] || { - echo "Задайте Actions Variables DEPLOY_HOST/DEPLOY_USER/DEPLOY_DIR/REGISTRY/WORDPDF_MAX_MB/WORDPDF_MAX_PAGES и Secret DEPLOY_SSH_KEY — см. GITEA-vars.md" >&2 - exit 1 - } + missing=0 + for v in DEPLOY_HOST DEPLOY_USER DEPLOY_DIR REGISTRY WORDPDF_MAX_MB WORDPDF_MAX_PAGES WORDPDF_PORT PROD_SUBNET PROD_GW; do + [ -n "${!v}" ] || { echo "Задайте Actions Variable $v — см. GITEA-vars.md" >&2; missing=1; } + done + for s in DEPLOY_SSH_KEY REGISTRY_USER REGISTRY_PASSWORD WORDPDF_API_KEY; do + [ -n "${!s}" ] || { echo "Задайте Actions Secret $s — см. GITEA-vars.md" >&2; missing=1; } + done + exit "$missing" - - name: Save rollback state and deploy + # Единственный источник правды конфигурации прода — этот workflow: docker-compose.yml + # и nginx.conf рендерятся на прод-хост на каждый деплой из Variables/Secrets; + # ключ API в файлы не пишется (берётся из окружения job'а). На прод-хосте + # конфигурации нет: restart.sh и .env удаляются как наследие ручного setup. + - name: Render prod stack and deploy + env: + DEPLOY_DIR: ${{ vars.DEPLOY_DIR }} + DEPLOY_HOST: ${{ vars.DEPLOY_HOST }} + REGISTRY: ${{ vars.REGISTRY }} + WORDPDF_MAX_MB: ${{ vars.WORDPDF_MAX_MB }} + WORDPDF_MAX_PAGES: ${{ vars.WORDPDF_MAX_PAGES }} + WORDPDF_PORT: ${{ vars.WORDPDF_PORT }} + PROD_SUBNET: ${{ vars.PROD_SUBNET }} + PROD_GW: ${{ vars.PROD_GW }} + WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} + REGISTRY_USER: ${{ secrets.REGISTRY_USER }} + REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} uses: appleboy/ssh-action@v1.0.3 with: host: ${{ vars.DEPLOY_HOST }} username: ${{ vars.DEPLOY_USER }} key: ${{ secrets.DEPLOY_SSH_KEY }} script_stop: true + envs: DEPLOY_DIR,DEPLOY_HOST,REGISTRY,WORDPDF_MAX_MB,WORDPDF_MAX_PAGES,WORDPDF_PORT,PROD_SUBNET,PROD_GW,WORDPDF_API_KEY,REGISTRY_USER,REGISTRY_PASSWORD script: | set -euo pipefail - cd "${{ vars.DEPLOY_DIR }}" - export WORDPDF_MAX_MB="${{ vars.WORDPDF_MAX_MB }}" WORDPDF_MAX_PAGES="${{ vars.WORDPDF_MAX_PAGES }}" umask 077 - { - echo "PREV_APP=$(podman inspect -f '{{.Image}}' wordpdf-prod-app-1)" - echo "PREV_WEB=$(podman inspect -f '{{.Image}}' wordpdf-prod-web-1)" - } > .rollback.env - ./restart.sh --deploy + mkdir -p "$DEPLOY_DIR" + cd "$DEPLOY_DIR" + rm -f restart.sh .env + cat > docker-compose.yml < nginx.conf < .rollback.env + fi + printf '%s' "$REGISTRY_PASSWORD" | podman login "$REGISTRY" --username "$REGISTRY_USER" --password-stdin + podman-compose pull app web + podman-compose up -d --force-recreate app web + for _ in $(seq 1 60); do + [ "$(podman inspect -f '{{.State.Health.Status}}' wordpdf-prod-app-1)" = healthy ] && break + sleep 2 + done + [ "$(podman inspect -f '{{.State.Health.Status}}' wordpdf-prod-app-1)" = healthy ] \ + || { echo "app не стал healthy за 120с" >&2; exit 1; } + # Гейт: app/web обязаны идти на только что стянутый из реестра образ + # (защита от молчаливого деплоя старого кода). + for svc in app web; do + ctr="wordpdf-prod-${svc}-1" + [ "$(podman inspect -f '{{.Image}}' "$ctr")" = \ + "$(podman image inspect "$REGISTRY/wordpdf-${svc}:prod" -f '{{.Id}}')" ] \ + || { echo "$ctr запущен не на новом образе $REGISTRY/wordpdf-${svc}:prod" >&2; exit 1; } + done + # gateway пересоздаётся последним (после healthy app/web): nginx.conf + # на каждый деплой рендерится заново, пересоздание применяет его. + podman-compose up -d --force-recreate gateway + for _ in $(seq 1 10); do + curl -fsS -o /dev/null "http://127.0.0.1:$WORDPDF_PORT/actuator/health" 2>/dev/null && break || sleep 1 + done + curl -fsS "http://127.0.0.1:$WORDPDF_PORT/actuator/health" + podman-compose ps autotests: runs-on: ubuntu-latest @@ -182,28 +325,34 @@ jobs: if: failure() steps: - name: Roll back prod to previous images + env: + DEPLOY_DIR: ${{ vars.DEPLOY_DIR }} + REGISTRY: ${{ vars.REGISTRY }} + WORDPDF_PORT: ${{ vars.WORDPDF_PORT }} + WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} uses: appleboy/ssh-action@v1.0.3 with: host: ${{ vars.DEPLOY_HOST }} username: ${{ vars.DEPLOY_USER }} key: ${{ secrets.DEPLOY_SSH_KEY }} script_stop: true + envs: DEPLOY_DIR,REGISTRY,WORDPDF_PORT,WORDPDF_API_KEY script: | set -euo pipefail - cd "${{ vars.DEPLOY_DIR }}" - export WORDPDF_MAX_MB="${{ vars.WORDPDF_MAX_MB }}" WORDPDF_MAX_PAGES="${{ vars.WORDPDF_MAX_PAGES }}" + cd "$DEPLOY_DIR" if [ ! -f .rollback.env ]; then echo "НЕТ .rollback.env — АВТОМАТИЧЕСКИЙ ОТКАТ НЕВОЗМОЖЕН" >&2 exit 1 fi . ./.rollback.env - podman tag "$PREV_APP" "${{ vars.REGISTRY }}/wordpdf-app:prod" - podman tag "$PREV_WEB" "${{ vars.REGISTRY }}/wordpdf-web:prod" + podman tag "$PREV_APP" "$REGISTRY/wordpdf-app:prod" + podman tag "$PREV_WEB" "$REGISTRY/wordpdf-web:prod" podman-compose up -d --force-recreate app web for _ in $(seq 1 60); do [ "$(podman inspect -f '{{.State.Health.Status}}' wordpdf-prod-app-1)" = healthy ] && break sleep 2 done - [ "$(podman inspect -f '{{.State.Health.Status}}' wordpdf-prod-app-1)" = healthy ] || { echo "app НЕ healthy после отката" >&2; exit 1; } - podman-compose restart gateway - curl -fsS http://127.0.0.1:9010/actuator/health + [ "$(podman inspect -f '{{.State.Health.Status}}' wordpdf-prod-app-1)" = healthy ] \ + || { echo "app НЕ healthy после отката" >&2; exit 1; } + podman-compose up -d --force-recreate gateway + curl -fsS "http://127.0.0.1:$WORDPDF_PORT/actuator/health" diff --git a/AGENTS.md b/AGENTS.md index 90ec128..432c058 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -55,9 +55,9 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр |`wordpdf-core/src/test/resources/samples/`|11 закоммиченных `.docx`-фикстур (единственные фикстуры)| |`wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/`|REST API (10 классов): `WordPdfApplication` (единственный public), `ConvertController`, `ConversionService` (очередь), `ApiExceptionHandler`, `ApiKeyFilter`, `OpenApiConfig` (`@SecurityScheme` X-API-Key для springdoc) + 5 класса исключений| |`wordpdf-web/src/`|SPA (React 19 + TS + Vite + Tailwind): `api.ts` (вся сеть), `components/` (App, ApiKeyGate, PdfPreview, StatusMessage, DropZone, Logo)| -|корневые `Containerfile`, `compose.yml`, `compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-**21-jre-alpine** (musl) — chart-движку нужен только модуль java.desktop (Graphics2D, он внутри JRE); fontconfig и системные шрифты рантайму не нужны — текст рисуется глифами fontbox, см. `fonts/GlyphFont` (проверено на musl-стенде без libfontconfig/`/etc/fonts`); HEALTHCHECK busybox `wget` (curl/apt не ставим), non-root uid 10001); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy`; прод-compose интерполирует `WORDPDF_MAX_MB:-5`/`WORDPDF_MAX_PAGES:-100`; podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет; app-хелсчеки — `wget`, как в Containerfile), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)| -|корневой `.env.example`|шаблон env: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` (пустое значение ломает старт — binding long/int); реальный прод `.env` — на прод-сервере (координаты: `/home/pjandro/prod/java-word-pdf/DEPLOY.md`, вне репо)| -|`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты → `images` (build+push в Nexus) → deploy (pull) → autotests → rollback)| +|корневые `Containerfile`, `compose.yml`, `compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-**21-jre-alpine** (musl) — chart-движку нужен только модуль java.desktop (Graphics2D, он внутри JRE); fontconfig и системные шрифты рантайму не нужны — текст рисуется глифами fontbox, см. `fonts/GlyphFont` (проверено на musl-стенде без libfontconfig/`/etc/fonts`); HEALTHCHECK busybox `wget` (curl/apt не ставим), non-root uid 10001); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy`; прод-compose не в репо — его рендерит job `deploy` (лимиты запекаются из Variables); podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет; app-хелсчеки — `wget`, как в Containerfile), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)| +|корневой `.env.example`|шаблон env для локальных/compose-стендов: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` (пустое значение ломает старт — binding long/int); проду `.env` **не нужен**: ключ и лимиты подаёт job `deploy` из Gitea Secrets/Variables, legacy-`.env` на проде удаляется деплоем| +|`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты → `images` (build+push в Nexus) → deploy (рендер прод-конфигов + pull) → autotests → rollback)| |корневой `GITEA-vars.md`|инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений| |корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 20 проверок): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh`| |`develop/` (вне git)|рабочие материалы и эталоны Word (`testDoc.doc/.pdf`, `testDoc.convert.pdf`, `openxml.docx/.pdf`) — **ручное сравнение, не фикстуры**, в тесты/jar не подключать| @@ -84,7 +84,7 @@ java -cp wordpdf-core/target/test-classes:$(cat /tmp/cp.txt) \ ru.pjandro.wordpdf.SampleDocxGenerator wordpdf-core/src/test/resources/samples ``` -Деплой. **Прод** — на пользовательском LAN-сервере (podman + podman-compose, docker-бинарников нет); координаты сервера, каталог, restart-секвенция, ключ и гейты успешности — вне репо: `/home/pjandro/prod/java-word-pdf/DEPLOY.md` (обязательно прочитать перед любым деплоем/перезапуском). Единая точка входа с dev-машины — `/home/pjandro/prod/java-word-pdf/restart.sh` (пробрасывает флаги удалённому скрипту: `--deploy` — pull образов `wordpdf-{app,web}:prod` из Nexus-реестра (их собирает CI, job `images`) и пересоздание app/web; без флага — restart контейнеров; предупреждает о не запушенном в `main`). В прод попадает только собранное CI из `main`; прод не собирает код и git-клона на проде нет (insecure-запись реестра в `/etc/containers/registries.conf.d/`, креды `REGISTRY_USER`/`REGISTRY_PASSWORD` в прод `.env`). Прод-compose `/opt/wordpdf/docker-compose.yml` (вне git) содержит podman-специфику: `x-podman.name_separator_compat` (имена `wordpdf-prod-app-1`, от них зависит `restart.sh`), явные healthcheck app/web и фиксированную подсеть `10.112.0.0/24` gw `10.112.0.1`. Наружный вход `https://pjandro.ru/pdf-converter/` (префикс срезает наружный nginx прод-хоста, не репозиторный gateway-конф; прод-копия gateway-конфа отличается от репо только резолвером `10.112.0.1` — под свою подсеть — и `proxy_read_timeout 300s` — в репо его нет, дефолтные 60s рвут 2-минутные конвертации; resolver + `proxy_pass` через переменную есть и там и там). Тот же наружный nginx в `location /pdf-converter/` добавляет `X-Forwarded-Host`/`X-Forwarded-Prefix` — из них springdoc собирает server-URL спека под префиксом. **Dev-стенд** — из репо `compose.dev.yml` (проект `wordpdf-dev`, `9011:80` на все интерфейсы, без env → ключ пуст, springdoc вкл). Репозиторный `compose.yml` — третий вариант (проект `wordpdf`, `9010:80`, `WORDPDF_API_KEY` fail-closed без `.env` — `up` упадёт; `VITE_BASE` — build-arg `wordpdf-web/Containerfile`, репо-compose НЕ передаёт: `compose build` без arg даёт base `/` и битые ассеты под префиксом; на прод-путь не влияет — там `VITE_BASE=/pdf-converter/` запекает CI в job `images`). Запуск по просьбе пользователя = прод-стек; dev/`java -jar`/`npm run dev` — внутренняя отладка. +Деплой. **Прод** — на пользовательском LAN-сервере (podman + podman-compose, docker-бинарников нет); координаты сервера и гейты успешности — вне репо: `/home/pjandro/prod/java-word-pdf/DEPLOY.md` (обязательно прочитать перед любым деплоем/перезапуском). Прод-хост **не хранит ни деплой-конфигурации, ни секретов**: job `deploy` в `main.yml` на каждый деплой рендерит `docker-compose.yml` и `nginx.conf` в директорию деплоя (значения — из Variables `REGISTRY`/`DEPLOY_HOST`/`WORDPDF_PORT`/`PROD_SUBNET`/`PROD_GW`/`WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES`, API-ключ — из Secret `WORDPDF_API_KEY` через окружение деплоя, на диск не пишется), затем login/pull/`up -d --force-recreate app web`/гейты healthy+image/recreate gateway. Наследие ручного setup `restart.sh` и `.env` деплой удаляет; единственное состояние на проде — `.rollback.env` (image ID для отката). Перезадеплой — push в `main` или Run workflow (`workflow_dispatch`), ручных скриптов нет. В прод попадает только собранное CI из `main`; прод не собирает код и git-клона на проде нет (insecure-запись реестра в `/etc/containers/registries.conf.d/`). Рендеренный compose содержит podman-специфику: `x-podman.name_separator_compat` (имена `wordpdf-prod-app-1`, от них зависят гейты), явные healthcheck app/web — `wget` (alpine-jre образ curl не содержит; curl-хелсчек на новом образе давал вечный unhealthy и висящий `up`), фиксированная подсеть (`PROD_SUBNET`/`PROD_GW`). Наружный вход `https://pjandro.ru/pdf-converter/` (префикс срезает наружный nginx прод-хоста, не репозиторный gateway-конф; прод-копия gateway-конфа рендерится workflow и отличается от репо только резолвером (Variable `PROD_GW` — под свою подсеть) и `proxy_read_timeout 300s` — в репо его нет, дефолтные 60s рвут 2-минутные конвертации; resolver + `proxy_pass` через переменную есть и там и там). Тот же наружный nginx в `location /pdf-converter/` добавляет `X-Forwarded-Host`/`X-Forwarded-Prefix` — из них springdoc собирает server-URL спека под префиксом. **Dev-стенд** — из репо `compose.dev.yml` (проект `wordpdf-dev`, `9011:80` на все интерфейсы, без env → ключ пуст, springdoc вкл). Репозиторный `compose.yml` — третий вариант (проект `wordpdf`, `9010:80`, `WORDPDF_API_KEY` fail-closed без `.env` — `up` упадёт; `VITE_BASE` — build-arg `wordpdf-web/Containerfile`, репо-compose НЕ передаёт: `compose build` без arg даёт base `/` и битые ассеты под префиксом; на прод-путь не влияет — там `VITE_BASE=/pdf-converter/` запекает CI в job `images`). Запуск по просьбе пользователя = прод-стек; dev/`java -jar`/`npm run dev` — внутренняя отладка. ## CI/CD (Gitea Actions) @@ -97,20 +97,22 @@ deploy, autotests` (`push` в `main` + `workflow_dispatch`): те же `java`/`w immovable `sha-<7 символов GITHUB_SHA>`; web пекётся с `--build-arg VITE_BASE=/pdf-converter/`; `DOCKER_BUILDKIT=0` обязателен — daemon за раннером podman, BuildKit-сессий нет; креды — вручную пишется `~/.docker/config.json`, job-контейнеры видят podman-сокет хоста — настройка -раннера вне репо, см. DEPLOY.md), `deploy` (SSH на прод: -сохранить `.rollback.env` — image ID контейнеров app/web — затем -`restart.sh --deploy` в директории деплоя (Variable `DEPLOY_DIR`); export Variables -`WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` в окружение compose — лимиты прода задаются -ими, `autotests`/`rollback` используют те же), `autotests` (venv + +раннера вне репо, см. DEPLOY.md), `deploy` (SSH на прод: рендер `docker-compose.yml` +и `nginx.conf` в директорию деплоя (Variable `DEPLOY_DIR`) из Variables/Secrets — +на проде конфигурации не хранится; сохранение `.rollback.env` — image ID контейнеров +app/web; login/pull/`up -d --force-recreate app web`; гейты healthy и image; +`up -d --force-recreate gateway`; health-check. Лимиты задают Variables +`WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES`, `autotests`/`rollback` используют те же), `autotests` (venv + `prod-autotests/` против прода), `rollback` (`if: failure()` — retag прежних image ID на `${{ vars.REGISTRY }}/wordpdf-app:prod` -и `…/wordpdf-web:prod`, `--force-recreate app web`, рестарт gateway). Кеш раннеров — +и `…/wordpdf-web:prod`, `--force-recreate app web`, пересоздание gateway). Кеш раннеров — сервер act_runner (серверная часть, вне репо). **Правило: координаты прода и креды в коммитимые файлы не попадают** — ни внутренние IP, ни SSH-пользователи/логины, ни хосты, ни директория деплоя, ни ключи/токены/пароли. Координаты стенда — Gitea Actions **Variables** (`DEPLOY_HOST`, `DEPLOY_USER`, `DEPLOY_DIR`, -`WORDPDF_BASE_URL`, `WORDPDF_MAX_PAGES`, `WORDPDF_MAX_MB`, `REGISTRY`), креды — **Secrets** (`DEPLOY_SSH_KEY`, +`WORDPDF_BASE_URL`, `WORDPDF_MAX_PAGES`, `WORDPDF_MAX_MB`, `REGISTRY`, `WORDPDF_PORT`, +`PROD_SUBNET`, `PROD_GW`), креды — **Secrets** (`DEPLOY_SSH_KEY`, `WORDPDF_API_KEY`, `REGISTRY_USER`, `REGISTRY_PASSWORD`); workflow-файлы ссылаются на них только `${{ vars.* }}`/`${{ secrets.* }}`. Инструкция владельца — корневой `GITEA-vars.md` (только имена, без значений). Защита ветки `main`: required-контексты **`PR checks / java (pull_request)`, `PR checks / web (pull_request)`** diff --git a/GITEA-vars.md b/GITEA-vars.md index 9a102a7..503111b 100644 --- a/GITEA-vars.md +++ b/GITEA-vars.md @@ -14,21 +14,24 @@ job'ах `deploy`/`autotests` с внятным сообщением, чего |Имя|Значение|Где взять| |---|---|---| |`DEPLOY_SSH_KEY`|Приватный SSH-ключ деплоя на прод (целиком, PEM)|CI-ключ `wordpdf-ci-deploy` на dev-машине; публичная половина уже добавлена в `authorized_keys` деплой-пользователя прод-сервера| -|`WORDPDF_API_KEY`|Прод-ключ API wordpdf|`.env` в директории деплоя на прод-сервере (значение `WORDPDF_API_KEY`)| +|`WORDPDF_API_KEY`|Прод-ключ API wordpdf|Единственный источник — этот Secret (прод `.env` выведен из эксплуатации, job `deploy` удаляет его как наследие); значение уже в Gitea| |`REGISTRY_USER`|Логин docker-реестра для CI-пуша (`ci-deploy`)|Nexus: Security → Users (роль `ci-deploy-role`, права на docker-hosted репозиторий)| -|`REGISTRY_PASSWORD`|Пароль этого пользователя|Тот же, что в `.env` директории деплоя на прод-сервере (значение `REGISTRY_PASSWORD`)| +|`REGISTRY_PASSWORD`|Пароль этого пользователя|Nexus: Security → Users → `ci-deploy` (Reset password)| ## Переменные (Settings → Actions → Variables) |Имя|Значение| |---|---| -|`DEPLOY_HOST`|Адрес прод-сервера (туда Actions ходит по SSH)| +|`DEPLOY_HOST`|IP прод-сервера (туда Actions ходит по SSH; им же связывается LAN-порт gateway — нужен именно IP, не hostname)| |`DEPLOY_USER`|SSH-пользователь прод-сервера с правами на podman| -|`DEPLOY_DIR`|Абсолютный путь директории деплоя на прод-сервере (compose, `restart.sh`, `.rollback.env`, `.env`)| +|`DEPLOY_DIR`|Абсолютный путь рабочей директории деплоя: job `deploy` создаёт её и рендерит в неё `docker-compose.yml` и `nginx.conf` на каждый деплой; `.rollback.env` — состояние отката (его пишет job `deploy`)| |`WORDPDF_BASE_URL`|Базовый URL прод-API для автотестов (вида `https://<домен-прода>/pdf-converter`)| |`WORDPDF_MAX_PAGES`|Лимит страниц на проде (сейчас `100`)| |`WORDPDF_MAX_MB`|Лимит размера входного .docx, МБ (сейчас `5`)| |`REGISTRY`|Адрес docker-реестра `host:port` без схемы (Nexus docker-registry на прод-сервере, коннектор `:5000`)| +|`WORDPDF_PORT`|Наружный порт gateway (bind на `127.0.0.1` и на `DEPLOY_HOST`)| +|`PROD_SUBNET`|Зафиксированная подсеть сети стека (CIDR) — за ней обращается резолвер nginx| +|`PROD_GW`|Шлюз `PROD_SUBNET` — адрес aardvark-dns, в него смотрит `resolver` nginx-конфа| При смене лимитов прода — править `WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB` в Variables, PR не нужен: job `deploy` прокидывает их в прод-stack (app пересоздаётся с новыми лимитами), job `autotests` сверяет проверки с ними же. Без обеих Variables job'ы `deploy`/`autotests` падают на проверке — fail-closed. -- 2.56.1 From e85505529c104a8440f0fc08fcdefbbe68c5f240 Mon Sep 17 00:00:00 2001 From: Pjandro Date: Wed, 21 Oct 2026 21:11:48 +0000 Subject: [PATCH 2/2] =?UTF-8?q?ci:=20=D0=BF=D0=BE=D1=80=D1=82=20gateway,?= =?UTF-8?q?=20=D0=BF=D0=BE=D0=B4=D1=81=D0=B5=D1=82=D1=8C=20=D0=B8=20=D1=80?= =?UTF-8?q?=D0=B5=D0=B7=D0=BE=D0=BB=D0=B2=D0=B5=D1=80=20=E2=80=94=20=D0=BB?= =?UTF-8?q?=D0=B8=D1=82=D0=B5=D1=80=D0=B0=D0=BB=D1=8B=20workflow,=20=D0=BD?= =?UTF-8?q?=D0=BE=D0=B2=D1=8B=D1=85=20Variables=20=D0=BD=D0=B5=D1=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit WORDPDF_PORT/PROD_SUBNET/PROD_GW — внутренняя геометрия стека, не координаты стенда: зашиты в рендер напрямую, job deploy проверяет только прежние Variables (DEPLOY_*/REGISTRY/WORDPDF_MAX_*). --- .gitea/workflows/main.yml | 30 ++++++++++++------------------ AGENTS.md | 5 ++--- GITEA-vars.md | 3 --- 3 files changed, 14 insertions(+), 24 deletions(-) diff --git a/.gitea/workflows/main.yml b/.gitea/workflows/main.yml index 8873fdf..9c25ceb 100644 --- a/.gitea/workflows/main.yml +++ b/.gitea/workflows/main.yml @@ -120,16 +120,13 @@ jobs: REGISTRY: ${{ vars.REGISTRY }} WORDPDF_MAX_MB: ${{ vars.WORDPDF_MAX_MB }} WORDPDF_MAX_PAGES: ${{ vars.WORDPDF_MAX_PAGES }} - WORDPDF_PORT: ${{ vars.WORDPDF_PORT }} - PROD_SUBNET: ${{ vars.PROD_SUBNET }} - PROD_GW: ${{ vars.PROD_GW }} DEPLOY_SSH_KEY: ${{ secrets.DEPLOY_SSH_KEY }} REGISTRY_USER: ${{ secrets.REGISTRY_USER }} REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} run: | missing=0 - for v in DEPLOY_HOST DEPLOY_USER DEPLOY_DIR REGISTRY WORDPDF_MAX_MB WORDPDF_MAX_PAGES WORDPDF_PORT PROD_SUBNET PROD_GW; do + for v in DEPLOY_HOST DEPLOY_USER DEPLOY_DIR REGISTRY WORDPDF_MAX_MB WORDPDF_MAX_PAGES; do [ -n "${!v}" ] || { echo "Задайте Actions Variable $v — см. GITEA-vars.md" >&2; missing=1; } done for s in DEPLOY_SSH_KEY REGISTRY_USER REGISTRY_PASSWORD WORDPDF_API_KEY; do @@ -148,9 +145,6 @@ jobs: REGISTRY: ${{ vars.REGISTRY }} WORDPDF_MAX_MB: ${{ vars.WORDPDF_MAX_MB }} WORDPDF_MAX_PAGES: ${{ vars.WORDPDF_MAX_PAGES }} - WORDPDF_PORT: ${{ vars.WORDPDF_PORT }} - PROD_SUBNET: ${{ vars.PROD_SUBNET }} - PROD_GW: ${{ vars.PROD_GW }} WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} REGISTRY_USER: ${{ secrets.REGISTRY_USER }} REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }} @@ -160,7 +154,7 @@ jobs: username: ${{ vars.DEPLOY_USER }} key: ${{ secrets.DEPLOY_SSH_KEY }} script_stop: true - envs: DEPLOY_DIR,DEPLOY_HOST,REGISTRY,WORDPDF_MAX_MB,WORDPDF_MAX_PAGES,WORDPDF_PORT,PROD_SUBNET,PROD_GW,WORDPDF_API_KEY,REGISTRY_USER,REGISTRY_PASSWORD + envs: DEPLOY_DIR,DEPLOY_HOST,REGISTRY,WORDPDF_MAX_MB,WORDPDF_MAX_PAGES,WORDPDF_API_KEY,REGISTRY_USER,REGISTRY_PASSWORD script: | set -euo pipefail umask 077 @@ -207,7 +201,7 @@ jobs: - ./nginx.conf:/etc/nginx/conf.d/default.conf:ro # 127.0.0.1 — наружный nginx этого же хоста (pjandro.ru/pdf-converter/), # $DEPLOY_HOST — прямой LAN-вход - ports: ["127.0.0.1:$WORDPDF_PORT:80", "$DEPLOY_HOST:$WORDPDF_PORT:80"] + ports: ["127.0.0.1:9010:80", "$DEPLOY_HOST:9010:80"] depends_on: app: condition: service_healthy @@ -216,12 +210,13 @@ jobs: restart: unless-stopped networks: # Подсеть зафиксирована намеренно: nginx резолвит app/web через aardvark-dns - # на шлюзе сети ($PROD_GW), адрес обязан быть предсказуемым. + # на шлюзе сети (10.112.0.1), адрес обязан быть предсказуемым. Внутренняя + # геометрия стека, не координата стенда — литералом здесь. default: ipam: config: - - subnet: $PROD_SUBNET - gateway: $PROD_GW + - subnet: 10.112.0.0/24 + gateway: 10.112.0.1 COMPOSE cat > nginx.conf </dev/null && break || sleep 1 + curl -fsS -o /dev/null "http://127.0.0.1:9010/actuator/health" 2>/dev/null && break || sleep 1 done - curl -fsS "http://127.0.0.1:$WORDPDF_PORT/actuator/health" + curl -fsS "http://127.0.0.1:9010/actuator/health" podman-compose ps autotests: @@ -328,7 +323,6 @@ jobs: env: DEPLOY_DIR: ${{ vars.DEPLOY_DIR }} REGISTRY: ${{ vars.REGISTRY }} - WORDPDF_PORT: ${{ vars.WORDPDF_PORT }} WORDPDF_API_KEY: ${{ secrets.WORDPDF_API_KEY }} uses: appleboy/ssh-action@v1.0.3 with: @@ -336,7 +330,7 @@ jobs: username: ${{ vars.DEPLOY_USER }} key: ${{ secrets.DEPLOY_SSH_KEY }} script_stop: true - envs: DEPLOY_DIR,REGISTRY,WORDPDF_PORT,WORDPDF_API_KEY + envs: DEPLOY_DIR,REGISTRY,WORDPDF_API_KEY script: | set -euo pipefail cd "$DEPLOY_DIR" @@ -355,4 +349,4 @@ jobs: [ "$(podman inspect -f '{{.State.Health.Status}}' wordpdf-prod-app-1)" = healthy ] \ || { echo "app НЕ healthy после отката" >&2; exit 1; } podman-compose up -d --force-recreate gateway - curl -fsS "http://127.0.0.1:$WORDPDF_PORT/actuator/health" + curl -fsS "http://127.0.0.1:9010/actuator/health" diff --git a/AGENTS.md b/AGENTS.md index 432c058..cdee305 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -84,7 +84,7 @@ java -cp wordpdf-core/target/test-classes:$(cat /tmp/cp.txt) \ ru.pjandro.wordpdf.SampleDocxGenerator wordpdf-core/src/test/resources/samples ``` -Деплой. **Прод** — на пользовательском LAN-сервере (podman + podman-compose, docker-бинарников нет); координаты сервера и гейты успешности — вне репо: `/home/pjandro/prod/java-word-pdf/DEPLOY.md` (обязательно прочитать перед любым деплоем/перезапуском). Прод-хост **не хранит ни деплой-конфигурации, ни секретов**: job `deploy` в `main.yml` на каждый деплой рендерит `docker-compose.yml` и `nginx.conf` в директорию деплоя (значения — из Variables `REGISTRY`/`DEPLOY_HOST`/`WORDPDF_PORT`/`PROD_SUBNET`/`PROD_GW`/`WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES`, API-ключ — из Secret `WORDPDF_API_KEY` через окружение деплоя, на диск не пишется), затем login/pull/`up -d --force-recreate app web`/гейты healthy+image/recreate gateway. Наследие ручного setup `restart.sh` и `.env` деплой удаляет; единственное состояние на проде — `.rollback.env` (image ID для отката). Перезадеплой — push в `main` или Run workflow (`workflow_dispatch`), ручных скриптов нет. В прод попадает только собранное CI из `main`; прод не собирает код и git-клона на проде нет (insecure-запись реестра в `/etc/containers/registries.conf.d/`). Рендеренный compose содержит podman-специфику: `x-podman.name_separator_compat` (имена `wordpdf-prod-app-1`, от них зависят гейты), явные healthcheck app/web — `wget` (alpine-jre образ curl не содержит; curl-хелсчек на новом образе давал вечный unhealthy и висящий `up`), фиксированная подсеть (`PROD_SUBNET`/`PROD_GW`). Наружный вход `https://pjandro.ru/pdf-converter/` (префикс срезает наружный nginx прод-хоста, не репозиторный gateway-конф; прод-копия gateway-конфа рендерится workflow и отличается от репо только резолвером (Variable `PROD_GW` — под свою подсеть) и `proxy_read_timeout 300s` — в репо его нет, дефолтные 60s рвут 2-минутные конвертации; resolver + `proxy_pass` через переменную есть и там и там). Тот же наружный nginx в `location /pdf-converter/` добавляет `X-Forwarded-Host`/`X-Forwarded-Prefix` — из них springdoc собирает server-URL спека под префиксом. **Dev-стенд** — из репо `compose.dev.yml` (проект `wordpdf-dev`, `9011:80` на все интерфейсы, без env → ключ пуст, springdoc вкл). Репозиторный `compose.yml` — третий вариант (проект `wordpdf`, `9010:80`, `WORDPDF_API_KEY` fail-closed без `.env` — `up` упадёт; `VITE_BASE` — build-arg `wordpdf-web/Containerfile`, репо-compose НЕ передаёт: `compose build` без arg даёт base `/` и битые ассеты под префиксом; на прод-путь не влияет — там `VITE_BASE=/pdf-converter/` запекает CI в job `images`). Запуск по просьбе пользователя = прод-стек; dev/`java -jar`/`npm run dev` — внутренняя отладка. +Деплой. **Прод** — на пользовательском LAN-сервере (podman + podman-compose, docker-бинарников нет); координаты сервера и гейты успешности — вне репо: `/home/pjandro/prod/java-word-pdf/DEPLOY.md` (обязательно прочитать перед любым деплоем/перезапуском). Прод-хост **не хранит ни деплой-конфигурации, ни секретов**: job `deploy` в `main.yml` на каждый деплой рендерит `docker-compose.yml` и `nginx.conf` в директорию деплоя (значения — из Variables `REGISTRY`/`DEPLOY_HOST`/`WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES`, API-ключ — из Secret `WORDPDF_API_KEY` через окружение деплоя, на диск не пишется), затем login/pull/`up -d --force-recreate app web`/гейты healthy+image/recreate gateway. Наследие ручного setup `restart.sh` и `.env` деплой удаляет; единственное состояние на проде — `.rollback.env` (image ID для отката). Перезадеплой — push в `main` или Run workflow (`workflow_dispatch`), ручных скриптов нет. В прод попадает только собранное CI из `main`; прод не собирает код и git-клона на проде нет (insecure-запись реестра в `/etc/containers/registries.conf.d/`). Рендеренный compose содержит podman-специфику: `x-podman.name_separator_compat` (имена `wordpdf-prod-app-1`, от них зависят гейты), явные healthcheck app/web — `wget` (alpine-jre образ curl не содержит; curl-хелсчек на новом образе давал вечный unhealthy и висящий `up`), наружный порт gateway `9010` и фиксированная подсеть `10.112.0.0/24` gw `10.112.0.1` — внутренняя геометрия стека, литералом в workflow (не координата стенда, Variables для неё не заведены). Наружный вход `https://pjandro.ru/pdf-converter/` (префикс срезает наружный nginx прод-хоста, не репозиторный gateway-конф; прод-копия gateway-конфа рендерится workflow и отличается от репо только резолвером `10.112.0.1` — под свою подсеть — и `proxy_read_timeout 300s` — в репо его нет, дефолтные 60s рвут 2-минутные конвертации; resolver + `proxy_pass` через переменную есть и там и там). Тот же наружный nginx в `location /pdf-converter/` добавляет `X-Forwarded-Host`/`X-Forwarded-Prefix` — из них springdoc собирает server-URL спека под префиксом. **Dev-стенд** — из репо `compose.dev.yml` (проект `wordpdf-dev`, `9011:80` на все интерфейсы, без env → ключ пуст, springdoc вкл). Репозиторный `compose.yml` — третий вариант (проект `wordpdf`, `9010:80`, `WORDPDF_API_KEY` fail-closed без `.env` — `up` упадёт; `VITE_BASE` — build-arg `wordpdf-web/Containerfile`, репо-compose НЕ передаёт: `compose build` без arg даёт base `/` и битые ассеты под префиксом; на прод-путь не влияет — там `VITE_BASE=/pdf-converter/` запекает CI в job `images`). Запуск по просьбе пользователя = прод-стек; dev/`java -jar`/`npm run dev` — внутренняя отладка. ## CI/CD (Gitea Actions) @@ -111,8 +111,7 @@ app/web; login/pull/`up -d --force-recreate app web`; гейты healthy и imag **Правило: координаты прода и креды в коммитимые файлы не попадают** — ни внутренние IP, ни SSH-пользователи/логины, ни хосты, ни директория деплоя, ни ключи/токены/пароли. Координаты стенда — Gitea Actions **Variables** (`DEPLOY_HOST`, `DEPLOY_USER`, `DEPLOY_DIR`, -`WORDPDF_BASE_URL`, `WORDPDF_MAX_PAGES`, `WORDPDF_MAX_MB`, `REGISTRY`, `WORDPDF_PORT`, -`PROD_SUBNET`, `PROD_GW`), креды — **Secrets** (`DEPLOY_SSH_KEY`, +`WORDPDF_BASE_URL`, `WORDPDF_MAX_PAGES`, `WORDPDF_MAX_MB`, `REGISTRY`), креды — **Secrets** (`DEPLOY_SSH_KEY`, `WORDPDF_API_KEY`, `REGISTRY_USER`, `REGISTRY_PASSWORD`); workflow-файлы ссылаются на них только `${{ vars.* }}`/`${{ secrets.* }}`. Инструкция владельца — корневой `GITEA-vars.md` (только имена, без значений). Защита ветки `main`: required-контексты **`PR checks / java (pull_request)`, `PR checks / web (pull_request)`** diff --git a/GITEA-vars.md b/GITEA-vars.md index 503111b..09a060f 100644 --- a/GITEA-vars.md +++ b/GITEA-vars.md @@ -29,9 +29,6 @@ job'ах `deploy`/`autotests` с внятным сообщением, чего |`WORDPDF_MAX_PAGES`|Лимит страниц на проде (сейчас `100`)| |`WORDPDF_MAX_MB`|Лимит размера входного .docx, МБ (сейчас `5`)| |`REGISTRY`|Адрес docker-реестра `host:port` без схемы (Nexus docker-registry на прод-сервере, коннектор `:5000`)| -|`WORDPDF_PORT`|Наружный порт gateway (bind на `127.0.0.1` и на `DEPLOY_HOST`)| -|`PROD_SUBNET`|Зафиксированная подсеть сети стека (CIDR) — за ней обращается резолвер nginx| -|`PROD_GW`|Шлюз `PROD_SUBNET` — адрес aardvark-dns, в него смотрит `resolver` nginx-конфа| При смене лимитов прода — править `WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB` в Variables, PR не нужен: job `deploy` прокидывает их в прод-stack (app пересоздаётся с новыми лимитами), job `autotests` сверяет проверки с ними же. Без обеих Variables job'ы `deploy`/`autotests` падают на проверке — fail-closed. -- 2.56.1