Dockerfile容器化应用最佳实践

亦凉 2022-05-20 00:11 387阅读 0赞

*  Dockerfile容器化应用最佳实践
    
     *  最佳实践
        
         *  让构建出来的镜像尽可能”小“
         *  让构建镜像过程尽可能“快”
         *  让镜像变得”好用“
         *  让构建镜像变得”省事、省心“
     *  FAQ
     *  参考文档

# Dockerfile容器化应用最佳实践 #

将一个应用容器化，就是将这个应用构建成Docker镜像，然后以Docker容器方式来运行。

构建Docker镜像就是编写Dockerfile，并通过`docker build` 命令构建成Docker镜像。

可以用**”小、快、好、省“**来概括Dockerfile的最佳实践。

## 最佳实践 ##

### 让构建出来的镜像尽可能”小“ ###

**Why？**

小的镜像的好处包括构建镜像快，占用磁盘空间小，网络传输快（比如`docker pull` 和`docker push` 时速度快）。

**How？**

*  **选择适合的尽量小的基础镜像**
    
    比如，你要从Linux操作系统基础镜像开始构建，可以参考下表来选择合适的基础镜像：

<table> 
 <thead> 
  <tr> 
   <th>镜像名称</th> 
   <th>大小</th> 
   <th>使用场景</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="https://hub.docker.com/_/busybox/" rel="nofollow">busybox</a></td> 
   <td>1.15MB</td> 
   <td>临时测试用</td> 
  </tr> 
  <tr> 
   <td><a href="https://hub.docker.com/_/alpine/" rel="nofollow">alpine</a></td> 
   <td>4.41MB</td> 
   <td>主要用于测试，也可用于生产环境</td> 
  </tr> 
  <tr> 
   <td><a href="https://hub.docker.com/_/centos/" rel="nofollow">centos</a></td> 
   <td>200MB</td> 
   <td>主要用于生产环境，支持CentOS/Red Hat，常用于追求稳定性的企业应用</td> 
  </tr> 
  <tr> 
   <td><a href="https://hub.docker.com/_/ubuntu/" rel="nofollow">ubuntu</a></td> 
   <td>81.1MB</td> 
   <td>主要用于生产环境，常用于人工智能计算和企业应用</td> 
  </tr> 
  <tr> 
   <td><a href="https://hub.docker.com/_/debian/" rel="nofollow">debian</a></td> 
   <td>101MB</td> 
   <td>主要用于生产环境</td> 
  </tr> 
 </tbody> 
</table>

