Dockerfiel与docker-compose

Posted 2021-03-09 ajunyu

Dockerfile用来构建镜像，docker-compose.yml用来启动一系列的服务。约定dockerfile命令用大写。

本文列举部分Dockerfile和docker-compose用法及常用命令

 

Dockerfile：

FROM

　　功能为指定基础镜像，并且必须是第一条指令。

　　如果不以任何镜像为基础，那么写法为：FROM scratch。

　　同时意味着接下来所写的指令将作为镜像的第一层开始

语法：

　　FROM <image>
　　FROM <image>:<tag>
　　FROM <image>:<digest> 

　　三种写法，其中<tag>和<digest> 是可选项，如果没有选择，那么默认值为latest

 

RUN

　　功能为运行指定的命令

RUN命令有两种格式

　　1. RUN <command>
　　2. RUN ["executable", "param1", "param2"]

　　第一种后边直接跟shell命令

　　在linux操作系统上默认 /bin/sh -c

　　在windows操作系统上默认 cmd /S /C

　　第二种是类似于函数调用。

　　可将executable理解成为可执行文件，后面就是两个参数。 

两种写法比对：

　　RUN /bin/bash -c source $HOME/.bashrc; echo $HOME

　　RUN ["/bin/bash", "-c", "echo hello"]

　　注意：多行命令不要写多个RUN，原因是Dockerfile中每一个指令都会建立一层，多少个RUN就构建了多少层镜像，会造成镜像的臃肿、多层，不仅仅增加了构件部署的时间，还容易出错。

RUN书写时的换行符是

 

CMD

　　功能为容器启动时要运行的命令

语法有三种写法

　　1. CMD ["executable","param1","param2"]
　　2. CMD ["param1","param2"]
　　3. CMD command param1 param2

　　第三种比较好理解了，就时shell这种执行方式和写法

　　第一种和第二种其实都是可执行文件加上参数的形式

 

举例说明两种写法：

