docker-compose CLI概述

预计阅读时间:5分钟

此页面提供docker-compose命令的用法信息。

命令选项概述和帮助

您也可以通过docker-compose --help从命令行运行来查看此信息。

Define and run multi-container applications with Docker.

Usage:
  docker-compose [-f <arg>...] [--profile <name>...] [options] [COMMAND] [ARGS...]
  docker-compose -h|--help

Options:
  -f, --file FILE             Specify an alternate compose file
                              (default: docker-compose.yml)
  -p, --project-name NAME     Specify an alternate project name
                              (default: directory name)
  --profile NAME              Specify a profile to enable
  --verbose                   Show more output
  --log-level LEVEL           Set log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
  --no-ansi                   Do not print ANSI control characters
  -v, --version               Print version and exit
  -H, --host HOST             Daemon socket to connect to

  --tls                       Use TLS; implied by --tlsverify
  --tlscacert CA_PATH         Trust certs signed only by this CA
  --tlscert CLIENT_CERT_PATH  Path to TLS certificate file
  --tlskey TLS_KEY_PATH       Path to TLS key file
  --tlsverify                 Use TLS and verify the remote
  --skip-hostname-check       Don't check the daemon's hostname against the
                              name specified in the client certificate
  --project-directory PATH    Specify an alternate working directory
                              (default: the path of the Compose file)
  --compatibility             If set, Compose will attempt to convert deploy
                              keys in v3 files to their non-Swarm equivalent

Commands:
  build              Build or rebuild services
  bundle             Generate a Docker bundle from the Compose file
  config             Validate and view the Compose file
  create             Create services
  down               Stop and remove containers, networks, images, and volumes
  events             Receive real time events from containers
  exec               Execute a command in a running container
  help               Get help on a command
  images             List images
  kill               Kill containers
  logs               View output from containers
  pause              Pause services
  port               Print the public port for a port binding
  ps                 List containers
  pull               Pull service images
  push               Push service images
  restart            Restart services
  rm                 Remove stopped containers
  run                Run a one-off command
  scale              Set number of containers for a service
  start              Start services
  stop               Stop services
  top                Display the running processes
  unpause            Unpause services
  up                 Create and start containers
  version            Show the Docker-Compose version information

您可以使用Docker Compose二进制文件docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]来构建和管理Docker容器中的多种服务。

使用-f指定名称和一个路径或多个文件撰写

使用该-f标志可以指定Compose配置文件的位置。

指定多个撰写文件

您可以提供多个-f配置文件。提供多个文件时,Compose会将它们组合为一个配置。Compose按照您提供文件的顺序构建配置。后续文件将覆盖并添加到其前身。

例如,考虑以下命令行:

$ docker-compose -f docker-compose.yml -f docker-compose.admin.yml run backup_db

docker-compose.yml文件可能指定了webapp服务。

webapp:
  image: examples/web
  ports:
    - "8000:8000"
  volumes:
    - "/data"

如果docker-compose.admin.yml还指定了相同的服务,则任何匹配的字段都将覆盖先前的文件。新值,添加到webapp服务配置中。

webapp:
  build: .
  environment:
    - DEBUG=1

当您使用多个Compose文件时,文件中的所有路径都相对于使用指定的第一个配置文件-f。您可以使用该 --project-directory选项覆盖此基本路径。

使用-f-(破折号)作为文件名从中读取配置 stdin。当stdin使用配置中的所有路径是相对于当前工作目录。

-f标志是可选的。如果未在命令行上提供此标志,则Compose遍历工作目录及其父目录以查找 docker-compose.ymldocker-compose.override.yml文件。您必须至少提供docker-compose.yml文件。如果两个文件都位于同一目录级别,则Compose会将两个文件合并为一个配置。

docker-compose.override.yml除了docker-compose.yml文件中的值外,还应用文件中的配置。

指定单个Compose文件的路径

您可以使用该-f标志通过命令行或通过在外壳程序或环境文件中设置COMPOSE_FILE环境变量来指定不在当前目录中的Compose文件的路径。

有关-f在命令行上使用该选项的示例,假设您正在运行Compose Rails示例,并docker-compose.yml在名为的目录中有一个文件sandbox/rails。您可以使用docker-compose pull之类的命令db,通过使用以下-f标志从任何地方获取服务的postgres图像:docker-compose -f ~/sandbox/rails/docker-compose.yml pull db

这是完整的示例:

$ docker-compose -f ~/sandbox/rails/docker-compose.yml pull db
Pulling db (postgres:latest)...
latest: Pulling from library/postgres
ef0380f84d05: Pull complete
50cf91dc1db8: Pull complete
d3add4cd115c: Pull complete
467830d8a616: Pull complete
089b9db7dc57: Pull complete
6fba0a36935c: Pull complete
81ef0e73c953: Pull complete
338a6c4894dc: Pull complete
15853f32f67c: Pull complete
044c83d92898: Pull complete
17301519f133: Pull complete
dcca70822752: Pull complete
cecf11b8ccf3: Pull complete
Digest: sha256:1364924c753d5ff7e2260cd34dc4ba05ebd40ee8193391220be0f9901d4e1651
Status: Downloaded newer image for postgres:latest

使用-p指定项目名称

每个配置都有一个项目名称。如果提供-p标志,则可以指定项目名称。如果未指定标志,则Compose使用当前目录名称。另请参见COMPOSE_PROJECT_NAME环境变量

使用--profile指定一个或多个活动概况

调用docker-compose --profile frontend up将使用配置文件启动服务,frontend而没有指定配置文件的服务将启动。您还可以启用多个配置文件,例如用docker-compose --profile frontend --profile debug up 配置文件frontenddebug将被启用。

另请参阅将配置文件与ComposeCOMPOSE_PROFILES环境变量一起使用

设置环境变量

您可以为各种 选项设置环境变量docker-compose,包括-f-p标志。

例如,COMPOSE_FILE环境变量-f标志有关,而COMPOSE_PROJECT_NAME 环境变量-p标志有关。

另外,您可以在环境文件中设置其中一些变量。

接下来要去哪里

无花果组成撰写docker编排cli参考docker-compose