Compose CLI environment variables

预计阅读时间:4分钟

您可以使用几个环境变量来配置 Docker Compose 命令行行为.

DOCKER_开头的变量与用于配置 Docker 命令行客户端的变量相同. 如果您使用的是docker-machine ,那么eval "$(docker-machine env my-docker-vm)"命令应该将它们设置为正确的值. (在本例中, my-docker-vm是您创建的机器的名称.)

注意:其中一些变量也可以使用环境文件提供.

COMPOSE_PROJECT_NAME

设置项目名称. 在启动时,该值会与服务名称一起添加到容器中. 例如,如果您的项目名称是myapp并且它包含两个服务dbweb ,那么 Compose 会分别启动名为myapp-db-1myapp-web-1容器.

设置这是可选的. 如果您不设置此项, COMPOSE_PROJECT_NAME默认为项目目录的basename . 另请参见-p命令行选项.

COMPOSE_FILE

指定 Compose 文件的路径. 如果未提供,Compose 会在当前目录中查找名为docker-compose.yml的文件,然后依次查找每个父目录,直到找到该名称的文件.

此变量支持由路径分隔符分隔的多个 Compose 文件(在 Linux 和 macOS 上,路径分隔符为: ,在 Windows 上为; ). 例如: COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml . 也可以使用COMPOSE_PATH_SEPARATOR自定义路径分隔符.

另请参见-f命令行选项.

COMPOSE_PROFILES

指定一个或多个要启用的活动配置文件. 使用COMPOSE_PROFILES=frontend调用 docker docker-compose up将使用配置文件frontend和没有指定配置文件的服务启动服务.

您可以指定用逗号分隔的配置文件列表: COMPOSE_PROFILES=frontend,debug将启用配置文件frontenddebug .

另请参阅将配置文件与 Compose--profile命令行选项一起使用.

COMPOSE_API_VERSION

Docker API 仅支持来自报告特定版本的客户端的请求. 如果您使用docker-compose收到client and server don't have same version的错误,您可以通过设置此环境变量来解决此错误. 设置版本值以匹配服务器版本.

设置此变量旨在作为一种解决方法,用于在客户端和服务器版本不匹配的情况下需要临时运行. 例如,如果您可以升级客户端但需要等待升级服务器.

使用这个变量集和已知的不匹配运行确实会阻止某些 Docker 功能正常工作. 失败的确切功能取决于 Docker 客户端和服务器版本. 因此,使用此变量集运行仅作为一种解决方法,并且不受官方支持.

如果您在使用此设置时遇到问题,请通过升级解决不匹配问题并删除此设置,以查看您的问题是否已解决,然后再通知支持人员.

DOCKER_HOST

设置docker守护进程的 URL. 与 Docker 客户端一样,默认为unix:///var/run/docker.sock .

DOCKER_TLS_VERIFY

当设置为空字符串以外的任何内容时,启用与docker守护程序的 TLS 通信.

DOCKER_CERT_PATH

配置用于 TLS 验证的ca.pemcert.pemkey.pem文件的路径. 默认为~/.docker .

COMPOSE_HTTP_TIMEOUT

配置在 Compose 认为失败之前允许对 Docker 守护程序的请求挂起的时间(以秒为单位). 默认为 60 秒.

COMPOSE_TLS_VERSION

Configure which TLS version is used for TLS communication with the docker daemon. Defaults to TLSv1. Supported values are: TLSv1, TLSv1_1, TLSv1_2.

COMPOSE_CONVERT_WINDOWS_PATHS

在卷定义中启用从 Windows 样式到 Unix 样式的路径转换. Windows 上 Docker Machine 的用户应始终设置此项. 默认为0 . 支持的值: true1启用, false0禁用.

COMPOSE_PATH_SEPARATOR

如果设置,则COMPOSE_FILE环境变量的值使用此字符作为路径分隔符进行分隔.

COMPOSE_FORCE_WINDOWS_HOST

如果设置,则使用短语法解析卷声明,假设主机路径是 Windows 路径,即使 Compose 在基于 UNIX 的系统上运行也是如此. 支持的值: true1启用, false0禁用.

COMPOSE_IGNORE_ORPHANS

如果设置,Compose 不会尝试检测项目的孤立容器. 支持的值: true1启用, false0禁用.

COMPOSE_PARALLEL_LIMIT

设置 Compose 可以并行执行的操作数限制. 默认值为64 ,并且不能设置为低于2 .

COMPOSE_INTERACTIVE_NO_CLI

如果设置,Compose 不会尝试使用 Docker CLI 进行交互式runexec操作. 此选项在上述操作需要 CLI 的 Windows 上不可用. 支持: true1启用, false0禁用.

COMPOSE_DOCKER_CLI_BUILD

配置是使用 Compose python 客户端构建镜像还是使用原生 docker cli. 默认情况下,Compose 使用docker CLI 执行构建,这允许您使用BuildKit执行构建.

设置COMPOSE_DOCKER_CLI_BUILD=0以禁用本机构建,并使用内置的 python 客户端.

fig, composition, compose, docker, orchestration, cli, reference

by  icopy.site