docker三剑客之docker compose

Posted 2020-10-01 Michael2397

compose环境变量

以DOCKER_开头的变量和用来配置Docker命令行客户端的使用一样，如果使用boot2docker，${boot2dockershellinit}将会设置他们为正确的值

compose环境变量：

COMPOSE_PROJECT_NAME:
设置compose的项目名称，默认是当前工作目录（docker-compose.yml文件所在目录）的名字
compose会为每一个启动的容器前添加项目名称。例如一个名称为proj的项目，其中的一个web容器，名称可能为proj_web_1



COMPOSE_FILE
设置要使用的 docker-compose.yml 的路径。默认路径是当前工作目录。如果不指定，默认会先查找当前目录下是否存在docker-compose.yml文件，如果找不到，则继续查找上层目录



DOCKER_HOST
设置 Docker daemon 的地址。默认使用 unix:///var/run/docker.sock，与 Docker 客户端采用的默认值一致。




DOCKER_TLS_VERIFY
如果设置不为空，则与 Docker daemon 交互通过 TLS 进行。


DOCKER_CERT_PATH
配置 TLS 通信所需要的验证（ca.pem、cert.pem 和 key.pem）文件的路径，默认是 ~/.docker

compose模板文件

旧版本（版本1），其中每个顶级元素为服务名称，刺激元素为服务容器的配置信息：

　　

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

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

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

每个服务都必须通过image指定镜像或build指令（dockerfile）等来自动构建生成镜像

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

compose模板文件主要指令

build

指定 Dockerfile 所在文件夹的路径。 Compose 将会利用它自动构建这个镜像，然后使用这个镜像。
build: /path/to/build/dir

command

覆盖容器启动后默认执行的命令。
command: bundle exec thin -p 3000

cgroup_parent

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

cgroup_parent:cgroup_1

container_name


指定容器名称，默认使用“项目名称_服务名称_序号”这样的格式
container_name：docker-web-container
需要注意，指定容器名称后，改服务将无法进行扩展，因为docker不允许多个容器具有相同的名称

devices：
 

指定设备映射关系
devices:
    - “/dev/ttyUSB1:/dev/ttyUSB0”

dockerfile

如果需要，指定额外的编译镜像的dockerfile文件
dockerfile:Dockerfile-alternate
注意该指令不能跟image同时使用，否则compose将不知道根据哪个指令来生成最终的服务镜像

env_file

从文件中获取环境变量，可以为单独的文件路径或列表
如果通过docker-compose -f FILE 方式来指定compose模板文件，则env_file中变量的路径会基于模板文件路径
如果有变量名称与envirntonment指令冲突，则以后者为准
env_file: .env
env_file:
    - ./common.env
    -./apps/web.env
    -./opt/secrets.env
环境变量文件中每一行必须符合格式，支持#开头的注释行：
#....
PROG_ENV=development

environment

设置环境变量，可以使用数组或字典两种格式
只给定名称的变量会自动获取运行compose主机上对应变量的值，可以用来防止泄露不必要的数据
environment:
    RACK_ENV：development
    SESSION_SECRET:
或者
environment:
    -RACK_ENV=development
    -SESSION_SECRET

expose

暴露端口，但不映射到宿主机，只允许能够被连接的服务访问。
仅可以指定内部端口为参数
expose:
- "3000"
- "8000"

extends


基于已有的服务进行扩展。例如我们已经有了一个 webapp 服务，模板文件为 common.yml。
# common.yml
webapp:
    build: ./webapp
    environment:
         - DEBUG=false
        - SEND_EMAILS=false
编写一个新的 development.yml 文件，使用 common.yml 中的 webapp 服务进行扩展。
 web:
    extends:
        file: common.yml
        service: webapp
    ports:
         - "8000:8000"
    links:
        - db
    environment:
        - DEBUG=true
    db:
        image: postgres
后者会自动继承 common.yml 中的 webapp 服务及相关环节变量。   

extends不会继承links和volumes_from中定义的容器和数据卷资源                               

external_links

链接到 docker-compose.yml 外部的容器，甚至 并非 Compose 管理的容器。参数格式跟 links 类似。
external_links:
    - redis_1
    - project_db_1:mysql
    - project_db_1:postgresql

extra_hosts

类似docker中的 --add-host参数，指定额外的host名称映射信息
extra_hosts:
    -"googledns:8.8.8.8"
会在启动后的服务容器中/etc/hosts文件中添加：
8.8.8.8 googledns

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

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

labels
为容器添加docker元数据(metadata)信息，例如添加辅助说明信息

labels:
    

links

链接到其它服务中的容器。使用服务名称（同时作为别名）或服务名称：服务别名 （SERVICE:ALIAS） 格式都可以。
links:
    - db
    - db:database
    - redis
使用的别名将会自动在服务容器中的 /etc/hosts 里创建。例如：
172.17.2.186 db
相应的环境变量也将被创建。

net

设置网络模式。使用和 docker client 的 --net 参数一样的值。
net: "bridge"
net: "none"
net: "container:[name or id]"
net: "host"

pid

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

cap_add, cap_drop

添加或放弃容器的 Linux 能力（Capabiliity）。
cap_add:
- ALL
cap_drop:
- NET_ADMIN
- SYS_ADMIN

ports:

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

volumes

卷挂载路径设置。可以设置宿主机路径 （HOST:CONTAINER） 或加上访问模式 （HOST:CONTAINER:ro）。
volumes:
    - /var/lib/mysql
    - cache/:/tmp/cache
    - ~/configs:/etc/configs/:ro

volumes_from

从另一个服务或容器挂载它的所有卷。
volumes_from:
- service_name
- container_name