Overview of docker-compose CLI

预计阅读时间:6分钟

此页面提供docker-compose命令的使用信息.

Command options overview and help

您还可以通过从命令行运行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           DEPRECATED and not working from 2.0 - 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 容器中的多个服务.

Use -f to specify name and path of one or more Compose files

使用-f标志指定 Compose 配置文件的位置.

Specifying multiple Compose files

您可以提供多个-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"

If the docker-compose.admin.yml also specifies this same service, any matching fields override the previous file. New values, add to the webapp service configuration.

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 .

Specifying a path to a single Compose file

您可以使用-f标志来指定不在当前目录中的 Compose 文件的路径,无论是从命令行还是通过在 shell 或环境文件中设置COMPOSE_FILE 环境变量.

对于在命令行中使用-f选项的示例,假设您正在运行Compose Rails 示例,并且在名为sandbox/rails的目录中有一个docker-compose.yml文件. 您可以使用docker-compose pull之类的命令,通过使用-f标志从任何地方获取db服务的 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

Use -p to specify a project name

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

Use --profile to specify one or more active profiles

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

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

Set up environment variables

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

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

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

Where to go next

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

by  icopy.site