Docker Compose配置文件docker-compose.yml文件详解

最新推荐文章于 2024-08-02 18:13:47 发布

爱上口袋的天空

最新推荐文章于 2024-08-02 18:13:47 发布

阅读量1.7k

点赞数

分类专栏： # docker

原文链接：https://blog.csdn.net/Carl_hxl/article/details/87283654?utm_medium=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.control&depth_1-utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.control

版权

docker 专栏收录该内容

49 篇文章 2 订阅

订阅专栏

一份标准的docker-compose.yml文件应该包含version、services、networks三大部分，其中最关键的就是services和networks两个部分。

version: '2'
services:
  web:
    image: dockercloud/hello-world
    ports:
      - 8080
    networks:
      - front-tier
      - back-tier
 
  redis:
    image: redis
    links:
      - web
    networks:
      - back-tier
 
  lb:
    image: dockercloud/haproxy
    ports:
      - 80:80
    links:
      - web
    networks:
      - front-tier
      - back-tier
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock 
 
networks:
  front-tier:
    driver: bridge
  back-tier:

services部分

1、image

services:
  web:
    image: hello-world

在services标签下的第二级标签是web，这个名字是用户自己自定义的，它就是服务名称。
image 则是指定服务的镜像名称或镜像id。如果镜像在本地不存在，compose将会尝试拉取这个镜像。

2、build

服务除了可以基于指定的镜像，还可以基于一份Dockerfile，在使用up启动之时执行构建人物，这个构建标签就是build，它可以指定Dockerfile所在文件夹的路径。compose将会利用它自动构建这个镜像，然后使用这个镜像启动服务同期。

build: /path/to/build/dir

也可以是想对路径，只要上下文确定就可以读取到Dockerfile

build: ./dir

设定上下文根目录，然后以该目录为准指定Dockerfike

build:
  context: ../
  dockerfile: path/of/Dockerfile

注意build都是一个目录，如果你指定Dockerfile文件需要在build标签的子级标签中使用dockerfile标签指定，如上面的例子。
如果你同事指定了 image和build 两个标签，那么compos会构建镜像并且把镜像命名为image后面的那个名字

build: ./dir
image: webapp:tag

3、command

command命令可以覆盖容器启动后默认执行的命令。两种写法。

command: bundle exec thin -p 3000
command: [bundle, exec, thin, -p, 3000]

4、container_name

前面说过 Compose 的容器名称格式是：<项目名称><服务名称><序号>
虽然可以自定义项目名称、服务名称，但是如果你想完全控制容器的命名，可以使用这个标签指定：

container_name: app

5、depends_on

depends_on解决了容器的依赖、启动先后的问题。
例如下面容器会先启动redis和db两个服务，最后才启动web服务：

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

注意的是，默认情况下使用 docker-compose up web 这样的方式启动 web 服务时，也会启动 redis 和 db 两个服务，因为在配置文件中定义了依赖关系。

6、dns

和 --dns参数一样的用途，格式如下：

dns: 8.8.8.8

也可以是一个列表：

dns:
  - 8.8.8.8
  - 9.9.9.9

此外dns_search的配置也类似：

dns_search: example.com
dns_search:
  - dc1.example.com
  - dc2.example.com

7、tmpfs

挂载临时目录到容器内部，与run的参数一样效果：

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

8、environment

设置镜像变量，它可以保存变量到镜像里，也就是说启动的容器也会包含这些变量设置

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:
 
environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET

9、expose

用于指定暴露的端口，但是只是作为参考，端口映射的话还得ports标签

expose:
 - "3000"
 - "8000"

10、external_links

在使用Docker的过程中，我们会有许多单独使用docker run启动的容器，为了使Compose能够连接这些不在docker-compose.yml中定义的容器，我们需要一个特殊的标签，就是external_links，它可以让Compose项目里面的容器连接到那些项目配置外部的容器（前提是外部容器中必须至少有一个容器是连接到与项目内的服务的同一个网络里面）

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

11、extra_hosts

添加主机名的标签，就是往容器内部/etc/hosts文件中添加一些记录，

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

12、labels

向容器添加元数据，和Dockerfile的lable指令一个意思

labels:
  com.example.description: "Accounting webapp"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""
labels:
  - "com.example.description=Accounting webapp"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"

13、links

解决容器连接问题，与docker的–link一样的效果，会连接到其他服务中的容器

links:
 - db
 - db:database
 - redis

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

172.12.2.186  db
172.12.2.186  database
172.12.2.187  redis

14、ports

用作端口映射
使用HOST:CONTAINER格式或者只是指定容器的端口，宿主机会随机映射端口

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

注意：当使用HOST:CONTAINER格式来映射端口时，如果你使用的容器端口小于60你可能会得到错误得结果，因为YAML将会解析xx:yy这种数字格式为60进制。所以建议采用字符串格式。

15、security_opt

为每个容器覆盖默认的标签。简单说来就是管理全部服务的标签，比如设置全部服务的user标签值为USER

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

16、volumes

挂载一个目录或者一个已经存在的数据卷容器，可以直接使用[HOST:CONTAINER]这样的格式，或者使用[HOST:CONTAINER:ro]这样的格式，或者对于容器来说，数据卷是只读的，这样可以有效保护宿主机的文件系统。
compose的数据卷指定路径可以是相对路径，使用 . 或者 … 来指定性对目录
数据卷的格式可以是下面多种形式：

volumes:
  // 只是指定一个路径，Docker 会自动在创建一个数据卷（这个路径是容器内部的）。
  - /var/lib/mysql
 
  // 使用绝对路径挂载数据卷
  - /opt/data:/var/lib/mysql
 
  // 以 Compose 配置文件为中心的相对路径作为数据卷挂载到容器。
  - ./cache:/tmp/cache
 
  // 使用用户的相对路径（~/ 表示的目录是 /home/<用户目录>/ 或者 /root/）。
  - ~/configs:/etc/configs/:ro
 
  // 已经存在的命名的数据卷。
  - datavolume:/var/lib/mysql

如果你不使用宿主机的路径，你可以指定一个volume_driver。

volume_driver: mydriver

17、volumes_from

从其它容器或者服务挂载数据卷，可选的参数是:ro或者:rw，前者表示容器只读，后者表示容器对数据卷是可读可写的，默认是可读可写的

volumes_from:
  - service_name
  - service_name:ro
  - container:container_name
  - container:container_name:rw

18、network_mode

网络模式，与docker client的–net参数类似，只是相对多了一个service:[sevice name]的格式。
例如：

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

19 networks

加入指定网络

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

关于这个标签还有一个特别的子标签aliases，这是一个用来设置服务别名的标签，例如：

services:
  some-service:
    networks:
      some-network:
        aliases:
         - alias1
         - alias3
      other-network:
        aliases:
         - alias2

docker-compose.yml还有很多其他命令，比如depends_on、pid、devices等，这里就不一一介绍了