How josepvco/source-provisioner works
Source Provisioner turns a YAML desired-state file into platform sources: validate it, optionally discover accounts and generate named, templated, staggered sources, then resolve, diff, apply changes idempotently, and report results. The client talks to a fictional FastAPI platform that serves account discovery and source CRUD, backed by SQLite with token authentication and rate limiting; optional fault injection is also documented. The notebook is the user-facing orchestrator. Unsampled API modules and notebook internals are represented only where the README or source index supports their role and connections.
Main entry points: sync.py Sync orchestration · main.py API application · generate.py Generation pipeline · sources.py Source CRUD routes
Components 23
Provisioning client
- Notebook workflow
notebooks/provision_sources.ipynb - Schema validation
src/provisioner/schema.py - Sync orchestration
src/provisioner/sync.py - Resolve extensions
src/provisioner/extend.py - Plan diff
src/provisioner/diff.py - HTTP client
src/provisioner/client.py - Run report
src/provisioner/report.py - Structured logging
src/provisioner/logs.py
Source generation
- Generation pipeline
src/provisioner/generate.py - Source naming
src/provisioner/naming.py - Template rendering
src/provisioner/template.py - Schedule staggering
src/provisioner/stagger.py
Mock platform
- API application
api/mock_platform/main.py - Account routes
api/mock_platform/routes/accounts.py - Seeded account data
api/mock_platform/discovery.py - Source CRUD routes
api/mock_platform/routes/sources.py - SQLite storage
api/mock_platform/db.py - API data models
api/mock_platform/models.py
Platform controls
- Bearer authentication
api/mock_platform/auth.py - Rate limiting
api/mock_platform/ratelimit.py - Fault injection
api/mock_platform/chaos.py
Other components
- Operator
- Desired-state YAML
Connections 27
- Operator → Notebook workflow: runs workflow
README.md - Desired-state YAML → Notebook workflow: provides desired state
README.md - Notebook workflow → Schema validation: loads and validates
README.md - Notebook workflow → Sync orchestration: invokes sync
README.md - Sync orchestration → Resolve extensions: resolves sources
src/provisioner/sync.py - Resolve extensions → Generation pipeline: runs discoverers
src/provisioner/generate.py - Generation pipeline → HTTP client: lists accounts
src/provisioner/generate.py - Generation pipeline → Template rendering: renders payloads
src/provisioner/generate.py - Generation pipeline → Source naming: builds names
src/provisioner/generate.py - Generation pipeline → Schedule staggering: computes schedules
src/provisioner/generate.py - Sync orchestration → Plan diff: plans changes
src/provisioner/sync.py - Sync orchestration → HTTP client: reads and applies
src/provisioner/sync.py - Sync orchestration → Run report: records outcomes
src/provisioner/sync.py - Sync orchestration → Structured logging: logs run
src/provisioner/sync.py - HTTP client → API application: calls platform API
README.md - API application → Account routes: mounts routes
api/mock_platform/main.py - API application → Source CRUD routes: mounts routes
api/mock_platform/main.py - API application → SQLite storage: initializes database
api/mock_platform/main.py - API application → Rate limiting: configures limiter
api/mock_platform/main.py - API application → Fault injection: optionally installs
api/mock_platform/main.py - Account routes → Seeded account data: lists accounts
api/mock_platform/routes/accounts.py - Source CRUD routes → Bearer authentication: requires token
api/mock_platform/routes/sources.py - Source CRUD routes → Rate limiting: enforces limits
api/mock_platform/routes/sources.py - Source CRUD routes → SQLite storage: reads and writes
api/mock_platform/routes/sources.py - Source CRUD routes → API data models: uses request models
api/mock_platform/routes/sources.py - Account routes → Bearer authentication: requires token
api/mock_platform/routes/accounts.py - Account routes → Rate limiting: enforces limits
api/mock_platform/routes/accounts.py