MariaDB Enterprise Docker Registry for MariaDB Enterprise Server 10.5

Maturity

The Docker images for MariaDB Enterprise Server 10.5 are currently beta maturity, so they are not currently recommended for production.

Storage Engines

The Docker images for MariaDB Enterprise Server 10.5 include all storage engines that are installed with MariaDB Enterprise Server 10.5 by default. The following storage engines are currently included:

• Aria

• CSV

• InnoDB

• MEMORY

• MRG_MYISAM

• MyISAM

You can check which storage engines are installed by connecting to the Docker container and executing the SHOW ENGINES statement.

Plugins

The Docker images for MariaDB Enterprise Server 10.5 include all plugins that are installed with MariaDB Enterprise Server 10.5 by default.

You can check which plugins are installed by connecting to the Docker container and executing the SHOW PLUGINS statement.

The container contains shared libraries for additional plugins that can be installed with the INSTALL SONAME statement or the --plugin-load-add command-line option. You can check which plugins are available by querying the information_schema.ALL_PLUGINS table:

SELECT PLUGIN_NAME, PLUGIN_VERSION, PLUGIN_LIBRARY
FROM information_schema.ALL_PLUGINS
WHERE PLUGIN_STATUS = 'NOT INSTALLED';

+---------------------------+----------------+------------------------+
| PLUGIN_NAME               | PLUGIN_VERSION | PLUGIN_LIBRARY         |
+---------------------------+----------------+------------------------+
| pam                       | 1.0            | auth_pam_v1.so         |
| LOCALES                   | 1.0            | locales.so             |
| BLACKHOLE                 | 1.0            | ha_blackhole.so        |
| SQL_ERROR_LOG             | 1.0            | sql_errlog.so          |
| METADATA_LOCK_INFO        | 0.1            | metadata_lock_info.so  |
| pam                       | 2.0            | auth_pam.so            |
| SERVER_AUDIT              | 1.4            | server_audit.so        |
| file_key_management       | 1.0            | file_key_management.so |
| QUERY_RESPONSE_TIME       | 1.0            | query_response_time.so |
| QUERY_RESPONSE_TIME_AUDIT | 1.0            | query_response_time.so |
+---------------------------+----------------+------------------------+

Repositories

The MariaDB Enterprise Docker Registry contains a single repository, which provides images for MariaDB Enterprise Server:

• enterprise-server

Tags

The enterprise-server repository in the MariaDB Enterprise Docker Registry contains images for different MariaDB Enterprise Server 10.5 releases using specific tags:

The supported tags in the table above are applicable for MariaDB Enterprise Server 10.5. For all supported tags for all MariaDB Enterprise Server versions, see the supported tags for all versions.

Connect to Container with Docker Bridge Networking

To connect to a Docker container that uses Docker bridge networking, execute MariaDB Client on the container using docker exec:

$ docker exec --interactive --tty \
   mariadb-es-10.5 \
   mariadb \
   --user=root \
   --password

To confirm the client is connected to the Docker container and the container is using the correct version of MariaDB Enterprise Server 10.5, query the version system variable with the SHOW GLOBAL VARIABLES statement:

SHOW GLOBAL VARIABLES
   LIKE 'version'\G

*************************** 1. row ***************************
Variable_name: version
        Value: 10.5.26-20-MariaDB-enterprise-log

To exit the container, use exit:

exit

Bye

The example above shows how to connect to a Docker container using MariaDB Client on the container, but you can also connect using MariaDB Client on the host using TCP/IP. You can inspect the Docker container to find the container's IP address and TCP port bindings.

Connect to Container with Host Networking

To connect to a Docker container that uses host networking, execute MariaDB Client on the host node and specify the host's IP address and the container's port:

$ mariadb --host=192.0.2.1 \
   --port=3307 \
   --user=root \
   --password

To confirm the client is connected to the Docker container and the container is using the correct version of MariaDB Enterprise Server 10.5, query the version system variable with the SHOW GLOBAL VARIABLES statement:

SHOW GLOBAL VARIABLES
   LIKE 'version'\G

*************************** 1. row ***************************
Variable_name: version
        Value: 10.5.26-20-MariaDB-enterprise-log

To exit the container, use exit:

exit

Bye

Create a Container with Docker Bridge Networking

By default, Docker containers use Docker bridge networking. To make connecting to the container easier, Docker can use port bindings to publish the container's TCP ports to the host.

To create a Docker container using Docker bridge networking, execute docker run:

$ docker run --detach \
   --name mariadb-es-10.5 \
   --env MARIADB_ROOT_PASSWORD='Password123!' \
   --publish '3307:3306/tcp' \
   docker.mariadb.com/enterprise-server:10.5 \
   --log-bin=mariadb-bin \
   <other mariadbd command-line options>

3082ab69e565be21c6157bb5a3d8c849ec03a2c51576778ac417a8a3aa9e7537

• Configure the container using environment variables by setting the --env command-line option.

• Configure TCP port bindings for the container by setting the --publish or --publish-all command-line options.

• Configure MariaDB Enterprise Server 10.5 by setting mariadbd command-line options.

To confirm the Docker container is running, execute docker ps:

$ docker ps \
   --all \
   --filter ancestor='docker.mariadb.com/enterprise-server:10.5'

CONTAINER ID   IMAGE                                         COMMAND                  CREATED          STATUS                      PORTS      NAMES
3082ab69e565   docker.mariadb.com/enterprise-server:10.5   "/es-entrypoint.sh -…"   12 seconds ago   Up 11 seconds               3306/tcp   mariadb-es-10.5

Create a Container with Host Networking

A Docker container can be configured to use the host operating system's network.

