dockerfile详解文件指令详解

Posted 2023-01-18 小志的博客

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了dockerfile详解文件指令详解相关的知识，希望对你有一定的参考价值。

一、环境介绍

Dockerfile中所用的所有文件一定要和Dockerfile文件在同一级父目录下，可以为Dockerfile父目录的子目录。
Dockerfile中相对路径默认都是Dockerfile所在的目录。
Dockerfile中一定要惜字如金，能写到一行的指令，一定要写到一行，原因是分层构建，联合挂载这个特性。
Dockerfile中每一条指令被视为一层。
Dockerfile中指明大写（约定俗成）。

二、指令介绍

2.1、FROM指令

2.1.1 、概述

功能为指定基础镜像，并且必须是第一条指令。
如果不以任何镜像为基础，那么写法为：FROM scratch。
同时意味着接下来所写的指令将作为镜像的第一层开始。

2.1.2 、语法

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

2.2、MAINTAINER指令

2.2.1 、概述

功能为指定作者

2.2.2 、语法

新版docker中使用LABEL指明
```
MAINTAINER <name>
```

2.3、LABEL指令

2.3.1 、概述

功能是为镜像指定标签

2.3.2 、语法

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

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"

2.4、ADD指令

2.4.1 、概述

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

2.4.2 、语法

LABEL会继承基础镜像种的LABEL，如遇到key相同，则值覆盖
```
ADD <src>... <dest>
ADD ["<src>",... "<dest>"]
```

2.4.3 、语法解释

路径的填写可以是容器内的绝对路径，也可以是相对于工作目录的相对路径，推荐写成绝对路径。
可以是一个本地文件或者是一个本地压缩文件，还可以是一个url。

如果把写成一个url，那么ADD就类似于wget命令。如下所示：

ADD test relativeDir/ 
ADD test /relativeDir
ADD http://example.com/foobar /

2.4.4 、注意事项

src为一个目录的时候，会自动把目录下的文件复制过去，目录本身不会复制。
如果src为多个文件，dest一定要是一个目录。

2.5、COPY指令

2.5.1 、概述

功能为一个复制命令

2.5.2 、语法

语法如下：

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

2.6、ADD指令和COPY指令的区别

COPY的只能是本地文件，其他用法一致

2.7、EXPOSE指令

2.7.1 、概述

功能为暴漏容器运行时的监听端口给外部。
但是EXPOSE并不会使容器访问主机的端口。
如果想使得容器与主机的端口有映射关系，必须在容器启动的时候加上 -P参数。

2.7.2 、语法

语法如下：
```
EXPOSE <port>/<tcp/udp>
```

2.8、ENV指令

2.8.1 、概述

功能为设置环境变量。

2.8.2 、语法

语法有两种，两者的区别就是第一种是一次设置一个，第二种是一次设置多个
```
ENV <key> <value>
ENV <key>=<value> ...
```

2.8.3、在Dockerfile中使用变量的方式

第一种和第二种相同

#第一种表示
$varname
#第二种表示
$varname

第三种表示当变量不存在使用-号后面的值
```
#第三种表示
$varname:-default value
```
第四种表示当变量存在时使用+号后面的值（当然不存在也是使用后面的值）
```
#第四种表示
$(varname:+default value
```

2.9、RUN指令

2.9.1 、概述

功能为运行指定的命令

2.9.2 、语法

RUN命令有两种格式

RUN <command>
RUN ["executable", "param1", "param2"]

2.9.3 、语法解释

第一种后边直接跟shell命令

在linux操作系统上默认 /bin/sh -c
在windows操作系统上默认 cmd /S /C

第二种是类似于函数调用

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

2.10、CMD指令

2.10.1 、概述

功能为容器启动时默认命令或参数

2.10.2 、语法

语法有三种写法

CMD ["executable","param1","param2"]
CMD ["param1","param2"]
CMD command param1 param2

2.10.3 、语法解释

第三种比较好理解了，就时shell这种执行方式和写法
第一种和第二种其实都是可执行文件加上参数的形式，举例说明两种写法：
```
CMD [ "sh", "-c", "echo $HOME" 
CMD [ "echo", "$HOME" ]
```

2.10.3 、注意事项

这里边包括参数的一定要用双引号，就是",不能是单引号。千万不能写成单引号。
原因是参数传递后，docker解析的是一个JSON array

2.11、RUN指令和CMD指令区别

RUN是构件容器时就运行的命令以及提交运行结果
CMD是容器启动时执行的命令，在构件时并不运行，构件时紧紧指定了这个命令到底是个什么样子

2.12、ENTRYPOINT指令

2.12.1 、概述

容器启动时运行得启动命令

2.12.2 、语法

语法如下

ENTRYPOINT ["executable", "param1", "param2"]  
ENTRYPOINT command param1 param2

