0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Next.js App RouterをGCP Cloud Runで動かす最適化デプロイ戦略

0
Posted at

多くのNext.js開発者がApp RouterとServer Componentsの強力な機能に魅力を感じながらも、本番環境、特にGCP Cloud Runへのデプロイ時に「最適な設定が分からない」「パフォーマンスが出ない」といった壁に直面します。特に、Server Componentsの挙動が従来のNext.jsアプリケーションと異なるため、デプロイ戦略も再考が必要です。

この記事では、Next.js App RouterとServer ComponentsをGCP Cloud Runで本番稼働させるための、パフォーマンスとコスト効率を最大化するデプロイ戦略を、具体的な手順と設定で解説します。これにより、コールドスタートの改善、ビルド時間の短縮、そして安定した運用を実現できます。

Next.js App RouterをGCP Cloud Runで動かすための基本戦略

Next.js App RouterアプリケーションをCloud Runにデプロイする際、従来のPages Routerとは異なる考慮点があります。特に、Server Componentsの導入により、ビルドプロセスとランタイムの挙動が変化しました。このセクションでは、その前提と基本的なデプロイ戦略について解説します。

Next.js App RouterとServer Componentsの特性

Next.js App Routerは、React Server Components (RSC) を核とした新しいルーティングおよびデータフェッチングパラダイムです。

  • Server Components (RSC): サーバーサイドでレンダリングされ、クライアントサイドJSバンドルには含まれません。これにより、初期ロードパフォーマンスが向上し、バンドルサイズを削減できます。GCP Cloud Runのようなサーバーレス環境では、このサーバーサイドでの処理がコンテナのリソース消費に直結します。
  • Client Components (RCC): 従来のReactコンポーネントと同様に、クライアントサイドでハイドレーションされ、インタラクティブ性を提供します。
  • データフェッチング: App Routerでは、fetch APIが自動的にリクエストをキャッシュするよう拡張されており、サーバー側での効率的なデータ取得が可能です。

これらの特性を理解し、Cloud Runのコンテナベースのサーバーレスアーキテクチャに最適化することが、スムーズなデプロイの鍵となります。

Cloud Runデプロイの前提と環境

GCP Cloud Runは、Dockerコンテナを実行するマネージドなサーバーレスプラットフォームです。Next.jsアプリケーションをデプロイするには、以下の準備が必要です。

  • Google Cloud プロジェクト: 課金が有効になっていること。
  • gcloud CLI: ローカル環境にインストール済みであること。
  • Docker: Dockerイメージのビルドおよびテストのために必要です。
  • Next.jsアプリケーション: App Routerを使用していること。

この記事では、Node.js 18以上、Next.js 13.4以上を前提としています。

Dockerfileの最適化:Next.js App Routerに特化したマルチステージビルド

Cloud Runへのデプロイにおいて最も重要なのが、Dockerイメージの最適化です。ここでは、next.config.jsのoutput: 'standalone'オプションを活用したマルチステージビルドについて解説します。これにより、最終的なイメージサイズを大幅に削減し、デプロイ時間を短縮できます。

next.config.js の設定

Next.js 12.2以降で導入されたoutput: 'standalone'オプションは、本番環境向けのデプロイパッケージを生成する際に非常に有用です。このオプションを有効にすると、node_modulesの中から必要な依存関係のみをコピーした軽量なstandaloneディレクトリが生成されます。

next.config.js

/** @type {import('next').NextConfig} */
const nextConfig = {
  experimental: {
    appDir: true, // App Routerを有効にする
  },
  output: 'standalone', // これが重要!
};

module.exports = nextConfig;

Dockerfileの作成:マルチステージビルド

output: 'standalone' を利用し、効率的なDockerイメージを構築します。ビルドステージでアプリケーションをビルドし、ランタイムステージで軽量なNode.jsイメージにstandaloneディレクトリと必要なファイルのみをコピーします。

Dockerfile

# === ビルドステージ ===
# Node.jsの最新LTS版をベースイメージとして使用
FROM node:18-alpine AS builder

# 作業ディレクトリを設定
WORKDIR /app

# package.jsonとpackage-lock.jsonをコピーし、依存関係をインストール
# これにより、パッケージ管理ファイルに変更がなければ依存関係のインストールをキャッシュできる
COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
RUN \
  if [ -f yarn.lock ]; then yarn install --frozen-lockfile; \
  elif [ -f package-lock.json ]; then npm ci; \
  elif [ -f pnpm-lock.yaml ]; then pnpm install --frozen-lockfile; \
  else echo "No lock file found. Please use yarn, npm, or pnpm."; exit 1; \
  fi

# 全てのソースファイルをコピー
COPY . .

# Next.jsアプリケーションをビルド
# next.config.jsでoutput: 'standalone'が設定されていることを前提とします
RUN npm run build

# === ランタイムステージ ===
# 軽量なNode.jsイメージを使用
FROM node:18-alpine AS runner

