クイックスタート: Cloud Run に Ruby サービスをデプロイする

クイックスタート: Cloud Run に Ruby サービスをデプロイする

シンプルな Hello World アプリケーションを作成してコンテナ イメージにパッケージ化し、Artifact Registry にアップロードして Cloud Run にデプロイする方法を学習します。

始める前に

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. Install the Google Cloud CLI.

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

   gcloud init

   Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.

6. 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

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

8. Install the Google Cloud CLI.

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

   gcloud init

   Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.
10. Cloud Run サービスのデフォルト プロジェクトを設定するには:

     gcloud config set project PROJECT_ID

    PROJECT_ID は、Google Cloud プロジェクト ID に置き換えます。

11. ドメイン制限の組織のポリシーでプロジェクトの未認証呼び出しが制限されている場合は、限定公開サービスのテストの説明に従って、デプロイされたサービスにアクセスする必要があります。

12. Cloud Run Admin API と Cloud Build API を有効にします。

    gcloud services enable run.googleapis.com \
        cloudbuild.googleapis.com

    Cloud Run Admin API を有効にすると、Compute Engine のデフォルトのサービス アカウントが自動的に作成されます。

13. Cloud Build がソースを構築できるようにするには、次のコマンドを実行して、Compute Engine のデフォルト サービス アカウントに Cloud Build サービス アカウントのロールを付与します。
    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:[e-mail] \
        --role=roles/cloudbuild.builds.builder

    PROJECT_NUMBER は Google Cloud プロジェクト番号に、PROJECT_ID は Google Cloud プロジェクト ID に置き換えます。プロジェクト ID とプロジェクト番号を確認する方法については、プロジェクトの作成と管理をご覧ください。

    Compute Engine のデフォルト サービス アカウントに Cloud Build サービス アカウントのロールを付与すると、ロールが伝播されるまでに数分かかることがあります。

    注:

    iam.automaticIamGrantsForDefaultServiceAccounts 組織のポリシーの制約により、編集者のロールはデフォルトのサービス アカウントに自動的に付与されません。2024 年 5 月 3 日より後に組織を作成した場合、この制約はデフォルトで適用されます。

    この制約を適用して、ロールの自動付与を無効にすることを強くおすすめします。ロールの自動付与を無効にする場合は、デフォルトのサービス アカウントに付与するロールを決定し、ご自身でこれらのロールを付与する必要があります。

    デフォルトのサービス アカウントにすでに編集者ロールが設定されている場合は、編集者ロールを権限の低いロールに置き換えることをおすすめします。サービス アカウントのロールを安全に変更するには、Policy Simulator を使用して変更の影響を確認してから、適切なロールを付与または取り消す操作を行います。

サンプル アプリケーションを作成する

Ruby アプリケーションを作成するには:

1. helloworld という名前の新しいディレクトリを作成し、そのディレクトリに移動します。

   mkdir helloworld
   cd helloworld
   

2. app.rb という名前のファイルを作成し、次のコードを貼り付けます。

   require "sinatra"
   
   set :bind, "0.0.0.0"
   port = ENV["PORT"] || "8080"
   set :port, port
   
   get "/" do
     name = ENV["NAME"] || "World"
     "Hello #{name}!"
   end

   このコードは、PORT 環境変数で定義されたポートをリッスンする基本的なウェブサーバーを作成します。

3. Gemfile という名前のファイルを作成し、次の内容をコピーします。

   source "https://rubygems.org"
   
   gem "sinatra", "~>3.1"
   gem "thin"
   
   group :test do
     gem "rack-test"
     gem "rest-client"
     gem "rspec"
     gem "rspec_junit_formatter"
     gem "rspec-retry"
     gem "rubysl-securerandom"
   end
   

4. Bundler 2.0 以降がインストールされていない場合は、Bundler をインストールします。

5. 次のコマンドを実行して Gemfile.lock ファイルを生成します。

   bundle install

6. ソースファイルと同じディレクトリに Dockerfile という名前の新しいファイルを作成します。

   
   # Use the official Ruby image.
   # https://hub.docker.com/_/ruby
   FROM ruby:3.2-buster
   
   # Install production dependencies.
   WORKDIR /usr/src/app
   COPY Gemfile Gemfile.lock ./
   ENV BUNDLE_FROZEN=true
   RUN gem install bundler && bundle config set --local without 'test'
   
   # Copy local code to the container image.
   COPY . ./
   RUN bundle install
   
   # Run the web service on container startup.
   CMD ["ruby", "./app.rb"]
   

7. .dockerignore ファイルを追加してコンテナ イメージからファイルを除外します。

   Dockerfile
   README.md
   .ruby-version
   .bundle/
   vendor/
   

これでアプリが完成し、デプロイできるようになりました。

ソースから Cloud Run にデプロイする

