【学习笔记】Dockerfile指令--参考手册学习总结

前言 Dockerfile简介

Dockerfile是docker用于构建image的文件。当执行 docker build指令时，docker会根据Dockerfile和上下文(context)来执行构建image的命令。其中“上下文”可以是指定的文件路径(PATH)和URL。PATH是你本地文件系统。而url可以使git库的地址。指定的路径里的所有文件都会遍历到，包括子文件夹下，如果不想添加某些文件可以编写.dockerignore 文件来让docker忽略该文件中匹配的一些文件，这个文件跟git工具中的.gitignore文件类似。简单总结各个指令的意义，方便以后使用遗忘时查看。详细信息，阅读原文

解析器指令（Parser directives）

出现在dockerfile的第一行固定格式为：# directive=value。（与linux shell中第一行，指定解释器的命令（#/bin/bash ）类似。）。解析器指令对大小写不敏感，但根据惯例，解析器指令时小写，其它后续指令按照惯例都是大写，以便与跟指令后的小写参数区分开来。目前支持的指令只有一个:

escape

# escape=\ (backslash)

Or

# escape=` (backtick)

escape指令：定义dockerfile中的转义字符（如果没有指定默认是“\”）。

在window中，通常把转义字符定义为"`"，反引号。这样可以跟window系统下文件路径的\区分开来。

环境变量（Environment replacement）

dockerfile中的变量用命令 ENV 声明。声明的变量可以在dockerfile中进行使用。使用时，用${variable_name} 表示变量，其中variable_name代表变量的名称。与bash中的变量类似，这里的变量语法也可以有下面的语法：

• ${variable_name：-word}： 如果变量variable_name已经被赋值，那么结果输出就是该变量值。如果变量没有被赋值，那么输出结果就是word
  
• ${variable_name：+word} ：如果变量variable_name已经被赋值，那么结果输出就是 word ，如果变量没有被赋值，那么输出结果为空字符串。

 以下的指令都支持变量的使用：

• ADD
• COPY
• ENV
• EXPOSE
• LABEL
• USER
• WORKDIR
• VOLUME
• STOPSIGNAL
• ONBUILD

FROM：

类似导入模块一样，导入指定的image以便在后续的dockerfile使用相应的image内含有的指令。

使用方法：

• FROM <img>:<tag>     引入指定tag的image
• FROM <img>               引入tag默认为:lastest的image
• FROM <img>@<digest>  引入指定ID的image

RUN：

使用方法：

• RUN <command>: (shell form )命令是在shell环境下执行，（linux环境下是"/bin/sh -c "，window下是“cmd /s /c ”） 
• RUN ["executable","parametar1","parametar2"] ：直接运行模式（exec form）

执行指定的命令后，执行的结果会生成一个新的image,供dockerfile后续的指令使用。

CMD：

使用方法：

• CMD ["executable","param1","param2"] (exec form, this is the preferred form)
• CMD ["param1","param2"] (as default parameters to ENTRYPOINT)
  
• CMD command param1 param2 (shell form)
  

CMD在Dockerfile中只能运行一次，如果有多次执行，那么以最后那次CMD指令为准。CMD主要的目标是为容器的执行提供一个defaults ，其中defaults 包含了一个可执行的文件，或者如果忽略可执行文件的话那么需要指定ENTRYPOINT指令。

LABEL:

使用方法：LABEL <key>=<value> <key>=<value> <key>=<value> ...

为image添加一些元数据，它是一对key/value的值。在一个image里面有很多元数据。如果key有重复，最后定义的key会覆盖之前的key。

注：MAINTAINER命令已经弃用，这个命令是用来标示image的作者信息，在最新版本已经弃用，取而代之的是用LABEL：

LABEL maintainer "email@author.com"

EXPOSE:

使用方法：EXPOSE <port> [<port>...]

用来告诉Docker容器监听的端口。这个命令并没有开启端口的作用，如果需要开启，需要在执行docker的时候加上-p参数，

ENV：

用来定义docker的变量，使用方法：

ENV <key> <value>
ENV <key>=<value> ...

在定义了变量之后，dokcer的运行过程中，变量始终是有效的，可以通过docker inspect来查看变量的值，如果想要改变变量的值，需要使用docker run --env <key>=<value>.

注：对单独的一个命令设置变量的时候，使用RUN <key>=<value> <command>

ADD：

使用方法：

• ADD <src>... <dest>
• ADD ["<src>",... "<dest>"] (this form is required for paths containing whitespace)

ADD命令添加<src>中的文件到docker image 路径为<dest>的文件系统中。其中<src>必须是指定在docker执行的目录下，<dest>可以是绝对路径，也可以使相对于wokdir的相对路径。

COPY:

使用方法：

• COPY <src>... <dest>
• COPY ["<src>",... "<dest>"] (this form is required for paths containing whitespace)
  

copy和add命令类似，他们不同的地方，可以从参考手册中的说明看出：

The COPY instruction copies new files or directories from <src> and adds them to the filesystem of the container at the path <dest>.
The ADD instruction copies new files, directories or remote file URLs from <src> and adds them to the filesystem of the image at the path <dest>.

ENTRYPOINT：

• ENTRYPOINT ["executable", "param1", "param2"] (exec form, preferred)
• ENTRYPOINT command param1 param2 (shell form)

为docker容器执行时进行配置。

VOLUME:

使用方法：

VOLUME ["/data"]

volume创建挂载点。

USER:

USER daemon

USER指令，设置一个image在执行时，使用的用户名或者UID

WORKDIR:

WORKDIR /path/to/workdir

为RUN CMD ENTRYPOINT 的执行，设置工作空间。

ARG:

ARG <name>[=<default value>]

为docker的构建传递参数，在执行docker build传递参数时使用 --build-arg <varname>=<value>

ONBUILD:

ONBUILD [INSTRUCTION]

这个命令是在后续需要用到此image时，为image构建的原始数据添加一个trigger。

STOPSIGNAL：

STOPSIGNAL signal

为docker 容器发送停止信号。

HEALTHCHECK:

• HEALTHCHECK [OPTIONS] CMD command (check container health by running a command inside the container)
• HEALTHCHECK NONE (disable any healthcheck inherited from the base image)

让docker检测容器是否还在正常工作。如下：

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

CMD前的参数可以是如下:
--interval=DURATION (default: 30s)
--timeout=DURATION (default: 30s)
--retries=N (default: 3)

SHELL:

SHELL ["executable", "parameters"]

指定默认的shell form运行的命令。linux默认的SHELL:["/bin/sh", "-c"], 而windows下默认的SHELL:["cmd", "/S", "/C"]