docker-compose使用原创

# 1 安装

需提前安装 Docker Engine 和 Docker CLI，参考docker安装 (opens new window)

yum install docker-compose

通过检查版本来验证 Docker Compose 是否正确安装

docker-compose -version

# 2 使用

提示

在服务器的/usr/local/下面创建名为docker的文件夹，上传jar包到此目录下，下列新建文件均在此目录

# 2.1 创建 Dockerfile (opens new window)

# 2.2 创建docker-compose.yml

# 2.3 使用 Compose 构建并运行程序

docker-compose up -d

# 2.4 更新镜像

# 拉取镜像

docker-compose pull

# docker-compose 重启服务

docker-compose up -d --build

# 2.5 编辑 Compose 文件以添加绑定挂载

编辑compose.yml项目目录中的文件以添加服务的绑定挂载 (opens new window)web

services:
  web:
    build: .
    restart: always
    ports:
      - 8080:8080
    volumes:
      - .:/code
    environment:
      FLASK_DEBUG: "true"

1
2
3
4
5
6
7
8
9
10

新volumes密钥将主机上的项目目录（当前目录）挂载到/code容器内部，允许您动态修改代码，而无需重建映像。关键environment设置 FLASK_DEBUG环境变量，它告诉flask run在开发模式下运行并在更改时重新加载代码。该模式仅应在开发中使用。

# 2.6 重新构建并运行程序，实现热更改

由于应用程序代码现在使用卷安装到容器中，因此您可以更改其代码并立即查看更改，而无需重建映像。

# 3 docker-compose常用命令

# `up`

格式为 docker-compose up [options] [SERVICE...]。

该命令十分强大，它将尝试自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。

链接的服务都将会被自动启动，除非已经处于运行状态。

可以说，大部分时候都可以直接通过该命令来启动一个项目。

默认情况，docker-compose up 启动的容器都在前台，控制台将会同时打印所有容器的输出信息，可以很方便进行调试。

当通过 Ctrl-C 停止命令时，所有容器将会停止。

如果使用 docker-compose up -d，将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。

默认情况，如果服务容器已经存在，docker-compose up 将会尝试停止容器，然后重新创建（保持使用 volumes-from 挂载的卷），以保证新启动的服务匹配 docker-compose.yml 文件的最新内容。如果用户不希望容器被停止并重新创建，可以使用 docker-compose up --no-recreate。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。如果用户只想重新部署某个服务，可以使用 docker-compose up --no-deps -d <SERVICE_NAME> 来重新创建服务并后台停止旧服务，启动新服务，并不会影响到其所依赖的服务。

选项：

-d 在后台运行服务容器。
--no-color 不使用颜色来区分不同的服务的控制台输出。
--no-deps 不启动服务所链接的容器。
--force-recreate 强制重新创建容器，不能与 --no-recreate 同时使用。
--no-recreate 如果容器已经存在了，则不重新创建，不能与 --force-recreate 同时使用。
--no-build 不自动构建缺失的服务镜像。
-t, --timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

# `start`

格式为 docker-compose start [SERVICE...]。

启动已经存在的服务容器。

# `stop`

格式为 docker-compose stop [options] [SERVICE...]。

停止已经处于运行状态的容器，但不删除它。通过 docker-compose start 可以再次启动这些容器。

选项：

-t, --timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

# `down`

关闭所有内容，完全删除容器down 。传递--volumes以同时删除容器使用的数据卷

docker compose down --volumes

# `restart`

格式为 docker-compose restart [options] [SERVICE...]。

重启项目中的服务。

选项：

-t, --timeout TIMEOUT 指定重启前停止容器的超时（默认为 10 秒）。

# `rm`

格式为 docker-compose rm [options] [SERVICE...]。

删除所有（停止状态的）服务容器。推荐先执行 docker-compose stop 命令来停止容器。

选项：

-f, --force 强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。
-v 删除容器所挂载的数据卷。

# `logs`

格式为 docker-compose logs [options] [SERVICE...]。