# 作業ディレクトリを設定
WORKDIR /app

# standalone出力されたファイルをコピー
# builderステージで生成された.next/standaloneディレクトリを/appにコピー
COPY --from=builder /app/.next/standalone ./

# publicディレクトリをコピー (静的ファイル)
COPY --from=builder /app/public ./public

# .next/staticディレクトリをコピー (ビルドされた静的アセット)
COPY --from=builder /app/.next/static ./.next/static

# 環境変数を設定 (必要に応じて)
# 例: PORTはCloud Runが自動的に設定するため、通常は不要
# ENV PORT 8080

# Next.jsアプリケーションを起動
# standalone出力の場合、サーバーは自動的に生成されたentrypoint.jsで起動します
CMD ["node", "server.js"]

Dockerfileのポイント

  • マルチステージビルド: builderとrunnerの2つのステージに分けることで、開発ツールやビルド時の依存関係を最終イメージから除外します。
  • キャッシュの活用: package.jsonとロックファイルを先にコピーし、依存関係をインストールすることで、ソースコードの変更時に依存関係の再インストールをスキップし、ビルド時間を短縮します。
  • output: 'standalone' の利用: builderステージで生成された.next/standaloneディレクトリをrunnerステージにコピーするだけで、必要なファイルが全て含まれます。これにより、最終イメージサイズが劇的に小さくなります。
  • 軽量なベースイメージ: node:18-alpineを使用することで、イメージサイズをさらに削減します。
  • CMD ["node", "server.js"]: standaloneモードの場合、Next.jsはserver.jsというエントリポイントを生成します。これを実行することでアプリケーションが起動します。

GCP Cloud Runへのデプロイ手順と設定

最適化されたDockerイメージを準備したら、いよいよGCP Cloud Runにデプロイします。ここでは、デプロイコマンド、環境変数、スケーリング設定について解説します。

DockerイメージのビルドとContainer Registryへのプッシュ

まず、作成したDockerfileを使ってDockerイメージをビルドし、Google Container Registry (GCR) または Artifact Registry にプッシュします。

# プロジェクトIDを設定
PROJECT_ID="your-gcp-project-id"
IMAGE_NAME="nextjs-app-router-cloudrun"
IMAGE_TAG="latest" # またはコミットハッシュなど

# Dockerイメージをビルド
docker build -t gcr.io/${PROJECT_ID}/${IMAGE_NAME}:${IMAGE_TAG} .

# Container Registry にプッシュ
docker push gcr.io/${PROJECT_ID}/${IMAGE_NAME}:${IMAGE_TAG}

Cloud Runサービスへのデプロイ

Dockerイメージがプッシュされたら、gcloud run deployコマンドでCloud Runサービスを作成または更新します。

# Cloud Runサービス名を設定
SERVICE_NAME="my-nextjs-app"
REGION="asia-northeast1" # デプロイするリージョンを選択

# Cloud Runにデプロイ
gcloud run deploy ${SERVICE_NAME} \
  --image gcr.io/${PROJECT_ID}/${IMAGE_NAME}:${IMAGE_TAG} \
  --platform managed \
  --region ${REGION} \
  --allow-unauthenticated \
  --cpu 2 \
  --memory 1Gi \
  --min-instances 0 \
  --max-instances 10 \
  --no-cpu-throttling \
  --port 8080 \
  --timeout 300 \
  --set-env-vars NEXT_PUBLIC_BASE_URL="https://${SERVICE_NAME}-xxxxxx-REGION.run.app"
  # 必要に応じて環境変数を追加

Cloud Runデプロイ設定のポイント

  • --image: プッシュしたDockerイメージのパスを指定します。
  • --platform managed: Cloud Runのマネージド環境を使用することを示します。
  • --allow-unauthenticated: 外部からの認証なしアクセスを許可します。必要に応じて削除または変更してください。
  • --cpu / --memory: コンテナに割り当てるCPUとメモリを指定します。Server Componentsはサーバーサイドで処理を行うため、ある程度のCPUとメモリが必要です。最初は少なめに設定し、負荷テストを通じて調整することをお勧めします。1Giメモリ、2CPUは良い出発点です。
  • --min-instances: 最小インスタンス数を設定します。コールドスタート対策として1以上に設定することも有効ですが、コストが増加します。Server Componentsは初回アクセス時にサーバーで多くの処理を行うため、min-instances: 1とすることでユーザー体験を向上できます。
  • --max-instances: 最大インスタンス数を設定します。過剰なスケーリングを防ぎ、コストを管理します。
  • --no-cpu-throttling: CPUがアイドル状態でも常に割り当てられたCPUを確保します。これにより、コールドスタートやリクエスト処理中のレイテンシを改善できますが、コストは増加します。Server Componentsの特性上、CPUを必要とする処理が多いため、検討する価値があります。
  • --port 8080: Cloud Runはデフォルトでポート8080をリッスンします。Next.jsのstandaloneモードも通常は8080で起動するため、明示的に指定します。
  • --timeout: リクエストタイムアウトを秒単位で指定します。データフェッチに時間がかかる場合などに調整します。
  • --set-env-vars: 環境変数を設定します。NEXT_PUBLIC_で始まる変数はクライアントサイドにも公開されます。APIキーなどの機密情報は、Cloud Secret Managerと連携して使用することを推奨します。

