Dockerfile source for mysql docker image.

This source repo was originally copied from: https://github.com/docker-library/mysql

This is not an official Google product.

This image contains an installation MySQL.

For more information, see the Official Image Marketplace Page.

Pull command (first install gcloud):

gcloud docker -- pull marketplace.gcr.io/google/mysql8

Dockerfile for this image can be found here.

• Using Kubernetes
  • Running MySQL server
    • Start a MySQL instance
    • Use a persistent data volume
    • Securely set up the server
  • Command line MySQL client
    • Connect to a running MySQL container
    • Connect command line client to a remote MySQL instance
  • Configurations
    • Using configuration volume
    • Using flags
  • Maintenance
    • Creating database dumps
• Using Docker
  • Running MySQL server
    • Start a MySQL instance
    • Use a persistent data volume
    • Securely set up the server
  • Command line MySQL client
    • Connect to a running MySQL container
    • Connect command line client to a remote MySQL instance
  • Configurations
    • Using configuration volume
    • Using flags
  • Maintenance
    • Creating database dumps
• References
  • Ports
  • Environment Variables
  • Volumes

Consult Marketplace container documentation for additional information about setting up your Kubernetes environment.

This section describes how to spin up a MySQL service using this image.

Copy the following content to pod.yaml file, and run kubectl create -f pod.yaml.

apiVersion: v1
kind: Pod
metadata:
  name: some-mysql
  labels:
    name: some-mysql
spec:
  containers:
    - image: marketplace.gcr.io/google/mysql8
      name: mysql
      env:
        - name: "MYSQL_ROOT_PASSWORD"
          value: "example-password"

Run the following to expose the port. Depending on your cluster setup, this might expose your service to the Internet with an external IP address. For more information, consult Kubernetes documentation.

kubectl expose pod some-mysql --name some-mysql-3306 \
  --type LoadBalancer --port 3306 --protocol TCP

For information about how to retain your database across restarts, see Use a persistent data volume.

See Configurations for how to customize your MySQL service instance.

Also see Securely set up the server for how to bootstrap the server with a more secure root password, without exposing it on the command line.

We can store MySQL data on a persistent volume. This way the database remains intact across restarts.

Copy the following content to pod.yaml file, and run kubectl create -f pod.yaml.

apiVersion: v1
kind: Pod
metadata:
  name: some-mysql
  labels:
    name: some-mysql
spec:
  containers:
    - image: marketplace.gcr.io/google/mysql8
      name: mysql
      env:
        - name: "MYSQL_ROOT_PASSWORD"
          value: "example-password"
      volumeMounts:
        - name: data
          mountPath: /var/lib/mysql
          subPath: data
  volumes:
    - name: data
      persistentVolumeClaim:
        claimName: data
---
# Request a persistent volume from the cluster using a Persistent Volume Claim.
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: data
  annotations:
    volume.alpha.kubernetes.io/storage-class: default
spec:
  accessModes: [ReadWriteOnce]
  resources:
    requests:
      storage: 5Gi

Run the following to expose the port. Depending on your cluster setup, this might expose your service to the Internet with an external IP address. For more information, consult Kubernetes documentation.

kubectl expose pod some-mysql --name some-mysql-3306 \
  --type LoadBalancer --port 3306 --protocol TCP

Note that once the database directory is established, MYSQL_ROOT_PASSWORD will be ignored when the instance restarts.

A recommended way to start up your MySQL server is to have the root password generated as a onetime password. You will then log on and change this password. MySQL will not fully function until this onetime password is changed.

Start the container with both environment variables MYSQL_RANDOM_ROOT_PASSWORD and MYSQL_ONETIME_PASSWORD set to yes.

Copy the following content to pod.yaml file, and run kubectl create -f pod.yaml.

apiVersion: v1
kind: Pod
metadata:
  name: some-mysql
  labels:
    name: some-mysql
spec:
  containers:
    - image: marketplace.gcr.io/google/mysql8
      name: mysql
      env:
        - name: "MYSQL_ONETIME_PASSWORD"
          value: "yes"
        - name: "MYSQL_RANDOM_ROOT_PASSWORD"
          value: "yes"

Run the following to expose the port. Depending on your cluster setup, this might expose your service to the Internet with an external IP address. For more information, consult Kubernetes documentation.

kubectl expose pod some-mysql --name some-mysql-3306 \
  --type LoadBalancer --port 3306 --protocol TCP

You can then obtain the generated password by viewing the container log and look for the "GENERATED ROOT PASSWORD" line.

Open a shell to the container.

kubectl exec -it some-mysql -- bash

Now log in with the generated onetime password.

mysql -u root -p

Once logged in, you can change the root password.

ALTER USER root IDENTIFIED BY 'new-password';

