Files
AWatch-rus/docs/MODULE_ARCHITECTURE_GRAPH_RU.md
T
igor04091968 81e927bf42
CI / Rust checks (push) Waiting to run
CI / Docs and registry checks (push) Waiting to run
CI / Smoke checks (push) Waiting to run
Coverage / Coverage baseline (push) Waiting to run
Security / Cargo audit (push) Waiting to run
Security / Cargo deny (push) Waiting to run
Security / Secret pattern check (push) Waiting to run
Security / Dependency review (push) Waiting to run
docs(architecture): track orchestration map
2026-06-30 13:13:15 +03:00

15 KiB
Raw Blame History

AWatch-rus / DetMir: модульная схема комплекса

Статус: операторская архитектурная карта для просмотра прямо в GitHub/Gitea.

Документ описывает, как связаны основные модули AWatch-rus / DetMir, где проходят данные и где администратор видит результат. Диаграммы выполнены в Mermaid: GitHub и Gitea отображают их непосредственно на странице Markdown.

1. Границы и честные утверждения

  • AWatch-rus / DetMir не заявляется как сертифицированная СЗИ, DLP, SIEM, EDR или XDR.
  • GitHub Actions и GitHub issues используются как публичная инженерная видимость и mirror validation, а не как evidence российского release-контура.
  • Основной российский контур поставки и контроля: private Gitea плюс планируемый российский build-runner.
  • Текущий production-профиль DetMir держит тяжелый DLP runtime отключенным для снижения нагрузки на Proxmox, InfluxDB, Grafana, ClickHouse и AW server. DLP-модуль не удален и может быть подключен отдельно после решения оператора.
  • Hayabusa/Sigma и Velociraptor используются как слой findings/forensics. Они не входят в горячий путь расчета рабочего времени и не должны запускать блокировку рабочих станций без явного approval.

2. Карта модулей верхнего уровня

flowchart LR
  subgraph endpoints["Рабочие места и RDP"]
    RDP["RDP host<br/>192.168.100.19<br/>logical host SHARKON2025"]
    WinCollectors["Windows collectors<br/>window, AFK, browser, worktime"]
    File1C["File1C upload task<br/>каждые 15 минут"]
    OptionalDlpEndpoint["Optional DLP endpoint sync<br/>обычно disabled"]
  end

  subgraph awserver["AW server 10.10.10.13"]
    AwServer["ActivityWatch server<br/>порт 5600"]
    AwBuckets["AW buckets<br/>SQLite datastore"]
    WorktimeApi["aw-worktime-api<br/>порт 5610"]
    InfluxExporter["worktime Influx exporter"]
    Healthd["aw-rus-healthd<br/>readiness and checks"]
  end

  subgraph analytics["Analytics and dashboards"]
    Influx["InfluxDB<br/>10.10.10.10:8086"]
    Grafana["Grafana<br/>10.10.10.11:3000"]
    ClickHouse["ClickHouse<br/>10.10.10.2:8123"]
    Portal["DetMir portal and gateway<br/>10.10.10.2:8720<br/>/portal"]
  end

  subgraph security["Security findings and containment"]
    Hayabusa["Hayabusa / Sigma<br/>EVTX and rule findings"]
    Velociraptor["Velociraptor<br/>offline collector or explicit server mode"]
    Inbox["Security Finding Inbox<br/>ClickHouse-backed"]
    Executor["Containment executor<br/>plan / apply / verify / rollback"]
  end

  subgraph governance["Governance and delivery"]
    GitHub["GitHub public mirror<br/>PR checks and ruleset"]
    Gitea["Russian Gitea<br/>primary private contour"]
    BuildRunner["Russian build-runner<br/>planned registry evidence"]
  end

  RDP --> WinCollectors
  WinCollectors --> AwServer
  AwServer --> AwBuckets
  AwBuckets --> WorktimeApi
  WorktimeApi --> Portal
  WorktimeApi --> InfluxExporter
  InfluxExporter --> Influx
  Influx --> Grafana
  Grafana --> Portal
  File1C --> ClickHouse
  ClickHouse --> Portal
  ClickHouse --> Grafana
  Healthd --> Portal

  Hayabusa --> Inbox
  Velociraptor --> Inbox
  OptionalDlpEndpoint -. optional .-> Inbox
  Inbox --> Portal
  Portal --> Executor
  Executor --> Inbox

  GitHub --> Gitea
  Gitea --> BuildRunner

3. Основные модули

