Docker Compose

docker-compose的yaml常用说明

  1Compose和Docker兼容性:
  2    Compose 文件格式有3个版本,分别为1, 2.x 和 3.x
  3    目前主流的为 3.x 其支持 docker 1.13.0 及其以上的版本
  4
  5常用参数:
  6    version           # 指定 compose 文件的版本
  7    services          # 定义所有的 service 信息, services 下面的第一级别的 key 既是一个 service 的名称
  8
  9        build                 # 指定包含构建上下文的路径, 或作为一个对象,该对象具有 context 和指定的 dockerfile 文件以及 args 参数值
 10            context               # context: 指定 Dockerfile 文件所在的路径
 11            dockerfile            # dockerfile: 指定 context 指定的目录下面的 Dockerfile 的名称(默认为 Dockerfile)
 12            args                  # args: Dockerfile 在 build 过程中需要的参数 (等同于 docker container build --build-arg 的作用)
 13            cache_from            # v3.2中新增的参数, 指定缓存的镜像列表 (等同于 docker container build --cache_from 的作用)
 14            labels                # v3.3中新增的参数, 设置镜像的元数据 (等同于 docker container build --labels 的作用)
 15            shm_size              # v3.5中新增的参数, 设置容器 /dev/shm 分区的大小 (等同于 docker container build --shm-size 的作用)
 16
 17        command               # 覆盖容器启动后默认执行的命令, 支持 shell 格式和 [] 格式
 18
 19        configs               # 不知道怎么用
 20
 21        cgroup_parent         # 不知道怎么用
 22
 23        container_name        # 指定容器的名称 (等同于 docker run --name 的作用)
 24
 25        credential_spec       # 不知道怎么用
 26
 27        deploy                # v3 版本以上, 指定与部署和运行服务相关的配置, deploy 部分是 docker stack 使用的, docker stack 依赖 docker swarm
 28            endpoint_mode         # v3.3 版本中新增的功能, 指定服务暴露的方式
 29                vip                   # Docker 为该服务分配了一个虚拟 IP(VIP), 作为客户端的访问服务的地址
 30                dnsrr                 # DNS轮询, Docker 为该服务设置 DNS 条目, 使得服务名称的 DNS 查询返回一个 IP 地址列表, 客户端直接访问其中的一个地址
 31            labels                # 指定服务的标签,这些标签仅在服务上设置
 32            mode                  # 指定 deploy 的模式
 33                global                # 每个集群节点都只有一个容器
 34                replicated            # 用户可以指定集群中容器的数量(默认)
 35            placement             # 不知道怎么用
 36            replicas              # deploy 的 mode 为 replicated 时, 指定容器副本的数量
 37            resources             # 资源限制
 38                limits                # 设置容器的资源限制
 39                    cpus: "0.5"           # 设置该容器最多只能使用 50% 的 CPU 
 40                    memory: 50M           # 设置该容器最多只能使用 50M 的内存空间 
 41                reservations          # 设置为容器预留的系统资源(随时可用)
 42                    cpus: "0.2"           # 为该容器保留 20% 的 CPU
 43                    memory: 20M           # 为该容器保留 20M 的内存空间
 44            restart_policy        # 定义容器重启策略, 用于代替 restart 参数
 45                condition             # 定义容器重启策略(接受三个参数)
 46                    none                  # 不尝试重启
 47                    on-failure            # 只有当容器内部应用程序出现问题才会重启
 48                    any                   # 无论如何都会尝试重启(默认)
 49                delay                 # 尝试重启的间隔时间(默认为 0s)
 50                max_attempts          # 尝试重启次数(默认一直尝试重启)
 51                window                # 检查重启是否成功之前的等待时间(即如果容器启动了, 隔多少秒之后去检测容器是否正常, 默认 0s)
 52            update_config         # 用于配置滚动更新配置
 53                parallelism           # 一次性更新的容器数量
 54                delay                 # 更新一组容器之间的间隔时间
 55                failure_action        # 定义更新失败的策略
 56                    continue              # 继续更新
 57                    rollback              # 回滚更新
 58                    pause                 # 暂停更新(默认)
 59                monitor               # 每次更新后的持续时间以监视更新是否失败(单位: ns|us|ms|s|m|h) (默认为0)
 60                max_failure_ratio     # 回滚期间容忍的失败率(默认值为0)
 61                order                 # v3.4 版本中新增的参数, 回滚期间的操作顺序
 62                    stop-first            #旧任务在启动新任务之前停止(默认)
 63                    start-first           #首先启动新任务, 并且正在运行的任务暂时重叠
 64            rollback_config       # v3.7 版本中新增的参数, 用于定义在 update_config 更新失败的回滚策略
 65                parallelism           # 一次回滚的容器数, 如果设置为0, 则所有容器同时回滚
 66                delay                 # 每个组回滚之间的时间间隔(默认为0)
 67                failure_action        # 定义回滚失败的策略
 68                    continue              # 继续回滚
 69                    pause                 # 暂停回滚
 70                monitor               # 每次回滚任务后的持续时间以监视失败(单位: ns|us|ms|s|m|h) (默认为0)
 71                max_failure_ratio     # 回滚期间容忍的失败率(默认值0)
 72                order                 # 回滚期间的操作顺序
 73                    stop-first            # 旧任务在启动新任务之前停止(默认)
 74                    start-first           # 首先启动新任务, 并且正在运行的任务暂时重叠
 75
 76            注意:
 77                支持 docker-compose up 和 docker-compose run 但不支持 docker stack deploy 的子选项
 78                security_opt  container_name  devices  tmpfs  stop_signal  links    cgroup_parent
 79                network_mode  external_links  restart  build  userns_mode  sysctls
 80
 81        devices               # 指定设备映射列表 (等同于 docker run --device 的作用)
 82
 83        depends_on            # 定义容器启动顺序 (此选项解决了容器之间的依赖关系, 此选项在 v3 版本中 使用 swarm 部署时将忽略该选项)
 84            示例:
 85                docker-compose up 以依赖顺序启动服务,下面例子中 redis 和 db 服务在 web 启动前启动
 86                默认情况下使用 docker-compose up web 这样的方式启动 web 服务时,也会启动 redis 和 db 两个服务,因为在配置文件中定义了依赖关系
 87
 88                version: '3'
 89                services:
 90                    web:
 91                        build: .
 92                        depends_on:
 93                            - db      
 94                            - redis  
 95                    redis:
 96                        image: redis
 97                    db:
 98                        image: postgres                             
 99
