指南工具

Docker

构建 Docker 镜像是一种部署各种应用程序的常用方法。然而，从 monorepo 执行此操作有若干挑战。

须知： 

本指南假定你正在使用 create-turbo 或具有类似结构的仓库。

问题

在 monorepo 中，不相关的更改可能会导致 Docker 在部署你的应用时执行不必要的工作。

让我们想象一下，你有一个如下所示的 monorepo

server.js
package.json
package.json
package.json
package-lock.json

你想要使用 Docker 部署 apps/api，因此你创建了一个 Dockerfile

./apps/api/Dockerfile
FROM node:16
 
WORKDIR /usr/src/app
 
# Copy root package.json and lockfile
COPY package.json ./
COPY package-lock.json ./
 
# Copy the api package.json
COPY apps/api/package.json ./apps/api/package.json
 
RUN npm install
 
# Copy app source
COPY . .
 
EXPOSE 8080
 
CMD [ "node", "apps/api/server.js" ]

这将把根目录的 package.json 和根目录的 lockfile 复制到 Docker 镜像中。然后，它会安装依赖项，复制应用程序源代码并启动应用程序。

你还应该创建一个 .dockerignore 文件，以防止 node_modules 与应用程序的源代码一起被复制进来。

.dockerignore
node_modules
npm-debug.log

lockfile 更改过于频繁

Docker 在部署你的应用程序方面非常智能。就像 Turborepo 一样，它会尝试尽可能少做工作。

在我们的 Dockerfile 示例中，只有当镜像中的文件与之前的运行不同时，它才会运行 npm install。否则，它会恢复之前拥有的 node_modules 目录。

这意味着，每当 package.json、apps/api/package.json 或 package-lock.json 更改时，Docker 镜像都会运行 npm install。

这听起来很棒 - 直到我们意识到一些事情。package-lock.json 对于 monorepo 来说是全局的。这意味着，如果我们在 apps/web 中安装一个新包，我们将导致 apps/api 重新部署。

在大型 monorepo 中，这可能会导致大量时间浪费，因为对 monorepo 的 lockfile 的任何更改都会级联到数十甚至数百个部署中。

解决方案

解决方案是修剪 Dockerfile 的输入，使其仅包含绝对必要的内容。Turborepo 提供了一个简单的解决方案 - turbo prune。

终端
turbo prune api --docker

运行此命令会在 ./out 目录中创建一个 monorepo 的修剪版本。它仅包含 api 依赖的工作区。它还会修剪 lockfile，以便仅下载相关的 node_modules。

--docker 标志

默认情况下，turbo prune 将所有相关文件放在 ./out 中。但是为了优化 Docker 的缓存，我们理想情况下希望分两个阶段复制文件。

首先，我们只想复制安装包所需的内容。当运行 --docker 时，你会在 ./out/json 中找到它。

package.json
package.json
server.js
package.json
package.json
turbo.json
package-lock.json

之后，你可以复制 ./out/full 中的文件以添加源文件。

以这种方式拆分依赖项和源文件使我们能够仅在依赖项更改时运行 npm install - 从而大大加快速度。

如果没有 --docker，所有修剪后的文件都将放置在 ./out 中。

示例

我们详细的 with-docker 示例深入探讨了如何充分利用 prune。这是 Dockerfile，为了方便起见复制过来。

从 monorepo 的根目录构建 Dockerfile

终端
docker build -f apps/web/Dockerfile .

此 Dockerfile 是为使用 standalone 输出模式 的 Next.js 应用程序编写的。

./apps/api/Dockerfile
FROM node:18-alpine AS base
 
FROM base AS builder
RUN apk update
RUN apk add --no-cache libc6-compat
# Set working directory
WORKDIR /app
# Replace <your-major-version> with the major version installed in your repository. For example:
# RUN yarn global add turbo@^2
RUN yarn global add turbo@^<your-major-version>
COPY . .
 
# Generate a partial monorepo with a pruned lockfile for a target workspace.
# Assuming "web" is the name entered in the project's package.json: { name: "web" }
RUN turbo prune web --docker
 
# Add lockfile and package.json's of isolated subworkspace
FROM base AS installer
RUN apk update
RUN apk add --no-cache libc6-compat
WORKDIR /app
 
# First install the dependencies (as they change less often)
COPY --from=builder /app/out/json/ .
RUN yarn install --frozen-lockfile
 
# Build the project
COPY --from=builder /app/out/full/ .
RUN yarn turbo run build
 
FROM base AS runner
WORKDIR /app
 
# Don't run production as root
RUN addgroup --system --gid 1001 nodejs
RUN adduser --system --uid 1001 nextjs
USER nextjs
 
# Automatically leverage output traces to reduce image size
# https://nextjs.net.cn/docs/advanced-features/output-file-tracing
COPY --from=installer --chown=nextjs:nodejs /app/apps/web/.next/standalone ./
COPY --from=installer --chown=nextjs:nodejs /app/apps/web/.next/static ./apps/web/.next/static
COPY --from=installer --chown=nextjs:nodejs /app/apps/web/public ./apps/web/public
 
CMD node apps/web/server.js

远程缓存

为了在 Docker 构建期间利用远程缓存，你需要确保你的构建容器具有访问你的远程缓存的凭据。

在 Docker 镜像中处理密钥有很多方法。我们将在此处使用一个简单的策略，即使用多阶段构建，将密钥作为构建参数，这些参数将在最终镜像中隐藏。

假设你正在使用类似于上面的 Dockerfile，我们将在 turbo build 之前从构建参数中引入一些环境变量

./apps/api/Dockerfile
ARG TURBO_TEAM
ENV TURBO_TEAM=$TURBO_TEAM
 
ARG TURBO_TOKEN
ENV TURBO_TOKEN=$TURBO_TOKEN
 
RUN yarn turbo run build

turbo 现在将能够命中你的远程缓存。要查看非缓存 Docker 构建镜像的 Turborepo 缓存命中，请从你的项目根目录运行如下命令

终端
docker build -f apps/web/Dockerfile . --build-arg TURBO_TEAM=“your-team-name” --build-arg TURBO_TOKEN=“your-token“ --no-cache

上一个

Biome

下一个

ESLint