docs: Diplodoc setup + полное руководство интеграции по API
Новая документация-as-code на платформе Diplodoc (Yandex open-source) с YFM (Yandex Flavored Markdown). Build → static HTML, deployable куда угодно. Что добавлено: - package.json + .yfm + toc.yaml — Diplodoc setup, навигация для sidebar - index.md — главная страница с tabs для разных audiences - README.md — инструкция для contributors Раздел integration/api/ — 11 страниц про интеграцию consumers: - index — обзор + глоссарий - auth — Keycloak service accounts, scope mapping - read-endpoints — GET /dictionaries, list/by-key, spatial filters - events — Kafka outbox топики, partition keys, idempotency, DLQ - webhooks — HMAC, SSRF guard, retry policy, test ping endpoint - bitemporal — validFrom/validTo + history, future-dated entries, bulk close/export - x-references — FK syntax, validation errors, scope hiding, orphan scanner, v2 cascade preview - caching — TTL / push / snapshot strategies, hybrid pattern - errors — full error code reference (validation/auth/conflict/server), retry strategy - best-practices — 33 numbered rules для consumers - bundle-cuod — все 40 справочников с FK графом и сценариями Обновлены: - ops/README.md — link на новую integration/api/, убран inline <br> - ops/slo.md — broken cross-repo links заменены на text references Build: cd docs && pnpm install && pnpm build → ./_dist (20 HTML files, 7.1M) pnpm serve # → http://localhost:8088 CI deploy job для GitLab Pages — в roadmap (см. docs/README.md). Существующий tech/api-integration.md оставлен в toc как legacy (содержимое мигрировано + расширено в integration/api/).
This commit is contained in:
+3
-3
@@ -71,7 +71,7 @@ kubectl get pods -n ordinis-staging | grep admin-ui
|
||||
|
||||
| Status | Причина |
|
||||
|-----------------------|---------|
|
||||
| `ImagePullBackOff` | Тег image не существует в registry. Проверь `kubectl describe`. Восстановить:<br>`kubectl set image deployment/ordinis-admin-ui -n ordinis-staging ui=repo.nstart.cloud/terravault/ordinis-admin-ui:main` |
|
||||
| `ImagePullBackOff` | Тег image не существует в registry. Проверь `kubectl describe`. Восстановить: `kubectl set image deployment/ordinis-admin-ui ui=<registry>/ordinis-admin-ui:main -n ordinis-staging` |
|
||||
| `CrashLoopBackOff` | nginx config invalid либо resolver недоступен. См. logs. |
|
||||
| `Running 1/1`, но 502 | Upstream (writer/read-api) сам в дауне. Проверь те pod'ы. |
|
||||
|
||||
@@ -91,8 +91,8 @@ kubectl get pods -n ordinis-staging | grep admin-ui
|
||||
|
||||
## 6. Связанные ресурсы
|
||||
|
||||
- API integration guide: [../tech/api-integration.md](../tech/api-integration.md)
|
||||
- API integration guide: [../integration/api/index.md](../integration/api/index.md) (Diplodoc, latest)
|
||||
- Альтум integration: [../integration/altum-imaging-order.md](../integration/altum-imaging-order.md)
|
||||
- Project state: [../status/2026-05-05-state.md](../status/2026-05-05-state.md)
|
||||
- Project state snapshots: см. `docs/status/*-state.md` в repo (исключены из Diplodoc build)
|
||||
- Helm chart: `ordinis-infra/charts/ordinis/`
|
||||
- Vault setup: `ordinis-infra/k8s/vault/setup.sh`
|
||||
|
||||
+2
-2
@@ -5,7 +5,7 @@
|
||||
после 2-3 месяцев наблюдения.
|
||||
|
||||
**Source of truth для алертов:**
|
||||
[ordinis-infra/charts/ordinis/templates/prometheus-rules.yaml](../../code/ordinis-infra/charts/ordinis/templates/prometheus-rules.yaml).
|
||||
`ordinis-infra/charts/ordinis/templates/prometheus-rules.yaml` (отдельный repo).
|
||||
|
||||
## 1. SLI (Service Level Indicators)
|
||||
|
||||
@@ -63,7 +63,7 @@ Routing в Slack/Telegram/Email — отдельная задача:
|
||||
- **warning** → digest channel (раз в час summary)
|
||||
- [ ] Эскалация: critical → engineer → tech lead через 15 мин если не acked.
|
||||
|
||||
См. v1 closure backlog в [docs/status/2026-05-05-state.md](../status/2026-05-05-state.md).
|
||||
См. `docs/status/2026-05-05-state.md` в repo (status snapshots исключены из Diplodoc build).
|
||||
|
||||
## 3. Error budget (v1 target)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user