Skip to main content

control-plane

What this package owns​

  • Dagster definitions, assets, jobs, schedules, and operational helper code for Origo's ingestion, backfill, export, and rebuild workflows.

What this package does not own​

  • Canonical business truth itself.
  • FastAPI request and response contracts.
  • Governance authority.

Key entry points​

  • origo_control_plane/definitions.py
  • origo_control_plane/jobs/
  • origo_control_plane/backfill/
  • origo_control_plane/bitcoin_core/
  • migrations/

Major dependencies and adjacent modules​

  • Adjacent modules:
    • ../origo/events
    • ../origo/observability
    • ../api/origo_api

Development​

cp ../.env.example .env
uv lock
uv sync --frozen
uv run python -c "import origo_control_plane; print('ok')"

Environment contract​

  • Required values must be set and non-empty:
    1. CLICKHOUSE_HOST
    2. CLICKHOUSE_PORT
    3. CLICKHOUSE_HTTP_PORT
    4. CLICKHOUSE_USER
    5. CLICKHOUSE_PASSWORD
    6. CLICKHOUSE_DATABASE

Canonical docs​

  • ../docs/Developer/README.md
  • ../docs/Developer/Release-And-Deployment.md
  • ../docs/Developer/SQL-Migrations.md
  • ../docs/projection-rebuild-reference.md