GVKun编程网logo

docker-compose.yml模板文件(docker-compose.yml 在哪里)

11

此处将为大家介绍关于docker-compose.yml模板文件的详细内容,并且为您解答有关docker-compose.yml在哪里的相关问题,此外,我们还将为您介绍关于25.dockercompo

此处将为大家介绍关于docker-compose.yml模板文件的详细内容,并且为您解答有关docker-compose.yml 在哪里的相关问题,此外,我们还将为您介绍关于25.docker compose 简介 和 docker-compose.yml 参数介绍、compose.yml模板文件、docker compose yml 文件常用字段简介、Docker Compose 模板文件的有用信息。

本文目录一览:

docker-compose.yml模板文件(docker-compose.yml 在哪里)

docker-compose.yml模板文件(docker-compose.yml 在哪里)

默认的模板文件名称为 docker-compose.yml,格式为 YAML 格式。

示例:

version: "3"

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

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

如果使用 build 指令,在 Dockerfile 中设置的选项(例如:CMDEXPOSEVOLUMEENV 等) 将会自动被获取,无需在 docker-compose.yml 中再次设置。

build

1、

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

version: ''3''
services:

  webapp:
    build: ./dir      # dir文佳夹里面有Dockerfile文件

2、

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

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

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

version: ''3''
services:

  webapp:
    build:
      context: ./dir     # Dockerfile 所在文件夹的路径。
      dockerfile: Dockerfile-alternate   # Dockerfile 文件名
      args:    # 构建镜像时的变量
        buildno: 1

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

build:
  context: .
  cache_from:    # 指定构建镜像的缓存
    - alpine:latest
    - corp/web_app:3.14

command

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

command: echo "hello world"

container_name

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

container_name: docker-web-container

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

devices

指定设备映射关系。

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

depends_on

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

version: ''3''

services:
  web:
    build: .
    depends_on:
      - db
      - redis

  redis:
    image: redis

  db:
    image: postgres

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

 

25.docker compose 简介 和 docker-compose.yml 参数介绍

25.docker compose 简介 和 docker-compose.yml 参数介绍

1. docker compose概念  文档  https://docs.docker.com/compose/compose-file/compose-versioning

  一个基于 docker 的工具

  可以通过一个 yml 文件定义多容器的 docker 应用

  通过一条命令就可以根据 yml 文件的定义 去创建或者管理这多个容器

2 docker compose 版本 2 与 版本 3 的区别

  最大的区别

    version 2 只能用于单机

    version 3 可用于多机

3. docker-compose.yml

  

    Services

      一个 service 代表一个 container , 这个 container 可以从 dockerhub 的 image 来创建, 或者从本地的 Dockerfile build出来的image 来创建

      service 的启动 类似与 docker run , 我们可以给其指定 network 和 volume . 所以可以给 service 指定 network 和 volume 的引用

      eg :

      docker run -d --name db -v db-data:/var/liv/postgresql/data --network back-tier  postgres:9.4

      services:

        db:                #service 的名称为 db

          image: postgres:9.4      #service image 为 postgres:9.4  这是从远程拉取的

          volumes:

            - "db-data:/var/liv/postgresql/data"  #将外部db-data挂载到container 的 /var/liv/postgresql/data 内

          networks:

            - back-tier        #网络为 back-tier

      eg2:

      docker run -d --link db --link redis --network back-tier  worker

      services:

        worker:

          build: ./worker

          links:

            - db

            - redis

          networks:

            - back-tier        #在同一个网络上 不需要links

    Volumes:

      上面 的

      volumes:

       - "db-data:/var/liv/postgresql/data"  #将外部db-data挂载到container 的 /var/liv/postgresql/data 内

      会有单独的一个 volumes (与 services 同级别) 对db-data 进行 阐述

      类似于 docker volume create db-data

      eg:

      volumes:

        db-data:

    Nerworks:

      上面 的

      networks:

        - back-tier        #在同一个网络上 不需要links

      会有单独的一个 networks (与 services 同级别) 对back-tier 进行 阐述

      类似于  docker nerwork create -d bridge back-tier

      networks:

        front-tier:

          driver: bridge

        back-tier:

          driver: bridge

4编写 docker-compose.yml

# docker compose api 版本

version: ''3''

 

services:

# 定义了 两个 service 分别是 名字分别是 wordpress 和 mysql

  wordpress:

#image 为 word press

    image: wordpress

#本地 8888 端口 映射 容器 80 端口

    ports:

      - 8888:80

#wordpress 连接数据库 的 host 为 mysql , passwword 为 root 类似于 -e

    environment:

      WORDPRESS_DB_HOST: mysql

      WORDPRESS_DB_PASSWORD: root

#指定连接 的网络 为 my-bridge

    networks:

      - my-bridge

 

  mysql:

    image: mysql:5.7.27

# 数据库 root 的 连接密码 和 所使用的数据库名称

    environment:

      MYSQL_ROOT_PASSWORD: root

      MYSQL_DATABASE: wordpress

# 外部 mysql-data 挂载到 容器内的 /var/lib/mysql

    volumes:

      - mysql-data:/var/lib/mysql

#指定连接 的网络 为 my-bridge

    networks:

      - my-bridge

 

# 定义 volumes

volumes:

  mysql-data:

 

# 定义 networks

networks:

  my-bridge:

    driver: bridge

 

compose.yml模板文件

compose.yml模板文件

默认的模板文件名称为 docker-compose.yml,格式为 YAML 格式。

示例:

version: "3"

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

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

如果使用 build 指令,在 Dockerfile 中设置的选项(例如:CMDEXPOSEVOLUMEENV 等) 将会自动被获取,无需在 docker-compose.yml 中再次设置。

build

1、

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

version: ''3''
services:

  webapp:
    build: ./dir      # dir文佳夹里面有Dockerfile文件

2、

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

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

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

version: ''3''
services:

  webapp:
    build:
      context: ./dir     # Dockerfile 所在文件夹的路径。
      dockerfile: Dockerfile-alternate   # Dockerfile 文件名
      args:    # 构建镜像时的变量
        buildno: 1

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

build:
  context: .
  cache_from:    # 指定构建镜像的缓存
    - alpine:latest
    - corp/web_app:3.14

command

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

command: echo "hello world"

container_name

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

container_name: docker-web-container

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

devices

指定设备映射关系。

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

depends_on

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

version: ''3''

services:
  web:
    build: .
    depends_on:
      - db
      - redis

  redis:
    image: redis

  db:
    image: postgres

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

 

docker compose yml 文件常用字段简介

docker compose yml 文件常用字段简介

常用参数:
version           # 指定 compose 文件的版本
services          # 定义所有的 service 信息, services 下面的第一级别的 key 既是一个 service 的名称

build                 # 指定包含构建上下文的路径, 或作为一个对象,该对象具有 context 和指定的 dockerfile 文件以及 args 参数值
    context               # context: 指定 Dockerfile 文件所在的路径
    dockerfile            # dockerfile: 指定 context 指定的目录下面的 Dockerfile 的名称(默认为 Dockerfile)
    args                  # args: Dockerfile 在 build 过程中需要的参数 (等同于 docker container build --build-arg 的作用)
    cache_from            # v3.2中新增的参数, 指定缓存的镜像列表 (等同于 docker container build --cache_from 的作用)
    labels                # v3.3中新增的参数, 设置镜像的元数据 (等同于 docker container build --labels 的作用)
    shm_size              # v3.5中新增的参数, 设置容器 /dev/shm 分区的大小 (等同于 docker container build --shm-size 的作用)

command               # 覆盖容器启动后默认执行的命令, 支持 shell 格式和 [] 格式

configs               # 不知道怎么用

cgroup_parent         # 不知道怎么用

container_name        # 指定容器的名称 (等同于 docker run --name 的作用)

credential_spec       # 不知道怎么用