To create a Docker container using host networking, execute docker run and specify the --network host option:

$ docker run --detach \
   --network host \
   --name mariadb-es-10.5 \
   --env MARIADB_ROOT_PASSWORD='Password123!' \
   docker.mariadb.com/enterprise-server:10.5 \
   --port=3307 \
   --log-bin=mariadb-bin \
   <other mariadbd command-line options>

3082ab69e565be21c6157bb5a3d8c849ec03a2c51576778ac417a8a3aa9e7537

• Configure the container using environment variables by setting the --env command-line option.

• Configure the port for MariaDB Enterprise Server 10.5 by setting the --port command-line option.

• Configure MariaDB Enterprise Server 10.5 by setting mariadbd command-line options.

To confirm the Docker container is running, execute docker ps:

$ docker ps \
   --all \
   --filter ancestor='docker.mariadb.com/enterprise-server:10.5'

Environment Variables

A Docker container can be configured to perform the following tasks using environment variables:

• Create a custom database

• Create a custom database user account with a custom password

• Initialize the timezone tables

• Set the host for the root database user

• Set the password for the root database user

The following table contains details about the environment variables that are supported:

To create a Docker container using environment variables, execute docker run, environment variables and specify each environment variable using the --env option:

$ docker run --detach \
   --network host \
   --name mariadb-es-10.5 \
   --env MARIADB_ROOT_PASSWORD='Password123!' \
   docker.mariadb.com/enterprise-server:10.5

3082ab69e565be21c6157bb5a3d8c849ec03a2c51576778ac417a8a3aa9e7537

Inspect Container

A Docker contained can be inspected to find out internal details about the container, such as the following details:

• IP addresses

• MAC addresses

• Port bindings

To inspect all internal details about a Docker container, execute docker inspect:

$ docker inspect mariadb-es-10.5

[
    {
        "Id": "d784a193ad828cbd3db10dfbef3e3b7274465fa587453c3f6e2e27703b361173",
        "Created": "2021-10-13T20:25:04.994759266Z",
        "Path": "docker-entrypoint.sh",
        "Args": [
            "--log-bin=mariadb-bin"
        ],
        "State": {
            "Status": "running",
            "Running": true,
            "Paused": false,
            "Restarting": false,
            "OOMKilled": false,
            "Dead": false,
            "Pid": 33714,
            "ExitCode": 0,
            "Error": "",
            "StartedAt": "2021-10-13T20:25:05.32049779Z",
            "FinishedAt": "0001-01-01T00:00:00Z"
        },
        ..
    }
]

To inspect a specific internal detail about a Docker container, execute docker inspect and specify a filter using the --format option. Some examples are shown below.

To inspect the container's IP address:

$ docker inspect \
   --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' \
   mariadb-es-10.5

172.17.0.3

To inspect the container's TCP port bindings:

$ docker inspect \
   --format='{{range $p, $conf := .NetworkSettings.Ports}}Container port: {{$p}} -> Host port: {{(index $conf 0).HostPort}} {{end}}' \
   mariadb-es-10.5

Container port: 3306/tcp -> Host port: 3307

Log In to Docker Registry

To log in to the MariaDB Enterprise Docker Registry, execute docker login:

$ docker login docker.mariadb.com

When prompted, enter the login details:

• As the user name, enter the email address associated with your MariaDB ID.

• As the password, enter your Customer Download Token.

The login details will be saved.

To confirm the login details were saved, check the ~/.docker/config.json file for a JSON object named "docker.mariadb.com" inside an "auths" parent JSON object:

$ cat ~/.docker/config.json
{
   "auths": {
      "docker.mariadb.com": {
         "auth": "<auth_hash>"
      }
   }
}

Obtain a Shell in Container

To obtain a shell in the Docker container, execute the shell on the container using docker exec:

$ docker exec --interactive --tty \
   mariadb-es-10.5 \
   bash

Pull Docker Image

To pull a Docker image with the appropriate tag, execute docker pull:

$ docker pull docker.mariadb.com/enterprise-server:10.5

10.5: Pulling from enterprise-server
5d87d5506868: Pull complete
Digest: sha256:68795ca747901e3402e30dab71d6d8bc72bce727db3b9e4888979468be77d250
Status: Downloaded newer image for docker.mariadb.com/enterprise-server:10.5
docker.mariadb.com/enterprise-server:10.5

To confirm the Docker image has been pulled, execute docker images:

$ docker images \
   --filter=reference='docker.mariadb.com/enterprise-server'

REPOSITORY                             TAG       IMAGE ID       CREATED        SIZE
docker.mariadb.com/enterprise-server   10.5      dd17291aa340   3 months ago   451MB

Remove Container

To remove a Docker container, execute docker rm:

$ docker rm mariadb-es-10.5

mariadb-es-10.5

To confirm the container is removed, execute docker ps:

$ docker ps \
   --all \
   --filter ancestor='docker.mariadb.com/enterprise-server:10.5'

CONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES

Stop Container

To stop a Docker container, execute docker stop:

$ docker stop mariadb-es-10.5

mariadb-es-10.5

To confirm the container is stopped, execute docker ps:

$ docker ps \
   --all \
   --filter ancestor='docker.mariadb.com/enterprise-server:10.5'

CONTAINER ID   IMAGE                                         COMMAND                  CREATED         STATUS                            PORTS       NAMES
3082ab69e565   docker.mariadb.com/enterprise-server:10.5   "/es-entrypoint.sh -…"   2 minutes ago   Exited (143) About a minute ago               mariadb-es-10.5

View Container Logs

To view the logs in the Docker container, execute docker logs:

$ docker logs mariadb-es-10.5