Managing Secrets¶

Lightrun requires various secrets for authentication, database access, message queues, and integrations. These secrets are managed under secrets and can either be deployed as part of this chart or managed externally.

Secrets Deployment Options¶

If deploy_secrets: true, the Helm chart will create and manage secrets.
If deploy_secrets: false, secrets must be pre-created in Kubernetes. The chart will look for an existing secret named:
```
{{ .Release.name }}-backend
```
To use a custom secret name, set:
```
general:
  deploy_secrets:
    existing_secrets:
      backend: ""
      keycloak: ""
```
Note that this is only relevant when deploy_secrets: false.

[!WARNING] When managing secrets externally, ensure all required fields are present. See the secrets template for reference.

(This is relevant only when deploy_secrets: false.)

Mandatory Secret Fields¶

When managing secrets externally, ensure the following fields are present in your secret (See the secrets template for reference):

Environment Variable	Description	Value Source
`SPRING_SECURITY_KEYCLOAK_CLI_PASSWORD`	Keycloak admin password	`secrets.keycloak.password`
`SPRING_MAIL_PASSWORD`	Mail server password	`secrets.defaults.mail_password`
`SPRING_FLYWAY_PASSWORD`	DB password	`secrets.db.password`
`SPRING_FLYWAY_USER`	DB user	`secrets.db.user`
`SPRING_DATASOURCE_USERNAME`	DB username	`secrets.db.user`
`SPRING_DATASOURCE_PASSWORD`	DB password	`secrets.db.password`
`KEYSTORE_PASSWORD`	Java Keystore password	`secrets.defaults.keystore_password`
`LICENSE_CONTENT`	Lightrun license content	`secrets.license.content`
`LICENSE_SIGNATURE`	Lightrun license signature	`secrets.license.signature`
`SPRING_RABBITMQ_USERNAME`	RabbitMQ username	`secrets.mq.user`
`SPRING_RABBITMQ_PASSWORD`	RabbitMQ password	`secrets.mq.password`
`encryption-key-0`	Backend encryption key (default)	`secrets.keysEncryption.userEncryptionKey`

[!WARNING] For encryption keys, it's strongly recommended to provide them as external secrets rather than letting the chart manage them. See Encryption Keys Documentation for details.

Secrets Configuration¶

Authentication and Access Secrets¶

These secrets store authentication credentials for essential services.

secrets:
  keycloak:
    password: ""  # Keycloak admin password

  db:
    user: ""      # Database username
    password: ""  # Database password

  mq:
    user: ""      # Message queue username
    password: ""  # Message queue password

  redis:
    password: ""  # Redis authentication password

Note: Redis authentication requires deployments.redis.auth.enabled: true.

License¶

Lightrun requires specific secrets for licensing.

  license:
    content: ""    # Lightrun license file content
    signature: ""  # License signature

Integration and Default Credentials¶

Some secrets are used for integrating with external services.

  defaults:
    mail_password: ""  # Password for mail server authentication
    keystore_password: ""  # Java Keystore password

    google_sso:
      client_id: ""      # (Optional) Google SSO Client ID
      client_secret: ""  # (Optional) Google SSO Client Secret

    datadog_api_key: ""  # (Optional) API key for Datadog integration
    mixpanel_token: ""   # (Optional) Token for Mixpanel analytics

Optional fields: If left empty, these values will not be included in the Kubernetes secret.

Container Image Registry Credentials¶

  dockerhub_config:
    existingSecret: ""  # Use an existing secret if provided
    configContent: ""   # Create a new secret if `existingSecret` is empty

Refer to Container Image Registry Overview for a detailed explanation of how to configure dockerhub_config.

Last update: June 11, 2025