App Engine で Rails 7 を使用して Cloud SQL for PostgreSQL を使用する

App Engine フレキシブル環境で動作する Ruby on Rails アプリの開発を始めます。作成したアプリはすべての Google プロダクトの基盤となる同じインフラストラクチャで動作するため、数人でも何百万人でも、すべてのユーザーに対応できるように確実にスケーリングできます。

このチュートリアルは、Rails ウェブ開発の知識があることを前提としています。ここでは、新しい Rails アプリを使用して Cloud SQL for PostgreSQL を設定する方法について説明します。このチュートリアルは、Cloud SQL for PostgreSQL を使用するように既存の Rails アプリを構成するためのリファレンスとしても使用できます。

このチュートリアルでは、Ruby 3.0 以降が必要です。

始める前に

Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、 アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud SQL Admin API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud SQL Admin API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

Cloud SQL for PostgreSQL インスタンスを準備する

このチュートリアル用に、Cloud SQL for PostgreSQL インスタンスを設定します。

1. PostgreSQL インスタンスを作成します。 このチュートリアルでは、インスタンスの名前は rails-cloudsql-instance です。

2. インスタンス内にデータベースを作成します。 このチュートリアルでは、本番環境のデータベースの名前は cat_list_production です。

3. インスタンスの postgres ユーザー パスワードを設定します。

Rails 用のローカル環境のセットアップ

このチュートリアルのために、以下のようにローカル環境をセットアップします。

1. Ruby バージョン 3.0 以降をインストールします。

2. Rails 7 gem をインストールします。

3. Bundler gem をインストールします。

注: インストール済みの Ruby、Rails、Bundler、Google Cloud CLI に付属する Cloud Shell を使用することもできます。

Rails とその依存関係のインストールの詳細については、公式の Rails スタートガイドをご覧ください。

事前準備が完了したら、Cloud SQL for PostgreSQL を使用して Rails アプリを作成し、デプロイします。以降のセクションでは、アプリの構成、Cloud SQL for PostgreSQL への接続、デプロイについて説明します。

猫をリストするための新しいアプリを作成する

1. rails new コマンドを実行して新しい Rails アプリを作成します。このアプリは Cloud SQL for PostgreSQL に猫のリストを保存します。

   rails new cat_sample_app
   

2. 生成された Rails アプリのあるディレクトリに移動します。

   cd cat_sample_app
   

アプリをローカルで実行する

ローカルのパソコン上で新しい Rails アプリを実行するには:

1. ローカル ウェブサーバーを起動します。

   bundle exec bin/rails server
   

2. ブラウザで http://localhost:3000/ にアクセスします。

   サンプルアプリには、Rails と Ruby のバージョンとともに Rails のロゴが表示されます。

注: ターミナル ウィンドウで Ctrl+C キーを押してウェブサーバーを終了します。

猫リストのスキャフォールディングを生成する

Cat という名前のリソースのスキャフォールディングを生成します。これは、名前と年齢を含む猫のリストを作成するために使用されます。

1. スキャフォールディングを生成します。

   bundle exec rails generate scaffold Cat name:string age:integer
   

   このコマンドは、Cat リソースのモデル、コントローラ、ビューを生成します。

   invoke  active_record
   create    db/migrate/20230922063608_create_cats.rb
   create    app/models/cat.rb
   invoke    test_unit
   create      test/models/cat_test.rb
   create      test/fixtures/cats.yml
   invoke  resource_route
   route    resources :cats
   invoke  scaffold_controller
   create    app/controllers/cats_controller.rb
   invoke    erb
   create      app/views/cats
   create      app/views/cats/index.html.erb
   create      app/views/cats/edit.html.erb
   create      app/views/cats/show.html.erb
   create      app/views/cats/new.html.erb
   create      app/views/cats/_form.html.erb
   create      app/views/cats/_cat.html.erb
   invoke    resource_route
   invoke    test_unit
   create      test/controllers/cats_controller_test.rb
   create      test/system/cats_test.rb
   invoke    helper
   create      app/helpers/cats_helper.rb
   invoke      test_unit
   invoke    jbuilder
   create      app/views/cats/index.json.jbuilder
   create      app/views/cats/show.json.jbuilder
   create      app/views/cats/_cat.json.jbuilder
   

