Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f275260b0d | |||
| 89b5983526 |
13
.dockerignore
Normal file
13
.dockerignore
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
.git
|
||||||
|
.github
|
||||||
|
.gitea
|
||||||
|
.venv
|
||||||
|
__pycache__
|
||||||
|
*.pyc
|
||||||
|
.pytest_cache
|
||||||
|
.env
|
||||||
|
.env.*
|
||||||
|
web/node_modules
|
||||||
|
web/dist
|
||||||
|
*.md
|
||||||
|
!README.md
|
||||||
24
.gitea/workflows/ci.yml
Normal file
24
.gitea/workflows/ci.yml
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
# Forgejo / Gitea Actions — проверка перед деплоем
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Python 3.12
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
|
||||||
|
- name: Pytest
|
||||||
|
run: |
|
||||||
|
pip install -e ".[dev]"
|
||||||
|
pytest -q
|
||||||
48
.gitea/workflows/deploy.yml
Normal file
48
.gitea/workflows/deploy.yml
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
# Деплой на сервер по SSH после пуша тега v* или вручную (в т.ч. откат на старый тег).
|
||||||
|
name: Deploy
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v*"
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
ref:
|
||||||
|
description: "Git ref (тег для релиза или отката, напр. v1.5.0 или v1.4.1)"
|
||||||
|
required: true
|
||||||
|
default: "main"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Определить ревизию
|
||||||
|
id: pick
|
||||||
|
run: |
|
||||||
|
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||||
|
echo "ref=${{ inputs.ref }}" >> "$GITHUB_OUTPUT"
|
||||||
|
else
|
||||||
|
echo "ref=${{ github.ref_name }}" >> "$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: SSH — fetch, checkout, docker compose
|
||||||
|
uses: appleboy/ssh-action@v1.2.0
|
||||||
|
with:
|
||||||
|
host: ${{ secrets.DEPLOY_HOST }}
|
||||||
|
username: ${{ secrets.DEPLOY_USER }}
|
||||||
|
key: ${{ secrets.DEPLOY_SSH_KEY }}
|
||||||
|
script_stop: true
|
||||||
|
command_timeout: 20m
|
||||||
|
script: |
|
||||||
|
set -euo pipefail
|
||||||
|
cd "${{ secrets.DEPLOY_PATH }}"
|
||||||
|
git fetch origin --tags --prune
|
||||||
|
git checkout "${{ steps.pick.outputs.ref }}"
|
||||||
|
if git show-ref --verify --quiet "refs/remotes/origin/${{ steps.pick.outputs.ref }}"; then
|
||||||
|
git reset --hard "origin/${{ steps.pick.outputs.ref }}"
|
||||||
|
else
|
||||||
|
git reset --hard "${{ steps.pick.outputs.ref }}"
|
||||||
|
fi
|
||||||
|
docker compose build
|
||||||
|
docker compose up -d
|
||||||
|
docker compose ps
|
||||||
23
CHANGELOG.md
23
CHANGELOG.md
@ -2,6 +2,29 @@
|
|||||||
|
|
||||||
Формат: семантическое версионирование `MAJOR.MINOR.PATCH`. Git-теги `v1.0.0`, `v1.1.0` и т.д. — см. [docs/VERSIONING.md](docs/VERSIONING.md).
|
Формат: семантическое версионирование `MAJOR.MINOR.PATCH`. Git-теги `v1.0.0`, `v1.1.0` и т.д. — см. [docs/VERSIONING.md](docs/VERSIONING.md).
|
||||||
|
|
||||||
|
## [1.6.0] — 2026-04-03
|
||||||
|
|
||||||
|
Docker-образ, `docker-compose.yml`, CI/CD Forgejo/Gitea Actions.
|
||||||
|
|
||||||
|
### Добавлено
|
||||||
|
|
||||||
|
- **`Dockerfile`**, **`docker-compose.yml`**, **`deploy/entrypoint.sh`** — `alembic upgrade` + `uvicorn` (отключение: `SKIP_ALEMBIC=1`).
|
||||||
|
- **`.gitea/workflows/ci.yml`** — pytest на push в `main` и PR.
|
||||||
|
- **`.gitea/workflows/deploy.yml`** — деплой по пушу тега `v*` или вручную; **откат** = тот же workflow с `ref` = старый тег.
|
||||||
|
- **[docs/CICD.md](docs/CICD.md)** — секреты, подготовка `root@pvestandt9`, порядок релиза и отката.
|
||||||
|
|
||||||
|
## [1.5.0] — 2026-04-03
|
||||||
|
|
||||||
|
IRM-ядро: инциденты, задачи, эскалации, миграция БД, документация.
|
||||||
|
|
||||||
|
### Добавлено
|
||||||
|
|
||||||
|
- **Документация:** [docs/IRM.md](docs/IRM.md) — матрица функций IRM и что настраивать в Grafana.
|
||||||
|
- **Alembic `002_irm_core`:** таблицы `incidents`, `tasks`, `escalation_policies`.
|
||||||
|
- **Модули:** `incidents` (API + UI, авто-создание из `alert.received` при наличии БД), `tasks`, `escalations`.
|
||||||
|
- **`register_module_events(bus, pool)`** — подписки получают пул PostgreSQL.
|
||||||
|
- **Тесты:** `tests/test_irm_modules.py`, обновлены тесты навигации.
|
||||||
|
|
||||||
## [1.4.1] — 2026-04-03
|
## [1.4.1] — 2026-04-03
|
||||||
|
|
||||||
### Исправлено
|
### Исправлено
|
||||||
|
|||||||
20
Dockerfile
Normal file
20
Dockerfile
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
FROM python:3.12-slim-bookworm
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends libpq5 \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
COPY pyproject.toml README.md alembic.ini ./
|
||||||
|
COPY alembic ./alembic
|
||||||
|
COPY onguard24 ./onguard24
|
||||||
|
COPY deploy/entrypoint.sh /entrypoint.sh
|
||||||
|
RUN chmod +x /entrypoint.sh \
|
||||||
|
&& pip install --no-cache-dir --upgrade pip \
|
||||||
|
&& pip install --no-cache-dir .
|
||||||
|
|
||||||
|
ENV PYTHONUNBUFFERED=1
|
||||||
|
EXPOSE 8080
|
||||||
|
|
||||||
|
ENTRYPOINT ["/entrypoint.sh"]
|
||||||
16
README.md
16
README.md
@ -1,6 +1,6 @@
|
|||||||
# onGuard24
|
# onGuard24
|
||||||
|
|
||||||
**Версия: 1.4.1** · Модульный монолит на **Python (FastAPI)**: ядро, приём алертов из Grafana, заготовки модулей (дежурства, контакты, светофор), PostgreSQL, проверки Vault / Grafana / Forgejo.
|
**Версия: 1.6.0** · Модульный монолит на **Python (FastAPI)**: ядро, приём алертов из Grafana, заготовки модулей (дежурства, контакты, светофор), PostgreSQL, проверки Vault / Grafana / Forgejo.
|
||||||
|
|
||||||
| Документ | Назначение |
|
| Документ | Назначение |
|
||||||
|----------|------------|
|
|----------|------------|
|
||||||
@ -10,6 +10,8 @@
|
|||||||
| [docs/AI_CONTEXT.md](docs/AI_CONTEXT.md) | Краткий контекст для доработок |
|
| [docs/AI_CONTEXT.md](docs/AI_CONTEXT.md) | Краткий контекст для доработок |
|
||||||
| [docs/DOMAIN.md](docs/DOMAIN.md) | Сущности (инцидент, алерт, эскалация), шина событий |
|
| [docs/DOMAIN.md](docs/DOMAIN.md) | Сущности (инцидент, алерт, эскалация), шина событий |
|
||||||
| [docs/MODULES.md](docs/MODULES.md) | Как добавлять модули и подписки на события |
|
| [docs/MODULES.md](docs/MODULES.md) | Как добавлять модули и подписки на события |
|
||||||
|
| [docs/IRM.md](docs/IRM.md) | Функционал IRM: что делаем, что в Grafana |
|
||||||
|
| [docs/CICD.md](docs/CICD.md) | Forgejo Actions: деплой на сервер, откат по тегу |
|
||||||
|
|
||||||
**Репозиторий:** [forgejo.pvenode.ru/admin/onGuard24](https://forgejo.pvenode.ru/admin/onGuard24)
|
**Репозиторий:** [forgejo.pvenode.ru/admin/onGuard24](https://forgejo.pvenode.ru/admin/onGuard24)
|
||||||
|
|
||||||
@ -21,7 +23,7 @@
|
|||||||
- **PostgreSQL:** пул asyncpg, таблица `ingress_events` для сырых тел webhook Grafana; схема через **Alembic** (отдельные ревизии в `alembic/versions/`).
|
- **PostgreSQL:** пул asyncpg, таблица `ingress_events` для сырых тел webhook Grafana; схема через **Alembic** (отдельные ревизии в `alembic/versions/`).
|
||||||
- **POST `/api/v1/ingress/grafana`** — приём JSON алерта (опционально защита `X-OnGuard-Secret`).
|
- **POST `/api/v1/ingress/grafana`** — приём JSON алерта (опционально защита `X-OnGuard-Secret`).
|
||||||
- **GET `/`**, **GET `/api/v1/status`** — проверки: БД, Vault, Grafana (service account), Forgejo (PAT).
|
- **GET `/`**, **GET `/api/v1/status`** — проверки: БД, Vault, Grafana (service account), Forgejo (PAT).
|
||||||
- **Модули (API + веб-UI):** JSON под `/api/v1/modules/...`, полные HTML-страницы под `/ui/modules/<slug>/`, превью на главной `/` (см. [docs/MODULES.md](docs/MODULES.md)).
|
- **Модули (API + веб-UI):** IRM — **инциденты**, **задачи**, **эскалации**, дежурства, контакты, светофор; JSON под `/api/v1/modules/...`, UI под `/ui/modules/<slug>/` (см. [docs/MODULES.md](docs/MODULES.md), [docs/IRM.md](docs/IRM.md)).
|
||||||
- **Фронт (опционально):** `web/` — Vite + React, прокси на API.
|
- **Фронт (опционально):** `web/` — Vite + React, прокси на API.
|
||||||
|
|
||||||
Чего **ещё нет** (следующие версии): авторизация публичных API (кроме секрета webhook), полноценная бизнес-логика IRM в коде (эскалации, дежурства, светофор), фоновые задачи. Доменные сущности и задел под модули описаны в [docs/DOMAIN.md](docs/DOMAIN.md).
|
Чего **ещё нет** (следующие версии): авторизация публичных API (кроме секрета webhook), полноценная бизнес-логика IRM в коде (эскалации, дежурства, светофор), фоновые задачи. Доменные сущности и задел под модули описаны в [docs/DOMAIN.md](docs/DOMAIN.md).
|
||||||
@ -35,7 +37,7 @@ source .venv/bin/activate # Windows: .venv\Scripts\activate
|
|||||||
pip install -e .
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
Скопируй `.env.example` в `.env` и заполни секреты (см. ниже). Перед первым запуском с БД примените миграции:
|
Скопируй `.env.example` в `.env` и заполни секреты (см. ниже). Перед первым запуском с БД примените миграции (в т.ч. таблицы IRM: `incidents`, `tasks`, `escalation_policies`):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
alembic upgrade head
|
alembic upgrade head
|
||||||
@ -96,3 +98,11 @@ pytest
|
|||||||
```
|
```
|
||||||
|
|
||||||
Покрытие: `/health`, `/api/v1/status`, webhook Grafana; внешние вызовы (Vault, Grafana, Forgejo) в тестах статуса подменяются моками.
|
Покрытие: `/health`, `/api/v1/status`, webhook Grafana; внешние вызовы (Vault, Grafana, Forgejo) в тестах статуса подменяются моками.
|
||||||
|
|
||||||
|
## Docker и CI/CD
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose build && docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
Деплой через **Forgejo Actions** (тег `v*`, SSH на сервер): см. [docs/CICD.md](docs/CICD.md). **Откат:** вручную запустить workflow **Deploy** с полем `ref` = нужный старый тег.
|
||||||
|
|||||||
72
alembic/versions/002_irm_core_tables.py
Normal file
72
alembic/versions/002_irm_core_tables.py
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
"""irm core: incidents, tasks, escalation_policies
|
||||||
|
|
||||||
|
Revision ID: 002_irm_core
|
||||||
|
Revises: 001_initial
|
||||||
|
Create Date: 2026-04-03
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from typing import Sequence, Union
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
revision: str = "002_irm_core"
|
||||||
|
down_revision: Union[str, None] = "001_initial"
|
||||||
|
branch_labels: Union[str, Sequence[str], None] = None
|
||||||
|
depends_on: Union[str, Sequence[str], None] = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
op.execute(
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS incidents (
|
||||||
|
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
title text NOT NULL,
|
||||||
|
status text NOT NULL DEFAULT 'open',
|
||||||
|
severity text NOT NULL DEFAULT 'warning',
|
||||||
|
source text NOT NULL DEFAULT 'grafana',
|
||||||
|
ingress_event_id uuid REFERENCES ingress_events (id) ON DELETE SET NULL,
|
||||||
|
created_at timestamptz NOT NULL DEFAULT now(),
|
||||||
|
updated_at timestamptz NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
op.execute(
|
||||||
|
"""
|
||||||
|
CREATE INDEX IF NOT EXISTS incidents_created_at_idx
|
||||||
|
ON incidents (created_at DESC);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
op.execute(
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS tasks (
|
||||||
|
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
incident_id uuid REFERENCES incidents (id) ON DELETE CASCADE,
|
||||||
|
title text NOT NULL,
|
||||||
|
status text NOT NULL DEFAULT 'open',
|
||||||
|
created_at timestamptz NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
op.execute(
|
||||||
|
"""
|
||||||
|
CREATE INDEX IF NOT EXISTS tasks_incident_id_idx ON tasks (incident_id);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
op.execute(
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS escalation_policies (
|
||||||
|
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
name text NOT NULL,
|
||||||
|
enabled boolean NOT NULL DEFAULT true,
|
||||||
|
steps jsonb NOT NULL DEFAULT '[]'::jsonb,
|
||||||
|
created_at timestamptz NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
op.execute("DROP TABLE IF EXISTS tasks;")
|
||||||
|
op.execute("DROP TABLE IF EXISTS incidents;")
|
||||||
|
op.execute("DROP TABLE IF EXISTS escalation_policies;")
|
||||||
7
deploy/entrypoint.sh
Normal file
7
deploy/entrypoint.sh
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
set -e
|
||||||
|
cd /app
|
||||||
|
if [ -n "${DATABASE_URL:-}" ] && [ "${SKIP_ALEMBIC:-0}" != "1" ]; then
|
||||||
|
alembic upgrade head
|
||||||
|
fi
|
||||||
|
exec uvicorn onguard24.main:app --host 0.0.0.0 --port "${PORT:-8080}"
|
||||||
21
docker-compose.yml
Normal file
21
docker-compose.yml
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# Прод: на сервере рядом с репозиторием лежит .env (не в git).
|
||||||
|
# Сборка: docker compose build && docker compose up -d
|
||||||
|
services:
|
||||||
|
onguard24:
|
||||||
|
build: .
|
||||||
|
image: onguard24:latest
|
||||||
|
container_name: onguard24
|
||||||
|
restart: unless-stopped
|
||||||
|
env_file:
|
||||||
|
- .env
|
||||||
|
ports:
|
||||||
|
- "${ONGUARD_HTTP_PORT:-8080}:8080"
|
||||||
|
environment:
|
||||||
|
SKIP_ALEMBIC: ${SKIP_ALEMBIC:-0}
|
||||||
|
PORT: "8080"
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://127.0.0.1:8080/health')"]
|
||||||
|
interval: 30s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 3
|
||||||
|
start_period: 15s
|
||||||
@ -20,11 +20,15 @@ onGuard24/
|
|||||||
│ ├── integrations/
|
│ ├── integrations/
|
||||||
│ │ ├── grafana_api.py # Grafana HTTP API (Bearer SA)
|
│ │ ├── grafana_api.py # Grafana HTTP API (Bearer SA)
|
||||||
│ │ └── forgejo_api.py # Forgejo/Gitea API (token + probe/fallback)
|
│ │ └── forgejo_api.py # Forgejo/Gitea API (token + probe/fallback)
|
||||||
│ └── modules/ # API + ui_router + registry + ui_support (фрагменты главной)
|
│ └── modules/ # IRM: incidents, tasks, escalations, … + registry + ui_support
|
||||||
├── web/ # Vite + React (опционально)
|
├── web/ # Vite + React (опционально)
|
||||||
|
├── Dockerfile
|
||||||
|
├── docker-compose.yml
|
||||||
|
├── deploy/entrypoint.sh
|
||||||
├── pyproject.toml
|
├── pyproject.toml
|
||||||
├── pytest.ini
|
├── pytest.ini
|
||||||
├── tests/ # pytest: health, status, ingress
|
├── tests/ # pytest: health, status, ingress
|
||||||
|
├── .gitea/workflows/ # CI + SSH deploy (Forgejo Actions)
|
||||||
├── CHANGELOG.md
|
├── CHANGELOG.md
|
||||||
└── docs/
|
└── docs/
|
||||||
```
|
```
|
||||||
|
|||||||
85
docs/CICD.md
Normal file
85
docs/CICD.md
Normal file
@ -0,0 +1,85 @@
|
|||||||
|
# CI/CD (Forgejo / Gitea) и деплой на `pvestandt9`
|
||||||
|
|
||||||
|
Цель: **пуш тега `v*`** → автоматический деплой на сервер; **откат** — повторный запуск workflow с другим тегом.
|
||||||
|
|
||||||
|
## Что в репозитории
|
||||||
|
|
||||||
|
| Файл | Назначение |
|
||||||
|
|------|------------|
|
||||||
|
| `.gitea/workflows/ci.yml` | На `push` в `main` и PR: `pytest`. |
|
||||||
|
| `.gitea/workflows/deploy.yml` | На `push` тега `v*`: SSH на сервер → `git checkout` → `docker compose build/up`. |
|
||||||
|
| `Dockerfile` | Образ Python 3.12, `pip install .`, entrypoint: `alembic upgrade` + `uvicorn`. |
|
||||||
|
| `docker-compose.yml` | Сервис `onguard24`, порт `8080`, `env_file: .env`. |
|
||||||
|
| `deploy/entrypoint.sh` | Перед стартом: `alembic upgrade head` (отключить: `SKIP_ALEMBIC=1` в `.env`). |
|
||||||
|
|
||||||
|
## Включить Actions в Forgejo
|
||||||
|
|
||||||
|
1. Админка инстанса или репозитория: включить **Actions**.
|
||||||
|
2. Зарегистрировать **runner** с меткой `ubuntu-latest` (или изменить `runs-on` в YAML на вашу метку, например `self-hosted`).
|
||||||
|
3. Если образы `actions/checkout` недоступны, в настройках Actions задайте зеркало GitHub или используйте встроенные экшены Forgejo (см. документацию вашей версии).
|
||||||
|
|
||||||
|
## Секреты репозитория
|
||||||
|
|
||||||
|
**Настройки репозитория → Actions → Secrets:**
|
||||||
|
|
||||||
|
| Секрет | Пример | Описание |
|
||||||
|
|--------|--------|----------|
|
||||||
|
| `DEPLOY_HOST` | `pvestandt9` или IP | Хост SSH. |
|
||||||
|
| `DEPLOY_USER` | `root` | Пользователь SSH. |
|
||||||
|
| `DEPLOY_SSH_KEY` | содержимое `id_rsa` | Приватный ключ (весь PEM, многострочный). |
|
||||||
|
| `DEPLOY_PATH` | `/opt/onGuard24` | Каталог **клона git** на сервере (там же `docker-compose.yml`). |
|
||||||
|
|
||||||
|
Ключ лучше отдельный **deploy key** только на чтение репозитория или полный доступ, если runner делает только `git fetch`.
|
||||||
|
|
||||||
|
## Однократная подготовка сервера (`root@pvestandt9`)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ssh root@pvestandt9
|
||||||
|
apt-get update && apt-get install -y git docker.io docker-compose-v2
|
||||||
|
# или Docker CE по инструкции вашей ОС
|
||||||
|
|
||||||
|
mkdir -p /opt/onGuard24
|
||||||
|
cd /opt
|
||||||
|
git clone https://forgejo.pvenode.ru/admin/onGuard24.git onGuard24
|
||||||
|
cd onGuard24
|
||||||
|
```
|
||||||
|
|
||||||
|
Создайте **`/opt/onGuard24/.env`** (как в `.env.example`): `DATABASE_URL`, `HTTP_ADDR` (в контейнере порт задаёт compose; для приложения можно `0.0.0.0:8080`), секреты Grafana и т.д.
|
||||||
|
|
||||||
|
Настройте **`git remote`** и доступ (`~/.ssh` deploy key или `git credential`), чтобы **`git fetch` без пароля** работал от пользователя, под которым заходит CI (часто `root`).
|
||||||
|
|
||||||
|
Проверка вручную:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /opt/onGuard24
|
||||||
|
docker compose build && docker compose up -d
|
||||||
|
curl -s http://127.0.0.1:8080/health
|
||||||
|
```
|
||||||
|
|
||||||
|
При необходимости пробросьте порт наружу (nginx, firewall).
|
||||||
|
|
||||||
|
## Релиз (деплой новой версии)
|
||||||
|
|
||||||
|
1. Закоммитить код, запушить тег: `git tag v1.6.0 && git push origin v1.6.0`.
|
||||||
|
2. Workflow **Deploy** запустится сам, на сервере обновится код и пересоберётся контейнер.
|
||||||
|
|
||||||
|
## Откат версии (простой процесс)
|
||||||
|
|
||||||
|
1. В Forgejo: **Actions → Deploy → Run workflow**.
|
||||||
|
2. В поле **ref** указать **старый тег**, например `v1.4.1`.
|
||||||
|
3. Запустить. На сервере выполнится `checkout` и `reset` на этот ref, затем `docker compose build && up -d`.
|
||||||
|
|
||||||
|
Убедитесь, что старый тег есть в `origin` (`git push --tags` не удалялся).
|
||||||
|
|
||||||
|
## Миграции БД
|
||||||
|
|
||||||
|
По умолчанию при каждом старте контейнера выполняется **`alembic upgrade head`**. Если нужно отключить (и гонять миграции вручную), в `.env` на сервере: `SKIP_ALEMBIC=1`.
|
||||||
|
|
||||||
|
## Устранение неполадок
|
||||||
|
|
||||||
|
- **Runner не берёт job** — проверьте `runs-on` и метки runner.
|
||||||
|
- **SSH fails** — `ssh -i key root@DEPLOY_HOST` с машины runner; `known_hosts` при необходимости добавьте в экшен (расширение `appleboy/ssh-action` / `ssh-keyscan`).
|
||||||
|
- **`git checkout` fails** — выполните на сервере `git fetch --tags` вручную, проверьте remote URL и ключ.
|
||||||
|
- **База недоступна из контейнера** — в `DATABASE_URL` укажите хост, доступный **из Docker** (не `127.0.0.1` хоста, если БД на хосте — используйте IP хоста или `host.docker.internal` где поддерживается).
|
||||||
|
|
||||||
|
См. также [VERSIONING.md](VERSIONING.md) и [IRM.md](IRM.md).
|
||||||
32
docs/IRM.md
Normal file
32
docs/IRM.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# IRM: функционал, назначение и реализация в onGuard24
|
||||||
|
|
||||||
|
Краткий ориентир для разработки (аналог облачного IRM: инциденты, задачи, эскалации, дежурства).
|
||||||
|
|
||||||
|
## Матрица: что это, зачем, как у нас, что в Grafana
|
||||||
|
|
||||||
|
| Область | Назначение | onGuard24 | Grafana / внешнее |
|
||||||
|
|---------|------------|-----------|-------------------|
|
||||||
|
| **Инциденты** | Учёт сбоев, статусы (open → resolved), связь с алертом | Модуль `incidents`: таблица `incidents`, API, UI, авто-создание из `alert.received` | Contact point **Webhook** → `POST /api/v1/ingress/grafana`; правила алертинга в Grafana |
|
||||||
|
| **Задачи** | Подзадачи по инциденту (разбор, фикс) | Модуль `tasks`: таблица `tasks`, привязка к `incident_id` | Опционально: ссылки из алерта; основная работа в onGuard24 |
|
||||||
|
| **Цепочки эскалаций** | Кого звать и в каком порядке при таймаутах | Модуль `escalations`: таблица `escalation_policies` (JSON `steps`), API/UI заготовка | Маршрутизация уведомлений может дублироваться в Grafana contact points; целевая логика — в onGuard24 |
|
||||||
|
| **Календарь дежурств** | Кто в смене, расписание | Модуль `schedules` (развитие) | Календари/команды — данные в onGuard24; уведомления — через интеграции |
|
||||||
|
| **Контакты** | Люди, каналы | Модуль `contacts` | Получатели в **Contact points** (email, Slack, webhook) |
|
||||||
|
| **Светофор / статус сервисов** | Агрегат здоровья | Модуль `statusboard` | Источник метрик — Prometheus/Loki; правила — Grafana |
|
||||||
|
| **Группы алертов** | Группировка шумных алертов | *План:* отдельная сущность / правила | **Alertmanager** / группировка в Grafana Alerting |
|
||||||
|
| **Интеграции** | Внешние системы | `integrations/`, статус в `/api/v1/status` | API-ключи Grafana, Vault, Forgejo в `.env` |
|
||||||
|
| **Пользователи / права** | RBAC | *Пока нет* | SSO Grafana, сеть за reverse proxy |
|
||||||
|
| **SLO** | Цели по доступности | *Вне скоупа v1* | Grafana SLO / Mimir |
|
||||||
|
|
||||||
|
## Поток данных (алерт → инцидент)
|
||||||
|
|
||||||
|
1. Grafana срабатывает правило → шлёт JSON на **webhook** onGuard24.
|
||||||
|
2. Сервис пишет строку в `ingress_events`, публикует **`alert.received`**.
|
||||||
|
3. Модуль **incidents** подписан на событие и создаёт запись в **`incidents`** с ссылкой на `ingress_event_id`.
|
||||||
|
|
||||||
|
## Что настроить в Grafana (обязательно для приёма алертов)
|
||||||
|
|
||||||
|
1. **Alerting → Contact points → New** — тип **Webhook**, URL: `https://<ваш-хост>/api/v1/ingress/grafana`, метод POST, Optional HTTP headers если задан `GRAFANA_WEBHOOK_SECRET`: `X-OnGuard-Secret: <секрет>`.
|
||||||
|
2. **Notification policies** — направить нужные правила на этот contact point (или default policy).
|
||||||
|
3. Убедиться, что сеть до onGuard24 доступна (firewall, TLS).
|
||||||
|
|
||||||
|
Подробнее: [MODULES.md](MODULES.md), [DOMAIN.md](DOMAIN.md).
|
||||||
@ -33,7 +33,7 @@
|
|||||||
- `router` — JSON API под `/api/v1/modules/<имя>/`.
|
- `router` — JSON API под `/api/v1/modules/<имя>/`.
|
||||||
- Опционально **`ui_router`** — `APIRouter(include_in_schema=False)`, маршруты полных HTML-страниц (корень `/` → `/ui/modules/<slug>/`).
|
- Опционально **`ui_router`** — `APIRouter(include_in_schema=False)`, маршруты полных HTML-страниц (корень `/` → `/ui/modules/<slug>/`).
|
||||||
- Опционально **`async def render_home_fragment(request) -> str`** — HTML-фрагмент (без `<html>`) для карточки на главной.
|
- Опционально **`async def render_home_fragment(request) -> str`** — HTML-фрагмент (без `<html>`) для карточки на главной.
|
||||||
- **`register_events(_bus)`** — подписки на шину.
|
- **`register_events(bus, pool)`** — подписки на шину; при необходимости используйте **`pool`** для записи в БД из обработчика события.
|
||||||
|
|
||||||
2. **Регистрация** в **`onguard24/modules/registry.py`** — объект **`ModuleMount`**:
|
2. **Регистрация** в **`onguard24/modules/registry.py`** — объект **`ModuleMount`**:
|
||||||
- `router`, `url_prefix`, `register_events`, **`slug`**, **`title`**, опционально **`ui_router`**, **`render_home_fragment`**.
|
- `router`, `url_prefix`, `register_events`, **`slug`**, **`title`**, опционально **`ui_router`**, **`render_home_fragment`**.
|
||||||
|
|||||||
@ -1,3 +1,3 @@
|
|||||||
"""onGuard24 — модульный монолит (ядро + модули)."""
|
"""onGuard24 — модульный монолит (ядро + модули)."""
|
||||||
|
|
||||||
__version__ = "1.4.1"
|
__version__ = "1.6.0"
|
||||||
|
|||||||
9
onguard24/deps.py
Normal file
9
onguard24/deps.py
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
"""Общие зависимости FastAPI."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from fastapi import Request
|
||||||
|
|
||||||
|
|
||||||
|
def get_pool(request: Request):
|
||||||
|
return getattr(request.app.state, "pool", None)
|
||||||
@ -34,7 +34,7 @@ async def lifespan(app: FastAPI):
|
|||||||
settings = get_settings()
|
settings = get_settings()
|
||||||
pool = await create_pool(settings)
|
pool = await create_pool(settings)
|
||||||
bus = InMemoryEventBus()
|
bus = InMemoryEventBus()
|
||||||
register_module_events(bus)
|
register_module_events(bus, pool)
|
||||||
app.state.pool = pool
|
app.state.pool = pool
|
||||||
app.state.settings = settings
|
app.state.settings = settings
|
||||||
app.state.event_bus = bus
|
app.state.event_bus = bus
|
||||||
|
|||||||
@ -9,7 +9,7 @@ router = APIRouter(tags=["module-contacts"])
|
|||||||
ui_router = APIRouter(tags=["web-contacts"], include_in_schema=False)
|
ui_router = APIRouter(tags=["web-contacts"], include_in_schema=False)
|
||||||
|
|
||||||
|
|
||||||
def register_events(_bus: EventBus) -> None:
|
def register_events(_bus: EventBus, _pool=None) -> None:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
153
onguard24/modules/escalations.py
Normal file
153
onguard24/modules/escalations.py
Normal file
@ -0,0 +1,153 @@
|
|||||||
|
"""IRM: цепочки эскалаций (политики в JSON, дальше — исполнение по шагам)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import html
|
||||||
|
import json
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
|
import asyncpg
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException, Request
|
||||||
|
from fastapi.responses import HTMLResponse
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
from onguard24.deps import get_pool
|
||||||
|
from onguard24.domain.events import EventBus
|
||||||
|
from onguard24.modules.ui_support import wrap_module_html_page
|
||||||
|
|
||||||
|
router = APIRouter(tags=["module-escalations"])
|
||||||
|
ui_router = APIRouter(tags=["web-escalations"], include_in_schema=False)
|
||||||
|
|
||||||
|
|
||||||
|
class PolicyCreate(BaseModel):
|
||||||
|
name: str = Field(..., min_length=1, max_length=200)
|
||||||
|
enabled: bool = True
|
||||||
|
steps: list[dict] = Field(default_factory=list)
|
||||||
|
|
||||||
|
|
||||||
|
def register_events(_bus: EventBus, _pool: asyncpg.Pool | None = None) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
async def render_home_fragment(request: Request) -> str:
|
||||||
|
pool = get_pool(request)
|
||||||
|
if pool is None:
|
||||||
|
return '<p class="module-note">Нужна БД для политик эскалации.</p>'
|
||||||
|
try:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
n = await conn.fetchval("SELECT count(*)::int FROM escalation_policies WHERE enabled = true")
|
||||||
|
except Exception:
|
||||||
|
return '<p class="module-note">Таблица политик недоступна (миграции?).</p>'
|
||||||
|
return f'<div class="module-fragment"><p>Активных политик: <strong>{int(n)}</strong></p></div>'
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/")
|
||||||
|
async def list_policies_api(pool: asyncpg.Pool | None = Depends(get_pool)):
|
||||||
|
if pool is None:
|
||||||
|
return {"items": [], "database": "disabled"}
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
rows = await conn.fetch(
|
||||||
|
"""
|
||||||
|
SELECT id, name, enabled, steps, created_at
|
||||||
|
FROM escalation_policies
|
||||||
|
ORDER BY name
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
items = []
|
||||||
|
for r in rows:
|
||||||
|
steps = r["steps"]
|
||||||
|
if isinstance(steps, str):
|
||||||
|
steps = json.loads(steps)
|
||||||
|
items.append(
|
||||||
|
{
|
||||||
|
"id": str(r["id"]),
|
||||||
|
"name": r["name"],
|
||||||
|
"enabled": r["enabled"],
|
||||||
|
"steps": steps if isinstance(steps, list) else [],
|
||||||
|
"created_at": r["created_at"].isoformat() if r["created_at"] else None,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return {"items": items}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/", status_code=201)
|
||||||
|
async def create_policy_api(body: PolicyCreate, pool: asyncpg.Pool | None = Depends(get_pool)):
|
||||||
|
if pool is None:
|
||||||
|
raise HTTPException(status_code=503, detail="database disabled")
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
row = await conn.fetchrow(
|
||||||
|
"""
|
||||||
|
INSERT INTO escalation_policies (name, enabled, steps)
|
||||||
|
VALUES ($1, $2, $3::jsonb)
|
||||||
|
RETURNING id, name, enabled, steps, created_at
|
||||||
|
""",
|
||||||
|
body.name.strip(),
|
||||||
|
body.enabled,
|
||||||
|
json.dumps(body.steps),
|
||||||
|
)
|
||||||
|
steps = row["steps"]
|
||||||
|
return {
|
||||||
|
"id": str(row["id"]),
|
||||||
|
"name": row["name"],
|
||||||
|
"enabled": row["enabled"],
|
||||||
|
"steps": list(steps) if steps else [],
|
||||||
|
"created_at": row["created_at"].isoformat() if row["created_at"] else None,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/{policy_id}", status_code=204)
|
||||||
|
async def delete_policy_api(policy_id: UUID, pool: asyncpg.Pool | None = Depends(get_pool)):
|
||||||
|
if pool is None:
|
||||||
|
raise HTTPException(status_code=503, detail="database disabled")
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
row = await conn.fetchrow(
|
||||||
|
"DELETE FROM escalation_policies WHERE id = $1::uuid RETURNING id",
|
||||||
|
policy_id,
|
||||||
|
)
|
||||||
|
if row is None:
|
||||||
|
raise HTTPException(status_code=404, detail="not found")
|
||||||
|
|
||||||
|
|
||||||
|
@ui_router.get("/", response_class=HTMLResponse)
|
||||||
|
async def escalations_ui_home(request: Request):
|
||||||
|
pool = get_pool(request)
|
||||||
|
rows_html = ""
|
||||||
|
err = ""
|
||||||
|
if pool is None:
|
||||||
|
err = "<p>База данных не настроена.</p>"
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
rows = await conn.fetch(
|
||||||
|
"SELECT id, name, enabled, steps FROM escalation_policies ORDER BY name"
|
||||||
|
)
|
||||||
|
for r in rows:
|
||||||
|
steps = r["steps"]
|
||||||
|
if hasattr(steps, "__iter__") and not isinstance(steps, (str, bytes)):
|
||||||
|
steps_preview = html.escape(json.dumps(steps, ensure_ascii=False)[:120])
|
||||||
|
else:
|
||||||
|
steps_preview = "—"
|
||||||
|
rows_html += (
|
||||||
|
"<tr>"
|
||||||
|
f"<td>{html.escape(str(r['id']))[:8]}…</td>"
|
||||||
|
f"<td>{html.escape(r['name'])}</td>"
|
||||||
|
f"<td>{'да' if r['enabled'] else 'нет'}</td>"
|
||||||
|
f"<td><code>{steps_preview}</code></td>"
|
||||||
|
"</tr>"
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
err = f"<p class=\"module-err\">{html.escape(str(e))}</p>"
|
||||||
|
inner = f"""<h1>Цепочки эскалаций</h1>
|
||||||
|
<p>Заготовка: шаги хранятся в JSON; исполнение по таймерам — следующие версии.</p>
|
||||||
|
{err}
|
||||||
|
<table class="irm-table">
|
||||||
|
<thead><tr><th>ID</th><th>Имя</th><th>Вкл.</th><th>Шаги (фрагмент)</th></tr></thead>
|
||||||
|
<tbody>{rows_html or '<tr><td colspan="4">Нет политик — создайте через API POST</td></tr>'}</tbody>
|
||||||
|
</table>"""
|
||||||
|
return HTMLResponse(
|
||||||
|
wrap_module_html_page(
|
||||||
|
document_title="Эскалации — onGuard24",
|
||||||
|
current_slug="escalations",
|
||||||
|
main_inner_html=inner,
|
||||||
|
)
|
||||||
|
)
|
||||||
200
onguard24/modules/incidents.py
Normal file
200
onguard24/modules/incidents.py
Normal file
@ -0,0 +1,200 @@
|
|||||||
|
"""IRM: инциденты — учёт сбоев, связь с сырым ingress и событием alert.received."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import html
|
||||||
|
import logging
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
|
import asyncpg
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException, Request
|
||||||
|
from fastapi.responses import HTMLResponse
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
from onguard24.deps import get_pool
|
||||||
|
from onguard24.domain.events import AlertReceived, DomainEvent, EventBus
|
||||||
|
from onguard24.modules.ui_support import wrap_module_html_page
|
||||||
|
|
||||||
|
log = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
router = APIRouter(tags=["module-incidents"])
|
||||||
|
ui_router = APIRouter(tags=["web-incidents"], include_in_schema=False)
|
||||||
|
|
||||||
|
|
||||||
|
class IncidentCreate(BaseModel):
|
||||||
|
title: str = Field(..., min_length=1, max_length=500)
|
||||||
|
status: str = Field(default="open", max_length=64)
|
||||||
|
severity: str = Field(default="warning", max_length=32)
|
||||||
|
|
||||||
|
|
||||||
|
def register_events(bus: EventBus, pool: asyncpg.Pool | None = None) -> None:
|
||||||
|
if pool is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
async def on_alert(ev: DomainEvent) -> None:
|
||||||
|
if not isinstance(ev, AlertReceived) or ev.raw_payload_ref is None:
|
||||||
|
return
|
||||||
|
a = ev.alert
|
||||||
|
title = (a.title if a else "Алерт без названия")[:500]
|
||||||
|
sev = (a.severity.value if a else "warning")
|
||||||
|
try:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
await conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO incidents (title, status, severity, source, ingress_event_id)
|
||||||
|
VALUES ($1, 'open', $2, 'grafana', $3::uuid)
|
||||||
|
""",
|
||||||
|
title,
|
||||||
|
sev,
|
||||||
|
ev.raw_payload_ref,
|
||||||
|
)
|
||||||
|
except Exception:
|
||||||
|
log.exception("incidents: не удалось создать инцидент из alert.received")
|
||||||
|
|
||||||
|
bus.subscribe("alert.received", on_alert)
|
||||||
|
|
||||||
|
|
||||||
|
async def render_home_fragment(request: Request) -> str:
|
||||||
|
pool = get_pool(request)
|
||||||
|
if pool is None:
|
||||||
|
return '<p class="module-note">Нужна БД для списка инцидентов.</p>'
|
||||||
|
try:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
n = await conn.fetchval("SELECT count(*)::int FROM incidents")
|
||||||
|
except Exception:
|
||||||
|
return '<p class="module-note">Таблица инцидентов недоступна (миграции?).</p>'
|
||||||
|
return f'<div class="module-fragment"><p>Инцидентов в учёте: <strong>{int(n)}</strong></p></div>'
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/")
|
||||||
|
async def list_incidents_api(
|
||||||
|
pool: asyncpg.Pool | None = Depends(get_pool),
|
||||||
|
limit: int = 50,
|
||||||
|
):
|
||||||
|
if pool is None:
|
||||||
|
return {"items": [], "database": "disabled"}
|
||||||
|
limit = min(max(limit, 1), 200)
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
rows = await conn.fetch(
|
||||||
|
"""
|
||||||
|
SELECT id, title, status, severity, source, ingress_event_id, created_at
|
||||||
|
FROM incidents
|
||||||
|
ORDER BY created_at DESC
|
||||||
|
LIMIT $1
|
||||||
|
""",
|
||||||
|
limit,
|
||||||
|
)
|
||||||
|
items = []
|
||||||
|
for r in rows:
|
||||||
|
items.append(
|
||||||
|
{
|
||||||
|
"id": str(r["id"]),
|
||||||
|
"title": r["title"],
|
||||||
|
"status": r["status"],
|
||||||
|
"severity": r["severity"],
|
||||||
|
"source": r["source"],
|
||||||
|
"ingress_event_id": str(r["ingress_event_id"]) if r["ingress_event_id"] else None,
|
||||||
|
"created_at": r["created_at"].isoformat() if r["created_at"] else None,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return {"items": items}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/", status_code=201)
|
||||||
|
async def create_incident_api(
|
||||||
|
body: IncidentCreate,
|
||||||
|
pool: asyncpg.Pool | None = Depends(get_pool),
|
||||||
|
):
|
||||||
|
if pool is None:
|
||||||
|
raise HTTPException(status_code=503, detail="database disabled")
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
row = await conn.fetchrow(
|
||||||
|
"""
|
||||||
|
INSERT INTO incidents (title, status, severity, source)
|
||||||
|
VALUES ($1, $2, $3, 'manual')
|
||||||
|
RETURNING id, title, status, severity, source, ingress_event_id, created_at
|
||||||
|
""",
|
||||||
|
body.title.strip(),
|
||||||
|
body.status,
|
||||||
|
body.severity,
|
||||||
|
)
|
||||||
|
return {
|
||||||
|
"id": str(row["id"]),
|
||||||
|
"title": row["title"],
|
||||||
|
"status": row["status"],
|
||||||
|
"severity": row["severity"],
|
||||||
|
"source": row["source"],
|
||||||
|
"ingress_event_id": None,
|
||||||
|
"created_at": row["created_at"].isoformat() if row["created_at"] else None,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{incident_id}")
|
||||||
|
async def get_incident_api(incident_id: UUID, pool: asyncpg.Pool | None = Depends(get_pool)):
|
||||||
|
if pool is None:
|
||||||
|
raise HTTPException(status_code=503, detail="database disabled")
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
row = await conn.fetchrow(
|
||||||
|
"""
|
||||||
|
SELECT id, title, status, severity, source, ingress_event_id, created_at
|
||||||
|
FROM incidents WHERE id = $1::uuid
|
||||||
|
""",
|
||||||
|
incident_id,
|
||||||
|
)
|
||||||
|
if not row:
|
||||||
|
raise HTTPException(status_code=404, detail="not found")
|
||||||
|
return {
|
||||||
|
"id": str(row["id"]),
|
||||||
|
"title": row["title"],
|
||||||
|
"status": row["status"],
|
||||||
|
"severity": row["severity"],
|
||||||
|
"source": row["source"],
|
||||||
|
"ingress_event_id": str(row["ingress_event_id"]) if row["ingress_event_id"] else None,
|
||||||
|
"created_at": row["created_at"].isoformat() if row["created_at"] else None,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ui_router.get("/", response_class=HTMLResponse)
|
||||||
|
async def incidents_ui_home(request: Request):
|
||||||
|
pool = get_pool(request)
|
||||||
|
rows_html = ""
|
||||||
|
err = ""
|
||||||
|
if pool is None:
|
||||||
|
err = "<p>База данных не настроена.</p>"
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
rows = await conn.fetch(
|
||||||
|
"""
|
||||||
|
SELECT id, title, status, severity, source, created_at
|
||||||
|
FROM incidents
|
||||||
|
ORDER BY created_at DESC
|
||||||
|
LIMIT 100
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
for r in rows:
|
||||||
|
rows_html += (
|
||||||
|
"<tr>"
|
||||||
|
f"<td>{html.escape(str(r['id']))[:8]}…</td>"
|
||||||
|
f"<td>{html.escape(r['title'])}</td>"
|
||||||
|
f"<td>{html.escape(r['status'])}</td>"
|
||||||
|
f"<td>{html.escape(r['severity'])}</td>"
|
||||||
|
f"<td>{html.escape(r['source'])}</td>"
|
||||||
|
"</tr>"
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
err = f"<p class=\"module-err\">{html.escape(str(e))}</p>"
|
||||||
|
inner = f"""<h1>Инциденты</h1>
|
||||||
|
{err}
|
||||||
|
<table class="irm-table">
|
||||||
|
<thead><tr><th>ID</th><th>Заголовок</th><th>Статус</th><th>Важность</th><th>Источник</th></tr></thead>
|
||||||
|
<tbody>{rows_html or '<tr><td colspan="5">Пока нет записей</td></tr>'}</tbody>
|
||||||
|
</table>
|
||||||
|
<p><small>Создание из Grafana: webhook → запись в <code>ingress_events</code> → событие → строка здесь.</small></p>"""
|
||||||
|
return HTMLResponse(
|
||||||
|
wrap_module_html_page(
|
||||||
|
document_title="Инциденты — onGuard24",
|
||||||
|
current_slug="incidents",
|
||||||
|
main_inner_html=inner,
|
||||||
|
)
|
||||||
|
)
|
||||||
@ -5,6 +5,7 @@
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncpg
|
||||||
from collections.abc import Awaitable, Callable
|
from collections.abc import Awaitable, Callable
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
|
|
||||||
@ -12,10 +13,18 @@ from fastapi import APIRouter
|
|||||||
from starlette.requests import Request
|
from starlette.requests import Request
|
||||||
|
|
||||||
from onguard24.domain.events import EventBus
|
from onguard24.domain.events import EventBus
|
||||||
from onguard24.modules import contacts, schedules, statusboard
|
from onguard24.modules import (
|
||||||
|
contacts,
|
||||||
|
escalations,
|
||||||
|
incidents,
|
||||||
|
schedules,
|
||||||
|
statusboard,
|
||||||
|
tasks,
|
||||||
|
)
|
||||||
|
|
||||||
# async (Request) -> str — фрагмент HTML для главной страницы (опционально)
|
# async (Request) -> str — фрагмент HTML для главной страницы (опционально)
|
||||||
HomeFragment = Callable[[Request], Awaitable[str]]
|
HomeFragment = Callable[[Request], Awaitable[str]]
|
||||||
|
RegisterEvents = Callable[[EventBus, asyncpg.Pool | None], None]
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@ -24,7 +33,7 @@ class ModuleMount:
|
|||||||
|
|
||||||
router: APIRouter
|
router: APIRouter
|
||||||
url_prefix: str
|
url_prefix: str
|
||||||
register_events: Callable[[EventBus], None]
|
register_events: RegisterEvents
|
||||||
slug: str
|
slug: str
|
||||||
title: str
|
title: str
|
||||||
ui_router: APIRouter | None = None
|
ui_router: APIRouter | None = None
|
||||||
@ -33,6 +42,33 @@ class ModuleMount:
|
|||||||
|
|
||||||
def _mounts() -> list[ModuleMount]:
|
def _mounts() -> list[ModuleMount]:
|
||||||
return [
|
return [
|
||||||
|
ModuleMount(
|
||||||
|
router=incidents.router,
|
||||||
|
url_prefix="/api/v1/modules/incidents",
|
||||||
|
register_events=incidents.register_events,
|
||||||
|
slug="incidents",
|
||||||
|
title="Инциденты",
|
||||||
|
ui_router=incidents.ui_router,
|
||||||
|
render_home_fragment=incidents.render_home_fragment,
|
||||||
|
),
|
||||||
|
ModuleMount(
|
||||||
|
router=tasks.router,
|
||||||
|
url_prefix="/api/v1/modules/tasks",
|
||||||
|
register_events=tasks.register_events,
|
||||||
|
slug="tasks",
|
||||||
|
title="Задачи",
|
||||||
|
ui_router=tasks.ui_router,
|
||||||
|
render_home_fragment=tasks.render_home_fragment,
|
||||||
|
),
|
||||||
|
ModuleMount(
|
||||||
|
router=escalations.router,
|
||||||
|
url_prefix="/api/v1/modules/escalations",
|
||||||
|
register_events=escalations.register_events,
|
||||||
|
slug="escalations",
|
||||||
|
title="Эскалации",
|
||||||
|
ui_router=escalations.ui_router,
|
||||||
|
render_home_fragment=escalations.render_home_fragment,
|
||||||
|
),
|
||||||
ModuleMount(
|
ModuleMount(
|
||||||
router=schedules.router,
|
router=schedules.router,
|
||||||
url_prefix="/api/v1/modules/schedules",
|
url_prefix="/api/v1/modules/schedules",
|
||||||
@ -66,6 +102,6 @@ def _mounts() -> list[ModuleMount]:
|
|||||||
MODULE_MOUNTS: list[ModuleMount] = _mounts()
|
MODULE_MOUNTS: list[ModuleMount] = _mounts()
|
||||||
|
|
||||||
|
|
||||||
def register_module_events(bus: EventBus) -> None:
|
def register_module_events(bus: EventBus, pool: asyncpg.Pool | None = None) -> None:
|
||||||
for m in MODULE_MOUNTS:
|
for m in MODULE_MOUNTS:
|
||||||
m.register_events(bus)
|
m.register_events(bus, pool)
|
||||||
|
|||||||
@ -9,7 +9,7 @@ router = APIRouter(tags=["module-schedules"])
|
|||||||
ui_router = APIRouter(tags=["web-schedules"], include_in_schema=False)
|
ui_router = APIRouter(tags=["web-schedules"], include_in_schema=False)
|
||||||
|
|
||||||
|
|
||||||
def register_events(_bus: EventBus) -> None:
|
def register_events(_bus: EventBus, _pool=None) -> None:
|
||||||
"""Подписка на доменные события (например alert.received)."""
|
"""Подписка на доменные события (например alert.received)."""
|
||||||
# _bus.subscribe("alert.received", handler)
|
# _bus.subscribe("alert.received", handler)
|
||||||
|
|
||||||
|
|||||||
@ -9,7 +9,7 @@ router = APIRouter(tags=["module-statusboard"])
|
|||||||
ui_router = APIRouter(tags=["web-statusboard"], include_in_schema=False)
|
ui_router = APIRouter(tags=["web-statusboard"], include_in_schema=False)
|
||||||
|
|
||||||
|
|
||||||
def register_events(_bus: EventBus) -> None:
|
def register_events(_bus: EventBus, _pool=None) -> None:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
159
onguard24/modules/tasks.py
Normal file
159
onguard24/modules/tasks.py
Normal file
@ -0,0 +1,159 @@
|
|||||||
|
"""IRM: задачи по инцидентам (или вне привязки)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import html
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
|
import asyncpg
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException, Request
|
||||||
|
from fastapi.responses import HTMLResponse
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
from onguard24.deps import get_pool
|
||||||
|
from onguard24.domain.events import EventBus
|
||||||
|
from onguard24.modules.ui_support import wrap_module_html_page
|
||||||
|
|
||||||
|
router = APIRouter(tags=["module-tasks"])
|
||||||
|
ui_router = APIRouter(tags=["web-tasks"], include_in_schema=False)
|
||||||
|
|
||||||
|
|
||||||
|
class TaskCreate(BaseModel):
|
||||||
|
title: str = Field(..., min_length=1, max_length=500)
|
||||||
|
incident_id: UUID | None = None
|
||||||
|
|
||||||
|
|
||||||
|
def register_events(_bus: EventBus, _pool: asyncpg.Pool | None = None) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
async def render_home_fragment(request: Request) -> str:
|
||||||
|
pool = get_pool(request)
|
||||||
|
if pool is None:
|
||||||
|
return '<p class="module-note">Нужна БД для задач.</p>'
|
||||||
|
try:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
n = await conn.fetchval("SELECT count(*)::int FROM tasks")
|
||||||
|
except Exception:
|
||||||
|
return '<p class="module-note">Таблица задач недоступна (миграции?).</p>'
|
||||||
|
return f'<div class="module-fragment"><p>Задач: <strong>{int(n)}</strong></p></div>'
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/")
|
||||||
|
async def list_tasks_api(
|
||||||
|
pool: asyncpg.Pool | None = Depends(get_pool),
|
||||||
|
incident_id: UUID | None = None,
|
||||||
|
limit: int = 100,
|
||||||
|
):
|
||||||
|
if pool is None:
|
||||||
|
return {"items": [], "database": "disabled"}
|
||||||
|
limit = min(max(limit, 1), 200)
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
if incident_id:
|
||||||
|
rows = await conn.fetch(
|
||||||
|
"""
|
||||||
|
SELECT id, incident_id, title, status, created_at
|
||||||
|
FROM tasks WHERE incident_id = $1::uuid
|
||||||
|
ORDER BY created_at DESC LIMIT $2
|
||||||
|
""",
|
||||||
|
incident_id,
|
||||||
|
limit,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
rows = await conn.fetch(
|
||||||
|
"""
|
||||||
|
SELECT id, incident_id, title, status, created_at
|
||||||
|
FROM tasks
|
||||||
|
ORDER BY created_at DESC
|
||||||
|
LIMIT $1
|
||||||
|
""",
|
||||||
|
limit,
|
||||||
|
)
|
||||||
|
items = []
|
||||||
|
for r in rows:
|
||||||
|
items.append(
|
||||||
|
{
|
||||||
|
"id": str(r["id"]),
|
||||||
|
"incident_id": str(r["incident_id"]) if r["incident_id"] else None,
|
||||||
|
"title": r["title"],
|
||||||
|
"status": r["status"],
|
||||||
|
"created_at": r["created_at"].isoformat() if r["created_at"] else None,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return {"items": items}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/", status_code=201)
|
||||||
|
async def create_task_api(body: TaskCreate, pool: asyncpg.Pool | None = Depends(get_pool)):
|
||||||
|
if pool is None:
|
||||||
|
raise HTTPException(status_code=503, detail="database disabled")
|
||||||
|
if body.incident_id:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
ok = await conn.fetchval(
|
||||||
|
"SELECT 1 FROM incidents WHERE id = $1::uuid",
|
||||||
|
body.incident_id,
|
||||||
|
)
|
||||||
|
if not ok:
|
||||||
|
raise HTTPException(status_code=400, detail="incident not found")
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
row = await conn.fetchrow(
|
||||||
|
"""
|
||||||
|
INSERT INTO tasks (title, incident_id, status)
|
||||||
|
VALUES ($1, $2::uuid, 'open')
|
||||||
|
RETURNING id, incident_id, title, status, created_at
|
||||||
|
""",
|
||||||
|
body.title.strip(),
|
||||||
|
body.incident_id,
|
||||||
|
)
|
||||||
|
return {
|
||||||
|
"id": str(row["id"]),
|
||||||
|
"incident_id": str(row["incident_id"]) if row["incident_id"] else None,
|
||||||
|
"title": row["title"],
|
||||||
|
"status": row["status"],
|
||||||
|
"created_at": row["created_at"].isoformat() if row["created_at"] else None,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ui_router.get("/", response_class=HTMLResponse)
|
||||||
|
async def tasks_ui_home(request: Request):
|
||||||
|
pool = get_pool(request)
|
||||||
|
rows_html = ""
|
||||||
|
err = ""
|
||||||
|
if pool is None:
|
||||||
|
err = "<p>База данных не настроена.</p>"
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
async with pool.acquire() as conn:
|
||||||
|
rows = await conn.fetch(
|
||||||
|
"""
|
||||||
|
SELECT t.id, t.title, t.status, t.incident_id, t.created_at
|
||||||
|
FROM tasks t
|
||||||
|
ORDER BY t.created_at DESC
|
||||||
|
LIMIT 100
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
for r in rows:
|
||||||
|
iid = str(r["incident_id"])[:8] + "…" if r["incident_id"] else "—"
|
||||||
|
rows_html += (
|
||||||
|
"<tr>"
|
||||||
|
f"<td>{html.escape(str(r['id']))[:8]}…</td>"
|
||||||
|
f"<td>{html.escape(r['title'])}</td>"
|
||||||
|
f"<td>{html.escape(r['status'])}</td>"
|
||||||
|
f"<td>{html.escape(iid)}</td>"
|
||||||
|
"</tr>"
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
err = f"<p class=\"module-err\">{html.escape(str(e))}</p>"
|
||||||
|
inner = f"""<h1>Задачи</h1>
|
||||||
|
{err}
|
||||||
|
<table class="irm-table">
|
||||||
|
<thead><tr><th>ID</th><th>Заголовок</th><th>Статус</th><th>Инцидент</th></tr></thead>
|
||||||
|
<tbody>{rows_html or '<tr><td colspan="4">Пока нет задач</td></tr>'}</tbody>
|
||||||
|
</table>"""
|
||||||
|
return HTMLResponse(
|
||||||
|
wrap_module_html_page(
|
||||||
|
document_title="Задачи — onGuard24",
|
||||||
|
current_slug="tasks",
|
||||||
|
main_inner_html=inner,
|
||||||
|
)
|
||||||
|
)
|
||||||
@ -27,6 +27,9 @@ APP_SHELL_CSS = """
|
|||||||
.rail-item a:hover { background: #f4f4f5; }
|
.rail-item a:hover { background: #f4f4f5; }
|
||||||
.rail-item.is-active a { background: #eff6ff; color: #1d4ed8; font-weight: 600; }
|
.rail-item.is-active a { background: #eff6ff; color: #1d4ed8; font-weight: 600; }
|
||||||
.module-page-main h1 { margin-top: 0; font-size: 1.35rem; }
|
.module-page-main h1 { margin-top: 0; font-size: 1.35rem; }
|
||||||
|
.irm-table { width: 100%; border-collapse: collapse; font-size: 0.9rem; }
|
||||||
|
.irm-table th, .irm-table td { border: 1px solid #e4e4e7; padding: 0.45rem 0.65rem; text-align: left; }
|
||||||
|
.irm-table thead th { background: #f4f4f5; }
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "onguard24"
|
name = "onguard24"
|
||||||
version = "1.4.1"
|
version = "1.6.0"
|
||||||
description = "onGuard24 — модульный сервис (аналог IRM)"
|
description = "onGuard24 — модульный сервис (аналог IRM)"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.11"
|
requires-python = ">=3.11"
|
||||||
|
|||||||
69
tests/test_irm_modules.py
Normal file
69
tests/test_irm_modules.py
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
"""IRM-модули: API без БД и обработчик инцидента по событию."""
|
||||||
|
|
||||||
|
from unittest.mock import AsyncMock, MagicMock
|
||||||
|
from uuid import uuid4
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
from onguard24.domain.entities import Alert, Severity
|
||||||
|
from onguard24.domain.events import AlertReceived
|
||||||
|
|
||||||
|
|
||||||
|
def test_incidents_api_list_no_db(client: TestClient) -> None:
|
||||||
|
r = client.get("/api/v1/modules/incidents/")
|
||||||
|
assert r.status_code == 200
|
||||||
|
assert r.json() == {"items": [], "database": "disabled"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_tasks_api_list_no_db(client: TestClient) -> None:
|
||||||
|
r = client.get("/api/v1/modules/tasks/")
|
||||||
|
assert r.status_code == 200
|
||||||
|
assert r.json()["database"] == "disabled"
|
||||||
|
|
||||||
|
|
||||||
|
def test_escalations_api_list_no_db(client: TestClient) -> None:
|
||||||
|
r = client.get("/api/v1/modules/escalations/")
|
||||||
|
assert r.status_code == 200
|
||||||
|
assert r.json()["database"] == "disabled"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_incident_inserted_on_alert_received() -> None:
|
||||||
|
"""При пуле БД подписка создаёт инцидент (INSERT)."""
|
||||||
|
inserted: dict = {}
|
||||||
|
|
||||||
|
async def fake_execute(_query, *args):
|
||||||
|
inserted["args"] = args
|
||||||
|
return "INSERT 0 1"
|
||||||
|
|
||||||
|
mock_conn = AsyncMock()
|
||||||
|
mock_conn.execute = fake_execute
|
||||||
|
mock_cm = AsyncMock()
|
||||||
|
mock_cm.__aenter__ = AsyncMock(return_value=mock_conn)
|
||||||
|
mock_cm.__aexit__ = AsyncMock(return_value=None)
|
||||||
|
mock_pool = MagicMock()
|
||||||
|
mock_pool.acquire = MagicMock(return_value=mock_cm)
|
||||||
|
|
||||||
|
from onguard24.domain.events import InMemoryEventBus
|
||||||
|
from onguard24.modules import incidents as inc_mod
|
||||||
|
|
||||||
|
bus = InMemoryEventBus()
|
||||||
|
inc_mod.register_events(bus, mock_pool)
|
||||||
|
|
||||||
|
uid = uuid4()
|
||||||
|
ev = AlertReceived(
|
||||||
|
alert=Alert(source="grafana", title="CPU high", severity=Severity.WARNING),
|
||||||
|
raw_payload_ref=uid,
|
||||||
|
)
|
||||||
|
await bus.publish(ev)
|
||||||
|
|
||||||
|
assert inserted.get("args") is not None
|
||||||
|
assert inserted["args"][0] == "CPU high"
|
||||||
|
assert inserted["args"][1] == "warning"
|
||||||
|
assert inserted["args"][2] == uid
|
||||||
|
|
||||||
|
|
||||||
|
def test_incidents_post_requires_db(client: TestClient) -> None:
|
||||||
|
r = client.post("/api/v1/modules/incidents/", json={"title": "x"})
|
||||||
|
assert r.status_code == 503
|
||||||
@ -32,6 +32,9 @@ def test_rail_lists_all_registered_ui_modules(client: TestClient) -> None:
|
|||||||
assert r.status_code == 200
|
assert r.status_code == 200
|
||||||
t = r.text
|
t = r.text
|
||||||
expected = (
|
expected = (
|
||||||
|
("incidents", "Инциденты"),
|
||||||
|
("tasks", "Задачи"),
|
||||||
|
("escalations", "Эскалации"),
|
||||||
("schedules", "Календарь дежурств"),
|
("schedules", "Календарь дежурств"),
|
||||||
("contacts", "Контакты"),
|
("contacts", "Контакты"),
|
||||||
("statusboard", "Светофор"),
|
("statusboard", "Светофор"),
|
||||||
@ -43,7 +46,14 @@ def test_rail_lists_all_registered_ui_modules(client: TestClient) -> None:
|
|||||||
|
|
||||||
def test_each_module_page_single_active_nav_item(client: TestClient) -> None:
|
def test_each_module_page_single_active_nav_item(client: TestClient) -> None:
|
||||||
"""На странице модуля ровно один пункт с aria-current (текущий раздел)."""
|
"""На странице модуля ровно один пункт с aria-current (текущий раздел)."""
|
||||||
for slug in ("schedules", "contacts", "statusboard"):
|
for slug in (
|
||||||
|
"incidents",
|
||||||
|
"tasks",
|
||||||
|
"escalations",
|
||||||
|
"schedules",
|
||||||
|
"contacts",
|
||||||
|
"statusboard",
|
||||||
|
):
|
||||||
r = client.get(f"/ui/modules/{slug}/")
|
r = client.get(f"/ui/modules/{slug}/")
|
||||||
assert r.status_code == 200
|
assert r.status_code == 200
|
||||||
assert r.text.count('aria-current="page"') == 1
|
assert r.text.count('aria-current="page"') == 1
|
||||||
|
|||||||
Reference in New Issue
Block a user