Skip to main content
The Control Plane is the service your Sidecars register with and pull configuration from. You run one per environment.
The Control Plane is an Enterprise feature and requires a license. Talk to us to get one, or use the managed service and skip this page entirely.

​
Before you start

  • A license key.
  • A hostname your Sidecars can reach over HTTPS. Sidecars only ever make outbound requests, so the Control Plane does not need to reach them.
  • A PostgreSQL database. The compose file below brings one up; point POSTGRES_DB_URI at your own instead if you have one.

​
How to deploy it

The mode is chosen by the subcommand: hoop start control-plane rather than hoop start gateway. One image serves both.

Docker Compose

Postgres and the Control Plane on a single host, with an optional Sidecar connected to it. Good for evaluation and for single-host production.

Kubernetes

The Helm chart, on any cloud provider. Bring your own PostgreSQL; publish it with a Service or the Gateway API.

​
After it is running

1

Create the first account

Authentication is local by default — the Control Plane manages users and passwords itself, so you can sign in as soon as it is up.
2

Apply your license

See License Management.
3

Connect your first Sidecar

Issue a token, point a Sidecar at the Control Plane, and confirm it picked up its configuration. See Connect a Sidecar.

​
Keeping it current

Upgrade the Control Plane first, then the Sidecars. A Control Plane at 1.210.0 or later serves each Sidecar only what its version can read, so Sidecars can lag behind it. See Upgrading for the details.

​
Next

Connect a Sidecar

Token, server host, and confirming the handshake.

Environment Variables

Every variable the Control Plane reads.