Configure a secrets provider#

Starburst control plane supports secrets providers that resolve sensitive values at runtime, so that you do not store them as plain text in the configuration.

To activate a secrets provider, put a secrets.toml file in /etc/starburst/. In a Helm installation, use the etcFiles.other map. After a provider is active, reference a secret in a configuration property with the syntax of the provider.

Use a secrets provider with Helm#

The following example reads secrets from environment variables:

etcFiles:
  other:
    secrets.toml: |
      [env]
      secrets-provider.name="env"
  config: |
    persistence.jdbc.password=${ENV:DB_PASSWORD}
    gateway.clusters.encryption.secret=${ENV:CLUSTERS_ENCRYPTION_SECRET}

The ${ENV:...} references read environment variables in the control plane pods. Provide the variables from a Kubernetes secret that you add to the pods with envFrom. See Create configuration secrets.

The following example reads secrets from AWS Secrets Manager:

etcFiles:
  other:
    secrets.toml: |
      [asm]
      secrets-provider.name="asm"
      region="us-east-2"
  config: |
    persistence.jdbc.url=${ASM:myapp/db:url}
    persistence.jdbc.user=${ASM:myapp/db:username}
    persistence.jdbc.password=${ASM:myapp/db:password}

The following example reads secrets from multiple providers simultaneously:

etcFiles:
  other:
    secrets.toml: |
      [asm]
      secrets-provider.name="asm"
      region="us-east-2"

      [env]
      secrets-provider.name="env"

Use a secrets provider with tar.gz#

In a tar.gz installation, create /etc/starburst/secrets.toml. This example reads secrets from environment variables:

[env]
secrets-provider.name="env"

Then reference the variables in /etc/starburst/config.properties:

persistence.jdbc.password=${ENV:DB_PASSWORD}
gateway.clusters.encryption.secret=${ENV:CLUSTERS_ENCRYPTION_SECRET}

Properties that can use a secret#

You can use a reference in the properties of control plane’s config.properties, such as persistence.jdbc.password, gateway.clusters.encryption.secret, and, in managed mode, gateway.clusters.authentication.secret.

On a SEP cluster in managed mode, you cannot use a reference for deployment.mode or deployment.manager.uri. Control plane reads them before secrets are resolved, and the cluster does not start if you do.

Files in catalogs#

A secrets provider resolves secrets. To use a file in a catalog property, such as a truststore, upload the file to control plane, and reference it with ${catalog-file:<name>}. You can use both in one catalog.