Введение в docker-compose CLI

Эта страница содержит информацию об использовании docker-compose команд. Вы также можете увидеть данную информацию выполнив команду docker-compose --help в командной строке.

Define and run multi-container applications with Docker.

Usage:
  docker-compose [-f=<arg>...] [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)
  --verbose                   Show more output
  -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 (for example if your docker host
                              is an IP address)

Commands:
  build              Build or rebuild services
  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
  help               Get help on a command
  kill               Kill containers
  logs               View output from containers
  pause              Pause services
  port               Print the public port for a port binding
  ps                 List containers
  pull               Pulls 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
  unpause            Unpause services
  up                 Create and start containers
  version            Show the Docker-Compose version information

Docker Compose является бинарником. Команда docker-compose используется для сборки и управления несколькими сервисами в Docker контейнере.

Используйте флаг -f для указания местоположения конфигурационного файла Compose. Вы можете использовать несколько конфигурациооных файлов, при этом 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

Используйте флаг -f вместе с - (тире) вместо имени файла для чтения конфигурации из stdin. Когда используется stdin все пути конфигурационных файлов считаются относительными текущей рабочей директории.

Флаг -f является не обязательным. Если вы не используете данный флаг в командной строке, Compose проверяет текущую директорию и родительские в поисках файлов docker-compose.yml и docker-compose.override.yml. Должен быть хотя бы файл docker-compose.yml. Если оба файла присутствуют в одном каталоге, Compose комбинирует оба файла в единую конфигурацию. Конфигурационный файл docker-compose.override.ymlприменяется поверх файла docker-compose.yml.

Ознакомьтесь также с информацией о переменной окружения COMPOSE_FILE.

Каждая конфигурация имеет имя проекта. С помощью флага -p, вы можете задать имя проекта. Если вы не используете данный флаг, Compose использует имя каталога с проектом. Для большей информации читайте о переменной окружения COMPOSE_PROJECT_NAME

Что дальше

CLI переменные окружения