Configs 顶级元素

Table of contents

配置（Config）允许服务在无需重新构建 Docker 镜像的情况下调整其行为。与卷（Volume）类似，配置也会作为文件挂载到容器的文件系统中。在 Linux 容器中，挂载点在容器内的位置默认为 /<config-name>；在 Windows 容器中，默认为 C:\<config-name>。

服务只有在 services 顶级元素内的 configs 属性中明确授权后才能访问配置。

默认情况下，配置：

  • 由运行容器命令的用户拥有，但可以通过服务配置覆盖。
  • 具有全局可读权限（模式 0444），除非服务配置为覆盖此设置。

顶级 configs 声明定义或引用授予 Compose 应用程序中服务的配置数据。配置的来源可以是 file、environment、content 或 external。

  • file：使用指定路径文件的内容创建配置。
  • environment：使用环境变量的值创建配置内容。在 Docker Compose 版本 2.23.1 中引入。
  • content：使用内联值创建内容。在 Docker Compose 版本 2.23.1 中引入。
  • external：如果设置为 true，external 指定此配置已存在。Compose 不会尝试创建它，如果不存在，则会发生错误。
  • name：容器引擎中要查找的配置对象的名称。此字段可用于引用包含特殊字符的配置。名称按原样使用，不会使用项目名称作为作用域。

示例 1

部署应用程序时，通过将 httpd.conf 的内容注册为配置数据来创建 <project_name>_http_config。

configs:
  http_config:
    file: ./httpd.conf

或者，可以将 http_config 声明为外部配置。Compose 查找 http_config 以将配置数据暴露给相关服务。

configs:
  http_config:
    external: true

示例 2

外部配置查找也可以通过指定 name 来使用不同的键。

以下示例修改了前一个示例，使用参数 HTTP_CONFIG_KEY 查找配置。实际的查找键在部署时通过变量的插值设置，但作为硬编码 ID http_config 暴露给容器。

configs:
  http_config:
    external: true
    name: "${HTTP_CONFIG_KEY}"

示例 3

部署应用程序时，通过将内联内容注册为配置数据来创建 <project_name>_app_config。这意味着 Compose 在创建配置时会推断变量，这允许你根据服务配置调整内容：

configs:
  app_config:
    content: |
      debug=${DEBUG}
      spring.application.admin.enabled=${DEBUG}
      spring.application.name=${COMPOSE_PROJECT_NAME}

示例 4

部署应用程序时，使用环境变量的值作为配置数据来创建 <project_name>_simple_config。这对于不需要插值的简单配置值很有用：

configs:
  simple_config:
    environment: "SIMPLE_CONFIG_VALUE"

如果 external 设置为 true，则除 name 之外的所有其他属性都无关紧要。如果 Compose 检测到任何其他属性，它会拒绝 Compose 文件为无效。