Docker-compose检查mysql连接是否准备就绪

Question 1

我试图确保我的应用容器在数据库容器启动并且准备接受连接之前不运行迁移/启动。

所以我决定使用运行状况检查，并取决于docker compose文件v2中的选项。

在应用程序中，我有以下内容

app:
    ...
    depends_on:
      db:
      condition: service_healthy

另一方面，数据库具有以下运行状况检查

db:
  ...
  healthcheck:
    test: TEST_GOES_HERE
    timeout: 20s
    retries: 10

我尝试了几种方法，例如：

确保已创建数据库DIR test: ["CMD", "test -f var/lib/mysql/db"]
获取mysql版本： test: ["CMD", "echo 'SELECT version();'| mysql"]
对管理员执行ping操作（将db容器标记为运行状况良好，但似乎不是有效的测试） test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]

有人对此有解决方案吗？

Question 2

version: "2.1"
services:
    api:
        build: .
        container_name: api
        ports:
            - "8080:8080"
        depends_on:
            db:
                condition: service_healthy
    db:
        container_name: db
        image: mysql
        ports:
            - "3306"
        environment:
            MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
            MYSQL_USER: "user"
            MYSQL_PASSWORD: "password"
            MYSQL_DATABASE: "database"
        healthcheck:
            test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
            timeout: 20s
            retries: 10

直到db容器运行正常（基本上直到mysqladmin启动并接受连接），api容器才会启动。

Question 3

如果您使用的是docker-compose v3 +，则已删除condition的选项。depends_on

推荐的途径是使用相当wait-for-it，dockerize或者wait-for。在docker-compose.yml文件中，将命令更改为：

command: sh -c 'bin/wait-for db:3306 -- bundle exec rails s'

我个人更喜欢，wait-for因为它可以在Alpine容器中运行（sh兼容，不依赖bash）。缺点是它取决于netcat，因此，如果您决定使用它，请确保已netcat安装在容器中或将其安装在Dockerfile中，例如使用：

RUN apt-get -q update && apt-get -qy install netcat

我还分叉了该wait-for项目，以便它可以检查健康的HTTP状态（使用wget）。然后，您可以执行以下操作：

command: sh -c 'bin/wait-for http://api/ping -- jest test'

PS：PR也准备好合并以增加该功能到wait-for项目中。

Question 4

这样就足够了

version: '2.1'
services:
  mysql:
    image: mysql
    ports: ['3306:3306']
    environment:
      MYSQL_USER: myuser
      MYSQL_PASSWORD: mypassword
    healthcheck:
      test: mysqladmin ping -h 127.0.0.1 -u $$MYSQL_USER --password=$$MYSQL_PASSWORD

Question 5

如果可以更改容器以等待mysql准备就绪，请执行此操作。

如果您无法控制要将数据库连接到的容器，则可以尝试等待特定的端口。

为此，我使用一个小脚本来等待另一个容器公开的特定端口。

在这个例子中，MYSERVER将等待端口3306的mydb的容器可到达。

# Your database
mydb:
  image: mysql
  ports:
    - "3306:3306"
  volumes:
    - yourDataDir:/var/lib/mysql

# Your server
myserver:
  image: myserver
  ports:
    - "....:...."
  entrypoint: ./wait-for-it.sh mydb:3306 -- ./yourEntryPoint.sh

您可以在此处找到脚本等待文档

Question 6

您好，我使用docker-compose v2.1进行了简单的健康检查，我使用了：

/usr/bin/mysql --user=root --password=rootpasswd --execute \"SHOW DATABASES;\"

基本上，它运行的简单mysql命令SHOW DATABASES;使用，例如，用户root的密码rootpasswd 在数据库中。

如果命令成功执行，则数据库已启动并且已准备就绪，因此运行状况检查路径。您可以使用interval它，以便每隔一段时间进行测试。

删除其他字段以提高可见性，这就是您的中的样子docker-compose.yaml。

version: '2.1'

  services:
    db:
      ... # Other db configuration (image, port, volumes, ...)
      healthcheck:
        test: "/usr/bin/mysql --user=root --password=rootpasswd --execute \"SHOW DATABASES;\""
        interval: 2s
        timeout: 20s
        retries: 10

     app:
       ... # Other app configuration
       depends_on:
         db:
         condition: service_healthy

Question 7

我docker-compose.yml按照以下示例进行了修改，并且可以正常工作。

  mysql:
    image: mysql:5.6
    ports:
      - "3306:3306"
    volumes:       
      # Preload files for data
      - ../schemaAndSeedData:/docker-entrypoint-initdb.d
    environment:
      MYSQL_ROOT_PASSWORD: rootPass
      MYSQL_DATABASE: DefaultDB
      MYSQL_USER: usr
      MYSQL_PASSWORD: usr
    healthcheck:
      test:  mysql --user=root --password=rootPass -e 'Design your own check script ' LastSchema

就我而言，../schemaAndSeedData包含多个模式和数据种子sql文件。Design your own check script可以类似于以下内容select * from LastSchema.LastDBInsert。

虽然网络依赖的容器代码是

depends_on:
  mysql:
    condition: service_healthy

Question 8