　　CMD [ "sh", "-c", "echo $HOME"

　　CMD [ "echo", "$HOME" ]

　　补充细节：这里边包括参数的一定要用双引号，就是",不能是单引号。千万不能写成单引号。

　　原因是参数传递后，docker解析的是一个JSON array

 

RUN & CMD

　　不要把RUN和CMD搞混了。

　　RUN是构件容器时就运行的命令以及提交运行结果

　　CMD是容器启动时执行的命令，在构件时并不运行，构件时紧紧指定了这个命令到底是个什么样子

 

LABEL

　　功能是为镜像指定标签

语法：

　　LABEL <key>=<value> <key>=<value> <key>=<value> ...

一个Dockerfile种可以有多个LABEL，如下：

　　LABEL "com.example.vendor"="ACME Incorporated"
　　LABEL com.example.label-with-value="foo"
　　LABEL version="1.0"
　　LABEL description="This text illustrates
　　that label-values can span multiple lines."

但是并不建议这样写，最好就写成一行，如太长需要换行的话则使用符号

如下：

　　LABEL multi.label1="value1"
　　multi.label2="value2"
　　other="value3"

说明：LABEL会继承基础镜像种的LABEL，如遇到key相同，则值覆盖

 

MAINTAINER

指定作者

语法：

　　MAINTAINER <name>

 

EXPOSE

　　功能为暴露容器运行时的监听端口给外部

　　但是EXPOSE并不会使容器访问主机的端口

　　如果想使得容器与主机的端口有映射关系，必须在容器启动的时候加上 -P参数

 

ENV

　　功能为设置环境变量

语法有两种

　　1. ENV <key> <value>
　　2. ENV <key>=<value> ...

　　两者的区别就是第一种是一次设置一个，第二种是一次设置多个

 

ADD

　　 一个复制命令，把文件复制到镜像中

　　如果把虚拟机与容器想象成两台linux服务器的话，那么这个命令就类似于scp，只是scp需要加用户名和密码的权限验证，而ADD不用。

语法如下：

　　1. ADD <src>... <dest>
　　2. ADD ["<src>",... "<dest>"]

　　<dest>路径的填写可以是容器内的绝对路径，也可以是相对于工作目录的相对路径

　　<src>可以是一个本地文件或者是一个本地压缩文件，还可以是一个url

　　如果把<src>写成一个url，那么ADD就类似于wget命令

如以下写法都是可以的：

　　ADD test relativeDir/ 

　　ADD test /relativeDir

　　ADD http://example.com/foobar /

　　尽量不要把<scr>写成一个文件夹，如果<src>是一个文件夹了，复制整个目录的内容,包括文件系统元数据

 

COPY

　　看这个名字就知道，又是一个复制命令

语法如下：

　　1. COPY <src>... <dest>
　　2. COPY ["<src>",... "<dest>"]

与ADD的区别

　　COPY的<src>只能是本地文件，ADD复制的如果是一个压缩文件，会解压到目标路径，其他用法一致

 

ENTRYPOINT

　　功能是启动时的默认命令

语法如下：

　　1. ENTRYPOINT ["executable", "param1", "param2"]
　　2. ENTRYPOINT command param1 param2

　　第二种就是写shell

　　第一种就是可执行文件加参数

与CMD比较说明（这俩命令太像了，而且还可以配合使用）：

1. 相同点：

　　只能写一条，如果写了多条，那么只有最后一条生效

　　容器启动时才运行，运行时机相同

2. 不同点：

 　　ENTRYPOINT不会被运行的command覆盖，而CMD则会被覆盖

 　　如果我们在Dockerfile种同时写了ENTRYPOINT和CMD，并且CMD指令不是一个完整的可执行命令，那么CMD指定的内容将会作为ENTRYPOINT的参数

如下：

　　FROM ubuntu
　　ENTRYPOINT ["top", "-b"]
　　CMD ["-c"]

　　如果我们在Dockerfile种同时写了ENTRYPOINT和CMD，并且CMD是一个完整的指令，那么它们两个会互相覆盖，谁在最后谁生效

如下：

　　FROM ubuntu
　　ENTRYPOINT ["top", "-b"]
　　CMD ls -al

　　那么将执行ls -al ,top -b不会执行。

 

VOLUME

　　可实现挂载功能，可以将内地文件夹或者其他容器中的文件夹挂在到这个容器中

语法为：

　　VOLUME ["/data"]

说明：

　　["/data"]可以是一个JsonArray ，也可以是多个值。所以如下几种写法都是正确的

　　VOLUME ["/var/log/"]

　　VOLUME /var/log

　　VOLUME /var/log /var/db

　　一般的使用场景为需要持久化存储数据时，容器使用的是AUFS，这种文件系统不能持久化数据，当容器关闭后，所有的更改都会丢失。

所以当数据需要持久化时用这个命令。

 

USER

　　设置启动容器的用户，可以是用户名或UID，所以，只有下面的两种写法是正确的

　　USER daemo

　　USER UID

　　注意：如果设置了容器以daemon用户去运行，那么RUN, CMD 和 ENTRYPOINT 都会以这个用户去运行

 

WORKDIR

语法：

　　WORKDIR /path/to/workdir

　　设置工作目录，对RUN,CMD,ENTRYPOINT,COPY,ADD生效。如果不存在则会创建，也可以设置多次。

如：

　　WORKDIR /a
　　WORKDIR b
　　WORKDIR c
　　RUN pwd

　　pwd执行的结果是/a/b/c

 

　　WORKDIR也可以解析环境变量

　　如：

　　ENV DIRPATH /path

　　WORKDIR $DIRPATH/$DIRNAME
　　RUN pwd

　　pwd的执行结果是/path/$DIRNAME

 

ARG

语法：

　　ARG <name>[=<default value>]

　　设置变量命令，ARG命令定义了一个变量，在docker build创建镜像的时候，使用--build-arg <varname>=<value>来指定参数

　　如果用户在build镜像时指定了一个参数没有定义在Dockerfile中，那么将有一个Warning

　　提示如下：

　　[Warning] One or more build-args [foo] were not consumed.

我们可以定义一个或多个参数，如下：

　　FROM busybox
　　ARG user1
　　ARG buildno
　　...

　　也可以给参数一个默认值：

　　FROM busybox
　　ARG user1=someuser
　　ARG buildno=1
　　...

　　如果我们给了ARG定义的参数默认值，那么当build镜像时没有指定参数值，将会使用这个默认值

 

ONBUILD

语法：

　　ONBUILD [INSTRUCTION]

　　这个命令只对当前镜像的子镜像生效。

　　比如当前镜像为A，在Dockerfile中添加：

　　ONBUILD RUN ls -al

　　这个 ls -al 命令不会在A镜像构建或启动的时候执行

　　此时有一个镜像B是基于A镜像构建的，那么这个ls -al 命令会在B镜像构建的时候被执行。

  

STOPSIGNAL

语法：

　　STOPSIGNAL signal

　　STOPSIGNAL命令是的作用是当容器推出时给系统发送什么样的指令

 

 

HEALTHCHECK

　　 容器健康状况检查命令

语法有两种：

　　1. HEALTHCHECK [OPTIONS] CMD command
　　2. HEALTHCHECK NONE

　　第一个的功能是在容器内部运行一个命令来检查容器的健康状况

　　第二个的功能是在基础镜像中取消健康检查命令

[OPTIONS]的选项支持以下三中选项：

   　 --interval=DURATION 两次检查默认的时间间隔为30秒

  　  --timeout=DURATION 健康检查命令运行超时时长，默认30秒

   　 --retries=N 当连续失败指定次数后，则容器被认为是不健康的，状态为unhealthy，默认次数是3

注意：

　　HEALTHCHECK命令只能出现一次，如果出现了多次，只有最后一个生效。

　　CMD后边的命令的返回值决定了本次健康检查是否成功，具体的返回值如下：

　　0: success - 表示容器是健康的

　　1: unhealthy - 表示容器已经不能工作了

　　2: reserved - 保留值

 

例子：

　　HEALTHCHECK --interval=5m --timeout=3s
　　CMD curl -f http://localhost/ || exit 1

　　健康检查命令是：curl -f http://localhost/ || exit 1

　　两次检查的间隔时间是5秒

　　命令超时时间为3秒

Docker-compose.yml

　　一份标准配置文件应该包含 version、services、networks 三大部分，其中最关键的就是 services 和 networks 两个部分，下面先来看 services 的书写规则。

services:
  web:
    image: hello-world

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

例如下面这些格式都是可以的：

　　image: redis

　　image: ubuntu:14.04

　　image: tutum/influxdb

　　image: example-registry.com:4000/postgresql

　　image: a4bc65fd

 

build

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

　　build: /path/to/build/dir

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

　　build: ./dir

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

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

　　注意 build 都是一个目录，如果你要指定 Dockerfile 文件需要在 build 标签的子级标签中使用 dockerfile 标签指定，如上面的例子。

　　如果你同时指定了 image 和 build 两个标签，那么 Compose 会构建镜像并且把镜像命名为 image 后面的那个名字。

　　build: ./dir

　　image: webapp:tag

　　既然可以在 docker-compose.yml 中定义构建任务，那么一定少不了 arg 这个标签，就像 Dockerfile 中的 ARG 指令，它可以在构建过程中指定环境变量，但是在构建成功后取消，在 docker-compose.yml 文件中也支持这样的写法：

build:
  context: .
  args:
    buildno: 1
    password: secret

　　下面这种写法也是支持的，一般来说下面的写法更适合阅读。

build:
  context: .
  args:
    - buildno=1
    - password=secret

　　与 ENV 不同的是，ARG 是允许空值的。例如：

args:
  - buildno
  - password

　　这样构建过程可以向它们赋值。

　　注意：YAML 的布尔值（true, false, yes, no, on, off）必须要使用引号引起来（单引号、双引号均可），否则会当成字符串解析。

 

command

　　使用 command 可以覆盖容器启动后默认执行的命令。

　　command: bundle exec thin -p 3000

　　也可以写成类似 Dockerfile 中的格式：

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

container_name

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

　　container_name: app

　　这样容器的名字就指定为app 了。

 

depends_on

　　在使用Compose 时，最大的好处就是少打启动命令，但是一般项目容器启动的顺序是有要求的，如果直接从上到下启动容器，必然会因为容器依赖问题而启动失败。

　　例如在没启动数据库容器的时候启动了应用容器，这时候应用容器会因为找不到数据库而退出，为了避免这种情况我们需要加入一个标签，就是depends_on，这个标签解决了容器的依赖、启动先后的问题。

　　例如下面容器会先启动 redis 和 db 两个服务，最后才启动 web 服务：

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

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

 

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

 

tmpfs

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

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

 

entrypoint

　　在 Dockerfile 中有一个指令叫做 ENTRYPOINT 指令，用于指定接入点

　　在 docker-compose.yml 中可以定义接入点，覆盖 Dockerfile 中的定义：

　　entrypoint: /code/entrypoint.sh

　　格式和 Docker 类似，不过还可以写成这样：

entrypoint:
    - php
    - -d
    - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
    - -d
    - memory_limit=-1
    - vendor/bin/phpunit

 

env_file

　　还记得前面提到的.env 文件吧，这个文件可以设置 Compose 的变量。而在 docker-compose.yml 中可以定义一个专门存放变量的文件。

　　如果通过 docker-compose -f FILE 指定了配置文件，则 env_file 中路径会使用配置文件路径。

　　如果有变量名称与 environment 指令冲突，则以后者为准。格式如下：

　　env_file: .env

或者根据 docker-compose.yml 设置多个：

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

　　注意的是这里所说的环境变量是对宿主机的 Compose 而言的，如果在配置文件中有 build 操作，这些变量并不会进入构建过程中，如果要在构建中使用变量还是首选前面刚讲的 arg 标签。

 

environment

　　与上面的 env_file 标签完全不同，反而和 arg 有几分类似，这个标签的作用是设置镜像变量，它可以保存变量到镜像里面，也就是说启动的容器也会包含这些变量设置，这是与 arg 最大的不同。

　　一般 arg 标签的变量仅用在构建过程中。而 environment 和 Dockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中，类似 docker run -e 的效果。

environment:
  RACK_ENV: development
  SHOW: ‘true‘
  SESSION_SECRET:

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

 

expose

　　这个标签与Dockerfile中的EXPOSE指令一样，用于指定暴露的端口，但是只是作为一种参考，实际上docker-compose.yml的端口映射还得ports这样的标签。

expose:
 - "3000"
 - "8000"

 

external_links

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

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

 

extra_hosts

　　添加主机名的标签，就是往/etc/hosts文件中添加一些记录，与Docker client的--add-host类似：

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

　　启动之后查看容器内部hosts：

162.242.195.82  somehost
50.31.209.229   otherhost

 

labels

　　向容器添加元数据，和Dockerfile的LABEL指令一个意思，格式如下：

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"

 

links

　　还记得上面的depends_on吧，那个标签解决的是启动顺序问题，这个标签解决的是容器连接问题，与Docker client的--link一样效果，会连接到其它服务中的容器。
格式如下：

links:
 - db
 - db:database
 - redis

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

172.12.2.186  db
172.12.2.186  database
172.12.2.187  redis

　　相应的环境变量也将被创建。

 

logging

这个标签用于配置日志服务。格式如下：

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

　　默认的driver是json-file。只有json-file和journald可以通过docker-compose logs显示日志，其他方式有其他日志查看方式，但目前Compose不支持。对于可选值可以使用options指定。
有关更多这方面的信息可以阅读官方文档：https://docs.docker.com/engine/admin/logging/overview/

 

pid

　　pid: "host"

　　将PID模式设置为主机PID模式，跟主机系统共享进程命名空间。容器使用这个标签将能够访问和操纵其他容器和宿主机的名称空间。

 

ports

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

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

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

 

security_opt

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

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

　　

stop_signal

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

　　stop_signal: SIGUSR1

 

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
volumes_from　　

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

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

　　 

cap_add, cap_drop

　　添加或删除容器的内核功能。

cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

 

cgroup_parent

　　指定一个容器的父级cgroup。

　　cgroup_parent: m-executor-abcd

 

devices

　　设备映射列表。与Docker client的--device参数类似。

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

　　

extends

这个标签可以扩展另一个服务，扩展内容可以是来自在当前文件，也可以是来自其他文件，相同服务的情况下，后来者会有选择地覆盖原有配置。

extends:
  file: common.yml
  service: webapp

　　用户可以在任何地方使用这个标签，只要标签内容包含file和service两个值就可以了。file的值可以是相对或者绝对路径，如果不指定file的值，那么Compose会读取当前YML文件的信息。

network_mode

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

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

可以指定使用服务或者容器的网络。

 

networks

加入指定网络，格式如下：

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

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

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

　　相同的服务可以在不同的网络有不同的别名。

 

其它

　　还有这些标签：cpu_shares, cpu_quota, cpuset, domainname, hostname, ipc, mac_address, mem_limit, memswap_limit, privileged, read_only, restart, shm_size, stdin_open, tty, user, working_dir
上面这些都是一个单值的标签，类似于使用docker run的效果。

cpu_shares: 73
cpu_quota: 50000
cpuset: 0,1
user: postgresql
working_dir: /code
domainname: foo.com
hostname: foo
ipc: host
mac_address: 02:42:ac:11:65:43
mem_limit: 1000000000
memswap_limit: 2000000000
privileged: true
restart: always
read_only: true
shm_size: 64M
stdin_open: true
tty: true

　　

docker-compose常用命令

docker-compose ps 　　　　　　查看当前有哪些容器（docker-compose.yml 所在文件夹下执行）

docker-compose config  -q   　　 验证（docker-compose.yml）文件配置，当配置正确时，不输出任何内容，当文件配置错误，输出错误信息。

docker-compose restart nginx  　重新启动nginx服务的容器（注意是 编排文件中的service）

docker-compose logs nginx   　   查看nginx的日志 

docker-compose logs -f nginx      查看nginx的实时日志

docker-compose up 

docker-compose down

docker-compose exec nginx bash  进入nginx服务下容器

docker-compose exec --index=1 nginx bash  进入nginx服务下容器 多台 需要加参数 --index=xxx