Moduleをdispach.yamlで振り分ける方法

Google App Engineには、アプリケーション内の機能をグループ化できる Modules というしくみがある。Moduleごとに、インスタンスのスペックやスケールのルールが設定できるため、フロントエンドとバックオフィス、バックグラウンドジョブといった用途別にModuleを作成すると良さそうだ。また、どのModuleが使われるかは、URL(パス)で振り分けることができる。今回はその方法のメモ。

Moduleのyamlファイルの作成

今回は、以下の3つのModuleを作ってみる。

・フロントエンド用(app.yaml) default
・バックオフィス用(back.yaml)
・JOB用(job.yaml)

まずは各Moduleのyamlファイルを作成する。

app.yaml

application: gcp-memo
module: default
version: 1
runtime: python27
api_version: 1
threadsafe: true
instance_class: F1
(以下省略)

admin.yaml

application: gcp-memo
module: admin
version: 1
runtime: python27
api_version: 1
threadsafe: true
instance_class: F1
(以下省略)

job.yaml

application: gcp-memo
module: job
version: 1
runtime: python27
api_version: 1
threadsafe: true
instance_class: B1
basic_scaling:
max_instances: 2
idle_timeout: 10m
(以下省略)

dispatch.yamlファイルの作成

続いて、これらのModuleを振り分けるdispatch.yamlを作成する。今回は、パスが/admin/に一致すればadminモジュールへ、/job/に一致すればjobモジュールが使用されるようにする。dispatch.yamlは、アプリケーションのルートディレクトリに配置する必要がある。Moduleのyamlファイルについては、ルートでも任意のディレクトリ配下でもOK。

dispatch.yaml

application: gcp-memo
dispatch:
- url: "*/job/*"
module: job
- url: "*/admin/*"
module: admin

ローカルサーバーでの起動

以下で実行できる。パラメータにdispatch.yamlとモジュールのyamlファイルを渡す。実行ディレクトリは、アプリケーションのルート。モジュールのyamlがサブディレクトリ配下にある場合は、ルートからの相対パスで指定する。

ローカルサーバーでの起動コマンド

dev_appserver.py dispatch.yaml app.yaml admin.yaml job.yaml

コンソールには以下が表示され、http://localhost:8080 にアクセスすれば、適宜ディスパッチされる。

コンソールの表示

Starting dispatcher running at: http://localhost:8080
Starting module "default" running at: http://localhost:8081
Starting module "admin" running at: http://localhost:8082
Starting module "job" running at: http://localhost:8083

デプロイとdispatch.yamlの更新

本番環境にデプロイするときは、各モジュールのデプロイとdispatch.yamlの更新とでコマンドが別。モジュールのデプロイは、複数のyamlファイルを指定できる。

デプロイ

appcfg.py update app.yaml job.yaml admin.yaml

dispatch.yamlの更新

appcfg.py update_dispatch ./

※update_dispatchは忘れがち。

app.yamlは必須か?

おまけ。フロントモジュールはapp.yamlという名前にしたが、app.yamlでなくてもOKみたい。ただ、Google App Engine Launcherでapp.yamlが無いと怒られたり、PyCharmでGAEプロジェクトと認識されなかったりするので、デフォルトのモジュールはapp.yamlにしたほうが無難だろう。