bitnamicharts/mysql
Bitnami Helm chart for MySQL
1M+
MySQL is a fast, reliable, scalable, and easy to use open source relational database system. Designed to handle mission-critical, heavy-load production applications.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/mysql
Looking to use MySQL in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
This chart bootstraps a MySQL replication cluster deployment on a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/mysql
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
These commands deploy MySQL on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
This chart can be integrated with Prometheus by setting metrics.enabled
to true
. This will deploy a sidecar container with mysqld_exporter in all pods and will expose it via the MariaDB service. This service will have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true
. Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
To modify the application version used in this chart, specify a different version of the image using the image.tag
parameter and/or a different repository using the image.repository
parameter.
The Bitnami MySQL image allows you to use your custom scripts to initialize a fresh instance. Custom scripts may be specified using the initdbScripts
parameter. Alternatively, an external ConfigMap may be created with all the initialization scripts and the ConfigMap passed to the chart via the initdbScriptsConfigMap
parameter. Note that this will override the initdbScripts
parameter.
The allowed extensions are .sh
, .sql
and .sql.gz
.
These scripts are treated differently depending on their extension. While .sh
scripts are executed on all the nodes, .sql
and .sql.gz
scripts are only executed on the primary nodes. This is because .sh
scripts support conditional tests to identify the type of node they are running on, while such tests are not supported in .sql
or sql.gz
files.
When using a .sh
script, you may wish to perform a "one-time" action like creating a database. This can be achieved by adding a condition in the script to ensure that it is executed only on one node, as shown in the example below:
initdbScripts:
my_init_script.sh: |
#!/bin/bash
if [[ $(hostname) == *primary* ]]; then
echo "Primary node"
password_aux="${MYSQL_ROOT_PASSWORD:-}"
if [[ -f "${MYSQL_ROOT_PASSWORD_FILE:-}" ]]; then
password_aux=$(cat "$MYSQL_ROOT_PASSWORD_FILE")
fi
mysql -P 3306 -uroot -p"$password_aux" -e "create database new_database";
else
echo "Secondary node"
fi
If you have a need for additional containers to run within the same pod as MySQL, you can do so via the sidecars
config parameter. Simply define your container according to the Kubernetes container spec.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Similarly, you can add extra init containers using the initContainers
parameter.
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
This chart supports encrypting communications using TLS. To enable this feature, set the tls.enabled
.
It is necessary to create a secret containing the TLS certificates and pass it to the chart via the tls.existingSecret
parameter. Every secret should contain a tls.crt
and tls.key
keys including the certificate and key files respectively and, optionally, a ca.crt
key including the CA certificate. For example: create the secret with the certificates files:
kubectl create secret generic tls-secret --from-file=./tls.crt --from-file=./tls.key --from-file=./ca.crt
You can manually create the required TLS certificates or relying on the chart auto-generation capabilities. The chart supports two different ways to auto-generate the required certificates:
tls.autoGenerated.enabled
to true
and tls.autoGenerated.engine
to helm
.tls.autoGenerated.enabled
to true
and tls.autoGenerated.engine
to cert-manager
. Please note it's supported to use an existing Issuer/ClusterIssuer for issuing the TLS certificates by setting the tls.autoGenerated.certManager.existingIssuer
and tls.autoGenerated.certManager.existingIssuerKind
parameters.Bitnami charts, with its default settings, configure credentials at first boot. Any further change in the secrets or credentials can be done using one of the following methods:
Manual update of the passwords and secrets
kubectl create secret generic SECRET_NAME --from-literal=password=PASSWORD --from-literal=root-password=ROOT_PASSWORD --dry-run -o yaml | kubectl apply -f -
Automated update using a password update job
The Bitnami MySQL provides a password update job that will automatically change the MySQL passwords when running helm upgrade. To enable the job set passwordUpdateJob.enabled=true
. This job requires:
auth.rootPassword
, auth.password
and auth.replicationPassword
(if applicable) or setting auth.existingSecret
.auth.existingSecret
or helm template
instead of helm upgrade
, then set either passwordUpdate.job.previousPasswords.rootPassword
, passwordUpdate.job.previousPasswords.password
, passwordUpdate.job.previousPasswords.replicationPassword
(when applicable), setting auth.existingSecret
.In the following example we update the password via values.yaml in a mysql installation with replication
architecture: "replication"
auth:
user: "user"
rootPassword: "newRootPassword123"
password: "newUserPassword123"
replicationPassword: "newReplicationPassword123"
passwordUpdateJob:
enabled: true
In this example we use two existing secrets (new-password-secret
and previous-password-secret
) to update the passwords:
auth:
existingSecret: new-password-secret
passwordUpdateJob:
enabled: true
previousPasswords:
existingSecret: previous-password-secret
You can add extra update commands using the passwordUpdateJob.extraCommands
value.
To enable network policy for MySQL, install a networking plugin that implements the Kubernetes NetworkPolicy spec, and set networkPolicy.enabled
to true
.
For Kubernetes v1.5 & v1.6, you must also turn on NetworkPolicy by setting the DefaultDeny namespace annotation. Note: this will enforce policy for all pods in the namespace:
kubectl annotate namespace default "net.beta.kubernetes.io/network-policy={\"ingress\":{\"isolation\":\"DefaultDeny\"}}"
With NetworkPolicy enabled, traffic will be limited to just port 3306.
For more precise policy, set networkPolicy.allowExternal=false
. This will only allow pods with the generated client label to connect to MySQL.
This label will be displayed in the output of a successful install.
This chart allows you to set your custom affinity using the XXX.affinity
parameter(s). Find more information about Pod affinity in the Kubernetes documentation.
As an alternative, you can use the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the XXX.podAffinityPreset
, XXX.podAntiAffinityPreset
, or XXX.nodeAffinityPreset
parameters.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
The Bitnami MySQL image stores the MySQL data and configurations at the /bitnami/mysql
path of the container.
The chart mounts a Persistent Volume volume at this location. The volume is created using dynamic volume provisioning by default. An existing PersistentVolumeClaim can also be defined for this purpose.
If you encounter errors when working with persistent volumes, refer to our troubleshooting guide for persistent volumes.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Force target Kubernetes version (using Helm capabilities if not set) | "" |
nameOverride | String to partially override common.names.fullname template (will maintain the release name) | "" |
fullnameOverride | String to fully override common.names.fullname template | "" |
namespaceOverride | String to fully override common.names.namespace | "" |
clusterDomain | Cluster domain | cluster.local |
commonAnnotations | Common annotations to add to all MySQL resources (sub-charts are not considered). Evaluated as a template | {} |
commonLabels | Common labels to add to all MySQL resources (sub-charts are not considered). Evaluated as a template | {} |
extraDeploy | Array with extra yaml to deploy with the chart. Evaluated as a template | [] |
serviceBindings.enabled | Create secret for service binding (Experimental) | false |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployment | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployment | ["infinity"] |
Name | Description | Value |
---|---|---|
image.registry | MySQL image registry | REGISTRY_NAME |
image.repository | MySQL image repository | REPOSITORY_NAME/mysql |
image.digest | MySQL image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy | MySQL image pull policy | IfNotPresent |
image.pullSecrets | Specify docker-registry secret names as an array | [] |
image.debug | Specify if debug logs should be enabled | false |
architecture | MySQL architecture (standalone or replication ) | standalone |
auth.rootPassword | Password for the root user. Ignored if existing secret is provided | "" |
auth.createDatabase | Whether to create the .Values.auth.database or not | true |
auth.database | Name for a custom database to create | my_database |
auth.username | Name for a custom user to create | "" |
auth.password | Password for the new user. Ignored if existing secret is provided | "" |
auth.replicationUser | MySQL replication user | replicator |
auth.replicationPassword | MySQL replication user password. Ignored if existing secret is provided | "" |
auth.existingSecret | Use existing secret for password details. The secret has to contain the keys mysql-root-password , mysql-replication-password and mysql-password | "" |
auth.usePasswordFiles | Mount credentials as files instead of using an environment variable | false |
auth.customPasswordFiles | Use custom password files when auth.usePasswordFiles is set to true . Define path for keys root and user , also define replicator if architecture is set to replication | {} |
auth.authenticationPolicy | Sets the authentication policy, by default it will use * ,, | "" |
initdbScripts | Dictionary of initdb scripts | {} |
initdbScriptsConfigMap | ConfigMap with the initdb scripts (Note: Overrides initdbScripts ) | "" |
startdbScripts | Dictionary of startdb scripts | {} |
startdbScriptsConfigMap | ConfigMap with the startdb |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/mysql/README.md