多阶段Docker构建使用pm2-docker时Pod崩溃报错排查

你编写的多阶段构建Dockerfile存在错误，是导致Pod启动崩溃的直接原因。

报错核心是运行阶段找不到pm2-docker可执行模块，具体问题点如下：

• 你在build阶段通过npm install pm2 -g全局安装的pm2，文件存放在Node镜像的全局路径下：可执行软链默认在/usr/local/bin/目录，依赖包默认在/usr/local/lib/node_modules/目录。但你在main运行阶段仅复制了build阶段的/app目录到容器根路径，完全没有复制pm2的相关文件，运行时自然找不到命令。
• 复制应用代码时写的COPY --from=build /app /逻辑错误，会把/app下的所有文件直接散落在容器根目录，不符合容器目录规范，也会引发潜在的路径匹配问题。
• build阶段安装的vim、jq、busybox-extras属于调试类工具，按照多阶段构建的设计初衷，本来就不应该被带到最终运行镜像中，如果强行复制反而会增大镜像体积，失去多阶段构建的优势。

FROM node:16.15.1-alpine3.16 as build

ENV NODE_TLS_REJECT_UNAUTHORIZED=0
WORKDIR /app
ENV NODE_OPTIONS --max-old-space-size=4096

COPY package.json .
RUN npm install --save-exact
COPY . .
# 若存在TS编译、前端打包等构建操作，统一在build阶段执行

FROM node:16.15.1-alpine3.16 as main
WORKDIR /app
ENV NODE_ENV=production
ENV NODE_OPTIONS --max-old-space-size=4096

# 运行阶段仅安装生产必需的pm2，不携带构建阶段的调试工具
RUN npm install pm2 -g

# 将构建好的应用代码复制到运行阶段的工作目录，不要复制到容器根路径
COPY --from=build /app /app

CMD ["pm2-docker", "index.js"]

• 如果你的业务场景必须在运行镜像中携带vim、jq、busybox-extras等调试工具，可以在main阶段追加apk安装指令：RUN apk update && apk add --no-cache vim jq busybox-extras，生产环境不推荐该配置。
• 构建阶段如果安装了devDependencies依赖，建议在构建完成后、复制到运行阶段前执行npm prune --production清理多余依赖，进一步减小镜像体积。

内容的提问来源于stack exchange，提问作者SVD