重要: 以下の説明では、このクイックスタートで使用するプロジェクトのオーナーロールまたは編集者ロールが付与されていることを前提としています。ロールが付与されていない場合は、Cloud Run ソース デベロッパー ロールで、ソースから Cloud Run リソースをデプロイするために必要な権限を確認してください。

ソースからのデプロイでは、ソースコードからコンテナ イメージが自動的にビルドされて、デプロイされます。

ソースからデプロイするには:

1. ソースコード ディレクトリで、次のコマンドを使用して現在のフォルダをデプロイします。

   gcloud run deploy --source .

   1. サービス名の入力を求められたら、Enter キーを押して、デフォルトの名前（helloworld など）を受け入れます。

   2. プロジェクトで追加の API（Artifact Registry API など）を有効にするよう求められたら、y を押して応答します。

   3. リージョンの入力を求められたら、任意のリージョン（us-central1 など）を選択します。

   4. 指定したリージョンにリポジトリを作成するように求められたら、y を押して応答します。

   5. 未認証の呼び出しを許可するように求められた場合は、「y」と入力します。ドメイン制限の組織のポリシーが原因でこのメッセージが表示されない場合があります。詳細については、始める前にのセクションをご覧ください。

   デプロイが完了するまで少しお待ちください。成功すると、コマンドラインにサービス URL が表示されます。

2. このサービス URL をウェブブラウザで開き、デプロイしたコンテナにアクセスします。

Cloud Run のロケーション

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

レイテンシ、可用性、耐久性の要件を満たしていることが、Cloud Run サービスを実行するリージョンを選択する際の主な判断材料になります。一般的には、ユーザーに最も近いリージョンを選択できますが、Cloud Run サービスで使用されている他の Google Cloud サービスのロケーションも考慮する必要があります。使用する Google Cloud サービスが複数のロケーションにまたがっていると、サービスの料金だけでなくレイテンシにも影響します。

Cloud Run は、次のリージョンで利用できます。

ティア 1 料金を適用

• asia-east1（台湾）
• asia-northeast1（東京）
• asia-northeast2（大阪）
• asia-south1（ムンバイ、インド）
• europe-north1（フィンランド） 低 CO₂
• europe-southwest1（マドリッド） 低 CO₂
• europe-west1（ベルギー） 低 CO₂
• europe-west4（オランダ） 低 CO₂
• europe-west8（ミラノ）
• europe-west9（パリ） 低 CO₂
• me-west1（テルアビブ）
• us-central1（アイオワ） 低 CO₂
• us-east1（サウスカロライナ）
• us-east4（北バージニア）
• us-east5（コロンバス）
• us-south1（ダラス） 低 CO₂
• us-west1（オレゴン） 低 CO₂

ティア 2 料金を適用

• africa-south1（ヨハネスブルグ）
• asia-east2（香港）
• asia-northeast3（ソウル、韓国）
• asia-southeast1（シンガポール）
• asia-southeast2 （ジャカルタ）
• asia-south2（デリー、インド）
• australia-southeast1（シドニー）
• australia-southeast2（メルボルン）
• europe-central2（ワルシャワ、ポーランド）
• europe-west10（ベルリン） 低 CO₂
• europe-west12（トリノ）
• europe-west2（ロンドン、イギリス） 低 CO₂
• europe-west3（フランクフルト、ドイツ） 低 CO₂
• europe-west6（チューリッヒ、スイス） 低 CO₂
• me-central1（ドーハ）
• me-central2（ダンマーム）
• northamerica-northeast1（モントリオール） 低 CO₂
• northamerica-northeast2（トロント） 低 CO₂
• southamerica-east1（サンパウロ、ブラジル） 低 CO₂
• southamerica-west1（サンティアゴ、チリ） 低 CO₂
• us-west2（ロサンゼルス）
• us-west3（ソルトレイクシティ）
• us-west4（ラスベガス）

Cloud Run サービスをすでに作成している場合は、Google Cloud コンソールの Cloud Run ダッシュボードにリージョンが表示されます。

OK

これで完了です。ソースコードから Cloud Run にコンテナ イメージをデプロイしました。Cloud Run は、受信したリクエストを処理するためにコンテナ イメージを自動的に水平方向にスケールアウトします。リクエスト数が減少すると、インスタンス数がスケールインします。料金は、リクエストの処理中に使用した CPU、メモリ、ネットワークに対してのみ発生します。

クリーンアップ

テスト プロジェクトを削除する

サービスが使用されていない場合、Cloud Run の料金は発生しませんが、コンテナ イメージを Artifact Registry に保存すると課金される場合があります。コンテナ イメージを削除するか、Google Cloud プロジェクトを削除してこのような料金が発生しないようにできます。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.

次のステップ

コードソースからコンテナをビルドし、リポジトリに push する方法については、以下をご覧ください。

• Cloud Run サービスを開発する
• コンテナをビルドする
• Cloud Run サービスをローカルでテストする
• ソースコードからデプロイする