# Controlplane

> Documentation for Controlplane, version 1.x.
> Every entry links to the page's markdown source.

Repository: https://github.com/xraph/ctrlplane
Site: https://www.xraph.com/docs/ctrlplane

## Pages

- [Go Packages](https://www.xraph.com/docs/ctrlplane/api-reference/go-packages.md): Quick reference for all Ctrl Plane Go packages and their public APIs.
- [HTTP API](https://www.xraph.com/docs/ctrlplane/api-reference/http-api.md): Complete reference for the Ctrl Plane REST API endpoints.
- [Architecture](https://www.xraph.com/docs/ctrlplane/architecture.md): How Ctrl Plane's packages fit together, from providers to the HTTP API.
- [Configuration](https://www.xraph.com/docs/ctrlplane/concepts/configuration.md): Global configuration, the option pattern, and how to customize Ctrl Plane behavior.
- [Entities](https://www.xraph.com/docs/ctrlplane/concepts/entities.md): The base entity type and how domain objects are structured across Ctrl Plane.
- [Error Handling](https://www.xraph.com/docs/ctrlplane/concepts/errors.md): Sentinel errors, wrapping conventions, and how Ctrl Plane surfaces problems.
- [Identity (TypeID)](https://www.xraph.com/docs/ctrlplane/concepts/identity.md): How Ctrl Plane uses prefix-qualified, globally unique identifiers for every entity.
- [Multi-Tenancy](https://www.xraph.com/docs/ctrlplane/concepts/multi-tenancy.md): How Ctrl Plane isolates tenants, enforces quotas, and scopes every operation.
- [Providers](https://www.xraph.com/docs/ctrlplane/concepts/providers.md): The cloud provider abstraction and how Ctrl Plane talks to infrastructure.
- [Getting Started](https://www.xraph.com/docs/ctrlplane/getting-started.md): Install Ctrl Plane, configure a provider, and create your first instance.
- [Writing a Custom Provider](https://www.xraph.com/docs/ctrlplane/guides/custom-provider.md): Implement the Provider interface to connect Ctrl Plane to your infrastructure.
- [Deployment Strategies](https://www.xraph.com/docs/ctrlplane/guides/deploy-strategies.md): How rolling, blue-green, canary, and recreate deployments work in Ctrl Plane.
- [Forge Extension](https://www.xraph.com/docs/ctrlplane/guides/forge-extension.md): Mount Ctrl Plane into a Forge application with shared auth and routing.
- [Full Example](https://www.xraph.com/docs/ctrlplane/guides/full-example.md): Build a complete SaaS management server with Ctrl Plane and Forge.
- [Introduction](https://www.xraph.com/docs/ctrlplane.md): A composable Go library for deploying and managing SaaS instances at scale.
- [AWS ECS/Fargate](https://www.xraph.com/docs/ctrlplane/providers/aws.md): Serverless container hosting on AWS using ECS and Fargate.
- [Docker](https://www.xraph.com/docs/ctrlplane/providers/docker.md): Local and single-host container orchestration using the Docker daemon.
- [Fly.io](https://www.xraph.com/docs/ctrlplane/providers/fly.md): Global edge deployment using Fly.io Machines.
- [Kubernetes](https://www.xraph.com/docs/ctrlplane/providers/kubernetes.md): Production-grade container orchestration using Kubernetes Deployments and Services.
- [HashiCorp Nomad](https://www.xraph.com/docs/ctrlplane/providers/nomad.md): Workload orchestration using HashiCorp Nomad jobs.
- [Badger Store](https://www.xraph.com/docs/ctrlplane/stores/badger.md): Embedded key-value store using BadgerDB for single-node persistence.
- [Memory Store](https://www.xraph.com/docs/ctrlplane/stores/memory.md): In-memory store for development, testing, and prototyping.
- [MongoDB Store](https://www.xraph.com/docs/ctrlplane/stores/mongo.md): Document store using Grove ORM with mongodriver for MongoDB.
- [PostgreSQL Store](https://www.xraph.com/docs/ctrlplane/stores/postgres.md): Production-grade PostgreSQL store using Grove ORM with pgdriver.
- [SQLite Store](https://www.xraph.com/docs/ctrlplane/stores/sqlite.md): Lightweight SQLite backend using Grove ORM with sqlitedriver.
- [Administration](https://www.xraph.com/docs/ctrlplane/subsystems/admin.md): Tenant management, quota enforcement, system statistics, and audit logging.
- [Deployments & Releases](https://www.xraph.com/docs/ctrlplane/subsystems/deployments.md): Push new versions with zero-downtime strategies and roll back to any previous release.
- [Events & Webhooks](https://www.xraph.com/docs/ctrlplane/subsystems/events.md): Publish, subscribe, and deliver lifecycle events across all Ctrl Plane subsystems.
- [Health Checks](https://www.xraph.com/docs/ctrlplane/subsystems/health.md): Configure and run health checks against instances using HTTP, TCP, gRPC, or custom commands.
- [Instances](https://www.xraph.com/docs/ctrlplane/subsystems/instances.md): Instance lifecycle management -- creating, scaling, suspending, and destroying tenant instances.
- [Networking](https://www.xraph.com/docs/ctrlplane/subsystems/network.md): Custom domains, traffic routes, and TLS certificate management for instances.
- [Secrets](https://www.xraph.com/docs/ctrlplane/subsystems/secrets.md): Store, version, and inject secrets into instances with pluggable vault backends.
- [Storage](https://www.xraph.com/docs/ctrlplane/subsystems/store.md): The persistence layer -- in-memory, SQLite, and PostgreSQL store implementations.
- [Telemetry](https://www.xraph.com/docs/ctrlplane/subsystems/telemetry.md): Collect metrics, logs, traces, and resource snapshots from running instances.
- [Background Workers](https://www.xraph.com/docs/ctrlplane/subsystems/workers.md): The worker scheduler and the built-in periodic tasks that keep the system running.