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. Both the Kubernetes chart and the AWS stack can provision one for you, so this is only something to arrange if you want to bring your own.

Deployment options

Docker Compose

The fastest way to stand one up. Good for evaluation and for single-host production.

Kubernetes

Helm chart, with the full set of values for ingress, database and TLS.

AWS

A CloudFormation stack that provisions the network, database and service.

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

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

See Updating for the upgrade process. Sidecars and the Control Plane are versioned independently, but keep them within a minor release of each other.

Next

Connect a Sidecar

Token, server host, and confirming the handshake.

Environment Variables

Every variable the service reads.