523 lines
18 KiB
Markdown
523 lines
18 KiB
Markdown
[](https://circleci.com/gh/bitnami/bitnami-docker-mysql/tree/master)
|
|
[](http://slack.oss.bitnami.com)
|
|
|
|
# What is MySQL?
|
|
|
|
> MySQL is a fast, reliable, scalable, and easy to use open-source relational database system. MySQL Server is intended for mission-critical, heavy-load production systems as well as for embedding into mass-deployed software.
|
|
|
|
[https://mysql.com/](https://mysql.com/)
|
|
|
|
# TL;DR;
|
|
|
|
```bash
|
|
$ docker run --name mysql -e ALLOW_EMPTY_PASSWORD=yes bitnami/mysql:latest
|
|
```
|
|
|
|
## Docker Compose
|
|
|
|
```bash
|
|
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-mysql/master/docker-compose.yml > docker-compose.yml
|
|
$ docker-compose up -d
|
|
```
|
|
|
|
# Why use Bitnami Images?
|
|
|
|
* 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.
|
|
* Bitnami images are built on CircleCI and automatically pushed to the Docker Hub.
|
|
* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.
|
|
|
|
# Get this image
|
|
|
|
The recommended way to get the Bitnami MySQL Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/mysql).
|
|
|
|
```bash
|
|
$ docker pull bitnami/mysql:latest
|
|
```
|
|
|
|
To use a specific version, you can pull a versioned tag. You can view the
|
|
[list of available versions](https://hub.docker.com/r/bitnami/mysql/tags/)
|
|
in the Docker Hub Registry.
|
|
|
|
```bash
|
|
$ docker pull bitnami/mysql:[TAG]
|
|
```
|
|
|
|
If you wish, you can also build the image yourself.
|
|
|
|
```bash
|
|
$ docker build -t bitnami/mysql:latest https://github.com/bitnami/bitnami-docker-mysql.git
|
|
```
|
|
|
|
# Persisting your database
|
|
|
|
If you remove the container all your data and configurations 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` path. If the mounted directory is empty, it will be initialized on the first run.
|
|
|
|
```bash
|
|
$ docker run \
|
|
-e ALLOW_EMPTY_PASSWORD=yes \
|
|
-v /path/to/mysql-persistence:/bitnami \
|
|
bitnami/mysql:latest
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
services:
|
|
mysql:
|
|
image: 'bitnami/mysql:latest'
|
|
environment:
|
|
- ALLOW_EMPTY_PASSWORD=yes
|
|
ports:
|
|
- '3306:3306'
|
|
volumes:
|
|
- /path/to/mysql-persistence:/bitnami
|
|
```
|
|
|
|
# Connecting to other containers
|
|
|
|
Using [Docker container networking](https://docs.docker.com/engine/userguide/networking/), a MySQL 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.
|
|
|
|
## Using the Command Line
|
|
|
|
In this example, we will create a MySQL client instance that will connect to the server instance that is running on the same docker network as the client.
|
|
|
|
### Step 1: Create a network
|
|
|
|
```bash
|
|
$ docker network create app-tier --driver bridge
|
|
```
|
|
|
|
### Step 2: Launch the MySQL server instance
|
|
|
|
Use the `--network app-tier` argument to the `docker run` command to attach the MySQL container to the `app-tier` network.
|
|
|
|
```bash
|
|
$ docker run -d --name mysql-server \
|
|
-e ALLOW_EMPTY_PASSWORD=yes \
|
|
--network app-tier \
|
|
bitnami/mysql:latest
|
|
```
|
|
|
|
### Step 3: Launch your MySQL client instance
|
|
|
|
Finally we create a new container instance to launch the MySQL client and connect to the server created in the previous step:
|
|
|
|
```bash
|
|
$ docker run -it --rm \
|
|
--network app-tier \
|
|
bitnami/mysql:latest mysql -h mysql-server -u root
|
|
```
|
|
|
|
## Using Docker Compose
|
|
|
|
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 MySQL server from your own custom application image which is identified in the following snippet by the service name `myapp`.
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
networks:
|
|
app-tier:
|
|
driver: bridge
|
|
|
|
services:
|
|
mysql:
|
|
image: 'bitnami/mysql:latest'
|
|
environment:
|
|
- ALLOW_EMPTY_PASSWORD=yes
|
|
networks:
|
|
- app-tier
|
|
myapp:
|
|
image: 'YOUR_APPLICATION_IMAGE'
|
|
networks:
|
|
- app-tier
|
|
```
|
|
|
|
> **IMPORTANT**:
|
|
>
|
|
> 1. Please update the `YOUR_APPLICATION_IMAGE` placeholder in the above snippet with your application image
|
|
> 2. In your application container, use the hostname `mysql` to connect to the MySQL server
|
|
|
|
Launch the containers using:
|
|
|
|
```bash
|
|
$ docker-compose up -d
|
|
```
|
|
|
|
# Configuration
|
|
|
|
## Setting the root password on first run
|
|
|
|
The root user and password can easily be setup with the Bitnami MySQL Docker image using the following environment variables:
|
|
|
|
- `MYSQL_ROOT_USER`: The database admin user. Defaults to `root`.
|
|
- `MYSQL_ROOT_PASSWORD`: The database admin user password. No defaults.
|
|
|
|
Passing the `MYSQL_ROOT_PASSWORD` environment variable when running the image for the first time will set the password of the `MYSQL_ROOT_USER` user to the value of `MYSQL_ROOT_PASSWORD`.
|
|
|
|
```bash
|
|
$ docker run --name mysql -e MYSQL_ROOT_PASSWORD=password123 bitnami/mysql:latest
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
services:
|
|
mysql:
|
|
image: 'bitnami/mysql:latest'
|
|
ports:
|
|
- '3306:3306'
|
|
environment:
|
|
- MYSQL_ROOT_PASSWORD=password123
|
|
```
|
|
|
|
**Warning** The `MYSQL_ROOT_USER` user is always created with remote access. It's suggested that the `MYSQL_ROOT_PASSWORD` env variable is always specified to set a password for the `MYSQL_ROOT_USER` user. In case you want to allow the `MYSQL_ROOT_USER` user to access the database without a password set the environment variable `ALLOW_EMPTY_PASSWORD=yes`. **This is recommended only for development**.
|
|
|
|
## Allowing empty passwords
|
|
|
|
By default the MySQL 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 recommended for testing or development purposes. We strongly recommend specifying the `MYSQL_ROOT_PASSWORD` for any other scenario.
|
|
|
|
```bash
|
|
$ docker run --name mysql -e ALLOW_EMPTY_PASSWORD=yes bitnami/mysql:latest
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
services:
|
|
mysql:
|
|
image: 'bitnami/mysql:latest'
|
|
ports:
|
|
- '3306:3306'
|
|
environment:
|
|
- ALLOW_EMPTY_PASSWORD=yes
|
|
```
|
|
|
|
## Creating a database on first run
|
|
|
|
By passing the `MYSQL_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.
|
|
|
|
```bash
|
|
$ docker run --name mysql \
|
|
-e ALLOW_EMPTY_PASSWORD=yes \
|
|
-e MYSQL_DATABASE=my_database \
|
|
bitnami/mysql:latest
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
services:
|
|
mysql:
|
|
image: 'bitnami/mysql:latest'
|
|
ports:
|
|
- '3306:3306'
|
|
environment:
|
|
- ALLOW_EMPTY_PASSWORD=yes
|
|
- MYSQL_DATABASE=my_database
|
|
```
|
|
|
|
## Creating a database user on first run
|
|
|
|
You can create a restricted database user that only has permissions for the database created with the [`MYSQL_DATABASE`](#creating-a-database-on-first-run) environment variable. To do this, provide the `MYSQL_USER` environment variable and to set a password for the database user provide the `MYSQL_PASSWORD` variable.
|
|
|
|
```bash
|
|
$ docker run --name mysql \
|
|
-e ALLOW_EMPTY_PASSWORD=yes \
|
|
-e MYSQL_USER=my_user \
|
|
-e MYSQL_PASSWORD=my_password \
|
|
-e MYSQL_DATABASE=my_database \
|
|
bitnami/mysql:latest
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
services:
|
|
mysql:
|
|
image: 'bitnami/mysql:latest'
|
|
ports:
|
|
- '3306:3306'
|
|
environment:
|
|
- ALLOW_EMPTY_PASSWORD=yes
|
|
- MYSQL_USER=my_user
|
|
- MYSQL_PASSWORD=my_password
|
|
- MYSQL_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 `MYSQL_ROOT_PASSWORD` env variable instead if you want to set a password for the `root` user.
|
|
|
|
## Setting up a replication cluster
|
|
|
|
A **zero downtime** MySQL master-slave [replication](https://dev.mysql.com/doc/refman/5.0/en/replication-howto.html) cluster can easily be setup with the Bitnami MySQL Docker image using the following environment variables:
|
|
|
|
- `MYSQL_REPLICATION_MODE`: The replication mode. Possible values `master`/`slave`. No defaults.
|
|
- `MYSQL_REPLICATION_USER`: The replication user created on the master on first run. No defaults.
|
|
- `MYSQL_REPLICATION_PASSWORD`: The replication users password. No defaults.
|
|
- `MYSQL_MASTER_HOST`: Hostname/IP of replication master (slave parameter). No defaults.
|
|
- `MYSQL_MASTER_PORT_NUMBER`: Server port of the replication master (slave parameter). Defaults to `3306`.
|
|
- `MYSQL_MASTER_ROOT_USER`: User on replication master with access to `MYSQL_DATABASE` (slave parameter). Defaults to `root`
|
|
- `MYSQL_MASTER_ROOT_PASSWORD`: Password of user on replication master with access to `MYSQL_DATABASE` (slave parameter). No defaults.
|
|
|
|
In a replication cluster you can have one master and zero or more slaves. When replication is enabled the master node is in read-write mode, while the slaves are in read-only mode. For best performance its advisable to limit the reads to the slaves.
|
|
|
|
### Step 1: Create the replication master
|
|
|
|
The first step is to start the MySQL master.
|
|
|
|
```bash
|
|
$ docker run --name mysql-master \
|
|
-e MYSQL_ROOT_PASSWORD=master_root_password \
|
|
-e MYSQL_REPLICATION_MODE=master \
|
|
-e MYSQL_REPLICATION_USER=my_repl_user \
|
|
-e MYSQL_REPLICATION_PASSWORD=my_repl_password \
|
|
-e MYSQL_USER=my_user \
|
|
-e MYSQL_PASSWORD=my_password \
|
|
-e MYSQL_DATABASE=my_database \
|
|
bitnami/mysql:latest
|
|
```
|
|
|
|
In the above command the container is configured as the `master` using the `MYSQL_REPLICATION_MODE` parameter. A replication user is specified using the `MYSQL_REPLICATION_USER` and `MYSQL_REPLICATION_PASSWORD` parameters.
|
|
|
|
### Step 2: Create the replication slave
|
|
|
|
Next we start a MySQL slave container.
|
|
|
|
```bash
|
|
$ docker run --name mysql-slave --link mysql-master:master \
|
|
-e MYSQL_REPLICATION_MODE=slave \
|
|
-e MYSQL_REPLICATION_USER=my_repl_user \
|
|
-e MYSQL_REPLICATION_PASSWORD=my_repl_password \
|
|
-e MYSQL_MASTER_HOST=master \
|
|
-e MYSQL_MASTER_ROOT_PASSWORD=master_root_password \
|
|
bitnami/mysql:latest
|
|
```
|
|
|
|
In the above command the container is configured as a `slave` using the `MYSQL_REPLICATION_MODE` parameter. The `MYSQL_MASTER_HOST`, `MYSQL_MASTER_ROOT_USER` and `MYSQL_MASTER_ROOT_PASSWORD` parameters are used by the slave to connect to the master. It also takes a dump of the existing data in the master server. The replication user credentials are specified using the `MYSQL_REPLICATION_USER` and `MYSQL_REPLICATION_PASSWORD` parameters and should be the same as the one specified on the master.
|
|
|
|
You now have a two node MySQL master/slave replication cluster up and running. You can scale the cluster by adding/removing slaves without incurring any downtime.
|
|
|
|
With Docker Compose the master/slave replication can be setup using:
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
services:
|
|
mysql-master:
|
|
image: 'bitnami/mysql:latest'
|
|
ports:
|
|
- '3306'
|
|
volumes:
|
|
- /path/to/mysql-persistence:/bitnami
|
|
environment:
|
|
- MYSQL_REPLICATION_MODE=master
|
|
- MYSQL_REPLICATION_USER=repl_user
|
|
- MYSQL_REPLICATION_PASSWORD=repl_password
|
|
- MYSQL_ROOT_PASSWORD=master_root_password
|
|
- MYSQL_USER=my_user
|
|
- MYSQL_PASSWORD=my_password
|
|
- MYSQL_DATABASE=my_database
|
|
mysql-slave:
|
|
image: 'bitnami/mysql:latest'
|
|
ports:
|
|
- '3306'
|
|
depends_on:
|
|
- mysql-master
|
|
environment:
|
|
- MYSQL_REPLICATION_MODE=slave
|
|
- MYSQL_REPLICATION_USER=repl_user
|
|
- MYSQL_REPLICATION_PASSWORD=repl_password
|
|
- MYSQL_MASTER_HOST=mysql-master
|
|
- MYSQL_MASTER_PORT_NUMBER=3306
|
|
- MYSQL_MASTER_ROOT_PASSWORD=master_root_password
|
|
```
|
|
|
|
Scale the number of slaves using:
|
|
|
|
```bash
|
|
$ docker-compose scale mysql-master=1 mysql-slave=3
|
|
```
|
|
|
|
The above command scales up the number of slaves to `3`. You can scale down in the same manner.
|
|
|
|
> **Note**: You should not scale up/down the number of master nodes. Always have only one master node running.
|
|
|
|
## Configuration file
|
|
|
|
The image looks for user-defined configurations in `/bitnami/mysql/conf/my_custom.cnf`. Create a file named `my_custom.cnf` and mount it at `/bitnami/mysql/conf/my_custom.cnf`.
|
|
|
|
For example, in order to override the `max_allowed_packet` directive:
|
|
|
|
# Step 1: Write your `my_custom.cnf` file with the following content.
|
|
|
|
```config
|
|
[mysqld]
|
|
max_allowed_packet=32M
|
|
```
|
|
|
|
# Step 2: Run the mariaDB image with the designed volume attached.
|
|
|
|
```bash
|
|
$ docker run --name mysql -v /path/to/my_custom.cnf:/bitnami/mysql/conf/my_custom.cnf:ro bitnami/mysql:latest
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```yaml
|
|
version: '2'
|
|
|
|
services:
|
|
mysql:
|
|
image: 'bitnami/mysql:latest'
|
|
environment:
|
|
- ALLOW_EMPTY_PASSWORD=yes
|
|
ports:
|
|
- '3306:3306'
|
|
volumes:
|
|
- /path/to/my_custom.cnf:/bitnami/mysql/conf/my_custom.cnf:ro
|
|
```
|
|
|
|
After that, your changes will be taken into account in the server's behaviour.
|
|
|
|
As mentioned in [Persisting your database](#persisting-your-database) if you mount a volume at `/bitnami`, you could copy `my_custom.cnf` at `/path/to/mysql-persistence/mysql/conf/my_custom.cnf` or even edit the `/path/to/mysql-persistence/mysql/conf/my.cnf` file.
|
|
|
|
Refer to the [MySQL server option and variable reference guide](https://dev.mysql.com/doc/refman/5.1/en/mysqld-option-tables.html) for the complete list of configuration options.
|
|
|
|
# Logging
|
|
|
|
The Bitnami MySQL Docker image sends the container logs to the `stdout`. To view the logs:
|
|
|
|
```bash
|
|
$ docker logs mysql
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```bash
|
|
$ docker-compose logs mysql
|
|
```
|
|
|
|
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
|
|
|
|
# Maintenance
|
|
|
|
## Upgrade this image
|
|
|
|
Bitnami provides up-to-date versions of MySQL, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
|
|
|
|
### Step 1: Get the updated image
|
|
|
|
```bash
|
|
$ docker pull bitnami/mysql:latest
|
|
```
|
|
|
|
or if you're using Docker Compose, update the value of the image property to
|
|
`bitnami/mysql:latest`.
|
|
|
|
### Step 2: Stop and backup the currently running container
|
|
|
|
Stop the currently running container using the command
|
|
|
|
```bash
|
|
$ docker stop mysql
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```bash
|
|
$ docker-compose stop mysql
|
|
```
|
|
|
|
Next, take a snapshot of the persistent volume `/path/to/mysql-persistence` using:
|
|
|
|
```bash
|
|
$ rsync -a /path/to/mysql-persistence /path/to/mysql-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
|
|
```
|
|
|
|
### Step 3: Remove the currently running container
|
|
|
|
```bash
|
|
$ docker rm -v mysql
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```bash
|
|
$ docker-compose rm -v mysql
|
|
```
|
|
|
|
### Step 4: Run the new image
|
|
|
|
Re-create your container from the new image.
|
|
|
|
```bash
|
|
$ docker run --name mysql bitnami/mysql:latest
|
|
```
|
|
|
|
or using Docker Compose:
|
|
|
|
```bash
|
|
$ docker-compose start mysql
|
|
```
|
|
|
|
# Notable Changes
|
|
|
|
## 5.7.17-r4
|
|
|
|
- `MYSQL_MASTER_USER` has been renamed to `MYSQL_MASTER_ROOT_USER`
|
|
- `MYSQL_MASTER_PASSWORD` has been renamed to `MYSQL_MASTER_ROOT_PASSWORD`
|
|
- `MYSQL_ROOT_USER` has been added to the available env variables. It can be used to specify the admin user.
|
|
- `ALLOW_EMPTY_PASSWORD` has been added to the available env variables. It can be used to allow blank passwords for MySQL.
|
|
- By default the MySQL image requires a root password to start. You can specify it using the `MYSQL_ROOT_PASSWORD` env variable or disable this requirement by setting the `ALLOW_EMPTY_PASSWORD` env variable to `yes` (testing or development scenarios).
|
|
|
|
# Contributing
|
|
|
|
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-mysql/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-mysql/pulls) with your contribution.
|
|
|
|
# Issues
|
|
|
|
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-mysql/issues). 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)
|
|
|
|
# Community
|
|
|
|
Most real time communication happens in the `#containers` channel at [bitnami-oss.slack.com](http://bitnami-oss.slack.com); you can sign up at [slack.oss.bitnami.com](http://slack.oss.bitnami.com).
|
|
|
|
Discussions are archived at [bitnami-oss.slackarchive.io](https://bitnami-oss.slackarchive.io).
|
|
|
|
# License
|
|
|
|
Copyright (c) 2015-2017 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.
|