100        dns                   # 设置 DNS 地址(等同于 docker run --dns 的作用)
101
102        dns_search            # 设置 DNS 搜索域(等同于 docker run --dns-search 的作用)
103
104        tmpfs                 # v2 版本以上, 挂载目录到容器中, 作为容器的临时文件系统(等同于 docker run --tmpfs 的作用, 在使用 swarm 部署时将忽略该选项)
105
106        entrypoint            # 覆盖容器的默认 entrypoint 指令 (等同于 docker run --entrypoint 的作用)
107
108        env_file              # 从指定文件中读取变量设置为容器中的环境变量, 可以是单个值或者一个文件列表, 如果多个文件中的变量重名则后面的变量覆盖前面的变量, environment 的值覆盖 env_file 的值
109            文件格式:
110                RACK_ENV=development 
111
112        environment           # 设置环境变量, environment 的值可以覆盖 env_file 的值 (等同于 docker run --env 的作用)
113
114        expose                # 暴露端口, 但是不能和宿主机建立映射关系, 类似于 Dockerfile 的 EXPOSE 指令
115
116        external_links        # 连接不在 docker-compose.yml 中定义的容器或者不在 compose 管理的容器(docker run 启动的容器, 在 v3 版本中使用 swarm 部署时将忽略该选项)
117
118        extra_hosts           # 添加 host 记录到容器中的 /etc/hosts 中 (等同于 docker run --add-host 的作用)
119
120        healthcheck           # v2.1 以上版本, 定义容器健康状态检查, 类似于 Dockerfile 的 HEALTHCHECK 指令
121            test                  # 检查容器检查状态的命令, 该选项必须是一个字符串或者列表, 第一项必须是 NONE, CMD 或 CMD-SHELL, 如果其是一个字符串则相当于 CMD-SHELL 加该字符串
122                NONE                  # 禁用容器的健康状态检测
123                CMD                   # test: ["CMD", "curl", "-f", "http://localhost"]
124                CMD-SHELL             # test: ["CMD-SHELL", "curl -f http://localhost || exit 1"] 或者 test: curl -f https://localhost || exit 1
125            interval: 1m30s       # 每次检查之间的间隔时间
126            timeout: 10s          # 运行命令的超时时间
127            retries: 3            # 重试次数
128            start_period: 40s     # v3.4 以上新增的选项, 定义容器启动时间间隔
129            disable: true         # true 或 false, 表示是否禁用健康状态检测和 test: NONE 相同
130
131        image                 # 指定 docker 镜像, 可以是远程仓库镜像、本地镜像
132
133        init                  # v3.7 中新增的参数, true 或 false 表示是否在容器中运行一个 init, 它接收信号并传递给进程
134
135        isolation             # 隔离容器技术, 在 Linux 中仅支持 default 值
136
137        labels                # 使用 Docker 标签将元数据添加到容器, 与 Dockerfile 中的 LABELS 类似
138
139        links                 # 链接到其它服务中的容器, 该选项是 docker 历史遗留的选项, 目前已被用户自定义网络名称空间取代, 最终有可能被废弃 (在使用 swarm 部署时将忽略该选项)
140
141        logging               # 设置容器日志服务
142            driver                # 指定日志记录驱动程序, 默认 json-file (等同于 docker run --log-driver 的作用)
143            options               # 指定日志的相关参数 (等同于 docker run --log-opt 的作用)
144                max-size              # 设置单个日志文件的大小, 当到达这个值后会进行日志滚动操作
145                max-file              # 日志文件保留的数量
146
147        network_mode          # 指定网络模式 (等同于 docker run --net 的作用, 在使用 swarm 部署时将忽略该选项)         
148
149        networks              # 将容器加入指定网络 (等同于 docker network connect 的作用), networks 可以位于 compose 文件顶级键和 services 键的二级键
150            aliases               # 同一网络上的容器可以使用服务名称或别名连接到其中一个服务的容器
151            ipv4_address      # IP V4 格式
152            ipv6_address      # IP V6 格式
153
154            示例:
155                version: '3.7'
156                services: 
157                    test: 
158                        image: nginx:1.14-alpine
159                        container_name: mynginx
160                        command: ifconfig
161                        networks: 
162                            app_net:                                # 调用下面 networks 定义的 app_net 网络
163                            ipv4_address: 172.16.238.10
164                networks:
165                    app_net:
166                        driver: bridge
167                        ipam:
168                            driver: default
169                            config:
170                                - subnet: 172.16.238.0/24
171
172        pid: 'host'           # 共享宿主机的 进程空间(PID)
173
174        ports                 # 建立宿主机和容器之间的端口映射关系, ports 支持两种语法格式
175            SHORT 语法格式示例:
176                - "3000"                            # 暴露容器的 3000 端口, 宿主机的端口由 docker 随机映射一个没有被占用的端口
177                - "3000-3005"                       # 暴露容器的 3000 到 3005 端口, 宿主机的端口由 docker 随机映射没有被占用的端口
178                - "8000:8000"                       # 容器的 8000 端口和宿主机的 8000 端口建立映射关系
179                - "9090-9091:8080-8081"
180                - "127.0.0.1:8001:8001"             # 指定映射宿主机的指定地址的
181                - "127.0.0.1:5000-5010:5000-5010"   
182                - "6060:6060/udp"                   # 指定协议
183
184            LONG 语法格式示例:(v3.2 新增的语法格式)
185                ports:
186                    - target: 80                    # 容器端口
187                      published: 8080               # 宿主机端口
188                      protocol: tcp                 # 协议类型
189                      mode: host                    # host 在每个节点上发布主机端口,  ingress 对于群模式端口进行负载均衡
190
191        secrets               # 不知道怎么用
192
193        security_opt          # 为每个容器覆盖默认的标签 (在使用 swarm 部署时将忽略该选项)
194
195        stop_grace_period     # 指定在发送了 SIGTERM 信号之后, 容器等待多少秒之后退出(默认 10s)
196
197        stop_signal           # 指定停止容器发送的信号 (默认为 SIGTERM 相当于 kill PID; SIGKILL 相当于 kill -9 PID; 在使用 swarm 部署时将忽略该选项)
198
199        sysctls               # 设置容器中的内核参数 (在使用 swarm 部署时将忽略该选项)
200
201        ulimits               # 设置容器的 limit
202
203        userns_mode           # 如果Docker守护程序配置了用户名称空间, 则禁用此服务的用户名称空间 (在使用 swarm 部署时将忽略该选项)
204
205        volumes               # 定义容器和宿主机的卷映射关系, 其和 networks 一样可以位于 services 键的二级键和 compose 顶级键, 如果需要跨服务间使用则在顶级键定义, 在 services 中引用
206            SHORT 语法格式示例:
207                volumes:
208                    - /var/lib/mysql                # 映射容器内的 /var/lib/mysql 到宿主机的一个随机目录中
209                    - /opt/data:/var/lib/mysql      # 映射容器内的 /var/lib/mysql 到宿主机的 /opt/data
210                    - ./cache:/tmp/cache            # 映射容器内的 /var/lib/mysql 到宿主机 compose 文件所在的位置
211                    - ~/configs:/etc/configs/:ro    # 映射容器宿主机的目录到容器中去, 权限只读
212                    - datavolume:/var/lib/mysql     # datavolume 为 volumes 顶级键定义的目录, 在此处直接调用
213
214            LONG 语法格式示例:(v3.2 新增的语法格式)
215                version: "3.2"
216                services:
217                    web:
218                        image: nginx:alpine
219                        ports:
220                            - "80:80"
221                        volumes:
222                            - type: volume                  # mount 的类型, 必须是 bind、volume 或 tmpfs
223                                source: mydata              # 宿主机目录
224                                target: /data               # 容器目录
225                                volume:                     # 配置额外的选项, 其 key 必须和 type 的值相同
226                                    nocopy: true                # volume 额外的选项, 在创建卷时禁用从容器复制数据
227                            - type: bind                    # volume 模式只指定容器路径即可, 宿主机路径随机生成; bind 需要指定容器和数据机的映射路径
228                                source: ./static
229                                target: /opt/app/static
230                                read_only: true             # 设置文件系统为只读文件系统
231                volumes:
232                    mydata:                                 # 定义在 volume, 可在所有服务中调用
233
234        restart               # 定义容器重启策略(在使用 swarm 部署时将忽略该选项, 在 swarm 使用 restart_policy 代替 restart)
235            no                    # 禁止自动重启容器(默认)
236            always                # 无论如何容器都会重启
237            on-failure            # 当出现 on-failure 报错时, 容器重新启动
238
239        其他选项:
240            domainname, hostname, ipc, mac_address, privileged, read_only, shm_size, stdin_open, tty, user, working_dir
241            上面这些选项都只接受单个值和 docker run 的对应参数类似
242
243        对于值为时间的可接受的值:
244            2.5s
245            10s
246            1m30s
247            2h32m
248            5h34m56s
249            时间单位: us, ms, s, m, h
250        对于值为大小的可接受的值:
251            2b
252            1024kb
253            2048k
254            300m
255            1gb
256            单位: b, k, m, g 或者 kb, mb, gb
257    networks          # 定义 networks 信息
258        driver                # 指定网络模式, 大多数情况下, 它 bridge 于单个主机和 overlay Swarm 上
259            bridge                # Docker 默认使用 bridge 连接单个主机上的网络
260            overlay               # overlay 驱动程序创建一个跨多个节点命名的网络
261            host                  # 共享主机网络名称空间(等同于 docker run --net=host)
262            none                  # 等同于 docker run --net=none
263        driver_opts           # v3.2以上版本, 传递给驱动程序的参数, 这些参数取决于驱动程序
264        attachable            # driver 为 overlay 时使用, 如果设置为 true 则除了服务之外,独立容器也可以附加到该网络; 如果独立容器连接到该网络,则它可以与其他 Docker 守护进程连接到的该网络的服务和独立容器进行通信
265        ipam                  # 自定义 IPAM 配置. 这是一个具有多个属性的对象, 每个属性都是可选的
266            driver                # IPAM 驱动程序, bridge 或者 default
267            config                # 配置项
268                subnet                # CIDR格式的子网,表示该网络的网段
269        external              # 外部网络, 如果设置为 true 则 docker-compose up 不会尝试创建它, 如果它不存在则引发错误
270        name                  # v3.5 以上版本, 为此网络设置名称
271文件格式示例:
272    version: "3"
273    services:
274      redis:
275        image: redis:alpine
276        ports:
277          - "6379"
278        networks:
279          - frontend
280        deploy:
281          replicas: 2
282          update_config:
283            parallelism: 2
284            delay: 10s
285          restart_policy:
286            condition: on-failure
287      db:
288        image: postgres:9.4
289        volumes:
290          - db-data:/var/lib/postgresql/data
291        networks:
292          - backend
293        deploy:
294          placement:
295            constraints: [node.role == manager]