Cloud Run上で動かすNext.jsアプリのDockerイメージサイズを軽くする

業務にて Cloud Run内でNext.jsアプリを動かすことになった。
その時イメージサイズについて四苦八苦した結果、ある程度の最適化ができたのでその時の検証結果をここに記しておく。

準備編：イメージサイズ検証のためのアプリケーション

https://github.com/vercel/next.js/tree/canary/examples/with-docker

yarn create next-app コマンドのオプションを設定することにより、Docker内で動作するサンプリアプリケーションのテンプレートを作ることが可能なので今回はそれを利用して検証してみる。

以下のコマンドで nextjs-docker というアプリケーションが作られる。

$ yarn create next-app --example with-docker nextjs-docker
...

$ cd nextjs-docker
＄ yarn dev
yarn run v1.22.19
$ next dev
ready - started server on 0.0.0.0:3000, url: http://localhost:3000
event - compiled client and server successfully in 842 ms (170 modules)

イメージサイズを全く考慮しないDockerfileの場合

自分も当初は知識が無かったため、以下のようなDockerfileで雑にnext startを実行するコンテナを生成していた。

FROM node:16-alpine AS deps

RUN apk add --no-cache libc6-compat

WORKDIR /app
COPY . .
RUN yarn install --frozen-lockfile
RUN yarn build

ENV NODE_ENV production

EXPOSE 3000
ENV PORT 3000

CMD ["yarn", "start"]

イメージサイズ

このDockerfileで作られたイメージサイズは 1Gを超えている。

REPOSITORY        TAG           IMAGE ID       CREATED              SIZE
nextjs-heavy      latest        c0ef98e8145f   4 minutes ago        1.06GB

イメージサイズが考慮されたDockerfileの場合

実は自分で頑張るまでもなく、今回利用したサンプルDockerアプリケーションで生成されたDockerfileをそのまま利用すると、イメージサイズを最小限に抑えることが出来る。

# Install dependencies only when needed
FROM node:16-alpine AS deps
# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
RUN apk add --no-cache libc6-compat
WORKDIR /app
COPY package.json yarn.lock ./
RUN yarn install --frozen-lockfile

# If using npm with a `package-lock.json` comment out above and use below instead
# COPY package.json package-lock.json ./ 
# RUN npm ci

# Rebuild the source code only when needed
FROM node:16-alpine AS builder
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .

# Next.js collects completely anonymous telemetry data about general usage.
# Learn more here: https://nextjs.org/telemetry
# Uncomment the following line in case you want to disable telemetry during the build.
# ENV NEXT_TELEMETRY_DISABLED 1

RUN yarn build

# If using npm comment out above and use below instead
# RUN npm run build

# Production image, copy all the files and run next
FROM node:16-alpine AS runner
WORKDIR /app

ENV NODE_ENV production
# Uncomment the following line in case you want to disable telemetry during runtime.
# ENV NEXT_TELEMETRY_DISABLED 1

RUN addgroup --system --gid 1001 nodejs
RUN adduser --system --uid 1001 nextjs

# You only need to copy next.config.js if you are NOT using the default configuration
# COPY --from=builder /app/next.config.js ./
COPY --from=builder /app/public ./public
COPY --from=builder /app/package.json ./package.json

# Automatically leverage output traces to reduce image size 
# https://nextjs.org/docs/advanced-features/output-file-tracing
COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static

USER nextjs

EXPOSE 3000

ENV PORT 3000

CMD ["node", "server.js"]

当初は自分の知識不足でNext.jsでどのファイルが必要なのか不明だったが、このDockerfileを見ると一目瞭然である。
マルチステージビルドで実行されているCOPYコマンド対象のファイル・ディレクトリだけあれば動作するようだ。

まとめると以下のファイル・ディレクトリになる。

./next.config.js
./public
./package.json
./.next/standalone
./.next/static

イメージサイズ

このDockerfileで作られたイメージサイズは 1１５MBである。

REPOSITORY        TAG           IMAGE ID       CREATED              SIZE
nextjs-light      latest        5ea5d933a06b   15 minutes ago       115MB

最後に：イメージサイズ比較

REPOSITORY        TAG           IMAGE ID       CREATED              SIZE
nextjs-heavy      latest        c0ef98e8145f   4 minutes ago        1.06GB
nextjs-light      latest        5ea5d933a06b   15 minutes ago       115MB

おおよそ、1/10程度のサイズに圧縮することが出来た 🎉

ここで自動生成されたDockerfileを微調整するだけで自分のNext.jsアプリケーションにも難なく適用できるはず（自分のアプリケーションにも適用出来た）