deploy                # v3 版本以上, 指定与部署和运行服务相关的配置, deploy 部分是 docker stack 使用的, docker stack 依赖 docker swarm
    endpoint_mode         # v3.3 版本中新增的功能, 指定服务暴露的方式
        vip                   # Docker 为该服务分配了一个虚拟 IP(VIP), 作为客户端的访问服务的地址
        dnsrr                 # DNS轮询, Docker 为该服务设置 DNS 条目, 使得服务名称的 DNS 查询返回一个 IP 地址列表, 客户端直接访问其中的一个地址
    labels                # 指定服务的标签,这些标签仅在服务上设置
    mode                  # 指定 deploy 的模式
        global                # 每个集群节点都只有一个容器
        replicated            # 用户可以指定集群中容器的数量(默认)
    placement             # 不知道怎么用
    replicas              # deploy 的 mode 为 replicated 时, 指定容器副本的数量
    resources             # 资源限制
        limits                # 设置容器的资源限制
            cpus: "0.5"           # 设置该容器最多只能使用 50% 的 CPU 
            memory: 50M           # 设置该容器最多只能使用 50M 的内存空间 
        reservations          # 设置为容器预留的系统资源(随时可用)
            cpus: "0.2"           # 为该容器保留 20% 的 CPU
            memory: 20M           # 为该容器保留 20M 的内存空间
    restart_policy        # 定义容器重启策略, 用于代替 restart 参数
        condition             # 定义容器重启策略(接受三个参数)
            none                  # 不尝试重启
            on-failure            # 只有当容器内部应用程序出现问题才会重启
            any                   # 无论如何都会尝试重启(默认)
        delay                 # 尝试重启的间隔时间(默认为 0s)
        max_attempts          # 尝试重启次数(默认一直尝试重启)
        window                # 检查重启是否成功之前的等待时间(即如果容器启动了, 隔多少秒之后去检测容器是否正常, 默认 0s)
    update_config         # 用于配置滚动更新配置
        parallelism           # 一次性更新的容器数量
        delay                 # 更新一组容器之间的间隔时间
        failure_action        # 定义更新失败的策略
            continue              # 继续更新
            rollback              # 回滚更新
            pause                 # 暂停更新(默认)
        monitor               # 每次更新后的持续时间以监视更新是否失败(单位: ns|us|ms|s|m|h) (默认为0)
        max_failure_ratio     # 回滚期间容忍的失败率(默认值为0)
        order                 # v3.4 版本中新增的参数, 回滚期间的操作顺序
            stop-first            #旧任务在启动新任务之前停止(默认)
            start-first           #首先启动新任务, 并且正在运行的任务暂时重叠
    rollback_config       # v3.7 版本中新增的参数, 用于定义在 update_config 更新失败的回滚策略
        parallelism           # 一次回滚的容器数, 如果设置为0, 则所有容器同时回滚
        delay                 # 每个组回滚之间的时间间隔(默认为0)
        failure_action        # 定义回滚失败的策略
            continue              # 继续回滚
            pause                 # 暂停回滚
        monitor               # 每次回滚任务后的持续时间以监视失败(单位: ns|us|ms|s|m|h) (默认为0)
        max_failure_ratio     # 回滚期间容忍的失败率(默认值0)
        order                 # 回滚期间的操作顺序
            stop-first            # 旧任务在启动新任务之前停止(默认)
            start-first           # 首先启动新任务, 并且正在运行的任务暂时重叠

    注意:
        支持 docker-compose up 和 docker-compose run 但不支持 docker stack deploy 的子选项
        security_opt  container_name  devices  tmpfs  stop_signal  links    cgroup_parent
        network_mode  external_links  restart  build  userns_mode  sysctls

devices               # 指定设备映射列表 (等同于 docker run --device 的作用)

depends_on            # 定义容器启动顺序 (此选项解决了容器之间的依赖关系, 此选项在 v3 版本中 使用 swarm 部署时将忽略该选项)
    示例:
        docker-compose up 以依赖顺序启动服务,下面例子中 redis 和 db 服务在 web 启动前启动
        默认情况下使用 docker-compose up web 这样的方式启动 web 服务时,也会启动 redis 和 db 两个服务,因为在配置文件中定义了依赖关系

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

dns                   # 设置 DNS 地址(等同于 docker run --dns 的作用)

dns_search            # 设置 DNS 搜索域(等同于 docker run --dns-search 的作用)

tmpfs                 # v2 版本以上, 挂载目录到容器中, 作为容器的临时文件系统(等同于 docker run --tmpfs 的作用, 在使用 swarm 部署时将忽略该选项)

entrypoint            # 覆盖容器的默认 entrypoint 指令 (等同于 docker run --entrypoint 的作用)

