gpt4 book ai didi

编写最佳的Dockerfile的方法

转载 作者:qq735679552 更新时间:2022-09-28 22:32:09 26 4
gpt4 key购买 nike

CFSDN坚持开源创造价值,我们致力于搭建一个资源共享平台,让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章编写最佳的Dockerfile的方法由作者收集整理,如果你对这篇文章有兴趣,记得点赞哟.

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

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

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

目标

  1. 更快的构建速度
  2. 更小的Docker镜像大小
  3. 更少的Docker镜像层
  4. 充分利用镜像缓存
  5. 增加Dockerfile可读性
  6. 让Docker容器使用起来更简单

总结 。

  1. 编写.dockerignore文件
  2. 容器只运行单个应用
  3. 将多个RUN指令合并为一个
  4. 基础镜像的标签不要用latest
  5. 每个RUN指令后删除多余文件
  6. 选择合适的基础镜像(alpine版本最好)
  7. 设置WORKDIR和CMD
  8. 使用ENTRYPOINT (可选)
  9. 在entrypoint脚本中使用exec
  10. COPY与ADD优先使用前者
  11. 合理调整COPY与RUN的顺序
  12. 设置默认的环境变量,映射端口和数据卷
  13. 使用LABEL设置镜像元数据
  14. 添加HEALTHCHECK

示例 。

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
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镜像的大小。示例如下

?
1
2
.git/
node_modules/

2. 容器只运行单个应用 。

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

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

现在,我从Dockerfile中删除一些不需要的安装包,另外,SSH可以用docker exec替代。示例如下:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
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删除,因为它会使得镜像构建非常不确定(我们只需要依赖基础镜像的更新就好了) 。

?
1
2
3
4
5
6
7
8
9
10
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,这显然不合适。因此,正确的写法是这样的

?
1
2
3
4
5
6
7
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作为标签.

?
1
2
3
4
5
6
7
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生成的).

?
1
2
3
4
5
6
7
8
9
10
11
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镜像应该是更好的选择.

?
1
2
3
4
5
6
7
8
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,这让它非常适合作为基础镜像.

?
1
2
3
4
5
6
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指令可以设置容器创建是执行的默认命令。另外,你应该讲命令写在一个数组中,数组中每个元素为命令的每个单词(参考官方文档).

?
1
2
3
4
5
6
7
FROM node:7-alpine
 
WORKDIR /app
ADD . /app
RUN npm install
 
CMD [ "npm" , "start" ]

8. 使用ENTRYPOINT (可选) 。

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#!/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

?
1
2
3
4
5
6
7
8
FROM node:7-alpine
 
WORKDIR /app
ADD . /app
RUN npm install
 
ENTRYPOINT [ "./entrypoint.sh" ]
CMD [ "start" ]

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

?
1
2
3
4
5
6
7
8
# 运行开发版本
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相对来讲复杂一些,可以用于下载远程文件以及解压压缩包(参考官方文档).

?
1
2
3
4
5
6
7
8
9
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模块.

?
1
2
3
4
5
6
7
8
9
10
FROM node:7-alpine
 
WORKDIR /app
 
COPY package.json /app
RUN npm install
COPY . /app
 
ENTRYPOINT [ "./entrypoint.sh" ]
CMD [ "start" ]

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

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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。示例如下

?
1
2
3
FROM node:7-alpine
LABEL maintainer "jakub.skalecki@example.com"
...

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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 。

原文链接:https://blog.fundebug.com/2017/05/15/write-excellent-dockerfile/ 。

最后此篇关于编写最佳的Dockerfile的方法的文章就讲到这里了,如果你想了解更多关于编写最佳的Dockerfile的方法的内容请搜索CFSDN的文章或继续浏览相关文章,希望大家以后支持我的博客! 。

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com