Control plane installation#

Note

The previous name of the Starburst control plane was Starburst Portal. The control plane is delivered with the name portal in many locations, including the names of the tar.gz archives and in the Helm installation scripts. These are the correct names to use for the current SEP release.

Control plane is a component that you deploy in addition to your SEP clusters. It stores its data in a backend database, and it manages the clusters that you add to it. Control plane runs in one of two modes, managed mode and standalone mode. For the difference, see Deployment modes.

To install control plane, complete the following steps:

  1. Check the requirements in the next section.

  2. Provision the backend database.

  3. Choose the mode. For new installations, use managed mode.

  4. Install control plane with the tar.gz archive or with Helm, and then configure the necessary configuration files.

  5. If you want to resolve secrets at runtime, configure a secrets provider. See Configure a secrets provider.

  6. Connect your clusters. In managed mode, see Connect a cluster to control plane. In standalone mode, see Manage clusters.

Requirements#

Before you install control plane, make sure you have the following:

  • A valid SEP license.

  • A supported backend database. See Backend database.

  • For tar.gz installation: a Linux server with x86_64 or AArch64 architecture.

  • For Helm installation: a Kubernetes cluster with kubectl and Helm.

Backend database#

Control plane requires a backend database for persistence. You must provision and configure the database before you start control plane. Use one of the following databases:

  • MySQL

  • PostgreSQL

  • Oracle

Create a dedicated database and user for control plane.

On startup, control plane automatically initializes your database and runs any required schema migrations.

For the configuration properties, see Configure the backend database.