env_file              # 从指定文件中读取变量设置为容器中的环境变量, 可以是单个值或者一个文件列表, 如果多个文件中的变量重名则后面的变量覆盖前面的变量, environment 的值覆盖 env_file 的值
    文件格式:
        RACK_ENV=development 

environment           # 设置环境变量, environment 的值可以覆盖 env_file 的值 (等同于 docker run --env 的作用)

expose                # 暴露端口, 但是不能和宿主机建立映射关系, 类似于 Dockerfile 的 EXPOSE 指令

external_links        # 连接不在 docker-compose.yml 中定义的容器或者不在 compose 管理的容器(docker run 启动的容器, 在 v3 版本中使用 swarm 部署时将忽略该选项)

extra_hosts           # 添加 host 记录到容器中的 /etc/hosts 中 (等同于 docker run --add-host 的作用)

healthcheck           # v2.1 以上版本, 定义容器健康状态检查, 类似于 Dockerfile 的 HEALTHCHECK 指令
    test                  # 检查容器检查状态的命令, 该选项必须是一个字符串或者列表, 第一项必须是 NONE, CMD 或 CMD-SHELL, 如果其是一个字符串则相当于 CMD-SHELL 加该字符串
        NONE                  # 禁用容器的健康状态检测
        CMD                   # test: ["CMD", "curl", "-f", "http://localhost"]
        CMD-SHELL             # test: ["CMD-SHELL", "curl -f http://localhost || exit 1"] 或者 test: curl -f https://localhost || exit 1
    interval: 1m30s       # 每次检查之间的间隔时间
    timeout: 10s          # 运行命令的超时时间
    retries: 3            # 重试次数
    start_period: 40s     # v3.4 以上新增的选项, 定义容器启动时间间隔
    disable: true         # truefalse, 表示是否禁用健康状态检测和 test: NONE 相同

image                 # 指定 docker 镜像, 可以是远程仓库镜像、本地镜像

init                  # v3.7 中新增的参数, truefalse 表示是否在容器中运行一个 init, 它接收信号并传递给进程

isolation             # 隔离容器技术, 在 Linux 中仅支持 default 值

labels                # 使用 Docker 标签将元数据添加到容器, 与 Dockerfile 中的 LABELS 类似

links                 # 链接到其它服务中的容器, 该选项是 docker 历史遗留的选项, 目前已被用户自定义网络名称空间取代, 最终有可能被废弃 (在使用 swarm 部署时将忽略该选项)

logging               # 设置容器日志服务
    driver                # 指定日志记录驱动程序, 默认 json-file (等同于 docker run --log-driver 的作用)
    options               # 指定日志的相关参数 (等同于 docker run --log-opt 的作用)
        max-size              # 设置单个日志文件的大小, 当到达这个值后会进行日志滚动操作
        max-file              # 日志文件保留的数量

network_mode          # 指定网络模式 (等同于 docker run --net 的作用, 在使用 swarm 部署时将忽略该选项)         

networks              # 将容器加入指定网络 (等同于 docker network connect 的作用), networks 可以位于 compose 文件顶级键和 services 键的二级键
    aliases               # 同一网络上的容器可以使用服务名称或别名连接到其中一个服务的容器
    ipv4_address      # IP V4 格式
    ipv6_address      # IP V6 格式

    示例:
        version: ''3.7''
        services: 
            test: 
                image: nginx:1.14-alpine
                container_name: mynginx
                command: ifconfig
                networks: 
                    app_net:                                # 调用下面 networks 定义的 app_net 网络
                    ipv4_address: 172.16.238.10
        networks:
            app_net:
                driver: bridge
                ipam:
                    driver: default
                    config:
                        - subnet: 172.16.238.0/24

pid: ''host''           # 共享宿主机的 进程空间(PID)

ports                 # 建立宿主机和容器之间的端口映射关系, ports 支持两种语法格式
    SHORT 语法格式示例:
        - "3000"                            # 暴露容器的 3000 端口, 宿主机的端口由 docker 随机映射一个没有被占用的端口
        - "3000-3005"                       # 暴露容器的 30003005 端口, 宿主机的端口由 docker 随机映射没有被占用的端口
        - "8000:8000"                       # 容器的 8000 端口和宿主机的 8000 端口建立映射关系
        - "9090-9091:8080-8081"
        - "127.0.0.1:8001:8001"             # 指定映射宿主机的指定地址的
        - "127.0.0.1:5000-5010:5000-5010"   
        - "6060:6060/udp"                   # 指定协议

    LONG 语法格式示例:(v3.2 新增的语法格式)
        ports:
            - target: 80                    # 容器端口
              published: 8080               # 宿主机端口
              protocol: tcp                 # 协议类型
              mode: host                    # host 在每个节点上发布主机端口,  ingress 对于群模式端口进行负载均衡