Also see Environment Variable reference for more information.

This section describes how to use this image as a MySQL client.

You can run a MySQL client directly within the container. Log on using the password for root user.

kubectl exec -it some-mysql -- mysql -uroot -p

Assume that we have a MySQL instance running at some.mysql.host and we want to log on as some-mysql-user when connecting.

kubectl run \
  some-mysql-client \
  --image marketplace.gcr.io/google/mysql8 \
  --rm --attach --restart=Never \
  -it \
  -- sh -c 'exec mysql -hsome.mysql.host -usome-mysql-user -p'

You will have to enter the password for some-mysql-user to log on, even though there might not be a prompt to enter password due to limitation of kubectl run --attach.

There are several ways to configure your MySQL service instance.

If /my/custom/path/config-file.cnf is the path and name of your custom configuration file, you can start your MySQL container like this.

Create the following configmap:

kubectl create configmap config \
  --from-file=/my/custom/path/config-file.cnf

Copy the following content to pod.yaml file, and run kubectl create -f pod.yaml.

apiVersion: v1
kind: Pod
metadata:
  name: some-mysql
  labels:
    name: some-mysql
spec:
  containers:
    - image: marketplace.gcr.io/google/mysql8
      name: mysql
      env:
        - name: "MYSQL_ROOT_PASSWORD"
          value: "example-password"
      volumeMounts:
        - name: config
          mountPath: /etc/mysql/conf.d
  volumes:
    - name: config
      configMap:
        name: config

Run the following to expose the port. Depending on your cluster setup, this might expose your service to the Internet with an external IP address. For more information, consult Kubernetes documentation.

kubectl expose pod some-mysql --name some-mysql-3306 \
  --type LoadBalancer --port 3306 --protocol TCP

See Volume reference for more details.

You can specify option flags directly to mysqld when starting your instance. The following example sets the default encoding and collation for all tables to UTF-8.

Copy the following content to pod.yaml file, and run kubectl create -f pod.yaml.

apiVersion: v1
kind: Pod
metadata:
  name: some-mysql
  labels:
    name: some-mysql
spec:
  containers:
    - image: marketplace.gcr.io/google/mysql8
      name: mysql
      args:
        - --character-set-server=utf8mb4
        - --collation-server=utf8mb4_unicode_ci
      env:
        - name: "MYSQL_ROOT_PASSWORD"
          value: "example-password"

Run the following to expose the port. Depending on your cluster setup, this might expose your service to the Internet with an external IP address. For more information, consult Kubernetes documentation.

kubectl expose pod some-mysql --name some-mysql-3306 \
  --type LoadBalancer --port 3306 --protocol TCP

You can also list all available options (several pages long).

kubectl run \
  some-mysql-client \
  --image marketplace.gcr.io/google/mysql8 \
  --rm --attach --restart=Never \
  -- --verbose --help

All databases can be dumped into a /some/path/all-databases.sql file on the host using the following command.

kubectl exec -it some-mysql -- sh -c 'exec mysqldump --all-databases -uroot -p"$MYSQL_ROOT_PASSWORD"' > /some/path/all-databases.sql

If your container was not started with a MYSQL_ROOT_PASSWORD value, substitute "$MYSQL_ROOT_PASSWORD" with the password of the root user. Alternatively, you can use another pair of username as password for -u and -p arguments.

Consult Marketplace container documentation for additional information about setting up your Docker environment.

This section describes how to spin up a MySQL service using this image.

Use the following content for the docker-compose.yml file, then run docker-compose up.

version: '2'
services:
  mysql:
    container_name: some-mysql
    image: marketplace.gcr.io/google/mysql8
    environment:
      "MYSQL_ROOT_PASSWORD": "example-password"
    ports:
      - '3306:3306'

Or you can use docker run directly:

docker run \
  --name some-mysql \
  -e "MYSQL_ROOT_PASSWORD=example-password" \
  -p 3306:3306 \
  -d \
  marketplace.gcr.io/google/mysql8

MySQL server is accessible on port 3306.

For information about how to retain your database across restarts, see Use a persistent data volume.

See Configurations for how to customize your MySQL service instance.

Also see Securely set up the server for how to bootstrap the server with a more secure root password, without exposing it on the command line.

We can store MySQL data on a persistent volume. This way the database remains intact across restarts. Assume that /my/persistent/dir/mysql is the persistent directory on the host.

Use the following content for the docker-compose.yml file, then run docker-compose up.

version: '2'
services:
  mysql:
    container_name: some-mysql
    image: marketplace.gcr.io/google/mysql8
    environment:
      "MYSQL_ROOT_PASSWORD": "example-password"
    ports:
      - '3306:3306'
    volumes:
      - /my/persistent/dir/mysql:/var/lib/mysql

