编写最佳的Dockerfile的方法

程序员文章站 2023-03-24 20:43:52

dockerfile的语法非常简单，然而如何加快镜像构建速度，如何减少docker镜像的大小却不是那么直观，需要积累实践经验。这篇博客可以帮助你快速掌握编写dockerfi...

dockerfile的语法非常简单，然而如何加快镜像构建速度，如何减少docker镜像的大小却不是那么直观，需要积累实践经验。这篇博客可以帮助你快速掌握编写dockerfile的技巧。

为了保证可读性，本文采用意译而非直译。另外，本文版权归原作者所有，翻译仅用于学习。

我已经使用docker有一段时间了，其中编写dockerfile是非常重要的一部分工作。在这篇博客中，我打算分享一些建议，帮助大家编写更好的dockerfile。

目标:

更快的构建速度
更小的docker镜像大小
更少的docker镜像层
充分利用镜像缓存
增加dockerfile可读性
让docker容器使用起来更简单

总结

编写.dockerignore文件
容器只运行单个应用
将多个run指令合并为一个
基础镜像的标签不要用latest
每个run指令后删除多余文件
选择合适的基础镜像(alpine版本最好)
设置workdir和cmd
使用entrypoint (可选)
在entrypoint脚本中使用exec
copy与add优先使用前者
合理调整copy与run的顺序
设置默认的环境变量，映射端口和数据卷
使用label设置镜像元数据
添加healthcheck

示例

示例dockerfile犯了几乎所有的错(当然我是故意的)。接下来，我会一步步优化它。假设我们需要使用docker运行一个node.js应用，下面就是它的dockerfile(cmd指令太复杂了，所以我简化了，它是错误的，仅供参考)。

from ubuntu

add . /app

run apt-get update 
run apt-get upgrade -y 
run apt-get install -y nodejs ssh mysql 
run cd /app && npm install

# this should start three processes, mysql and ssh
# in the background and node app in foreground
# isn't it beautifully terrible? <3
cmd mysql & sshd & npm start

构建镜像:

docker build -t wtf .

1. 编写.dockerignore文件

构建镜像时，docker需要先准备context ，将所有需要的文件收集到进程中。默认的context包含dockerfile目录中的所有文件，但是实际上，我们并不需要.git目录，node_modules目录等内容。 .dockerignore 的作用和语法类似于 .gitignore，可以忽略一些不需要的文件，这样可以有效加快镜像构建时间，同时减少docker镜像的大小。示例如下:

.git/
node_modules/

2. 容器只运行单个应用

从技术角度讲，你可以在docker容器中运行多个进程。你可以将数据库，前端，后端，ssh，supervisor都运行在同一个docker容器中。但是，这会让你非常痛苦:

非常长的构建时间(修改前端之后，整个后端也需要重新构建)
非常大的镜像大小
多个应用的日志难以处理(不能直接使用stdout，否则多个应用的日志会混合到一起)
横向扩展时非常浪费资源(不同的应用需要运行的容器数并不相同)
僵尸进程问题 - 你需要选择合适的init进程
因此，我建议大家为每个应用构建单独的docker镜像，然后使用 docker compose 运行多个docker容器。

现在，我从dockerfile中删除一些不需要的安装包，另外，ssh可以用docker exec替代。示例如下：

from ubuntu

add . /app

run apt-get update 
run apt-get upgrade -y

# we should remove ssh and mysql, and use
# separate container for database 
run apt-get install -y nodejs # ssh mysql 
run cd /app && npm install

cmd npm start

3. 将多个run指令合并为一个

docker镜像是分层的，下面这些知识点非常重要:

dockerfile中的每个指令都会创建一个新的镜像层。
镜像层将被缓存和复用
当dockerfile的指令修改了，复制的文件变化了，或者构建镜像时指定的变量不同了，对应的镜像层缓存就会失效
某一层的镜像缓存失效之后，它之后的镜像层缓存都会失效
镜像层是不可变的，如果我们再某一层中添加一个文件，然后在下一层中删除它，则镜像中依然会包含该文件(只是这个文件在docker容器中不可见了)。
docker镜像类似于洋葱。它们都有很多层。为了修改内层，则需要将外面的层都删掉。记住这一点的话，其他内容就很好理解了。

