🍁博主简介：
        🏅云计算领域优质创作者
        🏅2022年CSDN新星计划python赛道第一名

        🏅2022年CSDN原力计划优质作者
        🏅阿里云ACE认证高级工程师
        🏅阿里云开发者社区专家博主

💊交流社区：CSDN云计算交流社区欢迎您的加入！

目录

1、Compose模板文件

2、Compose模板文件主要指令

​​​​​​3、部分指令用法详解

 👑👑👑结束语👑👑👑​

---

1、Compose模板文件

模板文件是使用Compose的核心，涉及的指令关键字也比较多。但大家不用担心，这里的大部分指令与docker run相关参数的含义都是类似的。

默认的模板文件名称为docker-compose.yml，格式为YAML格式。 在旧版本（版本1）中，其中每个顶级元素为服务名称，次级元素为服务容器的配置信息，例如：

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

版本2扩展了Compose的语法，同时尽量兼容版本1，除了可以声明网络和存储信息外，最大的不同一是添加了版本信息，另一个是需要将所有的服务放到services根下面。

例如，上面例子改写为版本2，内容为：

version: "2"
services:
    webapp:
        image: examples/web
        ports:
            - "80:80"
        volumes:
            - "/data"

注意，每个服务都必须通过image指令指定镜像或build指令（需要Dockerfile）等来自动构建生成镜像。

如果使用build指令，在Dockerfile中设置的选项（例如：CMD、EXPOSE、VOLUME、ENV等）将会自动被获取，无需在docker- compose.yml中再次设置。

2、Compose模板文件主要指令

​​​​​​3、部分指令用法详解

1.Build指令 

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

build: /path/to/build/dir

2.cap_add，cap_drop 

指定容器的内核能力（capacity）分配。 例如，让容器拥有所有能力可以指定为：

cap_add:
    - ALL

去掉NET_ADMIN能力可以指定为：

cap_drop:
    - NET_ADMIN

3.command 

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

command: echo "hello world"

4.cgroup_parent 

指定父cgroup组，意味着将继承该组的资源限制。 例如，创建了一个cgroup组名称为cgroups_1：

cgroup_parent: cgroups_1

5.container_name 

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

container_name: docker-web-container

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

6.devices 

指定设备映射关系，例如：

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

7.dns 

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

dns: 8.8.8.8
dns:
    - 8.8.8.8
    - 9.9.9.9

8.dns_search 

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

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

9.Dockerfile 

如果需要，指定额外的编译镜像的Dockefile文件，可以通过该指令来指定，例如：

Dockerfile: Dockerfile-alternate

注意： 该指令不能跟image同时使用，否则Compose将不知道根据哪个指令来生成最终的服务镜像。

10.env_file 

从文件中获取环境变量，可以为单独的文件路径或列表。 如果通过docker-compose-f FILE方式来指定Compose模板文件，则env_file中变量的路径会基于模板文件路径。

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

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

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

# common.env: Set development environment
PROG_ENV=development

11.environment 

设置环境变量，可以使用数组或字典两种格式。 只给定名称的变量会自动获取运行Compose主机上对应变量的值，可以用来防止泄露不必要的数据。例如：

environment:
    RACK_ENV: development
    SESSION_SECRET:

或者：

environment:
    - RACK_ENV=development
    - SESSION_SECRET

注意： 如果变量名称或者值中用到true|false，yes|no等表达布尔含义的词汇，最好放到引号里，避免YAML自动解析某些内容为对应的布尔语义：

http://yaml.org/type/bool.html中给出了这些特定词汇，包括
y|Y|yes|Yes|YES|n|N|no|No|NO
|true|True|TRUE|false|False|FALSE
|on|On|ON|off|Off|OFF

12.expose 

暴露端口，但不映射到宿主机，只允许能被连接的服务访问。仅可以指定内部端口为参数，如下所示：

expose:
    - "3000"
    - "8000"

13.extends 

基于其他模板文件进行扩展。例如，我们已经有了一个webapp服务，定义一个基础模板文件为common.yml，如下所示：

# common.yml
webapp:
    build: ./webapp
    environment:
        - DEBUG=false
        - SEND_EMAILS=false

再编写一个新的development.yml文件，使用common.yml中的webapp服务进行扩展：

# development.yml
web:
    extends:
        file: common.yml
        service: webapp
    ports:
        - "8000:8000"
    links:
        - db
    environment:
        - DEBUG=true
db:
    image: postgres

后者会自动继承common.yml中的webapp服务及环境变量定义。 使用extends需要注意以下几点： ·要避免出现循环依赖，例如A依赖B，B依赖C，C反过来依赖A的情况 ·extends不会继承links和volumes_from中定义的容器和数据卷资源

一般情况下，推荐在基础模板中只定义一些可以共享的镜像和环境变量，在扩展模板中具体指定应用变量、链接、数据卷等信息。

14.external_links 

链接到docker-compose.yml外部的容器，甚至可以是非Compose管理的外部容器。参数格式跟links类似：

external_links:
    - redis_1
    - project_db_1:mysql
    - project_db_1:postgresql

15.extra_hosts 

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

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

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

8.8.8.8 googledns
52.1.157.61 dockerhub

16.image 

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

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

17.labels 

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

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

18.links 

链接到其他服务中的容器。使用服务名称（同时作为别名），或者“服务名称：服务别名”（如SERVICE：ALIAS），这样的格式都可以，例如：

links:
    - db
    - db:database
    - redis

使用的别名将会自动在服务容器中的/etc/hosts里创建。例如：

172.17.2.186 db
172.17.2.186 database
172.17.2.187 redis

所连接容器中相应的环境变量也将创建。

19.log_driver 

类似于Docker中的--log-driver参数，指定日志驱动类型。目前支持三种日志驱动类型：

log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"

20.log_opt 

日志驱动的相关参数。例如：

log_driver: "syslog"
log_opt:
    syslog-address: "tcp://192.168.0.42:123"

21.net 

设置网络模式。参数类似于docker client的--net参数：

net: "bridge"
net: "none"
net: "container:[name or id]"
net: "host"

22.pid 

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

pid: "host"

23.ports 

暴露端口信息 使用“宿主：容器”（如“HOST：CONTAINER”）格式，或者仅仅指定容器的端口（宿主将会随机选择端口）：

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

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

24.security_opt 

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

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

25.ulimits 

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

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

26.volumes 

数据卷所挂载路径设置。可以设置宿主机路径（HOST： CONTAINER）或加上访问模式（HOST：CONTAINER：ro）。该指令中路径支持相对路径。例如：

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

27.volumes_driver 

较新版本的Docker支持数据卷的插件驱动。用户可以先使用第三方驱动创建一个数据卷，然后使用名称来访问它。此时，可以通过 volumes_driver来指定驱动：

volume_driver: mydriver

28.volumes_from 

从另一个服务或容器挂载它的数据卷：

volumes_from:
    - service_name
    - container_name

29.其他指令 

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

例如，指定使用CPU核0和核1，只用50%的CPU资源：

cpu_shares: 73
cpuset: 0,1

指定服务容器启动后执行的命令：

entrypoint: /code/entrypoint.sh

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

user: nginx

指定容器中工作目录：

working_dir: /code

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

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

指定容器：

ipc: host

指定容器中内存和内存交换区限制都为1G：

mem_limit: 1g
memswap_limit: 1g

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

privileged: true

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

restart: always

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

read_only: true

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

stdin_open: true

模拟一个假的远程控制台：

tty: true

 👑👑👑结束语👑👑👑