Or you can use docker run directly:

docker run \
  --name some-mysql \
  -e "MYSQL_ROOT_PASSWORD=example-password" \
  -p 3306:3306 \
  -v /my/persistent/dir/mysql:/var/lib/mysql \
  -d \
  marketplace.gcr.io/google/mysql8

Note that once the database directory is established, MYSQL_ROOT_PASSWORD will be ignored when the instance restarts.

A recommended way to start up your MySQL server is to have the root password generated as a onetime password. You will then log on and change this password. MySQL will not fully function until this onetime password is changed.

Start the container with both environment variables MYSQL_RANDOM_ROOT_PASSWORD and MYSQL_ONETIME_PASSWORD set to yes.

Use the following content for the docker-compose.yml file, then run docker-compose up.

version: '2'
services:
  mysql:
    container_name: some-mysql
    image: marketplace.gcr.io/google/mysql8
    environment:
      "MYSQL_ONETIME_PASSWORD": "yes"
      "MYSQL_RANDOM_ROOT_PASSWORD": "yes"
    ports:
      - '3306:3306'

Or you can use docker run directly:

docker run \
  --name some-mysql \
  -e "MYSQL_ONETIME_PASSWORD=yes" \
  -e "MYSQL_RANDOM_ROOT_PASSWORD=yes" \
  -p 3306:3306 \
  -d \
  marketplace.gcr.io/google/mysql8

You can then obtain the generated password by viewing the container log and look for the "GENERATED ROOT PASSWORD" line.

Open a shell to the container.

docker exec -it some-mysql bash

Now log in with the generated onetime password.

mysql -u root -p

Once logged in, you can change the root password.

ALTER USER root IDENTIFIED BY 'new-password';

Also see Environment Variable reference for more information.

This section describes how to use this image as a MySQL client.

You can run a MySQL client directly within the container. Log on using the password for root user.

docker exec -it some-mysql mysql -uroot -p

Assume that we have a MySQL instance running at some.mysql.host and we want to log on as some-mysql-user when connecting.

docker run \
  --name some-mysql-client \
  --rm \
  -it \
  marketplace.gcr.io/google/mysql8 \
  sh -c 'exec mysql -hsome.mysql.host -usome-mysql-user -p'

There are several ways to configure your MySQL service instance.

If /my/custom/path/config-file.cnf is the path and name of your custom configuration file, you can start your MySQL container like this.

Use the following content for the docker-compose.yml file, then run docker-compose up.

version: '2'
services:
  mysql:
    container_name: some-mysql
    image: marketplace.gcr.io/google/mysql8
    environment:
      "MYSQL_ROOT_PASSWORD": "example-password"
    ports:
      - '3306:3306'
    volumes:
      - /my/custom/path/config-file.cnf:/etc/mysql/conf.d/config-file.cnf

Or you can use docker run directly:

docker run \
  --name some-mysql \
  -e "MYSQL_ROOT_PASSWORD=example-password" \
  -p 3306:3306 \
  -v /my/custom/path/config-file.cnf:/etc/mysql/conf.d/config-file.cnf \
  -d \
  marketplace.gcr.io/google/mysql8

See Volume reference for more details.

You can specify option flags directly to mysqld when starting your instance. The following example sets the default encoding and collation for all tables to UTF-8.

Use the following content for the docker-compose.yml file, then run docker-compose up.

version: '2'
services:
  mysql:
    container_name: some-mysql
    image: marketplace.gcr.io/google/mysql8 \
    command:
      - --character-set-server=utf8mb4
      - --collation-server=utf8mb4_unicode_ci
    environment:
      "MYSQL_ROOT_PASSWORD": "example-password"
    ports:
      - '3306:3306'

Or you can use docker run directly:

docker run \
  --name some-mysql \
  -e "MYSQL_ROOT_PASSWORD=example-password" \
  -p 3306:3306 \
  -d \
  marketplace.gcr.io/google/mysql8 \
  --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci

You can also list all available options (several pages long).

docker run \
  --name some-mysql-client \
  --rm \
  marketplace.gcr.io/google/mysql8 \
  --verbose --help

All databases can be dumped into a /some/path/all-databases.sql file on the host using the following command.

docker exec -it some-mysql sh -c 'exec mysqldump --all-databases -uroot -p"$MYSQL_ROOT_PASSWORD"' > /some/path/all-databases.sql

If your container was not started with a MYSQL_ROOT_PASSWORD value, substitute "$MYSQL_ROOT_PASSWORD" with the password of the root user. Alternatively, you can use another pair of username as password for -u and -p arguments.

These are the ports exposed by the container image.

These are the environment variables understood by the container image.

These are the filesystem paths used by the container image.