现在，我们将所有的run指令合并为一个。同时把apt-get upgrade删除，因为它会使得镜像构建非常不确定(我们只需要依赖基础镜像的更新就好了)

from ubuntu

add . /app

run apt-get update \ 
  && apt-get install -y nodejs \
  && cd /app \
  && npm install

cmd npm start

记住一点，我们只能将变化频率一样的指令合并在一起。将node.js安装与npm模块安装放在一起的话，则每次修改源代码，都需要重新安装node.js，这显然不合适。因此，正确的写法是这样的:

from ubuntu

run apt-get update && apt-get install -y nodejs 
add . /app 
run cd /app && npm install

cmd npm start

4. 基础镜像的标签不要用latest
当镜像没有指定标签时，将默认使用latest 标签。因此， from ubuntu 指令等同于from ubuntu:latest。当时，当镜像更新时，latest标签会指向不同的镜像，这时构建镜像有可能失败。如果你的确需要使用最新版的基础镜像，可以使用latest标签，否则的话，最好指定确定的镜像标签。

示例dockerfile应该使用16.04作为标签。

from ubuntu:16.04 # it's that easy!

run apt-get update && apt-get install -y nodejs 
add . /app 
run cd /app && npm install

cmd npm start

5. 每个run指令后删除多余文件
假设我们更新了apt-get源，下载，解压并安装了一些软件包，它们都保存在/var/lib/apt/lists/目录中。但是，运行应用时docker镜像中并不需要这些文件。我们最好将它们删除，因为它会使docker镜像变大。

示例dockerfile中，我们可以删除/var/lib/apt/lists/目录中的文件(它们是由apt-get update生成的)。

from ubuntu:16.04

