在 Docker 中如何高效部署 Node Server
大家好,我是山月。
一個高效合理的部署方案,不僅能夠實現快速升級,滾動更新,負載均衡,應用隔離等部署特性,而且配有一套成熟穩定的監控。
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 應用
- 多階段構建前端應用
在構建 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
5. 相關文章
- N-API and getting started with writing C addons for Node.js
- Using Docker for Node.js in Development and Production