👌

Next.jsアプリをCloud Runでデプロイする

2024/01/14に公開

Next.js

Cloud RunはGoogleが提供するコンテナイメージをデプロイするだけでかんたんにサーバーレスにサービスを運用できるフルマネージドなクラウドサービスです。（ちなみにコンテナじゃやなくても可能）
https://cloud.google.com/run?hl=ja

つまりDockerでコンテナ化すればどんなサービスでもかんたんにデプロイできちゃうというのが魅力で、さらに、トラフィックに応じて自動でスケールするので管理も楽なのです。さらにさらにトラフィックがないときはインスタンスが0になりお金もかかりません。

AWSを使ってEC2やRDSを使うとそれだけで維持費用がかかりますが、低コストにはじめれてよいので個人開発やスタートアップにもおすすめだと思います。ゆくゆく成長して移動させたくなっても、コンテナを動かしているだけなので、必要に応じて別のクラウドに移行もしやすいです。

無料枠が大きく毎月200万回のリクエストまで無料です。

ということでいま作っている個人開発のサービスはNext.jsだけでつくっているところでこれをCloud Runを使ってリリースしてみることにしました。その過程でいろいろ調べたりしたので、手順をまとめて公開したいと思います。

Dockerfileを作成

コンテナ化してデプロイするのでDockerfileをつくります。これは公式にサンプルがあるのでそのまま使えます。

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 --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 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 --from=builder /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 --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
# 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"]

next.config.jsファイルにoutputを追加します。

/** @type {import('next').NextConfig} */
const nextConfig = {
    output: 'standalone',
}

module.exports = nextConfig

output: 'standalone'は、ビルド時にアプリのすべての依存関係を含む単一の出力ディレクトリを生成するオプションです。これにより、外部依存関係なしで実行でき、サーバーレスプラットフォームやコンテナ上でのデプロイが容易になります。

ここまで終わったらGithubでリポジトリをつくってプッシュしておきましょう。

Cloud Run & Cloud Buildの設定

Google Cloudでアカウントをつくり、Cloud Runでサービスを作ります。

https://cloud.google.com/run?hl=ja

ビルド＆デプロイはトリガーを使って発動します。Cloud Runでサービスをつくるとhttps://*.run.app というドメインが自動で割り当てられ、アクセスできる環境がつくられます。

あとはトリガーを使ってビルド＆デプロイを行うことで、上のドメインでアクセスできるようになります。これは手動でターミナルをつかってデプロイもできますが、今回はGithubリポジトリにプッシュされたタイミングをトリガーとしてデプロイをするようにします。毎回手動でやるのも面倒ですしね。このあたりは細く設定もできます。

インスタンスの初期値を0ではなく1にするとコールドスタートが起きず、起動がはやくなりますがその分インスタンスが起動しつづけるのでお金がかかります。

Cloud Buildの設定ボタンをおすとGithubのリポジトリと接続する設定を行えます。デフォルトではmainブランチにプッシュされたタイミングをトリガーするようになっています。

Cloud Runが実行できるように権限も設定。

Identity and Access Management (IAM) APIも有効化。

あとはmainブランチにプッシュするだけでデプロイされるようになります。サーバーの設定をいろいろやっているうちにハマりがちで面倒なものですが、これだけでデプロイ環境ができあがり、コストも安いので素敵です。ちなみにDBはPlanetScaleを使っているのでデータベースも低コストでかんたんにつくれて助かっています。

その他

デプロイがうまくいかない場合は、トリガーが発動してないのか、ビルドが失敗しているのか調べてチェックしてみてください。ビルドの履歴からログを調べることもできます。

Dockerfileを作成

Cloud Run & Cloud Buildの設定

その他

Discussion