我遇到了同样的问题，为此我创建了一个外部bash脚本（受Maxim答案启发）。用mysql-container-name您的MySQL容器的名称替换，还需要密码/用户：

bin / wait-for-mysql.sh：

#!/bin/sh
until docker container exec -it mysql-container-name mysqladmin ping -P 3306 -proot | grep "mysqld is alive" ; do
  >&2 echo "MySQL is unavailable - waiting for it... 😴"
  sleep 1
done

在我的MakeFile中，我在docker-composeup调用之后立即调用此脚本：

wait-for-mysql: ## Wait for MySQL to be ready
    bin/wait-for-mysql.sh

run: up wait-for-mysql reload serve ## Start everything...

然后，我可以调用其他命令而不会出现错误：

驱动程序中发生异常：SQLSTATE [HY000] [2006] MySQL服务器已消失

输出示例：

docker-compose -f docker-compose.yaml up -d
Creating network "strangebuzzcom_default" with the default driver
Creating sb-elasticsearch ... done
Creating sb-redis              ... done
Creating sb-db                 ... done
Creating sb-app                ... done
Creating sb-kibana             ... done
Creating sb-elasticsearch-head ... done
Creating sb-adminer            ... done
bin/wait-for-mysql.sh
MySQL is unavailable - waiting for it... 😴
MySQL is unavailable - waiting for it... 😴
MySQL is unavailable - waiting for it... 😴
MySQL is unavailable - waiting for it... 😴
MySQL is unavailable - waiting for it... 😴
MySQL is unavailable - waiting for it... 😴
MySQL is unavailable - waiting for it... 😴
MySQL is unavailable - waiting for it... 😴
mysqld is alive
php bin/console doctrine:cache:clear-metadata
// Clearing all Metadata cache entries
[OK] Successfully deleted cache entries.

我已经删除了健康检查，因为这种方法现在已经无用了。

Question 9

重新启动失败

由于v3condition: service_healthy不再可用。这个想法是，开发人员应该在应用程序内部实现崩溃恢复机制。但是，对于简单的用例，解决此问题的一种简单方法是使用restartoption。

如果mysql服务状态导致您的应用程序出现问题，则exited with code 1可以使用restart可用的策略选项之一。例如，on-failure

version: "3"

services:

    app:
      ...
      depends_on:
        - db:
      restart: on-failure

Question 10

为运行状况检查方法添加了更新的解决方案。简单代码段：

healthcheck:
  test: out=$$(mysqladmin ping -h localhost -P 3306 -u foo --password=bar 2>&1); echo $$out | grep 'mysqld is alive' || { echo $$out; exit 1; }

说明：由于mysqladmin ping返回的是肯定的错误消息（尤其是输入错误的密码），因此我将输出保存到临时变量中，然后grep用于查找预期的输出（mysqld is alive）。如果找到，它将返回0错误代码。如果找不到它，我将打印整个消息，并返回1错误代码。

扩展代码段：

version: "3.8"
services:
  db:
    image: linuxserver/mariadb
    environment:
      - FILE__MYSQL_ROOT_PASSWORD=/run/secrets/mysql_root_password
      - FILE__MYSQL_PASSWORD=/run/secrets/mysql_password
    secrets:
      - mysql_root_password
      - mysql_password
    healthcheck:
      test: out=$$(mysqladmin ping -h localhost -P 3306 -u root --password=$$(cat $${FILE__MYSQL_ROOT_PASSWORD}) 2>&1); echo $$out | grep 'mysqld is alive' || { echo $$out; exit 1; }

secrets:
  mysql_root_password:
    file: ${SECRETSDIR}/mysql_root_password
  mysql_password:
    file: ${SECRETSDIR}/mysql_password

说明：我使用的是docker secrets而不是env变量（但这也可以通过常规的env vars实现）。使用的$$是文字$符号，当传递到容器时会被剥离。

来自docker inspect --format "{{json .State.Health }}" db | jq各种场合的输出：

一切都没事：

{
  "Status": "healthy",
  "FailingStreak": 0,
  "Log": [
    {
    {
      "Start": "2020-07-20T01:03:02.326287492+03:00",
      "End": "2020-07-20T01:03:02.915911035+03:00",
      "ExitCode": 0,
      "Output": "mysqld is alive\n"
    }
  ]
}

DB尚未启动（尚未）：

{
  "Status": "starting",
  "FailingStreak": 1,
  "Log": [
    {
      "Start": "2020-07-20T01:02:58.816483336+03:00",
      "End": "2020-07-20T01:02:59.401765146+03:00",
      "ExitCode": 1,
      "Output": "\u0007mysqladmin: connect to server at 'localhost' failed error: 'Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock' (2 \"No such file or directory\")' Check that mysqld is running and that the socket: '/var/run/mysqld/mysqld.sock' exists!\n"
    }
  ]
}

密码错误：

{
  "Status": "unhealthy",
  "FailingStreak": 13,
  "Log": [
    {
      "Start": "2020-07-20T00:56:34.303714097+03:00",
      "End": "2020-07-20T00:56:34.845972979+03:00",
      "ExitCode": 1,
      "Output": "\u0007mysqladmin: connect to server at 'localhost' failed error: 'Access denied for user 'root'@'localhost' (using password: YES)'\n"
    }
  ]
}