在 Docker 中如何高效部署 Node Server

山月

发布于 2021-09-07 11:25:58

6340

发布于 2021-09-07 11:25:58

文章被收录于专栏：服务器运维笔记服务器运维笔记

大家好，我是山月。

一个高效合理的部署方案，不仅能够实现快速升级，滚动更新，负载均衡，应用隔离等部署特性，而且配有一套成熟稳定的监控。

kubernetes 把 Node 应用视作一个服务端应用的黑盒子，完美匹配了以上条件，越来越多的团队把 node 部署在 k8s 上。

但在此之前，需要先把 Node 应用跑在一个 Docker 容器上，这也是本章的主题。

「目录」

1. 一个简单的 Node 应用
2. NODE_ENV=production
3. 一个 Node 服务的镜像
4. node-gyp 与 Native Addon
5. 相关文章

1. 一个简单的 Node 应用

聚土成沙，集腋成裘。从一个 hello, world 版的 Node Server 说起。

const http = require('http')

const app = async (req, res) => {
  res.end('hello, world')
}

http.createServer(app).listen(3000, () => console.log(3000))

在启动一个 Node Server 时，在生产环境中有很多先决条件，无法通过简单的 node index.js 启动服务。

此时在 package.json 中抽象一层，通过 npm start 启动服务，方便在 Docker 镜像中配置启动命令。

"scripts": {
  "start": "node index.js"
},

但这仅仅是最简单的 Node 应用，真实环境中还有各种数据存储、定时任务调度等，暂撇开不谈，目前已经足够了。

2. NODE_ENV=production

在生产环境中，如果无构建过程，则无需安装 devDependencies 中依赖。NODE_ENV 环境变量设置为 production 时将会跳过 devDependencies 依赖的安装。

# 通过设置环境变量，只安装生产环境依赖
$ NODE_ENV=production npm ci

# 通过显式指定 flag，只安装生产环境依赖
$ npm ci --production

另一方面，「某些第三方库会根据 NODE_ENV 环境变量做出一些意料不到的配置」。因此在生产环境注意该环境变量的配置。

3. 一个 Node 服务的镜像

一个典型的、面向服务端的 Node 服务是这么跑起来的:

npm install
npm run config，从配置服务(consul/vault)拉取配置，如数据库与缓存的账号密码，此时构建服务器需要配置服务权限
npm run migrate，数据库迁移脚本，执行数据库表列行更改操作，此时构建服务器需要数据库访问权限
npm start，启动一个 Node 服务

把运行步骤翻译为 Dockerfile:

# 选择一个体积小的镜像 (~5MB)
FROM node:12-alpine

# 环境变量设置为生产环境，设置该环境变量，将不会下载 devDependencies 中依赖
# 如果仍需要 devDependencies 依赖下载，则把该命令移动到 RUN npm ci 之后
ENV NODE_ENV production

WORKDIR /code

# 首先添加 package.json ，为了更好的根据 Image Layer 利用缓存
# 当 package.json 不变时，node_modules 将会重用，则能够利用缓存
ADD package.json package-lock.json /code

# 可考虑 npm ci 与 yarn
RUN npm i

# 把代码置于镜像
ADD . /code

# 配置服务及数据库迁移
RUN npm run config --if-present && npm run migrate --if-present

EXPOSE 3000

# 启动 Node Server
CMD npm start

这对于大部分 Node 应用已经是足够了，精益求精，接下来进行多阶段构建的优化。

4. node-gyp 与 Native Addon

在 Node 中的一些依赖存在 Native Addon，它们通过 node-gyp 进行编译，而它依赖于 python，make 与 g++。

$ apk --no-cache add python make g++

在带有编译过程的镜像构建中，源文件与构建工具都会造成空间的浪费。

借助镜像的「多阶段构建」可以高效利用空间。Go 语言与前端相关的构建也遵循此规则。

多阶段构建 Go 应用长按识别二维码查看原文标题：多阶段构建 Go 应用

多阶段构建前端应用长按识别二维码查看原文标题：多阶段构建前端应用

在构建 Node 应用镜像时，第一层镜像用各种构建工具以构造 node_modules，第二层镜像利用第一层镜像构造的 node_modules。

# 选择一个体积小的镜像 (~5MB)
FROM node:12-alpine as builder

# 环境变量设置为生产环境
ENV NODE_ENV production

# 为某些特殊的依赖库准备编译环境
RUN apk --no-cache add python make g++

# 更好的根据 Image Layer 利用缓存
ADD package.json package-lock.json ./
RUN npm i

# 多阶段构建之第二阶段
# 多阶段构建之第二阶段
# 多阶段构建之第二阶段
FROM node:12-alpine

WORKDIR /code
ENV NODE_ENV production

ADD . .
COPY --from=builder node_modules node_modules
# 配置服务及数据库迁移
RUN npm run config --if-present && npm run migrate --if-present

EXPOSE 3000
CMD npm start