yaml 構成ファイルを整理する

リージョン ID

REGION_ID は、アプリの作成時に選択したリージョンに基づいて Google が割り当てる省略形のコードです。一部のリージョン ID は、一般的に使用されている国や州のコードと類似しているように見える場合がありますが、このコードは国または州に対応するものではありません。2020 年 2 月以降に作成されたアプリの場合、REGION_ID.r が App Engine の URL に含まれています。この日付より前に作成されたアプリの場合、URL のリージョン ID は省略可能です。

詳しくは、リージョン ID をご覧ください。

ここでは、App Engine 用アプリのサービスと関連リソースを構造化する方法を説明します。

ディレクトリ構造

App Engine サービスの各バージョンは、app.yaml 構成ファイルで定義されます。単純なアプリでは、app.yaml ファイルの定義がデプロイの最小要件になります。app.yaml ファイルは、デプロイ記述子として機能し、特定バージョンのサービスのスケーリング タイプと CPU、ディスク、メモリのリソースを定義します。複数のバージョンのサービスをデプロイする場合は、同じディレクトリ内に複数の yaml ファイルを作成して、各バージョンの構成を表すことができます。

yaml 形式の構成ファイルは、Eclipse Jetty 9 ランタイムと Java 8 ランタイムで使用します。

ファイルの編成は、使用する Java ランタイムに応じて異なります。アプリ内のサービスごとに、WAR ファイルまたは JAR ファイルが必要になる場合があります。詳細については、該当の Java ランタイム デベロッパー ガイドをご覧ください。

インスタンスの稼働率に関する設計上の考慮事項

ハードウェアやソフトウェアの障害のため、事前の警告なくインスタンスが途中で終了したり頻繁に再起動したりする場合があり、このような障害の解決に長い時間がかかることもあります。アプリケーションはこのような障害に対処できる必要があります。

インスタンスの再起動によるダウンタイムを回避するには、次のような手法が効果的です。

  • インスタンスの再起動や新規インスタンスの起動にかかる時間を短縮する。
  • 長時間実行される処理では、チェックポイントを定期的に作成して、その状態から再開できるようにする。
  • アプリを「ステートレス」にして、インスタンスに何も格納されないようにする。
  • 非同期タスクの実行にキューを使用する。
  • インスタンスを手動スケーリングとして構成する場合:
    • 複数のインスタンス間で負荷分散を行う。
    • 通常のトラフィックの処理に必要な数よりも多くのインスタンスを構成する。
    • 手動スケーリング インスタンスを利用できないときにキャッシュ内の結果を使用するよう、フォールバック ロジックを作成する。

インスタンスの詳細については、インスタンスの管理方法をご覧ください。

default サービス

すべての App Engine アプリケーションには default サービスが含まれています。アプリの初期バージョンを default サービスにデプロイする必要があります。その後、追加のサービスを作成してアプリにデプロイできます。

default サービスは、app.yaml で service: default の設定を使用して指定できます（この設定は省略可能です）。

Cloud プロジェクトを使用するアプリに送信されたリクエストは、default サービスに送信されます（例: https://PROJECT_ID.REGION_ID.r.appspot.com）。他のサービスをターゲットに設定する方法については、サービス間の通信をご覧ください。

オプションの構成ファイル

以下の構成ファイルを使用すると、個々のアプリに含まれるすべてのサービスに適用されるオプション機能を制御できます。各オプション機能の詳細については、以下をご覧ください。

  • dispatch.yaml は、受信リクエストを URL のパスまたはホスト名に基づいて特定のサービスに送信することで、ルーティングのデフォルト ルールをオーバーライドします。
  • index.yaml は、Datastore クエリを使用する場合に、アプリに必要なインデックスを指定します。
  • cron.yaml は、定義された時刻または一定間隔で動作する定期スケジュール タスクを構成します。

データとファイルの保存に関する考慮事項

App Engine から、Datastore、Cloud SQL、Cloud Storage といった他の Google Cloud サービスに簡単にアクセスできます。

外部またはサードパーティのデータベースがご使用の言語でサポートされ、App Engine インスタンスからアクセスできる場合は、そのデータベースを使用することもできます。

ファイルを Google Cloud または外部に保存する方法については、データとファイルの保存についてをご覧ください。

静的コンテンツの提供方法を選択することもできます。App Engine でアプリからその静的コンテンツを直接提供する、Cloud Storage をはじめとする Google Cloud のサービスに静的コンテンツをデプロイしてホストする、サードパーティのコンテンツ配信ネットワーク（CDN）を使用するといった選択肢があります。静的コンテンツの提供に関する詳細については、静的ファイルの提供をご覧ください。

次のステップ

複数のサービスを使用していて、それらのサービスを一緒にデプロイする場合は、複数のサービスをデプロイするの手順をご覧ください。