Модуль Где работает Что делает Куда пишет/отдает
Windows collectors RDP/Windows hosts Собирают окна, AFK, браузерные домены, рабочие сессии ActivityWatch API
ActivityWatch server 10.10.10.13:5600 Принимает события и хранит buckets SQLite datastore, HTTP API
Worktime API 10.10.10.13:5610 Строит отчеты рабочего времени и management-срез Portal, Influx exporter
Influx exporter AW server Перекладывает рабочие метрики во временные ряды InfluxDB
InfluxDB 10.10.10.10:8086 Хранит time-series для Grafana Grafana
Grafana 10.10.10.11:3000 Показывает dashboards по активности, дисциплине и состоянию Администратор, portal links
DetMir portal 10.10.10.2:8720/portal Единая витрина: статус, workforce, security inbox, ссылки Browser UI/API
ClickHouse File1C 10.10.10.2:8123 Хранит 1C/file telemetry и security findings Portal, Grafana, manager API
Security Finding Inbox ClickHouse + Rust CLI/API Нормализует подозрительные станции и workflow Portal, executor, audit
Hayabusa/Sigma AW server / security host Разбирает Windows EVTX и Sigma-compatible findings Inbox
Velociraptor Optional mode Собирает endpoint forensics/artifacts Inbox/importers
DLP runtime Optional mode Тяжелый evidence/DLP слой, в production сейчас disabled Inbox/AW/ClickHouse when enabled
Containment executor Отдельный процесс Выполняет только approved plan/apply/verify/rollback Workflow events в ClickHouse
readiness/healthd AW server and gateway Проверяет живость сервисов, freshness, деградации Portal/status/logs

4. Горячий путь рабочего времени

Этот путь должен оставаться быстрым и независимым от тяжелых security-модулей. DLP, Velociraptor и Hayabusa не должны тормозить расчет рабочих отчетов.

flowchart LR
  Session["RDP user session"] --> Collectors["Collectors<br/>window / AFK / browser / worktime"]
  Collectors --> AwHttp["ActivityWatch HTTP API"]
  AwHttp --> Buckets["AW buckets<br/>host suffix SHARKON2025"]
  Buckets --> Worktime["aw-worktime-api"]
  Worktime --> Cache["stale-safe report cache"]
  Worktime --> PortalWorkforce["Portal<br/>workforce view"]
  Worktime --> Exporter["Influx exporter"]
  Exporter --> Influx["InfluxDB"]
  Influx --> Grafana["Grafana dashboards"]
  Grafana --> Admin["Администратор<br/>проверяет графики"]

Ключевой принцип: физическое имя или IP RDP-сервера может измениться, но логический host id для buckets и витрин остается стабильным, пока оператор явно не проводит миграцию идентификаторов.

5. Отбор и категоризация ресурсов

Браузерные события идут в общий поток ActivityWatch, затем интерпретируются политикой рабочих/нерабочих ресурсов. Категории должны храниться как управляемая конфигурация, а не как зашитые в код одиночные домены.

flowchart TD
  BrowserEvent["Browser event<br/>URL/domain/title"] --> Normalizer["Domain normalizer"]
  Normalizer --> CategoryRules["Category rules<br/>work / non-work / neutral / unknown"]
  CategoryRules --> WorktimeApi["Worktime API scoring"]
  WorktimeApi --> Portal["Portal recommendations"]
  WorktimeApi --> Grafana["Grafana panels"]
  CategoryRules --> AdminConfig["Admin-owned config<br/>review and update"]

Администратор должен видеть не только итоговые минуты, но и объяснение: какой домен, какая категория, сколько времени, почему это считается рабочим или нерабочим.

6. ClickHouse / File1C / управленческая аналитика

flowchart LR
  FileSource["RDP/Windows File1C telemetry"] --> UploadTask["Windows scheduled task<br/>File1C Upload"]
  UploadTask --> Landing["ClickHouse landing directory"]
  Landing --> Ingest["aw-1c-ingest-rust<br/>systemd timer"]
  Ingest --> CHRaw["ClickHouse raw tables"]
  CHRaw --> CHViews["Materialized views<br/>manager and workforce slices"]
  CHViews --> Portal1C["Portal / 1C manager brief"]
  CHViews --> Grafana1C["Grafana 1C dashboards"]
  Ingest --> Health["ClickHouse health timers"]
  Health --> PortalStatus["Portal status"]

Этот контур нужен для управленческой аналитики и файловых/1C-срезов. Он не заменяет ActivityWatch hot path и не должен блокировать портал при временной деградации ClickHouse.

7. Security Finding Inbox и управляемое containment

