Skip to content

Latest commit

 

History

History
154 lines (118 loc) · 7.01 KB

building-efficient-dockerfiles-nodejs.md

File metadata and controls

154 lines (118 loc) · 7.01 KB

构造有效的Dockerfile——Node.js

长文慎入

在安装完所有的依赖，还没有ADD你自己的代码到容器时，使用下面的代码片段（或者稍作修改）。这样每次重新构造容器时，不需要重新构造你自己的模块。如果package.json有变化，你的模块才会重新构造。完整的例子在这个gist里。

# 将这段代码插到Dockerfile里，在所有依赖之后，但在自己的代码之前。

ADD package.json /tmp/package.json
RUN cd /tmp && npm install
RUN mkdir -p /opt/app && cp -a /tmp/node_modules /opt/app/

为了模块使用缓存层

这篇文章是关于如何高效使用docker的中间层的。另一个作用是，我们会看到如何降低在docker容器里的node.js应用的开发和调试的时间。随着你把开发环境下所有事情迁移到docker，总有些事情越来越别扭，主要关于如何边修改边测试这种交互的工作方式。

过去，每当我对应用做了一点小修改，我都要花时间等待重新构造docker容器。经常是在等待重新安装所有的模块。我花在等待编译依赖的时间，要长于真正在修正问题时的时间。我希望这篇文章能帮助其他人从这种工作循环里解脱出来。

Docker作为一个新技术，如何写出高效的dockerfile是使用这个新技术乐趣的一部分。Docker强迫你用不同的方式思考。一旦你脑子的这种思考方式成型了，你会发现新的问题。

一个关键的问题是，理解docker存储层是如何工作的。现在，查看文档能看到一张图，演示了docker如何包含了多个存储层。dockerfile里的命令会创建多个新的存储层。如果可能，docker会尝试使用已经缓存的，之前创建过的存储层。你应该尽量利用存储层的这个优点，并根据这个特性重新安排dockerfile的命令顺序。我们一会儿会深入看看如何构造你应用里的node模块，并充分利用这个特性。

首先，这里是描述node程序依赖的文件的例子：

{
  "name": "myApp",
  "description": "This is my awesome app...",
  "version": "0.0.1",
  "private": true,
  "scripts": {
    "start": "node server.js"
  },
  "dependencies": {
    "docker.io": "*",
    "redis": "*",
    "restify": "*"
  }
}

而这里是我们要插入到旧dockerfile的代码：

# 将这段代码插到Dockerfile里，在所有依赖之后，但在自己的代码之前。

ADD package.json /tmp/package.json
RUN cd /tmp && npm install
RUN mkdir -p /opt/app && cp -a /tmp/node_modules /opt/app/

这段代码通常应该在你应用的所有依赖安装好之后，但是你的代码还没有加入到容器之前跑。

一个不好的dockerfile看起来是这样：

FROM ubuntu
 
RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
RUN apt-get update
RUN apt-get -y install python-software-properties git build-essential
RUN add-apt-repository -y ppa:chris-lea/node.js
RUN apt-get update
RUN apt-get -y install nodejs
 
WORKDIR /opt/app
 
ADD . /opt/app
RUN npm install
EXPOSE 3001
 
CMD ["node", "server.js"]

不好的原因是，在第12行我们拷贝app的工作目录——这个目录包含了package.json文件——到我们的容器的工作目录.，然后重新构造了所有的模块。这导致每次我们在目录.里改动文件，都会重新构建所有的模块。

这是一个完整的例子，是个好的实现：

FROM ubuntu
MAINTAINER David Weinstein <david@bitjudo.com>
 
# 安装依赖和nodejs
RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
RUN apt-get update
RUN apt-get -y install python-software-properties git build-essential
RUN add-apt-repository -y ppa:chris-lea/node.js
RUN apt-get update
RUN apt-get -y install nodejs
 
# 当我们改变程序在nodejs的依赖时，改变package.json会强制docker不使用已有的缓存
ADD package.json /tmp/package.json
RUN cd /tmp && npm install
RUN mkdir -p /opt/app && cp -a /tmp/node_modules /opt/app/
 
# 这里开始载入我们的应用代码，因此之前的docker存储层缓存在可能时会被用到
WORKDIR /opt/app
ADD . /opt/app
 
EXPOSE 3000
 
CMD ["node", "server.js"]

这里的想法是，如果package.json文件被改了（第14行），那么docker会重新执行npm install那一系列的命令（第15行），其他情况下，docker会使用已有的缓存，跳过那部分的执行。

下面的日志展示了，我们的docker容器现在在利用之前的dockerfile构建时，在模块依赖那步使用了缓存。

Uploading context 4.608 kB
Uploading context 
Step 0 : FROM ubuntu
 ---> 9cd978db300e
Step 1 : MAINTAINER David Weinstein <david@bitjudo.com>
 ---> Using cache
 ---> 67aeca8f12ae
Step 2 : RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
 ---> Using cache
 ---> be8f73b1204f
Step 3 : RUN apt-get update
 ---> Using cache
 ---> 70395f80789a
Step 4 : RUN apt-get -y install python-software-properties git build-essential
 ---> Using cache
 ---> 58821e45ea25
Step 5 : RUN add-apt-repository -y ppa:chris-lea/node.js
 ---> Using cache
 ---> 79afb0c0539a
Step 6 : RUN apt-get update
 ---> Using cache
 ---> 18fc6aa866d8
Step 7 : RUN apt-get -y install nodejs
 ---> Using cache
 ---> 1f1f41f47329
Step 8 : ADD package.json /tmp/package.json
 ---> Using cache
 ---> 0331fd81b4c8
Step 9 : RUN cd /tmp && npm install
 ---> Using cache
 ---> 95ee8b27b72b
Step 10 : RUN mkdir -p /opt/app && cp -a /tmp/node_modules /opt/app/
 ---> Using cache
 ---> 40102f5ce4f1
Step 11 : WORKDIR /opt/app
 ---> Using cache
 ---> 6a1ad0dca915
Step 12 : ADD . /opt/app
 ---> 6b9bdaa0e7a2
Step 13 : EXPOSE 3000
 ---> Running in 722c8f0b88e2
 ---> d97a3d372bda
Step 14 : CMD ["node", "server.js"]
 ---> Running in 3309a2dab1cc
 ---> a0b19d7625d3
Successfully built a0b19d7625d3

所有的例子都在这个gist里，你可以完全重复我所做的事情。

假设你之前构建过容器（比如，docker build -t testProject .），之后去掉例子的server.js里第七行的注释（模拟修改了应用程序的逻辑），再看看重新构建容器时，日志会提示发生了什么。看看日志，在第32行使用了缓存，而第38行则没有使用缓存。

结论

现在缓存了模块，所以每次修改应用程序代码时，不会再重新构建这些模块。这会大大提高测试和调试nodejs应用程序的速度。而且，这种缓存技巧也可以用于ruby gems，就像我们在另一篇文章里讨论的那样。