2. ファイル config/routes.rb を開いて、生成された内容を確認します。

   Rails.application.routes.draw do
     resources :cats
     get 'cats/index'
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
   
   end

3. ファイルに root 'cats#index' を追加します。

   Rails.application.routes.draw do
     resources :cats
     get 'cats/index'
   
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
     root 'cats#index'
   end

4. ファイルを保存して閉じます。

5. 前述の説明のとおりに Rails アプリをテストします。

App Engine での Cloud SQL for PostgreSQL の使用

Cloud SQL for PostgreSQL は、Google Cloudでリレーショナル PostgreSQL データベースを設定、メンテナンス、運用、管理するためのフルマネージド データベース サービスです。つまり、Rails アプリで Cloud SQL を他のリレーショナル データベースと同じように使用できます。

Cloud SQL for PostgreSQL をセットアップする

本番環境の Rails アプリで Cloud SQL の使用を開始するには:

1. pggemとappenginegemをGemfileファイルに追加します。

   bundle add pg
   bundle add appengine
   

   Rails Gemfile に、次の gem エントリが追加されます。

   gem "appengine", "~> 0.6"
   gem "pg", "~> 1.2"

   注: appengine gem は、本番環境でのデータベース移行を実行する Rake タスクを提供します。

2. Rails アプリを Cloud SQL に接続するように構成するため、config/database.yml ファイルを開きます。次のような SQLite 用のボイラープレート データベース設定が表示されます。

   # SQLite version 3.x
   #   gem install sqlite3
   #
   #   Ensure the SQLite 3 gem is defined in your Gemfile
   #   gem 'sqlite3'
   #
   default: &default
     adapter: sqlite3
     pool: 5
     timeout: 5000
   
   development:
     <<: *default
     database: db/development.sqlite3
   
   # Warning: The database defined as "test" will be erased and
   # re-generated from your development database when you run "rake".
   # Do not set this db to the same as development or production.
   test:
     <<: *default
     database: db/test.sqlite3
   
   production:
     <<: *default
     database: db/production.sqlite3

3. App Engine 本番環境用の Cloud SQL インスタンス接続名を構成します。

   1. インスタンス接続名を取得します。

      gcloud sql instances describe rails-cloudsql-instance
      

   2. connectionNameの横にある値をコピーします。

4. database.yml 本番環境のデータベース構成を次のように変更します。

   production:
     adapter: postgresql
     encoding: unicode
     pool: 5
     timeout: 5000
     username: "[YOUR_POSTGRES_USERNAME]"
     password: "[YOUR_POSTGRES_PASSWORD]"
     database: "cat_list_production"
     host:   "/cloudsql/[YOUR_INSTANCE_CONNECTION_NAME]"

   ここで

   • [YOUR_POSTGRES_USERNAME] は Cloud SQL for PostgreSQL インスタンスのユーザー名を表します。
   • [YOUR_POSTGRES_PASSWORD] は Cloud SQL for PostgreSQL インスタンスのパスワードを表します。
   • [YOUR_INSTANCE_CONNECTION_NAME] は、前の手順でコピーしたインスタンス接続名を表します。

これで、App Engine フレキシブル環境へのデプロイ時に Cloud SQL を使用するように Rails アプリが設定されました。

App Engine フレキシブル環境へのアプリのデプロイ

App Engine フレキシブル環境では、app.yaml というファイルを使用してアプリのデプロイ構成を記述します。このファイルが存在しない場合は、gcloud CLI によりデプロイ構成が自動的に推測されます。しかし、Rails の秘密鍵と Cloud SQL に必要な構成設定を提供するためにこのファイルを定義してください。

App Engine にデプロイメントするサンプルアプリを構成するには、Rails アプリ ディレクトリのルートに app.yaml という名前の新しいファイルを作成し、次を追加します。

entrypoint: bundle exec rackup --port $PORT
env: flex
runtime: ruby

app.yaml ファイルで Rails 秘密鍵を構成する

Rails アプリが production 環境にデプロイされたときにユーザー セッション データの保護に使用される秘密鍵を環境変数 SECRET_KEY_BASE に設定します。この環境変数は、Rails アプリの config/secrets.yml ファイルから読み込まれます。