secrets               # 不知道怎么用

security_opt          # 为每个容器覆盖默认的标签 (在使用 swarm 部署时将忽略该选项)

stop_grace_period     # 指定在发送了 SIGTERM 信号之后, 容器等待多少秒之后退出(默认 10s)

stop_signal           # 指定停止容器发送的信号 (默认为 SIGTERM 相当于 kill PID; SIGKILL 相当于 kill -9 PID; 在使用 swarm 部署时将忽略该选项)

sysctls               # 设置容器中的内核参数 (在使用 swarm 部署时将忽略该选项)

ulimits               # 设置容器的 limit

userns_mode           # 如果Docker守护程序配置了用户名称空间, 则禁用此服务的用户名称空间 (在使用 swarm 部署时将忽略该选项)

volumes               # 定义容器和宿主机的卷映射关系, 其和 networks 一样可以位于 services 键的二级键和 compose 顶级键, 如果需要跨服务间使用则在顶级键定义, 在 services 中引用
    SHORT 语法格式示例:
        volumes:
            - /var/lib/mysql                # 映射容器内的 /var/lib/mysql 到宿主机的一个随机目录中
            - /opt/data:/var/lib/mysql      # 映射容器内的 /var/lib/mysql 到宿主机的 /opt/data
            - ./cache:/tmp/cache            # 映射容器内的 /var/lib/mysql 到宿主机 compose 文件所在的位置
            - ~/configs:/etc/configs/:ro    # 映射容器宿主机的目录到容器中去, 权限只读
            - datavolume:/var/lib/mysql     # datavolume 为 volumes 顶级键定义的目录, 在此处直接调用

    LONG 语法格式示例:(v3.2 新增的语法格式)
        version: "3.2"
        services:
            web:
                image: nginx:alpine
                ports:
                    - "80:80"
                volumes:
                    - type: volume                  # mount 的类型, 必须是 bind、volume 或 tmpfs
                        source: mydata              # 宿主机目录
                        target: /data               # 容器目录
                        volume:                     # 配置额外的选项, 其 key 必须和 type 的值相同
                            nocopy: true                # volume 额外的选项, 在创建卷时禁用从容器复制数据
                    - type: bind                    # volume 模式只指定容器路径即可, 宿主机路径随机生成; bind 需要指定容器和数据机的映射路径
                        source: ./static
                        target: /opt/app/static
                        read_only: true             # 设置文件系统为只读文件系统
        volumes:
            mydata:                                 # 定义在 volume, 可在所有服务中调用

restart               # 定义容器重启策略(在使用 swarm 部署时将忽略该选项, 在 swarm 使用 restart_policy 代替 restart)
    no                    # 禁止自动重启容器(默认)
    always                # 无论如何容器都会重启
    on-failure            # 当出现 on-failure 报错时, 容器重新启动

其他选项:
    domainname, hostname, ipc, mac_address, privileged, read_only, shm_size, stdin_open, tty, user, working_dir
    上面这些选项都只接受单个值和 docker run 的对应参数类似

对于值为时间的可接受的值:
    2.5s
    10s
    1m30s
    2h32m
    5h34m56s

    时间单位: us, ms, s, m, h

对于值为大小的可接受的值:
    2b
    1024kb
    2048k
    300m
    1gb

    单位: b, k, m, g 或者 kb, mb, gb

networks          # 定义 networks 信息
driver                # 指定网络模式, 大多数情况下, 它 bridge 于单个主机和 overlay Swarm 上
    bridge                # Docker 默认使用 bridge 连接单个主机上的网络
    overlay               # overlay 驱动程序创建一个跨多个节点命名的网络
    host                  # 共享主机网络名称空间(等同于 docker run --net=host)
    none                  # 等同于 docker run --net=none

driver_opts           # v3.2以上版本, 传递给驱动程序的参数, 这些参数取决于驱动程序

