Cloud RunにNext.jsアプリをデプロイしてみる
この記事を参考にCloud RunにNext.jsアプリをデプロイしてみる。
手順通りにCloud Runのサービスを作成するとトリガーの実行に失敗した。
Cloud Buildの「構成」セクションを見てみると先ほどDockerfileを指定したはずなのに、Cloud Build構成ファイルにチェックがついている。
Dockerfileにチェックを入れて保存。
ソースコードにテキトーに変更を入れてGithubにpush。トリガーは起動しない。
Cloud Buildの「構成」セクションを自動検出にして保存。またGithubにpushすると、トリガーが起動したが、失敗。
Cloud Build上で以下のエラーメッセージが表示される。
サービスアカウントを未指定にするといいらしい。
Cloud Buildのサービスアカウントを何も指定しないで保存。
もう一回Githubにpush。ビルドが成功した。
でもCloud RunのURLをクリックするとデプロイはできていないっぽい。
Cloud Runのサービスから「新しいリビジョンの編集とデプロイ」をクリックして、Container Registryのコンテナイメージを選択して、デプロイするとうまくいった。
うーん、デプロイまでできたけど、GithubのpushをトリガーにしてDocker imageのビルドまでしかしてくれない。このフローだとデプロイは手動になってしまう。
なぜ最初の手順でうまくいかないのだろう?
これのGoogle Cloud SDK使う方法はすんなりうまくいった。
ポート設定がデフォルトの8080のままになってるけどなぜかうまくいっている。
ログを見るとNext.jsがちゃんと8080で起動してくれてる。誰がこんな親切なことを?
ChatGPTの回答
Cloud Runは、アプリケーションが起動するときにポート8080で受け入れることを期待していますが、コンテナ内で起動されるアプリケーションがデフォルトで使用するポートが8080でない場合でも、Cloud Runは対処できます。
この挙動は、Cloud Runがデプロイされたコンテナ内で実行されているプロセスを検知し、そのプロセスが使用しているポートを特定することによって実現されています。具体的には、Cloud Runは次の手順で動作します。
-
デプロイ時の設定: Cloud Runにデプロイする際に、デプロイコマンドやデプロイ設定で、アプリケーションが使用するポートを指定できます。これにより、Cloud Runは起動時に特定のポートを期待します。
-
PORT環境変数: Cloud Runは、デプロイされたコンテナ内で実行されているプロセスに対して
PORT
という環境変数を設定します。この環境変数には、Cloud Runが期待するポートが含まれます。
具体的には、次のようになります。
- Cloud Runはデプロイ時に指定されたポート(デフォルトは8080)を
PORT
環境変数に設定します。 - アプリケーションが起動すると、アプリケーションは
PORT
環境変数の値を読み取り、そのポートで待ち受けます。
したがって、Next.jsアプリケーションがデプロイ時にCloud Runによって期待されるポート(デフォルトで8080)を PORT
環境変数に設定することで、Cloud Runは正しくアプリケーションを起動し、トラフィックをルーティングします。
この動作により、Next.jsアプリケーションがデフォルトポート3000で起動していても、Cloud Runが適切に PORT
環境変数を設定しているため、問題なくデプロイと実行ができるのです。
よく見たらDockerfileにもPORTとHOSTNAME環境変数が定義されていた。これをCloud Runが上書きしてくれてるっぽい?
DockerfileはNext.js公式のwith-dockerリポジトリそのままだけど実装はこちら。
FROM node:18-alpine AS base
# Install dependencies only when needed
FROM base 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
# Install dependencies based on the preferred package manager
COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
RUN \
if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
elif [ -f package-lock.json ]; then npm ci; \
elif [ -f pnpm-lock.yaml ]; then yarn global add pnpm && pnpm i --frozen-lockfile; \
else echo "Lockfile not found." && exit 1; \
fi
# Rebuild the source code only when needed
FROM base AS builder
WORKDIR /app
COPY /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 base 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
COPY /app/public ./public
# Set the correct permission for prerender cache
RUN mkdir .next
RUN chown nextjs:nodejs .next
# Automatically leverage output traces to reduce image size
# https://nextjs.org/docs/advanced-features/output-file-tracing
COPY /app/.next/standalone ./
COPY /app/.next/static ./.next/static
USER nextjs
EXPOSE 3000
ENV PORT 3000
# set hostname to localhost
ENV HOSTNAME "0.0.0.0"
# server.js is created by next build from the standalone output
# https://nextjs.org/docs/pages/api-reference/next-config-js/output
CMD ["node", "server.js"]