查看服务容器的输出。默认情况下，docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过 --no-color 来关闭颜色。

该命令在调试问题的时候十分有用。

# `ps`

格式为 docker-compose ps [options] [SERVICE...]。

列出项目中目前的所有容器。

选项：

-q 只打印容器的 ID 信息。

# `run`

格式为 docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]。

在指定服务上执行一个命令。

例如：

docker-compose run ubuntu ping docker.com

将会启动一个 ubuntu 服务容器，并执行 ping docker.com 命令。

默认情况下，如果存在关联，则所有关联的服务将会自动被启动，除非这些服务已经在运行中。

该命令类似启动容器后运行指定的命令，相关卷、链接等等都将会按照配置自动创建。

两个不同点：

给定命令将会覆盖原有的自动运行命令；
不会自动创建端口，以避免冲突。

如果不希望自动启动关联的容器，可以使用 --no-deps 选项，例如

docker-compose run --no-deps web python manage.py shell

将不会启动 web 容器所关联的其它容器。

选项：

-d 后台运行容器。
--name NAME 为容器指定一个名字。
--entrypoint CMD 覆盖默认的容器启动指令。
-e KEY=VAL 设置环境变量值，可多次使用选项来设置多个环境变量。
-u, --user="" 指定运行容器的用户名或者 uid。
--no-deps 不自动启动关联的服务容器。
--rm 运行命令后自动删除容器，d 模式下将忽略。
-p, --publish=[] 映射容器端口到本地主机。
--service-ports 配置服务端口并映射到本地主机。
-T 不分配伪 tty，意味着依赖 tty 的指令将无法运行。

# `top`

查看各个服务容器内运行的进程。

# `images`

列出 Compose 文件中包含的镜像。

# `version`

格式为 docker-compose version。

# 4 yml 配置指令参考

# `image`

指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

1
2
3

# `volumes`

数据卷所挂载路径设置。可以设置为宿主机路径(HOST:CONTAINER)或者数据卷名称(VOLUME:CONTAINER)，并且可以设置访问模式（HOST:CONTAINER:ro）。

该指令中路径支持相对路径。

volumes:
 - /var/lib/mysql
 - cache/:/tmp/cache
 - ~/configs:/etc/configs/:ro

1
2
3
4

如果路径为数据卷名称，必须在文件中配置数据卷。

version: "3"
services:
  my_src:
    image: mysql:8.0
    volumes:
      - mysql_data:/var/lib/mysql
volumes:
  mysql_data:

1
2
3
4
5
6
7
8

# `restart`

指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效，在生产环境中推荐配置为 always 或者 unless-stopped。

restart: always

# `environment`

设置环境变量。你可以使用数组或字典两种格式。

只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

1
2
3
4
5
6
7

如果变量名称或者值中用到 true|false，yes|no 等表达布尔 (opens new window) 含义的词汇，最好放到引号里，避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇，包括

y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF

# `ports`

暴露端口信息。

使用宿主端口：容器端口 (HOST:CONTAINER) 格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

ports:
 - "3000"
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

1
2
3
4
5

注意：当使用 *HOST:CONTAINER* 格式来映射端口时，如果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果，因为 *YAML* 会自动解析 *xx:yy* 这种数字格式为 60 进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。

# `depends_on`

解决容器的依赖、启动先后的问题。以下例子中会先启动 redis db 再启动 web

version: '3'
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

1
2
3
4
5
6
7
8
9
10
11

注意：web 服务不会等待 redis db 「完全启动」之后才启动。

# `secrets`

存储敏感数据，例如 mysql 服务密码。

version: "3.1"
services:

mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
  secrets:
    - db_root_password
    - my_other_secret

secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# `build`

指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。 Compose 将会利用它自动构建这个镜像，然后使用这个镜像。

version: '3'
services:
  webapp:
    build: ./dir

1
2
3
4

你也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。

使用 dockerfile 指令指定 Dockerfile 文件名。

使用 arg 指令指定构建镜像时的变量。