attachable            # driver 为 overlay 时使用, 如果设置为 true 则除了服务之外,独立容器也可以附加到该网络; 如果独立容器连接到该网络,则它可以与其他 Docker 守护进程连接到的该网络的服务和独立容器进行通信

ipam                  # 自定义 IPAM 配置. 这是一个具有多个属性的对象, 每个属性都是可选的
    driver                # IPAM 驱动程序, bridge 或者 default
    config                # 配置项
        subnet                # CIDR格式的子网,表示该网络的网段

external              # 外部网络, 如果设置为 true 则 docker-compose up 不会尝试创建它, 如果它不存在则引发错误

name                  # v3.5 以上版本, 为此网络设置名称

 

Docker Compose 模板文件

Docker Compose 模板文件

Docker Compose 模板文件

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

默认的模板文件名称为 docker-compose.yml,格式为 YAML 格式。

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

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

如果使用 build 指令,在 Dockerfile 中设置的选项(例如:CMDEXPOSEVOLUMEENV 等) 将会自动被获取,无需在 docker-compose.yml 中再次设置。

下面分别介绍各个指令的用法。

1、build

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

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

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

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

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

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

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

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

2、cap_add, cap_drop

指定容器的内核能力(capacity)分配。

例如,让容器拥有所有能力可以指定为:

    cap_add:
      - ALL
 

去掉 NET_ADMIN 能力可以指定为:

    cap_drop:
      - NET_ADMIN
 

3、command

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

    command: echo "hello world"
 

4、configs

仅用于 Swarm mode

5、cgroup_parent

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

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

    cgroup_parent: cgroups_1
 

6、container_name

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

    container_name: docker-web-container
 

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

7、deploy

仅用于 Swarm mode

8、devices

指定设备映射关系。

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

9、depends_on

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

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

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

10、dns

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

    dns: 8.8.8.8
    
    dns:
      - 8.8.8.8
      - 114.114.114.114
 

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

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

12、tmpfs

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

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

13、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
 

14、environment

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

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

    environment:
      RACK_ENV: development
      SESSION_SECRET:
    
    environment:
      - RACK_ENV=development
      - SESSION_SECRET
 

如果变量名称或者值中用到 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
 

15、expose

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

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

    expose:
     - "3000"
     - "8000"
 

注意:不建议使用该指令。

链接到 docker-compose.yml 外部的容器,甚至并非 Compose 管理的外部容器。

    external_links:
     - redis_1
     - project_db_1:MysqL
     - project_db_1:postgresql
 

17、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
 

18、healthcheck

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

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

19、image

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

    image: ubuntu
    image: orchardup/postgresql
    image: a4bc65fd
 

20、labels

为容器添加 Docker 元数据(Metadata)信息。例如可以为容器添加辅助说明信息。

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

注意:不推荐使用该指令。

22、logging

配置日志选项。

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

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

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

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

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

23、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]"
 

24、networks

配置容器连接的网络。

    version: "3"
    services:
    
      some-service:
        networks:
         - some-network
         - other-network
    
    networks:
      some-network:
      other-network:
 

25、pid

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

    pid: "host"
 

26、ports

暴露端口信息。

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

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

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

27、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
 

28、security_opt

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

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

29、stop_signal

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

    stop_signal: SIGUSR1
 

30、sysctls

配置容器内核参数。

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

31、ulimits

指定容器的 ulimits 限制值。

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

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

32、volumes

数据卷所挂载路径设置。可以设置宿主机路径 (HOST:CONTAINER) 或加上访问模式 (HOST:CONTAINER:ro)。

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

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

33、其它指令

此外,还有包括 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
 

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

    privileged: true
 

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

    restart: always
 

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

    read_only: true
 

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

    stdin_open: true
 

模拟一个伪终端。

    tty: true
 

34、读取变量

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

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

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

如果执行 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
 

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

转自:有梦想的咸鱼

今天关于docker-compose.yml模板文件docker-compose.yml 在哪里的分享就到这里,希望大家有所收获,若想了解更多关于25.docker compose 简介 和 docker-compose.yml 参数介绍、compose.yml模板文件、docker compose yml 文件常用字段简介、Docker Compose 模板文件等相关知识,可以在本站进行查询。

本文标签: