在 Docker 中如何高效部署 Node Server
大家好,我是山月。
一個(gè)高效合理的部署方案,不僅能夠?qū)崿F(xiàn)快速升級(jí),滾動(dòng)更新,負(fù)載均衡,應(yīng)用隔離等部署特性,而且配有一套成熟穩(wěn)定的監(jiān)控。
kubernetes 把 Node 應(yīng)用視作一個(gè)服務(wù)端應(yīng)用的黑盒子,完美匹配了以上條件,越來(lái)越多的團(tuán)隊(duì)把 node 部署在 k8s 上。
但在此之前,需要先把 Node 應(yīng)用跑在一個(gè) Docker 容器上,這也是本章的主題。
「目錄」
1. 一個(gè)簡(jiǎn)單的 Node 應(yīng)用
2. NODE_ENV=production
3. 一個(gè) Node 服務(wù)的鏡像
4. node-gyp 與 Native Addon
5. 相關(guān)文章
1. 一個(gè)簡(jiǎn)單的 Node 應(yīng)用
聚土成沙,集腋成裘。從一個(gè) hello, world 版的 Node Server 說(shuō)起。
- const http = require('http')
- const app = async (req, res) => {
- res.end('hello, world')
- }
- http.createServer(app).listen(3000, () => console.log(3000))
在啟動(dòng)一個(gè) Node Server 時(shí),在生產(chǎn)環(huán)境中有很多先決條件,無(wú)法通過(guò)簡(jiǎn)單的 node index.js 啟動(dòng)服務(wù)。
此時(shí)在 package.json 中抽象一層,通過(guò) npm start 啟動(dòng)服務(wù),方便在 Docker 鏡像中配置啟動(dòng)命令。
- "scripts": {
- "start": "node index.js"
- },
但這僅僅是最簡(jiǎn)單的 Node 應(yīng)用,真實(shí)環(huán)境中還有各種數(shù)據(jù)存儲(chǔ)、定時(shí)任務(wù)調(diào)度等,暫撇開(kāi)不談,目前已經(jīng)足夠了。
2. NODE_ENV=production
在生產(chǎn)環(huán)境中,如果無(wú)構(gòu)建過(guò)程,則無(wú)需安裝 devDependencies 中依賴。NODE_ENV 環(huán)境變量設(shè)置為 production 時(shí)將會(huì)跳過(guò) devDependencies 依賴的安裝。
- # 通過(guò)設(shè)置環(huán)境變量,只安裝生產(chǎn)環(huán)境依賴
- $ NODE_ENV=production npm ci
- # 通過(guò)顯式指定 flag,只安裝生產(chǎn)環(huán)境依賴
- $ npm ci --production
另一方面,「某些第三方庫(kù)會(huì)根據(jù) NODE_ENV 環(huán)境變量做出一些意料不到的配置」。因此在生產(chǎn)環(huán)境注意該環(huán)境變量的配置。
3. 一個(gè) Node 服務(wù)的鏡像
一個(gè)典型的、面向服務(wù)端的 Node 服務(wù)是這么跑起來(lái)的:
- npm install
- npm run config,從配置服務(wù)(consul/vault)拉取配置 ,如數(shù)據(jù)庫(kù)與緩存的賬號(hào)密碼,此時(shí)構(gòu)建服務(wù)器需要配置服務(wù)權(quán)限
- npm run migrate,數(shù)據(jù)庫(kù)遷移腳本,執(zhí)行數(shù)據(jù)庫(kù)表列行更改操作,此時(shí)構(gòu)建服務(wù)器需要數(shù)據(jù)庫(kù)訪問(wèn)權(quán)限
- npm start,啟動(dòng)一個(gè) Node 服務(wù)
把運(yùn)行步驟翻譯為 Dockerfile:
- # 選擇一個(gè)體積小的鏡像 (~5MB)
- FROM node:12-alpine
- # 環(huán)境變量設(shè)置為生產(chǎn)環(huán)境,設(shè)置該環(huán)境變量,將不會(huì)下載 devDependencies 中依賴
- # 如果仍需要 devDependencies 依賴下載,則把該命令移動(dòng)到 RUN npm ci 之后
- ENV NODE_ENV production
- WORKDIR /code
- # 首先添加 package.json ,為了更好的根據(jù) Image Layer 利用緩存
- # 當(dāng) package.json 不變時(shí),node_modules 將會(huì)重用,則能夠利用緩存
- ADD package.json package-lock.json /code
- # 可考慮 npm ci 與 yarn
- RUN npm i
- # 把代碼置于鏡像
- ADD . /code
- # 配置服務(wù)及數(shù)據(jù)庫(kù)遷移
- RUN npm run config --if-present && npm run migrate --if-present
- EXPOSE 3000
- # 啟動(dòng) Node Server
- CMD npm start
這對(duì)于大部分 Node 應(yīng)用已經(jīng)是足夠了,精益求精,接下來(lái)進(jìn)行多階段構(gòu)建的優(yōu)化。
4. node-gyp 與 Native Addon
在 Node 中的一些依賴存在 Native Addon,它們通過(guò) node-gyp 進(jìn)行編譯,而它依賴于 python,make 與 g++。
- $ apk --no-cache add python make g++
在帶有編譯過(guò)程的鏡像構(gòu)建中,源文件與構(gòu)建工具都會(huì)造成空間的浪費(fèi)。
借助鏡像的「多階段構(gòu)建」可以高效利用空間。Go 語(yǔ)言與前端相關(guān)的構(gòu)建也遵循此規(guī)則。
- 多階段構(gòu)建 Go 應(yīng)用
- 多階段構(gòu)建前端應(yīng)用
在構(gòu)建 Node 應(yīng)用鏡像時(shí),第一層鏡像用各種構(gòu)建工具以構(gòu)造 node_modules,第二層鏡像利用第一層鏡像構(gòu)造的 node_modules。
- # 選擇一個(gè)體積小的鏡像 (~5MB)
- FROM node:12-alpine as builder
- # 環(huán)境變量設(shè)置為生產(chǎn)環(huán)境
- ENV NODE_ENV production
- # 為某些特殊的依賴庫(kù)準(zhǔn)備編譯環(huán)境
- RUN apk --no-cache add python make g++
- # 更好的根據(jù) Image Layer 利用緩存
- ADD package.json package-lock.json ./
- RUN npm i
- # 多階段構(gòu)建之第二階段
- # 多階段構(gòu)建之第二階段
- # 多階段構(gòu)建之第二階段
- FROM node:12-alpine
- WORKDIR /code
- ENV NODE_ENV production
- ADD . .
- COPY --from=builder node_modules node_modules
- # 配置服務(wù)及數(shù)據(jù)庫(kù)遷移
- RUN npm run config --if-present && npm run migrate --if-present
- EXPOSE 3000
- CMD npm start
5. 相關(guān)文章
- N-API and getting started with writing C addons for Node.js
- Using Docker for Node.js in Development and Production