Docker镜像制作规范

Docker镜像制作规范

镜像（Image）是在基础文件集（root filesystem）之上依次变更的集合，及在容器运行的默认执行参数。

术语

层（layer）

镜像由层（layer）组成。每一层都是若干文件的变更集合。层不包括环境变量或默认参数等元数据。这些元数据是镜像整体的属性，而不是特定层的。

ImageID

每个镜像的ID是其json描述文件的SHA256散列值，用十六进制编码表示，如sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9。
由于JSON文件包含镜像所有层的散列ID，据此计算出的ImageID，使得可以对镜像的即各层按内容寻址（Content Addressable，地址即各层的DiffID）。

标签（tag）

Tag是用户为ImageID指定的说明文字。Tag中的字符只能是大小写字母、数字、短线、下划线和点，即[a-zA-Z0-9_.-]，首个字符不能是.或-。Tag不能超过127个字符。

镜像名（Repository）

这里的Repository是指镜像全名在冒号:之前的部分，冒号:之后的部分是镜像的标签（tag），用来区分镜像的版本。 如名为my-app:3.1.4的镜像，my-app就是镜像的 Repository 部分。
Repository又可以用斜杠/分隔开，/之前的部分是可选的DNS格式的主机名。主机名必须符合DNS规则，但 不得 包含下划线_字符，主机名可以有如：8080格式的端口号。
镜像名可以包含小写字符，数字和分隔符。 分隔符是句点.，一个或两个下划线_，或一个或多个短横线-，镜像名 不允许 以分隔符开头或结尾。

Dockerfile

通过Dockerfile可以制作镜像，通过优化Dockerfile中的指令，可以减少镜像的大小，按照一些规范来制作Dockerfile，可以增加Dockerfile的可读性与可维护性。

基本原则

• 尽量使用干净的目录去制作精细，避免不必要的性能损耗。
• 只安装需要的包。为了减少镜像的体积和编译时间，应避免安装额外的、不需要的包。
• 每个容器只运行一个进程。
• 减少镜像层。Dockerfile中的指令会生成新的镜像层，一个镜像最多127层。
• 把多个参数排在不同的行中，提高可读性。

FROM指令

尽量使用官方镜像作为基础镜像。

RUN指令

• 从可读性的角度考虑，使用RUN命令时，应使用\将命令分成多行。
• 避免更新基础镜像中的基础软件包，避免执行yum update或apt upgrade的命令。
• 尽量使用RUN apt update && apt install -y \的方式保证每次制作镜像时，都是安装的最新的软件包。
• 在安装命令后，应清理缓存，减少镜像的大小，执行...&& yum clean all

CMD指令

CMD指令设置镜像中的默认启动命令和参数。容器启动之后，如果没有加入任何启动命令，则默认执行镜像中的CMD设置的默认的启动命令。

设置启动命令时，应该尽量使用json格式，如CMD ["command", "arg1", "arg2"].

ENTRYPOINT指令

通过ENTRYPOINT指令可设置镜像的入口程序。当启动主程序之前还需要执行大量的前置操作时，可将ENTRYPOINT的入口指令设置为一个脚本entrypoint.sh.

如postgres的官方用法：

...
ENTRYPOINT ["docker-entrypoint.sh"]
CMD ["postgres"]

EXPOSE指令

• EXPOSE 用来声明未来容器内需要监听的端口, 在 bridge 模式下, 这些容器内部的端口会映射到宿主机的端口上, 建议在容器内部不要更改应用原生的端口号
• EXPOSE 中只能指定未来容器内部需要暴露的端口, 不能指定未来容器外部与内部端口之间的映射关系, 比如设置 EXPOSE 8800:80 是没有任何意义的

ADD与COPY指令

ADD 与 COPY 都是将外部文件拷贝到镜像内部的指令, 相比之下可能 ADD 的功能更加强大一下, 建议如下:

• 尽量不要拷贝远程文件, 这样也就用不着 ADD 的功能, 用 COPY 就可以了。
• 如果压缩包拷贝进镜像后, 不希望这个压缩包被自动解压缩, 用 COPY 就对了. 反之如果希望拷贝进镜像之后就自动解压做, 那就用 ADD 拷贝进去。

如果涉及到远程文件, 建议使用 RUN curl 或 RUN wget 命令替代 ADD。

WORKDIR指令

• 尽量使用绝对路径
• 切换目录的时候尽量使用 WORKDIR, 而不是使用 RUN cd /dir

Dockerfile构建镜像总结

• 减少镜像的层数，尽量把一些功能上面统一的命令合到一起来做；
• 注意清理镜像构建的中间产物，比如一些安装包在装完之后就把它删掉；
• 注意优化网络请求，使用yum源的时候，用一些网络比较好的源站点，可节约时间，减少失败率；
• 尽量去构建缓存，尽量把一些不变的东西或者变动比较少的东西放在前面，因为不变的东西是可以被缓存的；
• 多阶段进行镜像构建。