如何使用 docker-compose 环境变量来填充配置文件

Question

我是 docker-compose 的新手。
我试图了解如何在Dockerfile 的构建阶段通过 docker-compose 传递环境变量以填充配置文件中缺少的变量值，因此在运行阶段，我将运行服务-rabbitmq它的配置填充了环境变量值。

在 docker-compose yml 文件中，我有一个 env_file: 和 environment:，我该如何将它们传递给配置文件。

任何帮助，一个简单的例子将不胜感激 当然。

示例 rabbitmq 配置文件（环境变量需要用 $SSL_PORT 的值填充）：

[{rabbit,
  [
    {loopback_users, []},
    {ssl_listeners, [$SSL_PORT]},
    {ssl_options, [{cacertfile,"/etc/rabbitmq/ca/cacert.pem"},
                   {certfile,"/etc/rabbitmq/server/cert.pem"},
                   {keyfile,"/etc/rabbitmq/server/key.pem"},
                   {verify,verify_none},
                   {fail_if_no_peer_cert,false}]}
  ]}
].

Answer 1

问题可以分为两部分：

1. 在容器内注入配置值
2. 让目标软件使用这样的配置值

第一个问题是通过使用环境变量解决的：正如您所说，您可以指示 docker 使用 env 文件 (--env-file file.env) 或指定单个环境变量 (--env VARIABLE=value)，docker 将使它们在容器。

第二个问题根据使用的配置框架有不同的解决方案。

例如，如果您使用 Typesafe config 或 Spring 之类的东西，您可以在配置本身中放置对环境变量的引用，配置框架会自动扩展它。

如果您正在配置不支持环境变量扩展的第三方软件，则需要在目标软件执行之前进行一些预处理。

这通常通过使用自定义 entrypoint 创建一个 docker 映像来完成。该入口点负责修改目标软件的配置，扩展已知环境变量，然后启动软件。

这种入口点脚本的一个例子可能是：

#!/bin/sh

sed -i "s/\$SSL_PORT/$SSL_PORT/g" /etc/software.conf

exec $@

以这种方式修改配置文件可能很危险且容易出错，因此在编写此类脚本时要小心。

更新：

如果您只想在原始入口点开始之前执行一些预处理，您可以遵循以下简单模式：假设原始入口点称为docker-entrypoint.sh，您需要做的就是创建@987654329 @有这个内容：

#!/bin/bash

# Perfom all the needed preprocessing here...

# Invoke the original entrypoint passing the command and arguments
exec /docker-entrypoint.sh $@ 

如果您使用新入口点构建 docker 映像并使用以下命令启动容器：

docker run --rm test-image echo "This is a test"

将会发生的情况是docker-entrypoint-pre.sh 将使用参数echo 和This is a test 进行调用。预处理完成后，原始入口点docker-entrypoint.sh 将使用相同的参数调用，从而保持原始图像的行为。

更新 2： 为了添加新的入口点，您必须创建一个继承自原始入口点的新 Docker 映像。假设原始图像是rabbit:latest，您需要创建一个具有以下内容的Dockerfile：

FROM rabbit:latest

COPY docker-entrypoint-pre.sh /docker-entrypoint-pre.sh

ENTRYPOINT ["/docker-entrypoint-pre.sh"]

然后使用包含Dockerfile 和docker-entrypoint-pre.sh 的目录中的docker build -t myrabbit:latest . 构建您的映像。

此时，您有了一个带有预处理逻辑的新图像myrabbit:latest。

Answer 2

假设您的配置文件在容器内部使用变量$SSL_PORT，并且您希望从要使用的主机机器传递环境变量在构建时，这可以在您的 docker-compose.yml 中完成。 YAML 支持使用环境变量，因此，您可以使用 environment: 后跟要在运行时传递给容器的变量数组。

例如：

version: '3'
services:
  your-app:
    build:
      context: .
      dockerfile: Dockerfile
    environment:
      - "SSL_PORT=${PORT_VARIABLE_FROM_HOST}"

要排除故障并确保您的变量实际上是在您的容器运行中分配的：

docker exec -it <container_name_or_id> printenv

这应该列出容器内的所有环境变量