version: '3'
services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

1
2
3
4
5
6
7
8

使用 cache_from 指定构建镜像的缓存

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14

1
2
3
4
5

# `cap_add, cap_drop`

指定容器的内核能力（capacity）分配。

例如，让容器拥有所有能力可以指定为：

cap_add:
  - ALL

1
2

去掉 NET_ADMIN 能力可以指定为：

cap_drop:
  - NET_ADMIN

1
2

# `command`

覆盖容器启动后默认执行的命令。

command: echo "hello world"

# `configs`

仅用于 Swarm mode，详细内容请查看 Swarm mode (opens new window) 一节。

# `cgroup_parent`

指定父 cgroup 组，意味着将继承该组的资源限制。

例如，创建了一个 cgroup 组名称为 cgroups_1。

cgroup_parent: cgroups_1

# `container_name`

指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式。

container_name: docker-web-container

注意: 指定容器名称后，该服务将无法进行扩展（scale），因为 Docker 不允许多个容器具有相同的名称。

# `deploy`

仅用于 Swarm mode，详细内容请查看 Swarm mode 一节

# `devices`

指定设备映射关系。

devices:
  - "/dev/ttyUSB1:/dev/ttyUSB0"

1
2

# `dns`

自定义 DNS 服务器。可以是一个值，也可以是一个列表。

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 114.114.114.114

1
2
3
4
5

# `dns_search`

配置 DNS 搜索域。可以是一个值，也可以是一个列表。

dns_search: example.com

dns_search:
  - domain1.example.com
  - domain2.example.com

1
2
3
4
5

# `tmpfs`

挂载一个 tmpfs 文件系统到容器。

tmpfs: /run
tmpfs:
  - /run
  - /tmp

1
2
3
4

# `env_file`

从文件中获取环境变量，可以为单独的文件路径或列表。

如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件，则 env_file 中变量的路径会基于模板文件路径。

如果有变量名称与 environment 指令冲突，则按照惯例，以后者为准。

env_file: .env

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env

1
2
3
4
5
6

环境变量文件中每一行必须符合格式，支持 # 开头的注释行。

# common.env: Set development environment
PROG_ENV=development

1
2

# `expose`

暴露端口，但不映射到宿主机，只被连接的服务访问。

仅可以指定内部端口为参数

expose:
 - "3000"
 - "8000"

1
2
3

# `extra_hosts`

类似 Docker 中的 --add-host 参数，指定额外的 host 名称映射信息。

extra_hosts:
 - "googledns:8.8.8.8"
 - "dockerhub:52.1.157.61"

1
2
3

会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。

8.8.8.8 googledns
52.1.157.61 dockerhub

1
2

# `healthcheck`

通过命令检查容器是否健康运行。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3

1
2
3
4
5

# `labels`

为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。

labels:
  com.startupteam.description: "webapp for a startup team"
  com.startupteam.department: "devops department"
  com.startupteam.release: "rc3 for v1.0"

1
2
3
4

# `logging`

配置日志选项。

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

1
2
3
4

目前支持三种日志驱动类型。

driver: "json-file"
driver: "syslog"
driver: "none"

1
2
3

options 配置日志驱动的相关参数。

options:
  max-size: "200k"
  max-file: "10"

1
2
3

# `network_mode`

设置网络模式。使用和 docker run 的 --network 参数一样的值。

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

1
2
3
4
5

# `networks`

配置容器连接的网络。

version: "3"
services:

  some-service:
    networks:
     - some-network
     - other-network

networks:
  some-network:
  other-network:

1
2
3
4
5
6
7
8
9
10
11

# `pid`

跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。

pid: "host"

# `security_opt`

指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。例如配置标签的用户名和角色名。

security_opt:
    - label:user:USER
    - label:role:ROLE

1
2
3

# `stop_signal`

设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。

stop_signal: SIGUSR1

# `sysctls`

配置容器内核参数。

sysctls:
  net.core.somaxconn: 1024
  net.ipv4.tcp_syncookies: 0