1. 新しい秘密鍵を生成します。

   bundle exec bin/rails secret
   

2. 生成された秘密鍵をコピーします。

3. 前の手順で作成した app.yaml ファイルを開き、env_variables セクションを追加します。env_variables は、App Engine フレキシブル環境の環境変数を定義します。app.yaml ファイルは次の例のようになります。[SECRET_KEY] は実際の秘密鍵に置き換えてください。

   entrypoint: bundle exec rackup --port $PORT
   env: flex
   runtime: ruby
   
   env_variables:
     SECRET_KEY_BASE: [SECRET_KEY]

app.yaml ファイルで Cloud SQL インスタンスを構成します。

次に、app.yaml 構成ファイルに Cloud SQL インスタンス接続名を指定することで、指定した Cloud SQL インスタンスを使用するように App Engine フレキシブル環境を構成します。

1. app.yaml ファイルを開き、beta_settings という名前の新しいセクションを追加します。

2. インスタンス接続名を値として、ネストされたパラメータ cloud_sql_instances を定義します。

   注:Cloud SQL インスタンス接続名を取得するには、gcloud sql instances describe rails-cloudsql-instanceを実行します。

   app.yaml は次のようになります。

   entrypoint: bundle exec rackup --port $PORT
   env: flex
   runtime: ruby
   
   env_variables:
     SECRET_KEY_BASE: [SECRET_KEY]
   
   beta_settings:
     cloud_sql_instances: [YOUR_INSTANCE_CONNECTION_NAME]

App Engine フレキシブル環境アプリを作成する

アプリを初めてデプロイする場合は、App Engine フレキシブル環境アプリを作成し、Rails アプリを実行するリージョンを選択する必要があります。

1. App Engine アプリを作成します。

   gcloud app create
   

2. Ruby アプリの App Engine フレキシブル環境をサポートするリージョンを選択します。リージョンとゾーンの詳細については、こちらをご覧ください。

新しいバージョンをデプロイする

次に、以下のコマンドを実行して、現在のデフォルト バージョンからトラフィックをリダイレクトせずに、app.yaml ファイルに記述された新しいバージョンの Rails アプリをデプロイします。

gcloud app deploy --no-promote

デプロイメントが完了するまで数分かかることがあります。成功メッセージが表示されるのを待ちます。デプロイされたバージョンは、App Engine のバージョン リストで確認できます。

警告: 古いバージョンのアプリはそのまま残り、それらに関連付けられた VM インスタンスも残ります。すべてのアプリ バージョンと VM インスタンスが課金対象のリソースとなるのでご注意ください。

新しいバージョンをデプロイした後、この新しいバージョンにアクセスしようとすると、データベースの移行がまだ終わっていないため、次のエラー メッセージが表示されます。

appengine gem に必要な権限を付与する

次に、appengine gem を使用して本番環境データベースの移行を行うために、cloudbuild サービス アカウントにアクセス権を付与します。

1. 使用可能なプロジェクトを一覧表示します。

   gcloud projects list
   

2. 出力結果からアプリのデプロイに使用するプロジェクトを探し、そのプロジェクト番号をコピーします。

3. データベースの移行を行うために、ロール roles/editor のプロジェクト IAM ポリシーに新しいメンバーを追加します。PROJECT_ID は実際の Google Cloud プロジェクト ID に置き換え、PROJECT_NUMBER は前のステップでコピーしたプロジェクト番号に置き換えます。

   gcloud projects add-iam-policy-binding PROJECT_ID \
     --member=serviceAccount:[e-mail] \
     --role=roles/editor
   

Rails データベースを移行する

Rails データベース移行は、SQL 構文を直接使わずにデータベースのスキーマを更新するために使用されます。次に、cat_list_production データベースを移行します。

appengine gem には、Rake タスク appengine:exec が用意されており、本番の App Engine フレキシブル環境にデプロイされた最新のアプリに対してコマンドを実行します。

