guard/docs/roadmap/README.md
loki5512344 280284667f
docs: per-task roadmap, architecture and changelog
- Split TODO into a thin status index plus docs/roadmap/ with one file per
  task (v0.4 reliability, v0.5 product, v0.6 research, icebox).
- Add docs/architecture.md (current processes, packet/data path, layers,
  storage, metrics) and docs/development.md (rules, gates, DoD).
- Add CHANGELOG.md reconstructed from history; move round details out of
  TODO.
- Align docs with the code: config defaults and missing [detect]/
  [protocol.http] sections, XDP metric names, ClickHouse table and TTL,
  Redis RDB restore, multiarch clang include, CLI binary name.
- Add scripts/check_docs_links.sh and run it in CI.
- release profile: thin LTO + one codegen unit. Binary 12.3 MB -> 9.7 MB,
  http parser bench 314 ns -> 278 ns; panic=abort stays off for
  catch_unwind in the Redis subscriber.
- Drop the unused JWT role claim; fix 'rampart doctor' hints in the CLI.
2026-11-16 14:51:50 +01:00

4.7 KiB
Raw Permalink Blame History

Roadmap — Rampart

Индекс планов по версиям. TODO.md в корне — только статус и ссылки сюда; детали каждой задачи живут в отдельном файле этой папки.


1. Правила

  1. Одна задача = один файл. Имя: <version>-<topic>.md, kebab-case, без дат.
  2. Файл создаётся, когда задача попадает в план, а не когда её начинают. Пока задача не начата, достаточно цели, объёма и критериев приёмки.
  3. Статус меняется в двух местах одновременно: в шапке файла задачи и в таблице TODO.md. Расхождение = баг документации.
  4. Завершённая задача получает Status: done, ссылку на коммит(ы) и остаётся в папке до релиза; после релиза её содержимое переносится в CHANGELOG.md, а файл удаляется.
  5. Не плоди версии. Если задача не влезает в текущий milestone, она едет в icebox-*.md, а не в «v0.7».
  6. Планы не врут. Команды и пути в плане проверяются по коду в том же PR.

2. Статусы

Статус Значение
idea сформулирована, не оценена
planned есть цель, объём и критерии приёмки, можно брать
design идёт обсуждение дизайна (brainstorming)
ready дизайн утверждён, есть пошаговый план
in-progress реализуется
blocked ждёт внешнего решения или зависимости
done готова, влита, отражена в CHANGELOG
dropped решено не делать; причина в файле

3. Milestones

Версия Тема Критерий выхода
v0.4 Надёжность и воспроизводимость XDP проверяется в CI, старт даёт честный вердикт об окружении, нет self-lockout
v0.5 Продуктовые фичи RST-challenge доведён до GA, внешние списки и API пригодны для интеграций, GeoIP/ASN, gRPC
v0.6 Исследования решения из backlog с доказанной пользой; каждая фича начинается с бенчмарка/прототипа
icebox Отложено без даты; берётся только при явном запросе

4. v0.4 — надёжность

Задача Приоритет Статус План
XDP netns+veth harness в CI P0 planned v0.4-xdp-ci-harness.md
Startup-диагностика окружения P1 planned v0.4-startup-diagnostics.md
Anti-lockout и баны по порту P1 planned v0.4-anti-lockout.md

5. v0.5 — продуктовые фичи

Задача Приоритет Статус План
RST-challenge: довести до GA P0 planned v0.5-rst-challenge-ga.md
Pinned maps + OpenAPI P1 idea v0.5-pinned-maps-openapi.md
GeoIP/ASN reputation P1 idea v0.5-geoip-asn.md
gRPC protocol plugin P2 idea v0.5-grpc-plugin.md

6. v0.6 — исследования

Задача Приоритет Статус План
HTTP поверх XDP (BPF hook) P1 idea v0.6-http-over-xdp.md
Bloom filter для blacklist P3 idea v0.6-bloom-filter.md
io_uring runtime P3 idea v0.6-io-uring.md
ML anomaly detection P3 idea v0.6-ml-anomaly.md
BGP Anycast P3 idea v0.6-bgp-anycast.md

7. Icebox

Задача Почему отложена План
Minecraft Velocity forwarding нужен только если MC-сегмент остаётся целевым icebox-minecraft-velocity.md

Версия: 1.0 | Ноябрь 2026