つまずきやすいポイントと解決策

Next.js App RouterをCloud Runにデプロイする際、よくある課題とその解決策をまとめます。

1. メモリ不足によるビルド失敗・コンテナ起動失敗

問題: ビルド時やコンテナ起動時にOOMKilledやメモリ不足のエラーが発生する。
原因: Next.jsのビルドプロセスはメモリを消費しやすく、またServer Componentsのレンダリングもメモリを必要とします。Cloud Runのデフォルト設定やDockerfileのベースイメージが適切でないと発生します。
解決策:

  • Dockerfileの最適化: マルチステージビルドで最終イメージサイズを最小化します。
  • Cloud Runのメモリ割り当て: --memoryオプションを1Giや2Giに増やしてみます。
  • ビルド時のメモリ: Cloud Buildを使用している場合、ビルドステップのメモリを増やす設定を検討します。

2. コールドスタートの遅延

問題: アイドル状態から最初のリクエストが来るまでの時間が長い(コールドスタート)。
原因: Cloud Runのコンテナが完全に停止している状態から起動するため、コンテナイメージのダウンロード、アプリケーションの起動に時間がかかります。Server Componentsは初回アクセス時にサーバーでレンダリングされるため、その処理も加わります。
解決策:

  • --min-instances 1: 最小インスタンス数を1以上に設定し、常に1つ以上のコンテナが稼働している状態を保ちます。これによりコストは上がりますが、コールドスタートはほぼ解消されます。
  • --no-cpu-throttling: CPUがアイドル時にもフルで割り当てられるため、コールドスタート時のCPU確保がスムーズになります。
  • Dockerイメージの軽量化: イメージサイズを小さくすることで、コンテナダウンロード時間を短縮します。

3. 環境変数の管理

問題: 機密情報(APIキーなど)を環境変数として直接Dockerイメージに含めたくない。
解決策:

  • Cloud Secret Managerの利用: 機密情報はCloud Secret Managerに保存し、Cloud RunのサービスアカウントにそのSecretへのアクセス権限を付与します。Cloud Runサービスにデプロイする際に、--set-secretsオプションでSecretを環境変数としてマウントできます。
  • NEXT_PUBLIC_環境変数: クライアントサイドで利用する環境変数はNEXT_PUBLIC_プレフィックスを付けます。それ以外の機密情報はサーバーサイドでのみ使用されるように注意します。

4. ルーティングや画像最適化の問題

問題: 画像が表示されない、ルーティングが期待通りに動作しない。
原因: Cloud Run環境でのパス解決や、Next.jsの画像最適化がデフォルト設定ではファイルシステムに依存している場合があるため。
解決策:

  • 画像最適化: Next.jsのデフォルトの画像最適化はSharpライブラリを使用し、ファイルシステムへのアクセスを伴う場合があります。Cloud Runのようなサーバーレス環境では、これを無効にするか、外部の画像最適化サービス(Cloudinary, Vercel Image Optimizationなど)を利用することを検討します。next.config.jsでimages.unoptimized = true;を設定することで無効にできます。
  • ベースパス: サブディレクトリにデプロイする場合など、next.config.jsのbasePath設定を確認します。

まとめと次の一歩

この記事では、Next.js App RouterとServer ComponentsをGCP Cloud Runで動かすための最適化デプロイ戦略を解説しました。

重要なポイントは以下の通りです。

  1. next.config.jsでoutput: 'standalone'を有効にすることで、軽量な本番向けビルドを生成します。
  2. マルチステージDockerfileを使い、standalone出力と軽量なNode.jsベースイメージで最終的なDockerイメージサイズを最小化します。
  3. **Cloud Runデプロイ時に適切なリソース(CPU, メモリ)とスケーリング設定(--min-instances, --no-cpu-throttling)**を行うことで、パフォーマンスとコストのバランスを取ります。

これらの設定により、Next.js App RouterアプリケーションをGCP Cloud Run上で効率的かつ安定して運用できるようになります。

次の一歩

  • CI/CDの導入: Cloud BuildやGitHub Actionsを使って、コード変更時に自動的にビルド&デプロイされるパイプラインを構築しましょう。
  • カスタムドメインの設定: Cloud Runサービスにカスタムドメインをマッピングし、SSL証明書を構成します。
  • モニタリングとログ: Cloud MonitoringとCloud Loggingを活用し、アプリケーションのパフォーマンスとエラーを監視します。

常にNext.jsとGoogle Cloudの公式ドキュメントで最新情報を確認し、サービスの進化に合わせてデプロイ戦略を最適化していくことが重要です。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?