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

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

リージョン ID

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

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

OK

注: 新しい Ruby ウェブサービスを Google Cloud にデプロイする場合は、Cloud Run の使用をおすすめします。

このクイックスタートでは、ショート メッセージを表示するアプリを作成してデプロイする方法を説明します。このクイックスタートのサンプル アプリケーションは、app.yaml ファイルでランタイム バージョンとオペレーティング システムを指定することで、Ruby のサポート対象のバージョンで使用できます。

始める前に

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Build API.

   Enable the API

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

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

   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

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Build API.

   Enable the API

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

追加の前提条件

1. プロジェクトで App Engine アプリケーションを初期化し、そのリージョンを選択します。

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   表示された指示に従って、App Engine アプリケーションを配置するリージョンを選択します。

   注: アプリのリージョンは、設定後に変更できません。

2. ローカルマシンに次のものをインストールします。

   • Git をダウンロードしてインストールします。

App Engine のロケーション

App Engine はリージョナルです。つまり、アプリを実行するインフラストラクチャは特定のリージョンに配置され、そのリージョン内のすべてのゾーンで冗長的に利用できるように Google が管理しています。

レイテンシ、可用性、耐久性の要件を満たすことが、アプリを実行するリージョンを選択する際の主な要素になります。一般的には、アプリのユーザーに最も近いリージョンを選択できますが、App Engine が使用可能なロケーションと、アプリが使用するその他の Google Cloud プロダクトおよびサービスのロケーションを考慮する必要があります。使用するサービスが複数のロケーションにまたがっていると、アプリのレイテンシだけでなく、料金にも影響する可能性があります。

設定したアプリのリージョンは変更できません。

注: App Engine コマンドと Google Cloud コンソールで europe-west および us-central と呼ばれる 2 つのロケーションは、Google ドキュメントの他の箇所では、それぞれ europe-west1、us-central1 と呼ばれています。

すでに App Engine アプリケーションを作成している場合は、次のいずれかの方法でそのリージョンを表示できます。

• gcloud app describe コマンドを実行します。

• Google Cloud コンソールの App Engine ダッシュボードを開きます。ページの上部にリージョンが表示されます。

OK

このクイックスタートでは、Sinatra ウェブ フレームワークを使用して記述された、App Engine にデプロイ可能なシンプルな Ruby アプリの例を示します。このサンプルでは Sinatra を使用しますが、Ruby on Rails など他のフレームワークも使用可能です。

Hello World アプリをダウンロードする

App Engine 用の Hello World アプリが用意されており、Google Cloud へのアプリのデプロイをすぐに試すことができます。

1. Hello World サンプルアプリ リポジトリのクローンをローカルマシンに作成します。

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
   

   または、zip 形式のサンプルをダウンロードして、ファイルを抽出します。

2. サンプルコードが含まれているディレクトリに移動します。

      cd ruby-docs-samples/appengine/flexible/hello_world
   

ローカルマシンで Hello World を実行する

次の例では、Bundler を使用してローカルのパソコンで Hello World アプリを実行します。

1. ランタイム用にプログラミング言語をまだインストールしていない場合は、Ruby をダウンロードしてインストールします。

   Ruby をダウンロードしてインストールする

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

   gem install bundler
   

3. このプロジェクトの依存関係をインストールします。

   bundle install
   

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

   bundle exec ruby app.rb -p 8080
   

5. ウェブブラウザで次のように入力します。

   http://localhost:8080

サンプルアプリから Hello World というメッセージがページに表示されます。ターミナル ウィンドウで Ctrl+C キーを押してウェブサーバーを終了します。

Hello World を App Engine にデプロイして実行する

App Engine フレキシブル環境にアプリをデプロイする手順は次のとおりです。