sysctls:
  - net.core.somaxconn=1024
  - net.ipv4.tcp_syncookies=0

1
2
3
4
5
6
7

# `ulimits`

指定容器的 ulimits 限制值。

例如，指定最大进程数为 65535，指定文件句柄数为 20000（软限制，应用可以随时修改，不能超过硬限制）和 40000（系统硬限制，只能 root 用户提高）。

  ulimits:
    nproc: 65535
    nofile:
      soft: 20000
      hard: 40000

1
2
3
4
5

# 其它指令

此外，还有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令，基本跟 docker run 中对应参数的功能一致。

指定服务容器启动后执行的入口文件。

entrypoint: /code/entrypoint.sh

指定容器中运行应用的用户名。

user: nginx

指定容器中工作目录。

working_dir: /code

指定容器中搜索域名、主机名、mac 地址等。

domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A

1
2
3

允许容器中运行一些特权命令。

privileged: true

以只读模式挂载容器的 root 文件系统，意味着不能对容器内容进行修改。

read_only: true

打开标准输入，可以接受外部输入。

stdin_open: true

模拟一个伪终端。

tty: true

# 读取变量

Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env 文件中的变量。

例如，下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值，并写入执行的指令中。

version: "3"
services:
db:
  image: "mongo:${MONGO_VERSION}"

1
2
3
4

如果执行 MONGO_VERSION=3.2 docker-compose up 则会启动一个 mongo:3.2 镜像的容器；如果执行 MONGO_VERSION=2.8 docker-compose up 则会启动一个 mongo:2.8 镜像的容器。

若当前目录存在 .env 文件，执行 docker-compose 命令时将从该文件中读取变量。

在当前目录新建 .env 文件并写入以下内容。

# 支持 # 号注释
MONGO_VERSION=3.6

1
2

执行 docker-compose up 则会启动一个 mongo:3.6 镜像的容器。

# 参考资料

官方文档 (opens new window)

https://www.runoob.com/docker/docker-compose.html (opens new window)

https://yeasy.gitbook.io/docker_practice/compose/commands (opens new window)

#后端 #Docker

上次更新: 2023/12/09 16:33:08

← Docker部署前后端分离项目代码上线事故原因→

docker-compose使用原创

# 1 安装

# 2 使用

# 2.1 创建 Dockerfile (opens new window)

# 2.2 创建docker-compose.yml

# 2.3 使用 Compose 构建并运行程序

# 2.4 更新镜像

# 拉取镜像

# docker-compose 重启服务

# 2.5 编辑 Compose 文件以添加绑定挂载

# 2.6 重新构建并运行程序，实现热更改

# 3 docker-compose常用命令

# up

# start

# stop

# down

# restart

# rm

# logs

# ps

# run

# top

# images

# version

# 4 yml 配置指令参考

# image

# volumes

# restart

# environment

# ports

# depends_on

# secrets

# build

# cap_add, cap_drop

# command

# configs

# cgroup_parent

# container_name

# deploy

# devices

# dns

# dns_search

# tmpfs

# env_file

# expose

# extra_hosts

# healthcheck

# labels

# logging

# network_mode

# networks

# pid

# security_opt

# stop_signal

# sysctls

# ulimits

# 其它指令

# 读取变量

# 参考资料

# `up`

# `start`

# `stop`

# `down`

# `restart`

# `rm`

# `logs`

# `ps`

# `run`

# `top`

# `images`

# `version`

# `image`

# `volumes`

# `restart`

# `environment`

# `ports`

# `depends_on`

# `secrets`

# `build`

# `cap_add, cap_drop`

# `command`

# `configs`

# `cgroup_parent`

# `container_name`

# `deploy`

# `devices`

# `dns`

# `dns_search`

# `tmpfs`

# `env_file`

# `expose`

# `extra_hosts`

# `healthcheck`

# `labels`

# `logging`

# `network_mode`

# `networks`

# `pid`

# `security_opt`

# `stop_signal`

# `sysctls`

# `ulimits`