赞
踩
Compose 是一个用于定义和运行多容器 Docker 的工具。借助 Compose,您可以使用 YAML 文件来配置应用程序的服务。
使用 Compose 基本上分为三步:
使用 Dockerfile 定义您的应用程序的环境
使用 docker-compose.yml 定义组成您的应用程序的服务
运行docker compose up启动并运行程序
我们可认为同一个项目配置多个compose文件,使用多个 Compose 文件使您能够针对不同的环境或不同的工作流程自定义 Compose 应用程序。
默认情况下,Compose 读取两个文件,docker-compose.yml和一个可选的docker-compose.override.yml文件。按照惯例,docker-compose.yml包含您的基本配置。override.yml 文件,顾名思义,就是包含现有服务或全新服务的配置覆盖。
如果在两个文件中都定义了服务,Compose 会使用 override 进行合并配置。
要使用多个覆盖文件或具有不同名称的覆盖文件,您可以使用该-f选项来指定文件列表。Compose 按照在命令行中指定的顺序合并文件。
当您使用多个配置文件时,您必须确保文件中的所有路径都相对于基本 Compose 文件( 指定的第一个 Compose 文件-f)
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d
版本信息,定义关乎于docker的兼容性,Compose 文件格式有3个版本,分别为1, 2.x 和 3.x
服务除了可以基于指定的镜像,还可以基于一份 Dockerfile,在使用 up 启动之时执行构建任务,这个构建标签就是 build,它可以指定 Dockerfile 所在文件夹的路径。Compose 将会利用它自动构建这个镜像,然后使用这个镜像启动服务容器。
build 可以指定为包含构建上下文路径的字符串:
version:"3.7"
services:
webapp:
build:./dir
或者,作为具有在上下文中指定的路径的对象以及可选的Dockerfile和args:
version:"3.7"
services:
webapp:
build:
context:./dir
dockerfile:Dockerfile-alternate
args:
buildno:1
如果你指定image以及build,则使用以下指定的webapp和可选项对构建的镜像进行命名:
这会在./dir目录下生成一个名为webapp和标记的镜像tag。
build:./dir
image:webapp:tag
context 选项可以是 Dockerfile 的文件路径,也可以是到链接到 git 仓库的 url。
当提供的值是相对路径时,它被解析为相对于撰写文件的路径,此目录也是发送到 Docker 守护进程的 context。
build:
context:./dir
使用此 dockerfile 文件来构建,必须指定构建路径。
build:
context:.
dockerfile:Dockerfile-alternate
添加构建参数,这些参数是仅在构建过程中可访问的环境变量。
首先,在Dockerfile中指定参数:
ARG buildno
ARG gitcommithash
RUN echo "Build number: $buildno"
RUN echo "Based on commit: $gitcommithash"
然后在build键下指定参数,可以传递映射或列表:
build: context:. args: buildno:1 gitcommithash:cdc3b19 build: context:. args: - buildno=1 - gitcommithash=cdc3b19
注意:在Dockerfile中,如果ARG在FROM指令之前指定, ARG则在构建说明中不可用FROM。如果您需要在两个位置都可以使用参数,请在FROM指令下指定它。
你可以在指定构建参数时省略该值,在这种情况下,它在构建时的值是运行Compose的环境中的值。
args:
- buildno
- gitcommithash
注意:YAML布尔值(true,false,yes,no,on,off)必须用引号括起来,这样分析器会将它们解释为字符串。
编写缓存解析镜像列表,此选项是v3.2中的新选项。
build:
context:.
cache_from:
- alpine:latest
- corp/web_app:3.14
使用 Docker标签 将元数据添加到生成的镜像中,可以使用数组或字典。
建议使用反向 DNS 标记来防止签名与其他软件所使用的签名冲突,此选项是v3.3中的新选项。
build: context:. labels: com.example.description:"Accountingwebapp" com.example.department:"Finance" com.example.label-with-empty-value:"" build: context:. labels: - "com.example.description=Accountingwebapp" - "com.example.department=Finance" - "com.example.label-with-empty-value"
设置容器 /dev/shm 分区的大小,值为表示字节的整数值或表示字符的字符串
build:
context:.
shm_size:'2gb'
build:
context:.
shm_size:10000000
根据对应的 Dockerfile 构建指定 Stage
build:
context:.
target:prod
添加或删除容器功能
cap_add:
- ALL
cap_drop:
- NET_ADMIN
- SYS_ADMIN
注意:当用(Version 3) Compose 文件在群集模式下部署堆栈时,该选项被忽略。因为 docker stack 命令只接受预先构建的镜像
覆盖容器启动后默认执行的命令
command:bundle exec thin -p 3000
该命令也可以是一个列表,方式类似于dockerfile:
command:["bundle","exec","thin","-p","3000"]
使用服务 configs 配置为每个服务赋予相应的访问权限,支持两种不同的语法
version:"3.7" services: redis: image:redis:latest deploy: replicas:1 configs: - my_config - my_other_config configs: my_config: file:./my_config.txt my_other_config: external:true
以上实例使用 SHORT 语法将 redis 服务访问授予 my_config 和 my_other_config ,并被 my_other_config 定义为外部资源,这意味着它已经在 Docker 中定义。可以通过 docker config create 命令或通过另一个堆栈部署。如果外部部署配置都不存在,则堆栈部署会失败并出现 config not found 错误。
注意: config 定义仅在 3.3 版本或在更高版本的撰写文件格式中受支持,YAML 的布尔值(true, false, yes, no, on, off)必须要使用引号引起来(单引号、双引号均可),否则会当成字符串解析。
LONG 语法提供了创建服务配置的更加详细的信息。
下面示例在容器中将 my_config 名称设置为 redis_config,将模式设置为 0440(group-readable)并将用户和组设置为 103。该redis服务无法访问 my_other_config 配置。
version:"3.7" services: redis: image:redis:latest deploy: replicas:1 configs: - source:my_config target:/redis_config uid:'103' gid:'103' mode:0440 configs: my_config: file:./my_config.txt my_other_config: external:true
可以同时授予多个配置的服务相应的访问权限,也可以混合使用 LONG 和 SHORT 语法。定义配置并不意味着授予服务访问权限。
为自定义的容器指定一个名称,而不是使用默认的名称
container_name:my-web-container
由于Docker容器名称必须是唯一的,因此如果指定了自定义名称,则无法将服务扩展到1个容器之外。试图这样做会导致错误。
容器中服务之间的依赖关系,依赖关系会导致以下行为:
version:"3.7" services: web: build:. depends_on: - db - redis redis: image:redis db: image:postgres
使用时需要注意以下几点depends_on:
depends_on不会在启动web之前等待db和redis“就绪”
版本3不再支持condition形式depends_on。
指定与部署和运行服务相关的配置。
version:"3.7" services: redis: image:redis:alpine deploy: replicas:6 update_config: parallelism:2 delay:10s restart_policy: condition:on-failure
有几个子选项可供选择:
endpoint_mode:指定连接到群组外部客户端服务发现方法
endpoint_mode:vip :Docker 为该服务分配了一个虚拟 IP(VIP),作为客户端的 “前端“ 部位用于访问网络上的服务。
endpoint_mode: dnsrr : DNS轮询(DNSRR)服务发现不使用单个虚拟 IP。Docker为服务设置 DNS 条目,使得服务名称的 DNS 查询返回一个 IP 地址列表,并且客户端直接连接到其中的一个。如果想使用自己的负载平衡器,或者混合 Windows 和 Linux 应用程序,则 DNS 轮询调度(round-robin)功能就非常实用。
version:"3.7" services: wordpress: image:wordpress ports: - "8080:80" networks: - overlay deploy: mode:replicated replicas:2 endpoint_mode:vip mysql: image:mysql volumes: - db-data:/var/lib/mysql/data networks: - overlay deploy: mode:replicated replicas:2 endpoint_mode:dnsrr volumes: db-data: networks: overlay:
指定服务的标签,这些标签仅在服务上设置
version:"3.7"
services:
web:
image:web
deploy:
labels:
com.example.description:"Thislabelwillappearonthewebservice"
通过将 deploy 外面的 labels 标签来设置容器上的 labels
version:"3.7"
services:
web:
image:web
labels:
com.example.description:"Thislabelwillappearonallcontainersforthewebservice"
global:每个集节点只有一个容器
replicated:指定容器数量(默认)
version:"3.7"
services:
worker:
image:dockersamples/examplevotingapp_worker
deploy:
mode:global
指定 constraints 和 preferences
version:"3.7" services: db: image:postgres deploy: placement: constraints: - node.role == manager - engine.labels.operatingsystem == ubuntu 14.04 preferences: - spread:node.labels.zone
如果服务是 replicated(默认),需要指定运行的容器数量
version:"3.7" services: worker: image:dockersamples/examplevotingapp_worker networks: - frontend - backend deploy: mode:replicated replicas:6
配置资源限制
version:"3.7" services: redis: image:redis:alpine deploy: resources: limits: cpus:'0.50' memory:50M reservations: cpus:'0.25' memory:20M
例子中,redis 服务限制使用不超过 50M 的内存和 0.50(50%)可用处理时间(CPU),并且保留 20M 了内存和 0.25 CPU时间。
设置映射列表,与 Docker 客户端的 --device 参数类似
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
自定义 DNS 服务器,与 --dns 具有一样的用途,可以是单个值或列表
dns:8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9
自定义 DNS 搜索域,可以是单个值或列表
dns_search:example.com
dns_search:
- dc1.example.com
- dc2.example.com
在 Dockerfile 中有一个指令叫做 ENTRYPOINT 指令,用于指定接入点。在 docker-compose.yml 中可以定义接入点,覆盖 Dockerfile 中的定义
entrypoint:/code/entrypoint.sh
入口点也可以是一个列表,方式类似于 dckerfile:
entrypoint:
- php
- -d
- zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
- -d
- memory_limit=-1
- vendor/bin/phpunit
从文件中添加环境变量。可以是单个值或是列表
如果已经用 docker-compose -f FILE 指定了 Compose 文件,那么 env_file 路径值为相对于该文件所在的目录
但 environment 环境中的设置的变量会会覆盖这些值,无论这些值未定义还是为 None
env_file:.env
env_file:
- ./common.env
- ./apps/web.env
-/opt/secrets.env
a.env 文件
# a.env
VAR=1
b.env文件
# b.env
VAR=hello
对于在文件a.env 中指定的相同变量但在文件 b.env 中分配了不同的值,如果 b.env 像下面列在 a.env 之后,则刚在 a.env 设置的值被 b.env 相同变量的值覆盖,此时 $VAR 值为 hello。此外,这里所说的环境变量是对宿主机的 Compose 而言的,如果在配置文件中有 build 操作,这些变量并不会进入构建过程中,如果要在构建中使用变量还是首选 arg 标签。
添加环境变量,可以使用数组或字典。与上面的 env_file 选项完全不同,反而和 arg 有几分类似,这个标签的作用是设置镜像变量,它可以保存变量到镜像里面,也就是说启动的容器也会包含这些变量设置,这是与 arg 最大的不同。
一般 arg 标签的变量仅用在构建过程中。而 environment 和 Dockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中,类似 docker run -e 的效果。
environment:
RACK_ENV:development
SHOW:'true'
SESSION_SECRET:
environment:
- RACK_ENV=development
- SHOW=true
- SESSION_SECRET
暴露端口,但不映射到宿主机,只被连接的服务访问。这个标签与 Dockerfile 中的 EXPOSE 指令一样,用于指定暴露的端口,但是只是作为一种参考,实际上 docker-compose.yml 的端口映射还得 ports 这样的标签
expose:
- "3000"
- "8000"
从指定的镜像中启动容器,可以是存储仓库、标签以及镜像 ID。
如果镜像不存在,Compose 会自动拉去镜像。
image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd
在容器内运行init,转发信号并重新获得进程。将此选项设置true是为服务启用此功能。
version:"3.7"
services:
web:
image:alpine:latest
init:true
链接到其它服务的中的容器,可以指定服务名称也可以指定链接别名(SERVICE:ALIAS),与 Docker 客户端的 --link 有一样效果,会连接到其它服务中的容器。
web:
links:
- db
- db:database
- redis
配置日志服务
logging:
driver:syslog
options:
syslog-address:"tcp://192.168.59.5:123"
该 driver值是指定服务器的日志记录驱动程序,默认值为 json-file,与 --log-diver 选项一样
driver: "json-file"
driver: "syslog"
driver: "none"
注意:只有驱动程序 json-file 和 journald 驱动程序可以直接从 docker-compose up 和 docker-compose logs 获取日志。使用任何其他方式不会显示任何日志。
对于可选值,可以使用 options 指定日志记录中的日志记录选项
driver:"syslog"
options:
syslog-address:"tcp://192.168.0.42:123"
默认驱动程序 json-file 具有限制存储日志量的选项,所以,使用键值对来获得最大存储大小以及最小存储数量
driver: "json-file"
options:
max-size:"200k"
max-file:"10"
上面实例将存储日志文件,直到它们达到max-size:200kB,存储的单个日志文件的数量由该 max-file 值指定。随着日志增长超出最大限制,旧日志文件将被删除以存储新日志
docker-compose.yml 限制日志存储的示例
version:"3.7" services: some-service: image:some-service logging: driver:"json-file" options: max-size:"200k" max-file:"10"
网络模式,用法类似于 Docke 客户端的 --net 选项,格式为:service:[service name],可以指定使用服务或者容器的网络。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"
加入指定网络
services:
some-service:
networks:
- some-network
- other-network
#####aliases
同一网络上的其他容器可以使用服务器名称或别名来连接到其他服务的容器,相同的服务可以在不同的网络有不同的别名。
services: some-service: networks: some-network: aliases: - alias1 - alias3 other-network: aliases: - alias2
下面实例中,提供 web 、worker以及db 服务,伴随着两个网络 new 和 legacy 。
version:"3.7" services: web: image:"nginx:alpine" networks: - new worker: image:"my-worker-image:latest" networks: - legacy db: image:mysql networks: new: aliases: - database legacy: aliases: - mysql networks: new: legacy:
为服务的容器指定一个静态 IP 地址
version:"3.7" services: app: image:nginx:alpine networks: app_net: ipv4_address:172.16.238.10 ipv6_address:2001:3984:3989::10 networks: app_net: ipam: driver:default config: - subnet:"172.16.238.0/24" - subnet:"2001:3984:3989::/64"
将 PID 模式设置为主机 PID 模式,可以打开容器与主机操作系统之间的共享 PID 地址空间。使用此标志启动的容器可以访问和操作宿主机的其他容器,反之亦然
pid: "host"
映射端口
ports: - "3000" - "3000-3005" - "8000:8000" - "9090-9091:8080-8081" - "49100:22" - "127.0.0.1:8001:8001" - "127.0.0.1:5000-5010:5000-5010" - "6060:6060/udp"
注意:当使用 HOST:CONTAINER 格式来映射端口时,如果使用的容器端口小于60可能会得到错误得结果,因为YAML 将会解析 xx:yy 这种数字格式为 60 进制,所以建议采用字符串格式。
ports:
- target:80
published:8080
protocol:tcp
mode:host
默认值为 no ,即在任何情况下都不会重新启动容器;当值为 always 时,容器总是重新启动;当值为 on-failure 时,当出现 on-failure 报错容器退出时,容器重新启动。
restart: "no"
restart: always
restart: on-failure
restart: unless-stopped
挂载一个目录或者一个已存在的数据卷容器,可以直接使用 HOST:CONTAINER 这样的格式,或者使用 HOST:CONTAINER:ro 这样的格式,后者对于容器来说,数据卷是只读的,这样可以有效保护宿主机的文件系统
version: "3.7" services: web: image: nginx:alpine volumes: - type: volume source: mydata target: /data volume: nocopy: true - type: bind source: ./static target: /opt/app/static db: image: postgres:latest volumes: - "/var/run/postgres/postgres.sock:/var/run/postgres/postgres.sock" - "dbdata:/var/lib/postgresql/data" volumes: mydata: dbdata:
此示例显示服务使用的命名卷(mydata)web以及为单个服务(db服务 下的第一个路径volumes)定义的绑定安装。该db服务还使用名为dbdata(db服务中的第二个路径volumes)的命名卷,但使用旧字符串格式定义它以安装命名卷。必须在顶级volumes键下列出命名卷
volumes: # Just specify a path and let the Engine create a volume - /var/lib/mysql # Specify an absolute path mapping - /opt/data:/var/lib/mysql # Path on the host, relative to the Compose file - ./cache:/tmp/cache # User-relative path - ~/configs:/etc/configs/:ro # Named volume - datavolume:/var/lib/mysql
LONG语法
LONG 语法有些附加字段
version: "3.7" services: web: image: nginx:alpine ports: - "80:80" volumes: - type: volume source: mydata target: /data volume: nocopy: true - type: bind source: ./static target: /opt/app/static networks: webnet: volumes: mydata:
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。