1. flexible/hello_world ディレクトリで次のコマンドを実行して、Hello World アプリをデプロイします。

   gcloud app deploy

   オプションのフラグをご覧ください。

   共通の gcloud コマンドフラグ

   • アプリのバージョンを一意に識別する ID を指定するには --version フラグを含めます。このフラグを含めない場合は自動的に生成されます。例: --version [YOUR_VERSION_ID]
   • gcloud ツールでデフォルトとして初期設定したものに代わる Google Cloud プロジェクト ID を指定するには、--project フラグを指定します。例: --project [YOUR_PROJECT_ID]

   例:

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   コマンドラインからアプリをデプロイする方法について詳しくは、アプリのテストとデプロイをご覧ください。すべてのコマンドフラグの一覧については、gcloud app deploy リファレンスをご覧ください。

   OK

2. ブラウザを起動し、https://PROJECT_ID.REGION_ID.r.appspot.com にアクセスしてアプリを表示します。

   gcloud app browse

   ここで PROJECT_ID は、Google Cloud プロジェクト ID です。

今回、Hello World メッセージが表示されるページは、App Engine インスタンスで実行されているウェブサーバーから配信されます。

これで完了です。App Engine フレキシブル環境に最初の App Engine アプリケーションをデプロイしました。

アプリケーションのデプロイでエラーが発生した場合は、トラブルシューティングのヒントをご覧ください。

クリーンアップの詳細については、以下の説明をご覧ください。また、活用できる次のステップへのリンクも併せてご確認ください。

クリーンアップ

課金されないようにするには、Google Cloud プロジェクトを削除してプロジェクト内のすべてのリソースへの課金を停止します。

注意: プロジェクトを削除すると、次のような影響があります。
• プロジェクト内のすべてのものが削除されます。このドキュメントのタスクで既存のプロジェクトを使用した場合、それを削除すると、そのプロジェクトで行った他の作業もすべて削除されます。
• カスタム プロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタム プロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（たとえば、appspot.com）を保持するには、プロジェクト全体ではなくプロジェクト内の選択したリソースだけを削除します。
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

次のステップ

プラットフォーム全体について学習する

App Engine アプリの開発とデプロイについて概要を理解した後は、Google Cloud の残りの部分についても確認します。すでに Google Cloud CLI がインストールされているため、Cloud SQL、Cloud Storage、Firestore などのプロダクトを操作するツールを使用できます。

App Engine フレキシブル環境について学習する

App Engine についてさらに理解を深めるためのトピックをご紹介します。

• App Engine の概要
• リクエストのルーティング
• リクエスト処理
• インスタンスの管理

Hello World コードレビュー

Hello World は、サービスが 1 つだけ含まれ、バージョンも 1 つだけで、すべてのコードがアプリケーションのルート ディレクトリにあるという、最もシンプルな App Engine アプリケーションです。このセクションでは、このアプリケーションの各ファイルについて詳しく説明します。

app.rb

Hello World アプリケーションは 1 つのファイルからなる基礎的な Sinatra アプリケーションです。

require "sinatra"

get "/" do
  "Hello world!"
end

app.yaml

app.yaml ファイルには、アプリの次の構成が記述されます。

• env: flex の設定。アプリで App Engine フレキシブル環境が使用されることが示されます。

• アプリで使用するランタイムを指定します。

  runtime: ruby
  env: flex
  entrypoint: bundle exec ruby app.rb
  
  runtime_config:
    operating_system: ubuntu22
  
  # This sample incurs costs to run on the App Engine flexible environment.
  # The settings below are to reduce costs during testing and are not appropriate
  # for production use. For more information, see:
  # https://cloud.google.com/appengine/docs/flexible/ruby/configuring-your-app-with-app-yaml
  manual_scaling:
    instances: 1
  resources:
    cpu: 1
    memory_gb: 0.5
    disk_size_gb: 10
  

  • Ruby ランタイムの動作の詳細については、Ruby ランタイムをご覧ください。

  • バージョンとサービスを利用するアプリケーションの作成方法について詳しくは、App Engine の概要をご覧ください。

  • App Engine の構成の詳細については、app.yaml によるアプリケーションの構成をご覧ください。

Gemfile

Gemfile はアプリの RubyGem 依存関係を指定するために使用され、Bundler は依存関係を宣言およびインストールするために使用されます。Hello World アプリには 1 つの Ruby gem（Sinatra ウェブ フレームワーク）が必要です。

source "https://rubygems.org"

gem "sinatra"
gem "webrick", "~> 1.8"