README
¶
SuperPlane
SuperPlane is an open source DevOps control plane for defining and running operational workflows across the tools you already use (CI/CD, release management, incident response, notifications, etc.).
SuperPlane is currently self-hosted only. A hosted version is not available today. You can sign up for updates on our website.
Project status
This project is new and moving quickly. Expect rough edges and occasional breaking changes while we stabilize the core model and integrations. If you try it and hit something confusing, please open an issue. Early feedback is extremely valuable.
What it does
- Workflow orchestration: Model multi-step operational workflows that span multiple systems.
- Event-driven automation: Trigger workflows from pushes, deploy events, alerts, schedules, and webhooks.
- Control plane UI: Design and manage DevOps processes; inspect runs, status, and history in a single place.
- Shared operational context: Keep workflow definitions and operational intent in one system instead of scattered scripts.
Example use cases
A few concrete things teams build with SuperPlane:
- Policy-gated production deploy: when CI finishes green, hold outside business hours, require on-call + product approval, then trigger the deploy.
- Progressive delivery (10% → 30% → 60% → 100%): deploy in waves, wait/verify at each step, and rollback on failure with an approval gate.
- Release train with a multi-repo ship set: wait for tags/builds from a set of services, fan-in once all are ready, then dispatch a coordinated deploy.
- “First 5 minutes” incident triage: on incident created, fetch context in parallel (recent deploys + health signals), generate an evidence pack, and open an issue.
Quick start
Run the latest demo container:
docker pull ghcr.io/superplanehq/superplane-demo:stable
docker run --rm -p 3000:3000 -v spdata:/app/data -ti ghcr.io/superplanehq/superplane-demo:stable
Then open http://localhost:3000.
Production installation
You can deploy SuperPlane on a single host or on Kubernetes:
- Single Host Installation - Deploy on AWS EC2, GCP Compute Engine, or other cloud providers
- Kubernetes Installation - Deploy on GKE, EKS, or any Kubernetes cluster
Contributing
We welcome your bug reports, ideas for improvement, and focused PRs.
- Read the Contributing Guide to get started.
- Issues: use GitHub issues for bugs and feature requests.
License
Apache License 2.0. See LICENSE.
Community
- Discord - Join our community for discussions, questions, and collaboration
- X - Follow us for updates and announcements
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cli
command
|
|
|
server
command
|
|
|
pkg
|
|
|
protos/applications
Package applications is a reverse proxy.
|
Package applications is a reverse proxy. |
|
protos/blueprints
Package blueprints is a reverse proxy.
|
Package blueprints is a reverse proxy. |
|
protos/components
Package components is a reverse proxy.
|
Package components is a reverse proxy. |
|
protos/groups
Package groups is a reverse proxy.
|
Package groups is a reverse proxy. |
|
protos/me
Package me is a reverse proxy.
|
Package me is a reverse proxy. |
|
protos/organizations
Package organizations is a reverse proxy.
|
Package organizations is a reverse proxy. |
|
protos/roles
Package roles is a reverse proxy.
|
Package roles is a reverse proxy. |
|
protos/secrets
Package secrets is a reverse proxy.
|
Package secrets is a reverse proxy. |
|
protos/triggers
Package triggers is a reverse proxy.
|
Package triggers is a reverse proxy. |
|
protos/users
Package users is a reverse proxy.
|
Package users is a reverse proxy. |
|
protos/widgets
Package widgets is a reverse proxy.
|
Package widgets is a reverse proxy. |
|
protos/workflows
Package workflows is a reverse proxy.
|
Package workflows is a reverse proxy. |
|
retry
Package retry holds a helper function for retrying a task.
|
Package retry holds a helper function for retrying a task. |
|
test
|
|