run apt-get update \ 
  && apt-get install -y nodejs \
  # added lines
  && rm -rf /var/lib/apt/lists/*

add . /app 
run cd /app && npm install

cmd npm start

6. 选择合适的基础镜像(alpine版本最好)

在示例中，我们选择了ubuntu作为基础镜像。但是我们只需要运行node程序，有必要使用一个通用的基础镜像吗？node镜像应该是更好的选择。

from node

add . /app 
# we don't need to install node 
# anymore and use apt-get
run cd /app && npm install

cmd npm start

更好的选择是alpine版本的node镜像。alpine是一个极小化的linux发行版，只有4mb，这让它非常适合作为基础镜像。

from node:7-alpine

add . /app 
run cd /app && npm install

cmd npm start

apk是alpine的包管理工具。它与apt-get有些不同，但是非常容易上手。另外，它还有一些非常有用的特性，比如no-cache和 --virtual选项，它们都可以帮助我们减少镜像的大小。

7. 设置workdir和 cmd

workdir指令可以设置默认目录，也就是运行run / cmd / entrypoint指令的地方。

cmd指令可以设置容器创建是执行的默认命令。另外，你应该讲命令写在一个数组中，数组中每个元素为命令的每个单词(参考官方文档)。

from node:7-alpine

workdir /app 
add . /app 
run npm install

cmd ["npm", "start"]

8. 使用entrypoint (可选)

entrypoint指令并不是必须的，因为它会增加复杂度。entrypoint是一个脚本，它会默认执行，并且将指定的命令错误其参数。它通常用于构建可执行的docker镜像。entrypoint.sh如下:

#!/usr/bin/env sh
# $0 is a script name, 
# $1, $2, $3 etc are passed arguments
# $1 is our command
cmd=$1

case "$cmd" in 
 "dev" )
  npm install
  export node_env=development
  exec npm run dev
  ;;

 "start" )
  # we can modify files here, using env variables passed in 
  # "docker create" command. it can't be done during build process.
  echo "db: $database_address" >> /app/config.yml
  export node_env=production
  exec npm start
  ;;

  * )
  # run custom command. thanks to this line we can still use 
  # "docker run our_image /bin/bash" and it will work
  exec $cmd ${@:2}
  ;;
esac

示例dockerfile:

from node:7-alpine

workdir /app 
add . /app 
run npm install

entrypoint ["./entrypoint.sh"] 
cmd ["start"]

可以使用如下命令运行该镜像:

# 运行开发版本
docker run our-app dev 

# 运行生产版本
docker run our-app start 

# 运行bash
docker run -it our-app /bin/bash

9. 在entrypoint脚本中使用exec
在前文的entrypoint脚本中，我使用了exec命令运行node应用。不使用exec的话，我们则不能顺利地关闭容器，因为sigterm信号会被bash脚本进程吞没。exec命令启动的进程可以取代脚本进程，因此所有的信号都会正常工作。

10. copy与add优先使用前者
copy指令非常简单，仅用于将文件拷贝到镜像中。add相对来讲复杂一些，可以用于下载远程文件以及解压压缩包(参考官方文档)。

from node:7-alpine

workdir /app

copy . /app 
run npm install

entrypoint ["./entrypoint.sh"] 
cmd ["start"]

11. 合理调整copy与run的顺序
我们应该把变化最少的部分放在dockerfile的前面，这样可以充分利用镜像缓存。

示例中，源代码会经常变化，则每次构建镜像时都需要重新安装npm模块，这显然不是我们希望看到的。因此我们可以先拷贝package.json，然后安装npm模块，最后才拷贝其余的源代码。这样的话，即使源代码变化，也不需要重新安装npm模块。

from node:7-alpine

workdir /app

copy package.json /app 
run npm install 
copy . /app

entrypoint ["./entrypoint.sh"] 
cmd ["start"]

12. 设置默认的环境变量，映射端口和数据卷

运行docker容器时很可能需要一些环境变量。在dockerfile设置默认的环境变量是一种很好的方式。另外，我们应该在dockerfile中设置映射端口和数据卷。示例如下:

from node:7-alpine

env project_dir=/app

workdir $project_dir

copy package.json $project_dir 
run npm install 
copy . $project_dir

env media_dir=/media \ 
  node_env=production \
  app_port=3000

volume $media_dir 
expose $app_port

entrypoint ["./entrypoint.sh"] 
cmd ["start"]

env指令指定的环境变量在容器中可以使用。如果你只是需要指定构建镜像时的变量，你可以使用arg指令。

13. 使用label设置镜像元数据
使用label指令，可以为镜像设置元数据，例如镜像创建者或者镜像说明。旧版的dockerfile语法使用maintainer指令指定镜像创建者，但是它已经被弃用了。有时，一些外部程序需要用到镜像的元数据，例如nvidia-docker需要用到com.nvidia.volumes.needed。示例如下:

from node:7-alpine 
label maintainer "jakub.skalecki@example.com" 
...

14. 添加healthcheck
运行容器时，可以指定--restart always选项。这样的话，容器崩溃时，docker守护进程(docker daemon)会重启容器。对于需要长时间运行的容器，这个选项非常有用。但是，如果容器的确在运行，但是不可(陷入死循环，配置错误)用怎么办？使用healthcheck指令可以让docker周期性的检查容器的健康状况。我们只需要指定一个命令，如果一切正常的话返回0，否则返回1。对healthcheck感兴趣的话，可以参考这篇博客。示例如下:

from node:7-alpine 
label maintainer "jakub.skalecki@example.com"

env project_dir=/app 
workdir $project_dir

copy package.json $project_dir 
run npm install 
copy . $project_dir

env media_dir=/media \ 
  node_env=production \
  app_port=3000

volume $media_dir 
expose $app_port 
healthcheck cmd curl --fail http://localhost:$app_port || exit 1

entrypoint ["./entrypoint.sh"] 
cmd ["start"]

当请求失败时，curl --fail 命令返回非0状态。

原文: how to write excellent dockerfiles

译者: fundebug

上一篇：侏儒的性生活

下一篇：吃点能补的

编写最佳的Dockerfile的方法

php防止伪造的数据从URL提交方法

python Selenium实现付费音乐批量下载的实现方法

CorelDRAW 12循序渐进之文本处理的方法介绍

猎豹浏览器打开网页很慢怎么办？猎豹浏览器清理缓存的方法

Android开发自定义TextView省略号样式的方法

深入解读php中关于抽象(abstract)类和抽象方法的问题分析

迅雷朋友圈怎么关闭？手机关闭迅雷朋友圈的方法

Sketchup怎么安装使用ToolsOnSurface插件? SU插件的使用方法

PHP连接SQLServer2005的实现方法(附ntwdblib.dll下载)

PHP中替换键名的简易方法示例详解