Dockerfile文件详解

Docker 可以通过读取 Dockerfile 中的指令自动构建镜像。 Dockerfile 是一个文本文档，其中包含了用户创建镜像的所有命令和说明。

指令详解

最佳实践

nginx

 1FROM ubuntu:latest
 2MAINTAINER rushui "rushui@qq.com"
 3# RUN apt-get update
 4# RUN apt-get install -y vim 
 5
 6# RUN apt-get install -y nginx
 7# 以上执行会创建 3 层镜像。可简化为以下格式：
 8RUN apt-get update && apt-get install -y vim &&  apt-get install -y nginx
 9# 如上，以 && 符号连接命令，这样执行后，只会创建 1 层镜像。
10#指定运行该镜像的容器使用的端口为 80
11# docker run的时候 一定要加上 -P
12EXPOSE 80
13CMD ["nginx","-g","daemon off;"]

多阶段构建golang

https://github.com/go-zeus/demo/blob/main/Dockerfile

1FROM golang:1.16-alpine AS build
2WORKDIR /go/src/project/
3COPY . /go/src/project/
4RUN go build -ldflags "-s -w" -o /bin/project
5FROM alpine:3.5
6RUN apk add --update curl && rm -rf /var/cache/apk/*
7COPY --from=build /bin/project /bin/project
8EXPOSE 8080
9CMD ["/bin/project"]

多阶段构建golang后端与vue前端

• .dockerignore文件

1/ui/dist
2/ui/node_modules

• Dockerfile

 1FROM golang:1.21-alpine AS admin
 2WORKDIR /project
 3COPY . /project/
 4RUN go env -w GOPROXY=https://goproxy.cn,direct && go build -ldflags "-s -w" -o /project/kb
 5FROM node:21.6-alpine AS ui
 6WORKDIR /project
 7COPY ./ui /project/
 8RUN npm install -g pnpm@8.3.1 && pnpm i && pnpm build-only
 9FROM alpine:3.18
10MAINTAINER rushui
11RUN sed -i 's/dl-cdn.alpinelinux.org/mirrors.aliyun.com/g' /etc/apk/repositories \
12    && apk add --update curl && rm -rf /var/cache/apk/*
13WORKDIR /app
14COPY --from=admin /project/kb /app/kb
15COPY --from=ui /project/dist /app/ui/dist
16EXPOSE 8080
17CMD ["./kb"]

一、 变量

变量用 $variable_name 或者 ${variable_name} 表示

• ${variable:-word}表示如果variable设置，则结果将是该值。如果variable未设置，word则将是结果。
• ${variable:+word}表示如果variable设置则为word结果，否则为空字符串。 变量前加 \ 可以转义成普通字符串：$fooor${foo}，表示转换为$foo和${foo}文字。

二、FROM

初始化一个新的构建阶段，并设置基础映像：

1FROM [--platform=<platform>] <image> [AS <name>]
2FROM [--platform=<platform>] <image>[:<tag>] [AS <name>]
3FROM [--platform=<platform>] <image>[@<digest>] [AS <name>]

• 单个dockfile可以多次出现 FROM ，以使用之前的构建阶段作为另一个构建阶段的依赖项
• AS name表示为构建阶段命名，在后续FROM和COPY –from=说明中可以使用这个名词，引用此阶段构建的映像
• digest其实就是就是根据镜像内容产生的一个ID，只要镜像的内容不变digest也不会变
• tag或digest值是可选的。如果您省略其中任何一个，构建器默认使用一个latest标签。如果找不到该tag值，构建器将返回错误。
• –platform标志可用于在FROM引用多平台镜像的情况下指定平台。例如，linux/amd64、linux/arm64、 或windows/amd64

三、RUN

将在当前镜像之上的新层中执行命令，在 docker build时运行

1RUN /bin/bash -c 'source $HOME/.bashrc; \
2echo $HOME'

RUN有两种形式：

1RUN <command>（shell 形式，命令在 shell 中运行，默认/bin/sh -c在 Linux 或cmd /S /CWindows 上）
2RUN ["executable", "param1", "param2"]（执行形式）

说明：

• 可以使用\（反斜杠）将单个 RUN 指令延续到下一行
• RUN在下一次构建期间，指令缓存不会自动失效。可以使用–no-cache标志使指令缓存无效
• Dockerfile 的指令每执行一次都会在 docker 上新建一层。所以过多无意义的层，会造成镜像膨胀过大，可以使用&& 符号连接命令，这样执行后，只会创建 1 层镜像

四、CMD

运行程序，在docker run 时运行，但是和run命令不同，RUN 是在 docker build时运行

1FROM ubuntu
2CMD ["/usr/bin/wc","--help"]

支持三种格式

1CMD ["executable","param1","param2"] 使用 exec 执行，推荐方式；
2CMD command param1 param2 在 /bin/sh 中执行，提供给需要交互的应用；
3CMD ["param1","param2"] 提供给 ENTRYPOINT 的默认参数；

指定启动容器时执行的命令，每个 Dockerfile 只能有一条 CMD 命令。如果指定了多条命令，只有最后一条会被执行。

如果用户启动容器时候指定了运行的命令，则会覆盖掉 CMD 指定的命令。

五、LABEL

添加元数据

1LABEL multi.label1="value1" \
2      multi.label2="value2" \
3      other="value3"

六、EXPOSE

1EXPOSE <port> [<port>/<protocol>...]

Docker 容器在运行时侦听指定的网络端口。可以指定端口是监听TCP还是UDP，如果不指定协议，默认为TCP。

该EXPOSE指令实际上并未发布端口。要在运行容器时实际发布端口，docker run -P 来发布和映射一个或多个端口。

默认情况下，EXPOSE假定 TCP。您还可以指定 UDP：

1EXPOSE 80/udp

七、ENV

设置环境变量

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

设置的环境变量将持续存在，您可以使用docker inspect来查看。使用docker run –env =来更改环境变量的值。

如果环境变量只在构建期间需要，请考虑为单个命令设置一个值：

1RUN DEBIAN_FRONTEND=noninteractive apt-get update && apt-get install -y ...

或者使用ARG，它不会保留在最终镜像中：

1ARG DEBIAN_FRONTEND=noninteractive
2RUN apt-get update && apt-get install -y ...

八、ADD

复制新文件、目录或远程文件 URL ，并将它们添加到中。

可以指定多个资源，但如果它们是文件或目录，则它们的路径被解释为相对于构建上下文的源，也就是WORKDIR。

每个都可能包含通配符，匹配将使用 Go 的 filepath.Match规则。例如：

添加所有以“hom”开头的文件：

1ADD hom* /mydir/

在下面的示例中，?被替换为任何单个字符，例如“home.txt”。

1ADD hom?.txt /mydir/

是一个绝对路径，或相对WORKDIR的相对路径。

九、COPY

语法同ADD一致，复制拷贝文件。

COPY指令和ADD指令的唯一区别在于：是否支持从远程URL获取资源。COPY指令只能从执行docker build所在的主机上读取资源并复制到镜像中。而ADD指令还支持通过URL从远程服务器读取资源并复制到镜像中。

相同需求时，推荐使用COPY指令。ADD指令更擅长读取本地tar文件并解压缩。

十、ENTRYPOINT

ENTRYPOINT 和 CMD 一样，都是在指定容器启动程序及参数，不过它不会被 docker run 的命令行参数指定的指令所覆盖。如果要覆盖的话，需要通过docker run –entrypoint 来指定。

它有2种格式：

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

当指定了 ENTRYPOINT 后， CMD 的内容作为参数传给 ENTRYPOINT 指令，实际执行时，将变为：

1<ENTRYPOINT> <CMD>

十一、VOLUME

创建一个具有指定名称的挂载数据卷

1VOLUME ["/var/log/"]
2VOLUME /var/log

它的主要作用是：

• 避免重要的数据，因容器重启而丢失
• 避免容器不断变大

十二、ARG

定义变量，与ENV 作用相同，不过ARG变量不会像ENV变量那样持久化到构建好的镜像中。

1ARG <name>[=<default value>]

Docker 有一组预定义的ARG变量，您可以在 Dockerfile 中没有相应指令的情况下使用这些变量。

• HTTP_PROXY
• http_proxy
• HTTPS_PROXY
• https_proxy
• FTP_PROXY
• ftp_proxy
• NO_PROXY
• no_proxy 要使用这些，请使用–build-arg标志在命令行上传递它们，例如：

1 docker build --build-arg HTTPS_PROXY=https://my-proxy.example.com .

十三、ONBUILD

将一个触发指令添加到镜像中，以便稍后在该镜像用作另一个构建的基础时执行。也就是另外一个dockerfile FROM了这个镜像的时候执行。

1ONBUILD ADD . /app/src
2ONBUILD RUN /usr/local/bin/python-build --dir /app/src

十四、STOPSIGNAL

设置将发送到容器退出的系统调用信号。该信号可以是与内核系统调用表中的位置匹配的有效无符号数，例如 9，或格式为 SIGNAME 的信号名称，例如 SIGKILL。

1STOPSIGNAL signal

默认的 stop-signal 是 SIGTERM，在docker stop的时候会给容器内PID为1的进程发送这个signal，通过–stop-signal 可以设置自己需要的signal，主要目的是为了让容器内的应用程序在接收到signal之后可以先处理一些事物，实现容器的平滑退出，如果不做任何处理，容器将在一段时间之后强制退出，会造成业务的强制中断，默认时间是10s。

十五、HEALTHCHECK

用于指定某个程序或者指令来监控 docker 容器服务的运行状态。该HEALTHCHECK指令有两种形式：

• HEALTHCHECK [OPTIONS] CMD command （通过在容器内运行命令来检查容器健康状况）
• HEALTHCHECK NONE （禁用从基础镜像继承的任何健康检查）

十六、SHELL

覆盖用于命令的shell 形式的默认 shell。Linux 上的默认 shell 是["/bin/sh", “-c”]，Windows 上是[“cmd”, “/S”, “/C”]

1SHELL ["executable", "parameters"] 

该SHELL指令在 Windows 上特别有用，因为 Windows 有两种常用且截然不同的本机 shell：cmd和powershell，以及可用的备用 shell，包括sh。该SHELL指令可以出现多次。每条SHELL指令都会覆盖所有先前的SHELL指令，并影响所有后续指令。

十七、WORKDIR

工作目录，如果WORKDIR不存在，即使它没有在后续Dockerfile指令中使用，它也会被创建。

docker build 构建镜像过程中，每一个 RUN 命令都会新建一层。只有通过 WORKDIR 创建的目录才会一直存在。

可以设置多个WORKDIR，如果提供了相对路径，它将相对于前一条WORKDIR指令的路径。例如：

1WORKDIR /a
2WORKDIR b
3WORKDIR c
4RUN pwd 

最终pwd命令的输出是/a/b/c.

该WORKDIR指令可以解析先前使用 ENV，例如：

1ENV DIRPATH=/path
2WORKDIR $DIRPATH/$DIRNAME
3RUN pwd

最终pwd命令的输出是/path/$DIRNAME

十八、USER

设置用户名（或 UID）和可选的用户组（或 GID）

1USER <user>[:<group>]
2USER <UID>[:<GID>]