1. 本番環境で Cloud SQL for PostgreSQL cat_list_production データベースを移行します。

   bundle exec rake appengine:exec -- bundle exec rake db:migrate
   

   次のような出力が表示されます。

   ---------- EXECUTE COMMAND ----------
   bundle exec rake db:migrate
   Debuggee gcp:787021104993:8dae9032f8b02004 successfully registered
   == 20230922063608 CreateCats: migrating =======================================
   -- create_table(:cats)
      -> 0.0219s
   == 20230922063608 CreateCats: migrated (0.0220s) ==============================
   
   ---------- CLEANUP ----------
   

   注: データベースの移行を行おうとしたときに権限エラーが発生した場合は、[e-mail] に roles/editor ロールがあることを確認してください。

2. データベースの移行を確認するため、ブラウザに次の URL を入力します。

   https://VERSION_ID-dot-PROJECT_ID.REGION_ID.r.appspot.com
   

   以下を置き換えます。

   • VERSION_ID: 以前にデプロイしたアプリの新しいバージョン。バージョンのリストを取得するには、gcloud app versions list を使用します。最後の default サービス バージョン項目が最新のデプロイメントです。
   • PROJECT_ID: 実際の Google Cloud プロジェクト ID
   • REGION_ID: App Engine がアプリに割り当てるコード

デプロイメントが成功すると、次のような出力が表示されます。

トラフィックを新しいバージョンに移行する

最後に、次のコマンドを使用して、新しくデプロイしたバージョンにトラフィックを誘導します。

gcloud app services set-traffic default --splits VERSION=1

アプリの新しいバージョンには、次の URL からアクセスできます。

https://PROJECT_ID.REGION_ID.r.appspot.com

App Engine のログを見る

Rails アプリをデプロイした後、ログを見ることができます。アプリのログは、 Google Cloud コンソールのログ エクスプローラを使用して確認できます。

詳細については、gcloud CLI を使用したログの読み取りをご覧ください。

リソースのクリーンアップ

チュートリアルが終了したら、作成したリソースをクリーンアップして、割り当ての使用を停止し、課金されないようにできます。次のセクションで、リソースを削除または無効にする方法を説明します。

プロジェクトの削除

課金をなくす最も簡単な方法は、チュートリアル用に作成したプロジェクトを削除することです。

プロジェクトを削除するには:

注意: プロジェクトを削除すると、次のような影響があります。

• プロジェクト内のすべてのものが削除されます。既存のプロジェクトを使用してこのドキュメントのタスクを行った場合、そのプロジェクトを削除すると、プロジェクト内で行った他の作業もすべて削除されます。
• カスタム プロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタム プロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（例: appspot.com）を保持するには、プロジェクト全体ではなく、プロジェクト内の選択したリソースだけを削除します。

複数のアーキテクチャ、チュートリアル、クイックスタートを実施する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て上限を超えないようにすることができます。

1. Google Cloud コンソールで [リソースの管理] ページに移動します。

   [リソースの管理] に移動

2. プロジェクト リストで、削除するプロジェクトを選択し、[削除] をクリックします。
3. ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。

App Engine のバージョンの削除

アプリのバージョンを削除するには:

1. Google Cloud コンソールで、App Engine の [バージョン] ページに移動します。

   [バージョン] に移動

2. デフォルト以外で削除するアプリのバージョンのチェックボックスをオンにします。
   注: App Engine アプリのデフォルト バージョンを削除する唯一の方法は、プロジェクトを削除することです。ただし、 Google Cloud コンソールでデフォルト バージョンを停止することもできます。このアクションによって、バージョンに関連付けられているすべてのインスタンスがシャットダウンします。これらのインスタンスは、必要に応じてあとで再起動できます。

   App Engine スタンダード環境では、お使いのアプリに手動スケーリングまたは基本スケーリングがある場合、デフォルト バージョンを停止させることができます。

3. アプリのバージョンを削除するには、[削除] をクリックします。

Cloud SQL インスタンスの削除

Cloud SQL インスタンスを削除するには:

1. Google Cloud コンソールで、[インスタンス] ページに移動します。

   [インスタンス] に移動

2. 削除する SQL インスタンスの名前をクリックします。
3. インスタンスを削除するには、 [削除] をクリックして、指示に従います。

次のステップ

• App Engine フレキシブル環境で Ruby Bookshelf サンプルアプリを実行する方法を学習する。

• Compute Engine で Ruby Bookshelf サンプルアプリを実行する方法を学習する。

• Google Kubernetes Engine で Ruby Bookshelf サンプルアプリを実行する方法を学習する。