2.12.3 、语法解释

第一种就是可执行文件加参数（EXEC调用,可在docker run启动时传递参数）
第二种就是写shell (shell执行)

2.13、ENTRYPOINT指令和CMD指令区别

2.13.1、相同点

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

2.13.2、不同点

ENTRYPOINT不会被运行的command覆盖，而CMD则会被覆盖。
```
FROM ubuntu
ENTRYPOINT ["top", "-b"]
CMD ["-c"]
```
如上内容示例，如果我们在Dockerfile种同时写了ENTRYPOINT和CMD，并且CMD是一个完整的指令，那么它们两个会互相覆盖，谁在最后谁生效。
如果我们在Dockerfile种同时写了ENTRYPOINT和CMD，并且CMD指令不是一个完整的可执行命令，那么CMD指定的内容将会作为ENTRYPOINT的参数。
```
FROM ubuntu
ENTRYPOINT ["top", "-b"]
CMD ls -al
```
如上内容示例，那么将执行ls -al ,top -b不会执行。

2.14、VOLUME指令

2.14.1 、概述

可实现挂载功能，可以将宿主机目录挂载到容器中

2.14.2 、语法

语法如下：
```
VOLUME ["/data"]
```

2.14.3 、语法解释

[“/data”]可以是一个JsonArray ，也可以是多个值。所以如下几种写法都是正确的
```
VOLUME ["/var/log/"]
VOLUME /var/log
VOLUME /var/log /var/db
```
一般的使用场景为需要持久化存储数据时。
容器使用的是AUFS，这种文件系统不能持久化数据，当容器关闭后，所有的更改都会丢失。
所以当数据需要持久化时用这个命令。

2.15、USER指令

2.15.1 、概述

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

2.15.2 、语法

语法如下：
```
USER daemo
USER UID
```

2.15.3 、注意事项

如果设置了容器以daemon用户去运行，那么RUN, CMD 和 ENTRYPOINT 都会以这个用户去运行,
使用这个命令一定要确认容器中拥有这个用户，并且拥有足够权限。

2.16、WORKDIR指令

2.16.1 、概述

2.16.2 、语法

语法如下：
```
WORKDIR /path/to/workdir
```

2.16.3 、注意事项

对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

2.17、ARG指令

2.17.1 、概述

设置变量命令,

2.17.2 、语法

语法如下：
```
ARG <name>[=<default value>]
```

2.17.3 、语法解释

ARG命令定义了一个变量，在docker build创建镜像的时候，使用 --build-arg =来指定参数
如果用户在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镜像时没有指定参数值，将会使用这个默认值

2.18、ONBUILD指令

2.18.1 、语法

语法如下：
```
ONBUILD [INSTRUCTION]
```

2.18.2 、语法解释

这个命令只对当前镜像的子镜像生效，比如当前镜像为A，在Dockerfile种添加：
```
ONBUILD RUN ls -al
```
这个 ls -al 命令不会在A镜像构建或启动的时候执行，此时有一个镜像B是基于A镜像构建的，那么这个ls -al 命令会在B镜像构建的时候被执行。

2.19、STOPSIGNAL指令

2.19.1 、概述

当容器停止时给系统发送什么样的指令，默认是15

2.19.2 、语法

语法如下：
```
STOPSIGNAL signal
```

2.20、HEALTHCHECK指令

2.20.1 、概述

容器健康状况检查命令

2.20.2 、语法

语法有两种如下：

HEALTHCHECK [OPTIONS] CMD command
HEALTHCHECK NONE

2.20.3 、语法解释

第一个命令的功能是在容器内部运行一个命令来检查容器的健康状况
第二个命令的功能是在基础镜像中取消健康检查命令

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

–interval=DURATION 两次检查默认的时间间隔为30秒
–timeout=DURATION 健康检查命令运行超时时长，默认30秒
–retries=N 当连续失败指定次数后，则容器被认为是不健康的，状态为unhealthy，默认次数是3

2.20.4 、注意事项

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

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

0: success - 表示容器是健康的
1: unhealthy - 表示容器已经不能工作了
2: reserved - 保留值

2.20.5 、示例

健康检查命令是：curl -f http://localhost/ || exit 1
```
HEALTHCHECK --interval=5m --timeout=3s \\
CMD curl -f http://localhost/ || exit 1
```
两次检查的间隔时间是5秒，命令超时时间为3秒

以上是关于dockerfile详解文件指令详解的主要内容，如果未能解决你的问题，请参考以下文章

Dockerfile使用方法详解

Dockerfile指令详解

Dockerfile常用指令详解&镜像缓存特性

Dockerfile详解

Docker：Dockerfile 命令详解

6.9 docker Dockerfile 指令详解