MariaDB Galera is a multi-master database cluster solution for synchronous replication and high availability.
https://mariadb.com/kb/en/library/galera-cluster/
$ docker run --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
bitnami/mariadb-galera:latest
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-mariadb-galera/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
- Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
- With Bitnami images the latest bug fixes and features are available as soon as possible.
- Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
- All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.
- All Bitnami images available in Docker Hub are signed with Docker Content Trust (DTC). You can use
DOCKER_CONTENT_TRUST=1
to verify the integrity of the images. - Bitnami container images are released daily with the latest distribution packages available.
This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami MariaDB Galera Chart GitHub repository.
Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
NOTE: Debian 9 and Oracle Linux 7 images have been deprecated in favor of Debian 10 images. Bitnami will not longer publish new Docker images based on Debian 9 or Oracle Linux 7.
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
10.5-debian-10
,10.5.4-debian-10-r7
,10.5
,10.5.4
,latest
(10.5/debian-10/Dockerfile)10.4-debian-10
,10.4.13-debian-10-r32
,10.4
,10.4.13
(10.4/debian-10/Dockerfile)10.3-debian-10
,10.3.23-debian-10-r64
,10.3
,10.3.23
(10.3/debian-10/Dockerfile)10.2-debian-10
,10.2.32-debian-10-r64
,10.2
,10.2.32
(10.2/debian-10/Dockerfile)10.1-debian-10
,10.1.45-debian-10-r65
,10.1
,10.1.45
(10.1/debian-10/Dockerfile)
Subscribe to project updates by watching the bitnami/mariadb-galera GitHub repo.
The recommended way to get the Bitnami MariaDB Galera Docker Image is to pull the prebuilt image from the Docker Hub Registry.
$ docker pull bitnami/mariadb-galera:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
$ docker pull bitnami/mariadb-galera:[TAG]
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build
command. Remember to replace the VERSION
and OPERATING-SYSTEM
path placeholders in the example command below with the correct values.
$ git clone https://github.com/bitnami/bitnami-docker-mariadb-galera.git
$ cd bitnami-docker-mariadb/VERSION/OPERATING-SYSTEM
$ docker build -t bitnami/mariadb-galera:latest .
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
For persistence you should mount a directory at the /bitnami/mariadb
path. If the mounted directory is empty, it will be initialized on the first run.
$ docker run \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/mariadb-persistence:/bitnami/mariadb \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
volumes:
- /path/to/mariadb-persistence:/bitnami/mariadb
...
Using Docker container networking, a MariaDB server running inside a container can easily be accessed by your application containers.
Containers attached to the same network can communicate with each other using the container name as the hostname.
In this example, we will create a MariaDB client instance that will connect to the server instance that is running on the same docker network as the client.
$ docker network create app-tier --driver bridge
Use the --network app-tier
argument to the docker run
command to attach the MariaDB container to the app-tier
network.
$ docker run -d --name mariadb-galera \
-e ALLOW_EMPTY_PASSWORD=yes \
--network app-tier \
bitnami/mariadb-galera:latest
Finally we create a new container instance to launch the MariaDB client and connect to the server created in the previous step:
$ docker run -it --rm \
--network app-tier \
bitnami/mariadb-galera:latest mysql -h mariadb-galera -u root
When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge
network named app-tier
. In this example we assume that you want to connect to the MariaDB server from your own custom application image which is identified in the following snippet by the service name myapp
.
version: '2'
networks:
app-tier:
driver: bridge
services:
mariadb-galera:
image: 'bitnami/mariadb-galera:latest'
environment:
- ALLOW_EMPTY_PASSWORD=yes
networks:
- app-tier
myapp:
image: 'YOUR_APPLICATION_IMAGE'
networks:
- app-tier
IMPORTANT:
- Please update the
YOUR_APPLICATION_IMAGE
placeholder in the above snippet with your application image- In your application container, use the hostname
mariadb
to connect to the MariaDB server
Launch the containers using:
$ docker-compose up -d
When the container is executed for the first time, it will execute the files with extensions .sh
, .sql
and .sql.gz
located at /docker-entrypoint-initdb.d
.
In order to have your custom files inside the docker image you can mount them as a volume.
Passing extra command-line flags to the mysqld service command is possible through the following env var:
MARIADB_EXTRA_FLAGS
: Flags to be appended to the startup command. No defaults
$ docker run --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
-e MARIADB_EXTRA_FLAGS='--max-connect-errors=1000 --max_connections=155' \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
environment:
- MARIADB_EXTRA_FLAGS=--max-connect-errors=1000 --max_connections=155
...
It is possible to configure the character set and collation used by default by the database with the following environment variables:
MARIADB_CHARACTER_SET
: The default character set to use. Default:utf8
MARIADB_COLLATE
: The default collation to use. Default:utf8_general_ci
The root user and password can easily be setup with the Bitnami MariaDB Galera Docker image using the following environment variables:
MARIADB_ROOT_USER
: The database admin user. Defaults toroot
.MARIADB_ROOT_PASSWORD
: The database admin user password. No defaults.
Passing the MARIADB_ROOT_PASSWORD
environment variable when running the image for the first time will set the password of the MARIADB_ROOT_USER
user to the value of MARIADB_ROOT_PASSWORD
.
$ docker run --name mariadb \
-e MARIADB_ROOT_PASSWORD=password123 \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
environment:
- MARIADB_ROOT_PASSWORD=password123
...
Warning The MARIADB_ROOT_USER
user is always created with remote access. It's suggested that the MARIADB_ROOT_PASSWORD
env variable is always specified to set a password for the MARIADB_ROOT_USER
user. In case you want to allow the MARIADB_ROOT_USER
user to access the database without a password set the environment variable ALLOW_EMPTY_PASSWORD=yes
. This is suggested only for development or testing environments.
By default the MariaDB Galera image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the ALLOW_EMPTY_PASSWORD=yes
env variable. This env variable is only suggested for testing or development purposes. We strongly recommend specifying the MARIADB_ROOT_PASSWORD
for any other scenario.
$ docker run --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
environment:
- ALLOW_EMPTY_PASSWORD=yes
...
By passing the MARIADB_DATABASE
environment variable when running the image for the first time, a database will be created. This is useful if your application requires that a database already exists, saving you from having to manually create the database using the MySQL client.
$ docker run --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
-e MARIADB_DATABASE=my_database \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
environment:
- ALLOW_EMPTY_PASSWORD=yes
- MARIADB_DATABASE=my_database
...
You can create a restricted database user that only has permissions for the database created with the MARIADB_DATABASE
environment variable. To do this, provide the MARIADB_USER
environment variable and to set a password for the database user provide the MARIADB_PASSWORD
variable.
$ docker run --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
-e MARIADB_USER=my_user \
-e MARIADB_PASSWORD=my_password \
-e MARIADB_DATABASE=my_database \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
environment:
- ALLOW_EMPTY_PASSWORD=yes
- MARIADB_USER=my_user
- MARIADB_PASSWORD=my_password
- MARIADB_DATABASE=my_database
...
Note! The root
user will be created with remote access and without a password if ALLOW_EMPTY_PASSWORD
is enabled. Please provide the MARIADB_ROOT_PASSWORD
env variable instead if you want to set a password for the root
user.
LDAP configuration parameters must be specified if you wish to enable LDAP support for your MariaDB Galera cluster. The following environment variables are available to configure LDAP support:
MARIADB_ENABLE_LDAP
: Whether to enable LDAP authentication. Defaults tono
.LDAP_URI
: LDAP URL beginning in the formldap[s]:/<hostname>:<port>
. No defaults.LDAP_BASE
: LDAP base DN. No defaults.LDAP_BIND_DN
: LDAP bind DN. No defaults.LDAP_BIND_PASSWORD
: LDAP bind password. No defaults.LDAP_BASE_LOOKUP
: LDAP base lookup (Optional). No defaults.LDAP_NSS_INITGROUPS_IGNOREUSERS
: LDAP ignored users. Defaults toroot,nslcd
.LDAP_SCOPE
: LDAP search scope (Optional). No defaults.LDAP_TLS_REQCERT
: LDAP TLS check on server certificates (Optional). No defaults.
$ docker run --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
-e MARIADB_ENABLE_LDAP=yes \
-e LDAP_URI=ldap://ldap.example.org/ \
-e LDAP_BASE=dc=example,dc=org \
-e LDAP_BIND_DN=cn=admin,dc=example,dc=org \
-e LDAP_BIND_PASSWORD=admin \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
environment:
- MARIADB_ENABLE_LDAP=yes
- LDAP_URI=ldap://ldap.example.org/
- LDAP_BASE=dc=example,dc=org
- LDAP_BIND_DN=cn=admin,dc=example,dc=org
- LDAP_BIND_PASSWORD=admin
...
Note: The LDAP connection parameters can be fine tuned by specifying the LDAP_BASE_LOOKUP
, LDAP_SCOPE
and LDAP_TLS_REQCERT
environment variables.
Login to the MariaDB server using the root
credentials and configure the LDAP users you wish to have access to the MariaDB Galera cluster.
$ mysql -uroot -e "CREATE USER 'foo'@'localhost' IDENTIFIED VIA pam USING 'mariadb';"
The above command configures the database user foo
to authenticate itself with the LDAP credentials to log in to MariaDB Galera server.
Refer to the OpenLDAP Administrator's Guide to learn more about LDAP.
To secure the traffic you must mount the certificates files and set the following environment variables in all the cluster members:
MARIADB_ENABLE_TLS
: Whether to enable TLS for traffic. Defaults tono
.MARIADB_TLS_CERT_FILE
: File containing the certificate file for the TSL traffic. No defaults.MARIADB_TLS_KEY_FILE
: File containing the key for certificate. No defaults.MARIADB_TLS_CA_FILE
: File containing the CA of the certificate. No defaults.
$ docker run --name mariadb \
-v /path/to/cert.pem:/bitnami/mariadb/certs/cert.pem:ro
-v /path/to/key.pem:/bitnami/mariadb/certs/key.pem:ro
-v /path/to/ca.pem:/bitnami/mariadb/certs/ca.pem:ro
-e ALLOW_EMPTY_PASSWORD=yes \
-e MARIADB_ENABLE_SSL=yes \
-e MARIADB_TLS_CERT_FILE=/bitnami/mariadb/certs/cert.pem \
-e MARIADB_TLS_KEY_FILE=/bitnami/mariadb/certs/key.pem \
-e MARIADB_TLS_CA_FILE=/bitnami/mariadb/certs/ca.pem \
bitnami/mariadb-galera:latest
To connect to the server using TLS you need to mount the CA certificate file and start the client using the --ssl-ca
parameter
$ docker run -it --rm \
-v /path/to/ca.pem:/bitnami/mariadb/certs/ca.pem:ro \
--network app-tier \
bitnami/mariadb-galera:latest mysql -h mariadb-galera -u root --ssl-ca=/bitnami/mariadb/certs/ca.pem
A zero downtime MariaDB Galera replication cluster can easily be setup with the Bitnami MariaDB Galera Docker image by starting additional MariaDB Galera nodes. The following environment variables are available to configure the cluster:
MARIADB_GALERA_CLUSTER_BOOTSTRAP
: Whether node is first node of the cluster. No defaults.MARIADB_GALERA_CLUSTER_NAME
: Galera cluster name. Default togalera
.MARIADB_GALERA_CLUSTER_ADDRESS
: Galera cluster address to join. Defaults togcomm://
on a bootstrap node.MARIADB_GALERA_NODE_ADDRESS
: Node address to report to the Galera cluster. Defaults to eth0 address inside container.MARIADB_GALERA_MARIABACKUP_USER
: mariabackup username for State Snapshot Transfer(SST). Defaults tomariabackup
.MARIADB_GALERA_MARIABACKUP_PASSWORD
: mariabackup password for SST. No defaults.
In a MariaDB Galera cluster the first node should be a bootstrap node (started with MARIADB_GALERA_CLUSTER_BOOTSTRAP=yes
). The other nodes in the cluster should not be started with this environment variable, instead the MARIADB_GALERA_CLUSTER_ADDRESS
variable should be specified. All the nodes in the MariaDB Galera cluster are in read-write mode and therefore offers high availability for high traffic applications.
The first step is to start the MariaDB Galera bootstrap node.
$ docker run -d --name mariadb-galera-0 \
-e MARIADB_GALERA_CLUSTER_NAME=my_galera \
-e MARIADB_GALERA_MARIABACKUP_USER=my_mariabackup_user \
-e MARIADB_GALERA_MARIABACKUP_PASSWORD=my_mariabackup_password \
-e MARIADB_ROOT_PASSWORD=my_root_password \
-e MARIADB_USER=my_user \
-e MARIADB_PASSWORD=my_password \
-e MARIADB_DATABASE=my_database \
bitnami/mariadb-galera:latest
In the above command the container is configured as the bootstrap node by specifying the MARIADB_GALERA_CLUSTER_BOOTSTRAP
parameter. The SST user is specified using the MARIADB_GALERA_MARIABACKUP_USER
and MARIADB_GALERA_MARIABACKUP_PASSWORD
parameters and a cluster name is specified using the MARIADB_GALERA_CLUSTER_NAME
parameter.
Next we add a new node to the cluster.
$ docker run -d --name mariadb-galera-1 --link mariadb-galera-0:mariadb-galera \
-e MARIADB_GALERA_CLUSTER_NAME=my_galera \
-e MARIADB_GALERA_CLUSTER_ADDRESS=gcomm://mariadb-galera:4567,0.0.0.0:4567 \
-e MARIADB_GALERA_MARIABACKUP_USER=my_mariabackup_user \
-e MARIADB_GALERA_MARIABACKUP_PASSWORD=my_mariabackup_password \
-e MARIADB_ROOT_PASSWORD=my_root_password \
bitnami/mariadb-galera:latest
In the above command a new node is created and configured to join the bootstrapped MariaDB Galera cluster by specifying the MARIADB_GALERA_CLUSTER_ADDRESS
parameter. The MARIADB_GALERA_CLUSTER_NAME
, MARIADB_GALERA_MARIABACKUP_USER
and MARIADB_GALERA_MARIABACKUP_PASSWORD
are also specified for the Snapshot State Transfer (SST).
You now have a two node MariaDB Galera cluster up and running. Write to any node of the cluster are automatically propagated to every node. You can scale the cluster by adding/removing slaves without incurring any downtime.
Important: If you need to stop the MariaDB Galera cluster, ensure you stop the bootstrap node only after you have stopped all other nodes in the cluster. This ensure you do not loose any write that may have occurred while the nodes were being stopped.
In some platforms, the filesystem used for persistence could be slow. That could cause the database to take extra time to be ready. If that's the case, you can configure the MARIADB_INIT_SLEEP_TIME
environment variable to make the initialization script to wait extra time (in seconds) before proceeding with the configuration operations.
The image looks for user-defined configurations in /opt/bitnami/mariadb/conf/my_custom.cnf
. Create a file named my_custom.cnf
and mount it at /opt/bitnami/mariadb/conf/my_custom.cnf
.
For example, in order to override the max_allowed_packet
directive:
[mysqld]
max_allowed_packet=32M
$ docker run --name mariadb \
-p 3306:3306 \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/my_custom.cnf:/opt/bitnami/mariadb/conf/my_custom.cnf:ro \
-v /path/to/mariadb-persistence:/bitnami/mariadb \
bitnami/mariadb-galera:latest
or by modifying the docker-compose.yml
file present in this repository:
services:
mariadb:
...
volumes:
- /path/to/my_custom.cnf:/opt/bitnami/mariadb/conf/my_custom.cnf:ro
- /path/to/mariadb-persistence:/bitnami/mariadb
...
After that, your changes will be taken into account in the server's behaviour.
Refer to the MySQL server option and variable reference guide for the complete list of configuration options.
It is also possible to use your custom my.cnf
and overwrite the main configuration file.
$ docker run --name mariadb \
-e ALLOW_EMPTY_PASSWORD=yes \
-v /path/to/my.cnf:/opt/bitnami/mariadb/conf/my.cnf:ro \
bitnami/mariadb-galera:latest
The Bitnami MariaDB Galera Docker image is designed to be extended so it can be used as the base image for your custom configuration.
Before extending this image, please note there are certain configuration settings you can modify using the original image:
- Settings that can be adapted using environment variables. For instance, you can change the ports used by MariaDB, by setting the environment variables
MARIADB_PORT_NUMBER
or the character set usingMARIADB_CHARACTER_SET
respectively.
If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
FROM bitnami/mariadb-galera
## Put your customizations below
...
Here is an example of extending the image with the following modifications:
- Install the
vim
editor - Modify the MariaDB configuration file
- Modify the ports used by MariaDB
- Change the user that runs the container
FROM bitnami/mariadb-galera
LABEL maintainer "Bitnami <containers@bitnami.com>"
## Install 'vim'
USER 0 # Required to perform privileged actions
RUN install_packages vim
USER 1001 # Revert to the original non-root user
## modify configuration file.
RUN ini-file set --section "mysqld" --key "collation-server" --value "utf8_general_ci" "/opt/bitnami/mariadb-galera/conf/my.cnf"
## Modify the ports used by MariaDB by default
# It is also possible to change these environment variables at runtime
ENV MARIADB_PORT_NUMBER=3307
EXPOSE 3307
## Modify the default container user
USER 1002
Based on the extended image, you can use a Docker Compose file like the one below to add other features:
- Add a custom configuration
version: '2'
services:
mariadb:
build: .
ports:
- '3306:3307'
volumes:
- /path/to/my_custom.cnf:/opt/bitnami/mariadb-galera/conf/my_custom.cnf:ro
- data:/bitnami/mariadb-galera/data
volumes:
data:
driver: local
The Bitnami MariaDB Galera Docker image sends the container logs to stdout
. To view the logs:
$ docker logs mariadb
or using Docker Compose:
$ docker-compose logs mariadb
You can configure the containers logging driver using the --log-driver
option if you wish to consume the container logs differently. In the default configuration docker uses the json-file
driver.
Bitnami provides up-to-date versions of MariaDB, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
$ docker pull bitnami/mariadb-galera:latest
or if you're using Docker Compose, update the value of the image property to
bitnami/mariadb-galera:latest
.
Stop the currently running container using the command
$ docker stop mariadb
or using Docker Compose:
$ docker-compose stop mariadb
Next, take a snapshot of the persistent volume /path/to/mariadb-persistence
using:
$ rsync -a /path/to/mariadb-persistence /path/to/mariadb-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
You can use this snapshot to restore the database state should the upgrade fail.
$ docker rm -v mariadb
or using Docker Compose:
$ docker-compose rm -v mariadb
Re-create your container from the new image.
$ docker run --name mariadb bitnami/mariadb-galera:latest
or using Docker Compose:
$ docker-compose up mariadb
- Create An AMP Development Environment With Bitnami Containers
- Create An EMP Development Environment With Bitnami Containers
- This image has been adapted so it's easier to customize. See the Customize this image section for more information.
- The MariaDB Galera container has been migrated to a "non-root" user approach. Previously the container ran as the
root
user, and the MySQL daemon was started as themysql
user. From now on, both the container and the MySQL daemon run as user1001
. You can revert this behavior by changingUSER 1001
toUSER root
in the Dockerfile. - Consequences:
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the data site by creating a backup of the databse, and restoring it on a new MariaDB Galera container. In the link below you can find a guide that explain the whole process:
- Environment variables related to LDAP configuration were renamed removing the
MARIADB_
prefix. For instance, to indicate the LDAP URI to use, you must setLDAP_URI
instead ofMARIADB_LDAP_URI
.
10.1.43-centos-7-r78
,10.2.30-centos-7-r40
,10.3.21-centos-7-r41
, and10.4.11-centos-7-r32
are considered the latest images based on CentOS.- Standard supported distros: Debian & OEL.
We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:
- Host OS and version
- Docker version (
docker version
) - Output of
docker info
- Version of this container (
echo $BITNAMI_IMAGE_VERSION
inside the container) - The command you used to run the container, and any relevant output you saw (masking any sensitive information)
Copyright 2020 Bitnami
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.