Configure TLS#

Starburst control plane requires TLS for all authentication methods. Configure TLS using one of the following methods:

  • Direct TLS termination: control plane terminates TLS connections directly.

  • Load balancer termination: A load balancer terminates TLS and forwards traffic to control plane.

Direct TLS termination#

To configure control plane to handle TLS termination directly, add a keystore that contains the server certificate and private key to your configuration.

To use a JKS keystore, set the following properties in your config.properties file:

http-server.https.enabled=true
http-server.https.port=8443
http-server.https.keystore.path=/etc/starburst/keystore.jks
http-server.https.keystore.key=<KEYSTORE_PASSWORD>

To use a PEM-encoded certificate file, set the following properties in your config.properties file:

http-server.https.enabled=true
http-server.https.port=8443
http-server.https.keystore.path=/etc/starburst/server.pem
http-server.https.keystore.key=

Load balancer termination#

To configure control plane to accept forwarded traffic from a load balancer, set the following properties in your config.properties file:

http-server.http.port=8080
http-server.process-forwarded=true

When you enable http-server.process-forwarded, control plane uses X-Forwarded-* headers from the load balancer to construct correct redirect URLs and identify the original client.

Important

  • Only enable http-server.process-forwarded when control plane is behind a trusted load balancer.

  • Make sure that the load balancer sets the appropriate X-Forwarded-* headers.

  • Secure the network between the load balancer and control plane.

TLS configuration properties#

Property

Description

Default

http-server.https.enabled

Enables HTTPS.

false

http-server.https.port

The HTTPS port.

8443

http-server.https.keystore.path

The path to the keystore file (JKS) or PEM certificate file.

None

http-server.https.keystore.key

The password for the keystore. Use an empty string for PEM files without a password.

None

http-server.http.port

The HTTP port.

8080

http-server.process-forwarded

Enables trust of X-Forwarded-* headers from a load balancer. Only enable when control plane is behind a trusted load balancer.

false