*  **尽量减少镜像层的数目**
    
    `RUN` 、`ADD` 和 `COPY` 命令每次执行时都会创建一个镜像层，每个镜像层都会有一定的磁盘开销。
    
    通过合并Dockerfile命令，比如将多条安装包和库文件命令合并成一个`RUN`命令（通过`\`来换行），可以显著减少镜像层的数目。
    
    参考文档：
    
     *  [https://docs.docker.com/develop/develop-images/dockerfile\_best-practices/\#minimize-the-number-of-layers][https_docs.docker.com_develop_develop-images_dockerfile_best-practices_minimize-the-number-of-layers]
     *  [https://docs.docker.com/develop/develop-images/dockerfile\_best-practices/\#sort-multi-line-arguments][https_docs.docker.com_develop_develop-images_dockerfile_best-practices_sort-multi-line-arguments]
 *  **不要安装不必要的包**
    
    不要安装不必要的包，可以减小构建出来Docker镜像的大小。
 *  **构建后删除临时的包**  
    比如解压压缩包后，因为容器运行时不会用到原来的压缩包，因此可以删除原有的压缩包。

### 让构建镜像过程尽可能“快” ###

**Why？**

加快构建的好处不言而喻，比如加快构建Docker镜像环节可以提升整个部署流水线的效率。

**How？**

*  **使用清洁的构建上下文(build context)**
    
    Docker CLI是由给定一个目录或者URL作为构建上下文的，在镜像构建之前会将该上下文发送到Docker Daemon。建议在一个新的目录里创建Dockerfile，然后在该目录里只添加镜像包含的文件。这为`docker build`命令提供了一个更加清洁的上下文并且允许更快地构建镜像。否则，扫描带有多个文件的目录将不必要地减慢构建速度。
    
    参考文档：[https://docs.docker.com/engine/reference/builder/\#usage][https_docs.docker.com_engine_reference_builder_usage]
 *  **利用构建时缓存(build cache)**
    
    Docker build构建镜像时会重复使用已经构建过的中间层作为缓存来加快构建过程。而Docker build构建时是按照Dockerfile顺序构建的，因此需要将不经常变化的生成层的命令放在前面，把经常变化的生成层的命令放在后面。
    
    参考文档：[https://docs.docker.com/develop/develop-images/dockerfile\_best-practices/\#leverage-build-cache][https_docs.docker.com_develop_develop-images_dockerfile_best-practices_leverage-build-cache]

### 让镜像变得”好用“ ###

**Why？**

好用的镜像，造就好用的容器。好用的容器是指可以使用Docker 标准命令前后台运行，传入运行时环境变量控制容器行为，传入运行命令替换缺省命令，优雅的停止，方便查看日志和进入容器内部调试。

**How？**

*  **选择官方基础镜像**
    
    选择官方认证的基础镜像，是构建出好用的镜像的前提。
 *  **设置正确的程序入口点**
    
    容器的程序入口点就是容器启动后要启动的进程。
    
    比如一个Java应用的容器启动后，要启动的进程通常是`java -jar app.jar`。
    
    Dockerfile中的`CMD` 命令和 `ENTRYPOINT` 命令的多种格式，以及单独使用和混合使用很容易混淆，请参考：
 *  [https://docs.docker.com/engine/reference/builder/\#cmd][https_docs.docker.com_engine_reference_builder_cmd]
 *  [https://docs.docker.com/engine/reference/builder/\#entrypoint][https_docs.docker.com_engine_reference_builder_entrypoint]
 *  [https://docs.docker.com/engine/reference/builder/\#understand-how-cmd-and-entrypoint-interact][https_docs.docker.com_engine_reference_builder_understand-how-cmd-and-entrypoint-interact]
 *  **不要加入不必要的限制**
    
    不要加入不必要的限制，比如只能以root用户运行，只能以特定uid 运行，特权端口，特权模式运行。

### 让构建镜像变得”省事、省心“ ###

**Why？**

Dockerfile越复杂，越容易出错；Dockerfile有问题，运行的容器会有安全隐患。

**How？**

*  **选择高级别基础镜像**
    
    尽量使用高级别基础镜像来简化编写Dockerfile的工作，比如为Java应用容器化使用openjdk基础镜像，而不是从alpine 操作系统基础镜像开始构建。
 *  **保持Dockerfile尽可能简单**
    
    参考Docker官方和其它一些好的开源软件的Dockerfile，让Dockerfile尽量保持简单，可读。
 *  **使用经过安全扫描的基础镜像**
    
    经过安全扫描的基础镜像，可以让容器运行在一个安全的环境。

## FAQ ##

Q: `ARG` 和`ENV` 命令的区别。

A: `ARG` 支持在构建镜像时（build-time）修改参数的值，比如`docker build --build-arg var=xxx`。

`ENV` 支持在运行容器时(run-time) 修改参数的值，比如`docker run -e var=yyy` 。

*  [https://stackoverflow.com/questions/41916386/arg-or-env-which-one-to-use-in-this-case][https_stackoverflow.com_questions_41916386_arg-or-env-which-one-to-use-in-this-case]
 *  [https://docs.docker.com/engine/reference/builder/\#arg][https_docs.docker.com_engine_reference_builder_arg]

Q: `ADD` 和 `COPY` 命令的区别。

A: 推荐使用COPY命令。

*  [https://docs.docker.com/develop/develop-images/dockerfile\_best-practices/\#add-or-copy][https_docs.docker.com_develop_develop-images_dockerfile_best-practices_add-or-copy]

Q: Docker build的cache问题。

A: `ADD` 和`COPY` 命令利用cksum来检查同名文件是否存在在缓存中，但是对cksum的计算不包括last-modified time和last-accessed time，有可能导致缓存机制失效。如果你的应用每次都基于一个同名文件，需要注意这个问题。

[https://docs.docker.com/develop/develop-images/dockerfile\_best-practices/\#leverage-build-cache][https_docs.docker.com_develop_develop-images_dockerfile_best-practices_leverage-build-cache]

Q: `RUN` , `CMD` 和 `ENTRYPOINT`的区别。

A: `RUN` 命令是在`docker build` 构建时被执行，在容器运行时不会被执行。

`CMD` 和 `ENTRYPOINT` 命令是在`docker run` 运行容器时被执行，在容器构建时不会被执行。

Docker缺省的ENTRYPOINT是`/bin/sh -c`。

*  [https://docs.docker.com/engine/reference/builder/\#entrypoint][https_docs.docker.com_engine_reference_builder_entrypoint]
 *  [https://docs.docker.com/engine/reference/builder/\#cmd][https_docs.docker.com_engine_reference_builder_cmd]
 *  [https://docs.docker.com/engine/reference/builder/\#understand-how-cmd-and-entrypoint-interact][https_docs.docker.com_engine_reference_builder_understand-how-cmd-and-entrypoint-interact]
 *  [https://aboullaite.me/dockerfile-run-vs-cmd-vs-entrypoint/][https_aboullaite.me_dockerfile-run-vs-cmd-vs-entrypoint]

## 参考文档 ##

*  [https://docs.docker.com/engine/reference/builder/][https_docs.docker.com_engine_reference_builder]
 *  [https://docs.docker.com/develop/develop-images/dockerfile\_best-practices/][https_docs.docker.com_develop_develop-images_dockerfile_best-practices]
 *  [如何Docker化任意一个应用？你需要参照这10步][Docker_10]
 *  [5个构建第一个Java镜像的小窍门][5_Java]
 *  [如何选择Docker基础镜像][Docker]

[https_docs.docker.com_develop_develop-images_dockerfile_best-practices_minimize-the-number-of-layers]: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#minimize-the-number-of-layers
[https_docs.docker.com_develop_develop-images_dockerfile_best-practices_sort-multi-line-arguments]: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#sort-multi-line-arguments
[https_docs.docker.com_engine_reference_builder_usage]: https://docs.docker.com/engine/reference/builder/#usage
[https_docs.docker.com_develop_develop-images_dockerfile_best-practices_leverage-build-cache]: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#leverage-build-cache
[https_docs.docker.com_engine_reference_builder_cmd]: https://docs.docker.com/engine/reference/builder/#cmd
[https_docs.docker.com_engine_reference_builder_entrypoint]: https://docs.docker.com/engine/reference/builder/#entrypoint
[https_docs.docker.com_engine_reference_builder_understand-how-cmd-and-entrypoint-interact]: https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact
[https_stackoverflow.com_questions_41916386_arg-or-env-which-one-to-use-in-this-case]: https://stackoverflow.com/questions/41916386/arg-or-env-which-one-to-use-in-this-case
[https_docs.docker.com_engine_reference_builder_arg]: https://docs.docker.com/engine/reference/builder/#arg
[https_docs.docker.com_develop_develop-images_dockerfile_best-practices_add-or-copy]: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#add-or-copy
[https_aboullaite.me_dockerfile-run-vs-cmd-vs-entrypoint]: https://aboullaite.me/dockerfile-run-vs-cmd-vs-entrypoint/
[https_docs.docker.com_engine_reference_builder]: https://docs.docker.com/engine/reference/builder/
[https_docs.docker.com_develop_develop-images_dockerfile_best-practices]: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/
[Docker_10]: https://mp.weixin.qq.com/s?__biz=MzIzNjUxMzk2NQ==&mid=2247489522&idx=1&sn=7328aac4967fafa967d67cc79f123353&chksm=e8d7e830dfa06126cf2f12e12495948553c001c626bb4809d0b19bfeeb9aed091a972a525566&mpshare=1&scene=1&srcid=0708W9rNsIQAMN7lSRfVAmOr&pass_ticket=z2rJIQxFZ8g5%2B8EtzowJFNB4G9XdRV1CRytAT0MdZckD1QGKWMU%2FDZFeEIyekf%2FQ#rd
[5_Java]: http://dockone.io/article/2039
[Docker]: https://blog.csdn.net/nklinsirui/article/details/80967677