欢迎您, 来到 宁时修博客.^_^

Docker系列12--Docker Compose(中)

2018/11/20 林木立 Docker 942
Docker容器技术

一、Compose 模板文件

    模板文件是使用  Compose  的核心。默认的模板文件名称为  docker-compose.yml ,格式为 YAML 格式。

version: "3"

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

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

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



二、compose各个指令

    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

   使用每个服务的配置,授予对每个服务基础上的访问权限。


    5、cgroup_parent

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

cgroup_parent: cgroups_1


    6、container_name

    指定自定义容器名称,而不是生成的默认名称。默认将会使用  项目名称_服务名称_序号  这样的格式。

container_name: my-web-container

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


    7、deploy

    指定服务部署和运行相关的配置。仅用于  swarm。


    8、devices

    指定设备映射关系。

devices:
  - "/dev/ttyUSB0:/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
  - 9.9.9.9


    11、dns_search

    自定义DNS搜索域。可以是单个值或列表。

dns_search: example.com


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


    12、tmpfs

    挂载tmpfs(临时文件系统)到容器。可以是单个值或列表。

tmpfs: /run


tmpfs:
  - /run
  - /tmp


    13、env_file

    从文件中添加环境变量。可以是单独的文件路径或列表。

    如果通过  docker-compose -f FILE  方式来指定 Compose 模板文件,则env_file  中变量的路径会与Compose模板文件路径相对应。

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

env_file: .env

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

    compose希望env每一个都是  VAR=VAL格式,以 “#”开头视为注释,空白行会被忽略。

# Set Rails/Rack environment
RACK_ENV=development


    14、environment

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

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

environment:
  RACK_ENV: development
  SESSION_SECRET:


environment:
  - RACK_ENV=development
  - SESSION_SECRET

    如果变量名称或者值中用到  true|false,yes|no  等表达 布尔 含义的词汇,最好放到引号里,避免 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"


    16、external_links

    链接到  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)信息。可以使用数组或字典。

    建议使用反向DNS表示法来防止标签与其他软件使用的标签冲突。

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"


    21、links

    不建议使用。建议使用用户自定义的网络 来使两个容器之间的通信,而不是使用--link。


    22、logging

    配置日志选项。

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

    driver 指定服务容器的日志驱动程序。

    目前支持三种日志驱动类型,默认是 json-file:

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

    只有 json-file 和 journald 驱动程序可以直接从docker-compose up和docker-compose logs中获取日志,其它驱动程序不打印任何日志。


    默认驱动程序 json-file 具有限制存储日志量的选项。使用键值对来获得最大存储大小和最大文件数:

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

    存储日志文件达到max-size 200kB,然后轮流下一个文件。存储的各个日志文件的数量由max-file值指定。随着日志文件数量超出最大限制,将删除较旧的日志文件以允许存储新日志。


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

    network_mode: "host"  不能与 links 混用。


    24、networks

    配置容器连接的网络。

version: "3"

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




networks:
  some-network:
  other-network:


    25、pid

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

pid: "host"


    26、ports

    暴露端口。

    端口映射不兼容 network_mode: host


    短语法

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

    以HOST:CONTAINER格式映射端口时,使用低于60的容器端口并且没有放入引号中,可能会得到错误结果。因为YAML会将 xx:yy 中的数字格式解析为60进制。因此,建议数字串都采用引号包括起来的字符串格式。    

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"


    长语法

    长语法是 3.2版本的新功能。

    长格式语法允许配置不能以简短形式表示的其他字段

        target:容器内的端口

        published:公开暴露的港口

        protocol:端口协议(tcp或udp)

        mode:host用于在每个节点上发布主机端口,或者ingress用于负载平衡的集群模式端口。

ports:
  - target: 80
    published: 8080
    protocol: tcp
    mode: host


    27、secrets

    设置文件访问权限,存储敏感数据,例如  mysql 、redis服务密码。

   

    短语法

    使用短语法授予redis服务访问权限 my_secret和my_other_secret

version: "3.1"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    secrets:
      - my_secret
      - my_other_secret
secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true


    长语法

    source:Docker中存在的机密文件名称。

    target:要挂载到服务容器中/run/secrets/下的文件名称。如果未指定,则默认为 source。

    uid和gid:在服务容器中/run/secrets/下拥有该文件的UID或GID是多少 。如果未指定,则默认为0。

    mode:以八进制表示法表示 服务容器中/run/secrets/下的文件的权限。例如,0444 代表谁都可读。Docker 1.13.1中的默认值是0000,但是在较新的版本中是0444。因为挂载在临时文件系统中,所以无法写。如果设置了可写(r),则被忽略。可以设置可执行(x)。

    下面的示例在容器中将my_secret的名称设置为redis_secret,权限设置为0440(组可读),并将用户和组设置为103。redis服务无法访问该my_other_secret。

version: "3.1"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    secrets:
      - source: my_secret
        target: redis_secret
        uid: '103'
        gid: '103'
        mode: 0440
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:
  # 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


    长语法  3.2版本新功能

    type:mount类型volume、bind或tmpfs

    source:mount的源,主机上用于绑定挂载的路径,或顶层volumes中定义的卷的名称 。不适用于tmpfs安装。

    target:挂载到容器中的路径

    read_only:将volume设置为只读

    bind:配置其他绑定选项

    propagation:用于绑定的传播模式

    volume:配置volume的其它选项

        nocopy:创建volume时禁用从容器复制数据

    tmpfs:配置tmpfs其它选项

        size:tmpfs mount的大小(以字节为单位)

version: "3.2"
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:


    33、其它指令

    官方全部指令:https://docs.docker.com/compose/compose-file/

    

    指定服务容器启动后执行的入口文件。

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


三、compose示例文件

version: "3"
services:

  redis:
    image: redis:alpine
    ports:
      - "6379"
    networks:
      - frontend
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  db:
    image: postgres:9.4
    volumes:
      - db-data:/var/lib/postgresql/data
    networks:
      - backend
    deploy:
      placement:
        constraints: [node.role == manager]

  vote:
    image: dockersamples/examplevotingapp_vote:before
    ports:
      - "5000:80"
    networks:
      - frontend
    depends_on:
      - redis
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
      restart_policy:
        condition: on-failure

  result:
    image: dockersamples/examplevotingapp_result:before
    ports:
      - "5001:80"
    networks:
      - backend
    depends_on:
      - db
    deploy:
      replicas: 1
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  worker:
    image: dockersamples/examplevotingapp_worker
    networks:
      - frontend
      - backend
    deploy:
      mode: replicated
      replicas: 1
      labels: [APP=VOTING]
      restart_policy:
        condition: on-failure
        delay: 10s
        max_attempts: 3
        window: 120s
      placement:
        constraints: [node.role == manager]

  visualizer:
    image: dockersamples/visualizer:stable
    ports:
      - "8080:8080"
    stop_grace_period: 1m30s
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"
    deploy:
      placement:
        constraints: [node.role == manager]

networks:
  frontend:
  backend:

volumes:
  db-data:



四、读取变量

    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  镜像的容器。

点赞
说说你的看法

所有评论: (0)