ddmitry/clickstream-ch-kafka-superset-demo
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add runbook reference and makefile commands

Browse Source 
- Add reference to `plans/runbook.md` in key artifacts section
- Add reference to `plans/kafka_ingest_plan.md` in key artifacts section
- Document `make up`, `make ddl`, and `make data` commands in basic commands section
This commit is contained in:
ddadmin
2026-02-05 22:12:51 +03:00
parent a81a2c1b68
commit a39dba6dae
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+5
View File
@@ -15,6 +15,8 @@
## Ключевые артефакты ## Ключевые артефакты
- `plans/clickhouse_ddl.md` — основной документ со схемой слоёв, DDL/MV и витринами DM. - `plans/clickhouse_ddl.md` — основной документ со схемой слоёв, DDL/MV и витринами DM.
- `plans/runbook.md` — runbook: порядок запуска (`make up`/`make ddl`/`make data`) и параметры.
- `plans/kafka_ingest_plan.md` — детальный план реализации загрузки данных в Kafka.
- `data/DE-task.md` — текст задания. - `data/DE-task.md` — текст задания.
- `data/*.jsonl` — исходные данные (могут быть грязными). - `data/*.jsonl` — исходные данные (могут быть грязными).
- `configs/` — конфиги ClickHouse/Prometheus/Grafana (по мере развития). - `configs/` — конфиги ClickHouse/Prometheus/Grafana (по мере развития).
@@ -29,6 +31,9 @@
Базовые команды: Базовые команды:
- `make up` (или `docker compose up -d`)
- `make ddl` (применяет SQL из `plans/clickhouse_ddl.md` в ClickHouse)
- `make data` (пересоздаёт топики и заливает небольшой срез данных в Kafka; полный режим — `FULL=1 make data`)
- `docker compose up -d` - `docker compose up -d`
- `docker compose ps` - `docker compose ps`
- `docker compose logs -f --tail=200 <service>` - `docker compose logs -f --tail=200 <service>`