dfd9a9277a
PR checks / web (pull_request) Successful in 33s
PR checks / java (pull_request) Successful in 1m6s
Main: tests, deploy, autotests / web (push) Successful in 30s
Main: tests, deploy, autotests / java (push) Successful in 1m2s
Main: tests, deploy, autotests / images-web (push) Successful in 29s
Main: tests, deploy, autotests / images-app (push) Successful in 54s
Main: tests, deploy, autotests / deploy (push) Successful in 1m29s
Main: tests, deploy, autotests / autotests (push) Successful in 37s
Main: tests, deploy, autotests / rollback (push) Has been skipped
85 lines
8.5 KiB
Markdown
85 lines
8.5 KiB
Markdown
# Настройка Gitea для CI/CD этого репо
|
||
|
||
Секреты, переменные и защиту ветки заводит **владелец репо** в Web UI — у CI-токена прав
|
||
admin нет. Workflow-файлы уже в репо; прогоны main-пайплайна без Variables/Secrets падают на
|
||
job'ах `images-app`/`images-web` (проверка `REGISTRY`/`REGISTRY_USER`/`REGISTRY_PASSWORD`), `deploy`/`autotests` с внятным сообщением, чего не хватает, — это ожидаемо. После
|
||
заполнения перезапустите упавший run («Re-run jobs» на странице run'а) или запустите
|
||
`Main: tests, deploy, autotests` вручную (Actions → Run workflow, branch `main`).
|
||
|
||
**Правило: координаты прода и креды в файлы репо не попадают** — ни в workflow'ы, ни в этот
|
||
гайд: здесь только имена Variables/Secrets, значения живут только в Gitea.
|
||
|
||
## Секреты (Settings → Actions → Secrets)
|
||
|
||
|Имя|Значение|Где взять|
|
||
|---|---|---|
|
||
|`DEPLOY_SSH_KEY`|Приватный SSH-ключ деплоя на прод (целиком, PEM)|CI-ключ `wordpdf-ci-deploy` на dev-машине; публичная половина уже добавлена в `authorized_keys` деплой-пользователя прод-сервера|
|
||
|`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`|Пароль этого пользователя|Nexus: Security → Users → `ci-deploy` (Reset password)|
|
||
|`DEPLOY_KNOWN_HOSTS`|Строка known_hosts прод-хоста (host-key pinning: job `deploy` пишет её в `~/.ssh/known_hosts` и ставит `StrictHostKeyChecking=yes`)|`ssh-keyscan -t ed25519 <IP из DEPLOY_HOST>` с любой машины, знающей хост. Завести ДО мержа: без секрета деплой падает fail-closed (ssh отваливается до передачи ключей) и штатно отрабатывает `rollback`|
|
||
|
||
## Переменные (Settings → Actions → Variables)
|
||
|
||
|Имя|Значение|
|
||
|---|---|
|
||
|`DEPLOY_HOST`|IP прод-сервера (туда Actions ходит по SSH; им же связывается LAN-порт gateway — нужен именно IP, не hostname)|
|
||
|`DEPLOY_USER`|SSH-пользователь прод-сервера с правами на podman|
|
||
|`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`)|
|
||
|`PIP_INDEX_URL`|Полный URL pypi-proxy индекса Nexus без кредов, вида `http://<host из REGISTRY>:<http-порт Nexus>/repository/pypi-proxy/simple` (репозиторий заводится по разделу «Nexus: анонимный доступ CI» ниже; HTTP-порт Nexus — не docker-коннектор `:5000`)|
|
||
|`MAVEN_MIRROR_URL`|Полный URL зеркала Nexus maven-central со слэшем на конце: `http://<host из REGISTRY>:<http-порт Nexus>/repository/maven-central/` (репозиторий `maven-central` — штатный proxy на Central из коробки Nexus 3, создавать не надо; заводка доступа — раздел «Nexus: анонимный доступ CI» ниже)|
|
||
|
||
При смене лимитов прода — править `WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB` в Variables, PR не нужен: job `deploy` прокидывает их в прод-stack (app пересоздаётся с новыми лимитами), job `autotests` сверяет проверки с ними же. Без обеих Variables job'ы `deploy`/`autotests` падают на проверке — fail-closed.
|
||
|
||
## Nexus: анонимный доступ CI (pypi-proxy + maven-central)
|
||
|
||
Заводится **до мержа** PR'ов, использующих `PIP_INDEX_URL`/`MAVEN_MIRROR_URL`: иначе
|
||
соответствующие job'ы упадут на fail-closed проверке (а `autotests` ещё и спровоцирует
|
||
`rollback`). Nexus 3 поддерживает PEP 503 (Simple Repository API) для pypi-proxy —
|
||
https://help.sonatype.com/en/pypi-repositories.html; `maven-central` (proxy на Central)
|
||
и `maven-public` (group) есть из коробки Nexus — создавать нечего.
|
||
|
||
1. Settings → Repositories → Create repository: format **PyPI**, type **Proxy**, name
|
||
**`pypi-proxy`**, Remote storage URL **`https://pypi.org/`**, blob store — тот же, что у
|
||
docker-репозиториев.
|
||
2. Read-доступ CI без новых секретов — анонимный доступ, ограниченный двумя репозиториями
|
||
(контент pypi/maven central публичный):
|
||
- Roles → Create role: name `ci-anonymous`, Role type **Simple**, memberships —
|
||
`nx-anonymous`, privileges — `nx-repository-view-pypi-pypi-proxy-read`,
|
||
`nx-repository-view-pypi-pypi-proxy-browse`,
|
||
`nx-repository-view-maven2-maven-central-read`,
|
||
`nx-repository-view-maven2-maven-central-browse`.
|
||
Если роль `pypi-anonymous` уже заведена по прежней инструкции — переименовать её
|
||
в `ci-anonymous` и добавить два maven-привилегия.
|
||
- Security → Anonymous Access: включить, **Anonymous User Role IDs = `ci-anonymous`**
|
||
(единственная роль; не `nx-anonymous` — иначе анонимы получат вид на все репозитории).
|
||
3. Проверка с любой машины LAN (порт — HTTP-коннектор Nexus, дефолт `8081`, не `:5000`):
|
||
`curl -fsS 'http://<nexus>:<порт>/repository/pypi-proxy/simple/pytest/'` — PEP 503-лист
|
||
без кредов; `curl -fsS 'http://<nexus>:<порт>/repository/maven-central/org/apache/maven/maven-core/3.9.16/maven-core-3.9.16.pom'`
|
||
— XML; docker-репозиторий анониму по-прежнему 401/403.
|
||
|
||
Затем — Variables `PIP_INDEX_URL` и `MAVEN_MIRROR_URL` (см. таблицу выше).
|
||
|
||
## Защита ветки main (блокировка мержа до зелёных проверок)
|
||
|
||
Settings → Branches → Branch Protection → Add protection:
|
||
- Branch name: `main`
|
||
- включить **Enable Status Check on Merge**
|
||
- **Status checks on merge**: `PR checks / java (pull_request), PR checks / web (pull_request)`
|
||
|
||
Контексты — фактические строки статуса, которые Gitea 1.26 публикует для job'ов Actions
|
||
(формат `<workflow> / <job> (<event>)`, проверено на первом PR-ране), а не голые имена
|
||
job'ов. `deploy`/`autotests` в список НЕ включать: на PR они не запускаются,
|
||
мерж блокировался бы навсегда.
|
||
|
||
## Ручной перезапуск проверок
|
||
|
||
- Упавший run: страница run'а → **Re-run jobs** (можно только упавшие job'ы).
|
||
- Новый прогон main-пайплайна без нового коммита: Actions → `Main: tests, deploy, autotests`
|
||
→ **Run workflow** (branch `main`) — триггер `workflow_dispatch`.
|
||
- PR-проверки без нового коммита: Actions → `PR checks` → Run workflow (branch PR-ветки).
|