flowchart LR
  HayabusaFindings["Hayabusa/Sigma findings"] --> Adapter["Finding adapters"]
  VelociraptorFindings["Velociraptor exports"] --> Adapter
  ManualFinding["Manual operator finding"] --> Adapter
  OptionalDlp["Optional DLP evidence<br/>disabled by default"] -.-> Adapter
  Adapter --> Inbox["Security Finding Inbox<br/>ClickHouse"]
  Inbox --> Suspicious["Portal page<br/>Подозрительные станции"]
  Suspicious --> Decide["decide"]
  Decide --> Plan["plan"]
  Plan --> Approve["approve<br/>human gate"]
  Approve --> Apply["executor apply"]
  Apply --> Verify["verify"]
  Verify --> Closed["workflow event<br/>closed or escalated"]
  Verify --> Rollback["rollback<br/>when verification fails"]
  Rollback --> Inbox
  Closed --> Inbox
stateDiagram-v2
  [*] --> FindingReceived
  FindingReceived --> Planned: decide and plan
  Planned --> ApprovalRequired: action is risky
  ApprovalRequired --> Applied: approved
  ApprovalRequired --> Rejected: rejected
  Applied --> Verified: verify passed
  Applied --> RollbackRequired: verify failed
  RollbackRequired --> RolledBack: rollback completed
  Verified --> Closed
  Rejected --> Closed
  RolledBack --> Escalated

Запрет: findings не должны автоматически блокировать рабочую станцию. Исполнение возможно только после явного approval и через отдельный executor, который пишет результат обратно в workflow-аудит.

8. Операционный контроль и recovery

flowchart TD
  DailyCheck["daily / weekly contour checks"] --> Healthd["aw-rus-healthd"]
  Orchestration["Ansible and scripts<br/>deploy / validate / support"] --> DailyCheck
  Healthd --> AwCheck["AW server and bucket freshness"]
  Healthd --> WorktimeCheck["Worktime API health"]
  Healthd --> ClickHouseCheck["ClickHouse health"]
  Healthd --> GrafanaCheck["Grafana dashboard smoke"]
  AwCheck --> Status["Portal status"]
  WorktimeCheck --> Status
  ClickHouseCheck --> Status
  GrafanaCheck --> Status
  Status --> Operator["Operator decision<br/>restart, repair, or escalate"]
  Operator --> Runbooks["Docs and runbooks"]

Важное разделение: routine checks не должны автоматически включать тяжелый DLP runtime и не должны менять сетевые маршруты. Любое изменение маршрутизации, firewall или containment выполняется как отдельное управляемое действие.

9. Governance, GitHub и Gitea

flowchart LR
  DevBranch["Feature/docs branch"] --> PR["GitHub PR<br/>public mirror validation"]
  PR --> Checks["Required checks<br/>rust, docs, security, smoke"]
  Checks --> Review["CODEOWNERS review"]
  Review --> Main["main branch"]
  Main --> Gitea["Russian Gitea mirror<br/>primary private contour"]
  Gitea --> Runner["Russian build-runner<br/>planned release evidence"]
  PR -. not registry evidence .-> Note["Public transparency only"]

GitHub полезен для публичной проверяемости: PR, issues, checks, branch ruleset. Но для российского реестрового release evidence нужен отдельный российский контур сборки и хранения артефактов.

10. Оркестрация и поддержание актуальности

Оркестрационные entrypoints отдельно зафиксированы в docs/ORCHESTRATION_MAP_RU.md. Этот документ связывает архитектурные модули с Ansible playbooks, systemd timers, Windows Scheduled Tasks и read-only check scripts.

В репозитории есть guard:

bash scripts/check_orchestration_map.sh

Он не ходит в production и не меняет runtime. Его задача - проверить, что карта оркестрации ссылается на реальные playbooks/scripts и содержит обязательные safety-маркеры: DLP optional mode, Hayabusa/Velociraptor boundary, approval gate для containment и разделение GitHub/Gitea release контуров.

11. Где смотреть руками

Что проверить Где смотреть
Единый портал DetMir /portal на gateway
Рабочая активность и рекомендации Portal workforce pages, Worktime API
Графики по сотрудникам и приложениям Grafana dashboards detmir-aw-main, detmir-rdp-user-activity и связанные panels
Состояние AW buckets ActivityWatch API и readiness/status в portal
1C/File analytics Portal 1C manager views, ClickHouse dashboards
Подозрительные станции Portal security view / Security Finding Inbox
Hayabusa/Velociraptor findings Inbox import status, security dashboards, runbooks
Runtime checks aw-rus-healthd, contour check scripts, portal status
Код и evidence процесса GitHub PR/issues, private Gitea mirror

12. Связанные документы