MySQL¶

This page describes how to configure MySQL as the database. The following methods are supported:
- Deploy a Local MySQL (general.db_local true).
- Connect to an External MySQL (general.db_local false).

[!Note] To enable SSL for both local and external MySQL instances, set general.db_require_secure_transport: true, which enforces secure connections by passing require_secure_transport=ON to the MySQL pod (db_local=true) and configuring backend services, including Keycloak, to use SSL when connecting to the database.

External MySQL (general.db_local: false)¶

In this mode, MySQL is not deployed inside the cluster.
Instead, the application connects to an existing MySQL database.

Required MySQL Server Configuration¶

Before using an external MySQL database, you MUST configure the following server settings and create the database:

Pre-created Database Requirement:
The target MySQL database must be created in advance and should match the value of general.db_database. The application will not create the database automatically. Example command to create the database:

CREATE DATABASE lightrunserver;

[MANDATORY] External Database Requirements¶

• MySQL Version: >= 8.0.34
• Database Size: Minimum requirements are 2vCPU with 8GB memory & 100GB disk. Specific size according to planned capacity should be coordinated with Lightrun support engineer.
• Database Engine: Must be MySQL (MySQL-compatible databases like Aurora are NOT supported).

[OPTIONAL] High Availability (HA) Recommendations¶

While not required, the following HA settings are recommended for production:

• -Primary-Standby Deployment for redundancy
• Source-Replica Replication (not cluster mode)
• No Cluster Mode (Avoid Galera, InnoDB Cluster, etc.)

Helm Chart Configuration¶

general:
  db_local: false
  db_endpoint: "mysql.external.example.com"
  db_database: lightrunserver

Local MySQL (general.db_local: true)¶

In this mode, MySQL is deployed inside the cluster using either:

A StatefulSet with persistent storage (Recommended)
A Deployment with ephemeral storage (for testing purposes)

HA is not supported for MySql in local mode

Basic Configuration¶

general:
  db_local: true
  db_database: lightrunserver
  db_require_secure_transport: false

Option 1: Persistent Storage (StatefulSet Enabled)¶

• Uses PersistentVolumeClaim (PVC)
• Data is retained across restarts

  general:
    statefulset:
      enabled: true
      storageClassName: "gp3"
      storageSize: 100Gi
  

Option 2: Ephemeral Storage (StatefulSet Disabled)¶

⚠️ Recommended for testing only! - Uses emptyDir (non-persistent storage) - Data is lost if the pod restarts

general:
  statefulset:
    enabled: false
deployments:
  mysql:
    emptyDir:
      sizeLimit: 5Gi

Pod Configuration¶

This is the default MySQL pod configuration. Configuration is defined under deployments.mysql in the values.yaml file.

deployments:
  mysql:
    nodeSelector: {}
    podSecurityContext:
      # When using a PVC, it is necessary to set fsGroup to ensure the pod has write permissions to the mounted volume.
      # The fsGroup should be aligned with the runAsUser of the container.
      fsGroup: 1000000
    containerSecurityContext: {}
    image:
      repository: mysql
      tag: 8.0.38
      pullPolicy: IfNotPresent
    resources:
      cpu: 2000m
      memory: 8Gi
    podLabels: {}
    podAnnotations: {}
    annotations: {} # deprecated in favor of podAnnotations
    service:
      annotations: {}
      labels: {}
    # In case of db_local=true and statefulset.enabled=false
    # non-persistent emptyDir is used for mysql data
    emptyDir:
      sizeLimit: 5Gi
    affinity: {}
    livenessProbe:
      initialDelaySeconds: 200
      periodSeconds: 30
      timeoutSeconds: 10
      successThreshold: 1
      failureThreshold: 3
    readinessProbe:
      initialDelaySeconds: 5
      periodSeconds: 2
      timeoutSeconds: 1
      successThreshold: 1
      failureThreshold: 3

Example Configurations¶

1️) Deploy a Local MySQL Instance with Persistent Storage¶

general:
  db_local: true
  db_database: lightrunserver
  statefulset:
    enabled: true
    storageClassName: "gp3"
    storageSize: "100Gi"

2️) Deploy a Local MySQL Instance with Ephemeral Storage (Testing Mode)¶

general:
  db_local: true
  statefulset:
    enabled: false
  deployments:
    mysql:
      emptyDir:
        sizeLimit: 5Gi

3️) Connect to an External MySQL Instance¶

general:
  db_local: false
  db_endpoint: "mysql.external.example.com"
  db_database: lightrunserver