Internal Developer Platform¶
Welcome to the IDP MVP documentation. Use the navigation above to explore the platform.
Quick Links¶
Getting Started¶
- Getting Started — 5-minute quickstart for local or AWS
- Local Setup — Run the full platform on your laptop with Kind
- Pre-Deployment Secrets Verification — Read this first! Verify all API keys and credentials before AWS deployment
- AWS Deployment Guide — Complete AWS EKS deployment with pre-flight checklist, known issues, and troubleshooting
Core Concepts¶
- Golden Path — Conventions every service must follow
- Multi-Region (V2) — Active-standby AWS across eu-central-1 + us-east-1, opt-in
- Mobile Platform — 7 mobile golden-path templates (Android, iOS, Flutter, SDK, code signing, app store, device farm)
- Crossplane — Self-serve per-service AWS resources via in-cluster Claims
- Crossplane vs Terraform — Which tool owns what, and why
- CLI Reference —
idpCLI commands, flags, and all 18 test-suite types - Scripts Reference — Every
scripts/*.shscript, grouped by day-0/½
Team Management¶
- Team Management — Onboard a team: namespace, SecretStore, ArgoCD ApplicationSet, Grafana folder, DORA metrics
- GitHub App Setup — Replace PAT with GitHub App for higher rate limits and per-installation scoping
- Scaling Runbook — Small/Medium/Large tiers, scaling signals, implementation status
Engineering Intelligence¶
- Product Vision — What the intelligence layer answers, and for whom
- Architecture — How it is built, and an honest inventory of which data actually exists
- Maturity Model — Ad Hoc → Standardised → Platform Enabled → AI Enabled → Autonomous
- Scoring — The evidence contract: no score without evidence, no number without data
- Integrations — Every collector, its source, and what happens when that source is down
- AI Advisor — What it may say, what it refuses to say, and why
- Roadmap — The thirteen phases and the data blocker on each
Advanced Topics¶
- Contract Testing — Self-describing, self-testing APIs with MCP
- AI Assistant — KAgent AI agents embedded in Backstage
- Agentic Development Platform (ADP) — Agent-driven dev workflow + ops, HiTL approval gate, opt-in via
bootstrap-ai.sh --adp - Agent Approvals — Human-in-the-loop gate for agent-initiated mutating actions: policy, approval API, Backstage UI
- DORA & FinOps — DORA entity tab (Elite/High/Medium/Low badges) + FinOps cost overview with team dimension in Backstage
- Security — Pod Security Standards, OPA/Gatekeeper, RBAC, per-team secret isolation, production hardening
- Flaky-Test Quarantine — How flaky tests get detected (exporter) and acted on (auto quarantine PRs)
- Test-Impact Analysis — Selective test execution on PRs via pytest-testmon (python-service golden path)
Operations¶
- Troubleshooting — Start here when something is broken. Symptom-indexed fixes
- SRE & Reliability — SLOs, burn-rate alerts, PodDisruptionBudgets, rollback, DR failover
- Production Readiness — Pre-production checklist
- AWS Install Failure Modes — What breaks during an EKS bootstrap, and why
- Docker Recovery — Recover Kind cluster after Docker Desktop restarts
- Security Scanning — gitleaks, CodeQL, Trivy, Snyk and how findings are triaged
- Postmortem Template — Blameless incident write-up scaffold
- Runbooks — Operational procedures and on-call guides
Shift-Left Programme¶
- Shift-Left Quality — How the platform embeds testing at scaffold, PR, deploy, and runtime
- Pilot Kickoff — Running the programme with a first team
- Leadership Brief — The case, the metrics, and what to expect
- Demo Cheatsheet — Short script for demoing the quality story
- Demo Runbook — Full end-to-end platform demo walkthrough
Reference¶
- Roadmap — Upcoming features and milestones, tracked as GitHub Project issues
- Architecture — System design and data flow