アプリ モダナイゼーションのワークショップ

1. はじめに

最終更新日: 2024 年 11 月 1 日

古い PHP アプリケーションを Google Cloud にモダナイズするにはどうすればよいですか?

(📽️ この Codelab の 7 分間の紹介動画をご覧ください)

オンプレミスで実行されているレガシー アプリケーションをモダナイズする必要があることはよくあります。つまり、スケーラブルで安全、かつさまざまな環境にデプロイできるようにすることです。

このワークショップでは、次の作業を行います。

  1. PHP アプリケーションをコンテナ化する。
  2. マネージド データベース サービス(Cloud SQL)に移行する。
  3. Cloud Run にデプロイする(GKE / Kubernetes のゼロオペレーション代替手段)。
  4. Identity and Access Management(IAM)と Secret Manager を使用してアプリケーションを保護する。
  5. Cloud Build を介して CI / CD パイプラインを定義します。Cloud Build は、GitHub や GitLab などの一般的な Git プロバイダでホストされている Git リポジトリに接続でき、たとえば main への push でトリガーできます。
  6. アプリケーションの画像を Cloud Storage でホストする。これはマウントによって実現され、アプリを変更するためのコードは必要ありません。
  7. Cloud Functions(サーバーレス)を介してオーケストレートされた Gemini を通じて、生成 AI 機能を導入します。
  8. SLO と、新しく更新されたアプリの運用について理解する。

これらの手順に沿って、PHP アプリケーションを段階的にモダナイズし、スケーラビリティ、セキュリティ、デプロイの柔軟性を向上させることができます。さらに、Google Cloud に移行することで、その強力なインフラストラクチャとサービスを活用して、クラウドネイティブ環境でアプリケーションをスムーズに実行できます。

これらの簡単な手順に沿って学習した内容は、異なる言語 / スタックや異なるユースケースを使用する独自のアプリケーションや組織に適用できると考えています。

アプリについて

フォークするアプリケーション(コード、MIT ライセンスに基づく)は、MySQL 認証を使用する基本的な PHP 5.7 アプリケーションです。このアプリの主な目的は、ユーザーが写真をアップロードできるプラットフォームを提供することです。管理者は不適切な画像にタグを付けることができます。このアプリケーションには、次の 2 つのテーブルがあります。

  • ユーザー。管理者向けに事前コンパイルされています。新規ユーザーが登録できます。
  • 画像。いくつかのサンプル画像が付属しています。ログインしたユーザーは新しい写真をアップロードできます。ここに魔法をかけます。

目標

古いアプリケーションをモダナイズして Google Cloud に移行したいと考えています。Google Cloud のツールとサービスを活用して、スケーラビリティの向上、セキュリティの強化、インフラストラクチャ管理の自動化を実現します。また、Cloud SQL、Cloud Run、Cloud Build、Secret Manager などのサービスを使用して、画像処理、モニタリング、データ ストレージなどの高度な機能を統合します。

445f7a9ae37e9b4d.png

さらに重要なのは、各ステップの背後にある思考プロセスを学習できるように、ステップごとに進めることです。通常、各ステップは次のステップの新しい可能性を切り開きます(例: モジュール 2 -> 3、6 -> 7)。

まだ納得できない場合は、YouTube の 7 分間の動画をご覧ください。

必要なもの

  • ブラウザがインストールされ、インターネットに接続されているパソコン。
  • GCP クレジット。次のステップをご覧ください。
  • Cloud Shell を使用します。必要なコマンドがすべてプリインストールされており、IDE も付属しています。
  • GitHub アカウント。🧑🏻‍💻 gdgpescara/app-mod-workshop の元のコードを独自の Git リポジトリにブランチするために必要です。これは、独自の CI / CD パイプライン(自動 commit -> ビルド -> デプロイ)を使用するために必要です。

サンプル ソリューションは、こちらで確認できます。

このワークショップは、Cloud Shell(ブラウザ上)で完了するように設計されています。

ただし、ローカル コンピュータから試すこともできます。

2. クレジットの設定とフォーク

6dafc658860c0ce5.png

GCP クレジットを利用して GCP 環境をセットアップする [任意]

このワークショップを実行するには、クレジットのある請求先アカウントが必要です。この Codelab の上部にあるバナーのクレジットを使用して開始します。すでに請求先アカウントに接続している場合は、この手順をスキップできます。

完了したら、Google Cloud コンソールを開き、[組織なし] と表示されている左上のプルダウン メニューのプロジェクト セレクタをクリックして、新しいプロジェクトを作成します。以下を参照

bd7548f78689db0b.png

プロジェクトがない場合は、下のスクリーンショットに示すように、新しいプロジェクトを作成します。右上に [新しいプロジェクト] オプションがあります。

6c82aebcb9f5cd47.png

次の手順で、新しいプロジェクトを GCP トライアルの請求先アカウントにリンクします。

f202527d254893fb.png

Google Cloud Platform を使用する準備が整いました。初心者の方や、Cloud 環境ですべての操作を行いたい方は、以下に示すように、左上隅にある次のボタンから Cloud Shell とそのエディタにアクセスできます。

7d732d7bf0deb12e.png

左上で新しいプロジェクトが選択されていることを確認します。

選択されていない(不適切):

c2ffd36a781b276a.png

選択済み(良好):

594563c158f4f590.png

GitHub からアプリをフォークする

  1. デモアプリ(https://github.com/gdgpescara/app-mod-workshop)に移動します。
  2. [🍴 fork] をクリックします。
  3. GitHub アカウントをお持ちでない場合は、新しいアカウントを作成する必要があります。
  4. 必要に応じて編集します。

734e51bfc29ee5df.png

  1. 次のコマンドを使用してアプリコードのクローンを作成します。
  2. git clone https://github.com/YOUR-GITHUB-USER/YOUR-REPO-NAME
  1. クローンを作成したプロジェクト フォルダを任意のエディタで開きます。Cloud Shell を選択した場合は、以下に示すように [エディタを開く] をクリックします。

40f5977ea4c1d1cb.png

次の図に示すように、Google Cloud Shell エディタには必要なものがすべて揃っています。

a4e5ffb3e9a35e84.png

これは、[Open Folder] をクリックしてフォルダ(通常はホームフォルダの app-mod-workshop)を選択することで、視覚的に行うことができます。

3. モジュール 1: SQL インスタンスを作成する

645902e511a432a6.png

Google Cloud SQL インスタンスを作成する

PHP アプリは MySQL データベースに接続するため、移行をスムーズに行うには、データベースを Google Cloud に複製する必要があります。Cloud SQL は、クラウドでフルマネージドの MySQL データベースを実行できるため、最適な選択肢です。手順は次のとおりです。

  1. Cloud SQL ページ(https://console.cloud.google.com/sql/instances)に移動します。
  2. [インスタンスを作成] をクリックします。
  3. API を有効にします(必要な場合)。この処理には数秒かかることがあります。
  4. [MySQL を選択] をクリックします。
  5. (できるだけ安価なバージョンを入手して、長く使えるようにしたいと考えています)。
  • エディション: Enterprise
  • プリセット: development(Sandbox を試しましたが、うまくいきませんでした)
  • MySQL のバージョン: 5.7(かなり古いバージョンです)
  1. インスタンス ID: appmod-phpapp を選択します(これを変更する場合は、今後のスクリプトとソリューションもそれに応じて変更してください)。
  2. パスワード: 任意のパスワード。ただし、CLOUDSQL_INSTANCE_PASSWORD としてメモしておきます。
  3. リージョン: アプリの他の部分で選択したリージョンと同じリージョンを選択します(例: ミラノ = europe-west8)。
  4. ゾーンの可用性: シングルゾーン(デモの費用を節約するため)

[インスタンスを作成] ボタンをクリックして、Cloud SQL データベースをデプロイします。⌛ 完了までに 10 分ほどかかります ⌛。その間に、ドキュメントを読み進めてください。また、次のモジュール(「PHP アプリをコンテナ化する」)は、最初の部分(DB 接続を修正するまで)ではこのモジュールに依存していないため、次のモジュールの解決を開始することもできます。

注: このインスタンスの費用は 1 日あたり約 7 ドルです。ワークショップの終了後に必ずスピンオフしてください。

Cloud SQL で image_catalog DB とユーザーを作成する

App プロジェクトには、2 つの SQL ファイルを含む db/ フォルダが付属しています。

  1. 01_schema.sql: ユーザーと画像のデータを含む 2 つのテーブルを作成する SQL コードが含まれています。
  2. 02_seed.sql: 以前に作成したテーブルにデータをシードする SQL コードが含まれています。

これらのファイルは、image_catalog データベースが作成された後に使用されます。手順は次のとおりです。

  1. インスタンスを開き、[データベース] タブをクリックします。
  2. [データベースを作成] をクリックします。
  3. image_catalog という名前を付けます(PHP アプリの構成と同様)。

997ef853e5ebd857.png

次に、データベース ユーザーを作成します。これにより、image_catalog データベースに対して認証を行うことができます。

  1. [Users] タブをクリックします。
  2. [ユーザー アカウントを追加] をクリックします。
  3. ユーザー: 作成しましょう。
  • ユーザー名: appmod-phpapp-user
  • パスワード: 覚えやすいパスワードを選択するか、[生成] をクリックします。
  • [すべてのホストを許可する(%)] のままにします。
  1. [追加] をクリックします。

既知の IP に DB を開く。

Cloud SQL のすべての DB は「分離」された状態で作成されます。アクセス可能なネットワークを明示的に設定する必要があります。

  1. インスタンスをクリックします。
  2. [接続] メニューを開きます。
  3. [ネットワーキング] タブをクリックします。
  4. [承認済みネットワーク] の下をクリックします。次に、ネットワーク(サブネット)を追加します。
  • ここでは、アプリを動作させるために、迅速ではあるものの安全ではない設定を選択します。後で、信頼できる IP に制限することをおすすめします。
  • 名前: 「世界中のすべての人 - 安全でない」。
  • ネットワーク: "0.0.0.0/0"(注: これは安全でない部分です!)
  • [完了] をクリックします。
  1. [保存] をクリックします。

次のように表示されます。

5ccb9062a7071964.png

注: このソリューションは、ワークショップを O(時間)で完了するための適切な妥協案です。ただし、本番環境でソリューションを保護するために、セキュリティ ドキュメントを確認してください。

DB 接続をテストする

以前に作成した image_catalog ユーザーが機能するかどうかを確認してみましょう。

インスタンス内の「Cloud SQL Studio」にアクセスし、以下に示すように、認証するデータベース、ユーザー、パスワードを入力します。

d56765c6154c11a4.png

ログインしたら、SQL エディタを開いて次のセクションに進みます。

コードベースからデータベースをインポートする

SQL エディタを使用して、image_catalog テーブルとそのデータをインポートします。リポジトリ内のファイル(01_schema.sql、02_seed.sql)から SQL コードをコピーし、順番に実行します。

この後、以下に示すように、image_catalog に users と images の 2 つのテーブルが作成されます。

65ba01e4c6c2dac0.png

エディタで select * from images; を実行してテストできます。

また、Cloud SQL インスタンスのパブリック IP アドレスをメモしておいてください。後で必要になります。IP を取得するには、[概要] ページにある Cloud SQL インスタンスのメインページに移動します。([概要] > [このインスタンスに接続] > [パブリック IP アドレス])。

4. モジュール 2: PHP アプリをコンテナ化する

e7f0e9979d8805f5.png

このアプリをクラウド向けに構築したいと考えています。

つまり、クラウドで実行するために必要なすべての情報を含む ZIP ファイルにコードをパッケージ化します。

パッケージ化にはいくつかの方法があります。

  • Docker。非常に人気がありますが、正しく設定するにはかなり複雑です。
  • Buildpack。あまり一般的ではありませんが、何をビルドして何を実行するかを「自動推測」する傾向があります。多くの場合、問題なく動作します。

このワークショップでは、Docker を使用することを前提としています。

Cloud Shell を使用する場合は、ここで再度開きます(Cloud コンソールの右上をクリックします)。

ec6a6b90b39e03e.png

ページの下部に便利なシェルが開きます。設定手順でコードをフォークした場所です。

6999b906c0dedeb7.png

Docker

制御を必要とする場合は、このソリューションが適しています。これは、特定のライブラリを構成する必要があり、特定の明確でない動作(アップロードでの chmod、アプリでの非標準の実行可能ファイルなど)を挿入する必要がある場合に適しています。

最終的にコンテナ化されたアプリケーションを Cloud Run にデプロイするため、次のドキュメントを確認してください。PHP 8 から PHP 5.7 にバックポートするにはどうすればよいですか?Gemini を使ってみてはどうでしょうか。または、次の事前作成バージョンを使用することもできます。

# Use the official PHP image: https://hub.docker.com/_/php
FROM php:5.6-apache

# Configure PHP for Cloud Run.
# Precompile PHP code with opcache.
# Install PHP's extension for MySQL
RUN docker-php-ext-install -j "$(nproc)" opcache mysqli pdo pdo_mysql && docker-php-ext-enable pdo_mysql

RUN set -ex; \
  { \
    echo "; Cloud Run enforces memory & timeouts"; \
    echo "memory_limit = -1"; \
    echo "max_execution_time = 0"; \
    echo "; File upload at Cloud Run network limit"; \
    echo "upload_max_filesize = 32M"; \
    echo "post_max_size = 32M"; \
    echo "; Configure Opcache for Containers"; \
    echo "opcache.enable = On"; \
    echo "opcache.validate_timestamps = Off"; \
    echo "; Configure Opcache Memory (Application-specific)"; \
    echo "opcache.memory_consumption = 32"; \
  } > "$PHP_INI_DIR/conf.d/cloud-run.ini"

# Copy in custom code from the host machine.
WORKDIR /var/www/html

COPY . .

# Setup the PORT environment variable in Apache configuration files: https://cloud.google.com/run/docs/reference/container-contract#port
ENV PORT=8080

# Tell Apache to use 8080 instead of 80.
RUN sed -i 's/80/${PORT}/g' /etc/apache2/sites-available/000-default.conf /etc/apache2/ports.conf

# Note: This is quite insecure and opens security breaches. See last chapter for hardening ideas.
# Uncomment at your own risk:
#RUN chmod 777 /var/www/html/uploads/

# Configure PHP for development.
# Switch to the production php.ini for production operations.
# RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
# https://github.com/docker-library/docs/blob/master/php/README.md#configuration
RUN mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini"

# Expose the port
EXPOSE 8080

最新の Dockerfile バージョンはこちらから入手できます。

アプリケーションをローカルでテストするには、PHP アプリが Google Cloud SQL で利用可能な MYSQL データベースに接続するように config.php ファイルを変更する必要があります。これまでに設定した内容に基づいて、空欄に入力してください。

<?php
// Database configuration
$db_host = '____________';
$db_name = '____________';
$db_user = '____________';
$db_pass = '____________';

try {
    $pdo = new PDO("mysql:host=$db_host;dbname=$db_name", $db_user, $db_pass);
    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
} catch (PDOException $e) {
    die("Errore di connessione: " . $e->getMessage());
}

session_start();
?>
  • DB_HOST は Cloud SQL のパブリック IP アドレスです。SQL コンソールで確認できます。

bd27071bf450a8d0.png

  • DB_NAME は変更しないでください。image_catalog
  • DB_USER は appmod-phpapp-user にしてください
  • DB_PASS は、あなたが選択したものです。一重引用符で囲み、必要に応じてエスケープします。

また、Gemini を使って、イタリア語の数曲を英語に翻訳することもできます。

Dockerfile を取得し、DB に接続するように PHP アプリを構成したので、試してみましょう。

Docker をまだインストールしていない場合は、インストールします(リンク)。Cloud Shell を使用している場合は、この操作を行う必要はありません。

次に、適切な docker build コマンドと run コマンドを使用して、コンテナ化された PHP アプリをビルドして実行してみます。

# Build command - don't forget the final . This works if Dockerfile is inside the code folder:
$ docker build -t my-php-app-docker .   

# Local Run command: most likely ports will be 8080:8080
$ docker run -it -p <CONTAINER_PORT>:<LOCAL_MACHINE_PORT> my-php-app-docker

すべてが正常に機能している場合、ローカルホストに接続すると次のウェブページが表示されます。アプリがポート 8080 で実行されているので、[ウェブでプレビュー] アイコン(目の付いたブラウザ)をクリックし、[ポート 8080 でプレビュー](または他のポートの場合は [ポートを変更])をクリックします。

33a24673f4550454.png

ブラウザで結果をテストする

アプリケーションは次のようになります。

2718ece96b1f18b6.png

Admin/admin123 でログインすると、次のように表示されます。

68b62048c2e86aea.png

すごい!イタリア語のテキスト以外は、正常に動作しています。🎉🎉🎉

Docker 化は適切に行われているものの、DB 認証情報が間違っている場合は、次のようなメッセージが表示されることがあります。

e22f45b79bab86e1.png

惜しいです。もう一度お試しください。

Artifact Registry への保存 [省略可]

これで、コンテナ化された PHP アプリケーションが動作し、クラウドにデプロイする準備が整いました。次に、Docker イメージを保存し、Cloud Run などの Google Cloud サービスにデプロイできるように、クラウドに保存場所を用意する必要があります。このストレージ ソリューションは Artifact Registry と呼ばれ、Docker コンテナ イメージ、Maven パッケージ、npm モジュールなどのアプリケーション アーティファクトを保存するために設計されたフルマネージドの Google Cloud サービスです。

適切なボタンを使用して、Google Cloud Artifact Registry にリポジトリを作成しましょう。

e1123f0c924022e6.png

有効な名前、形式、アーティファクトの保存に適したリージョンを選択します。

4e516ed209c470ee.png

ローカル開発環境に戻り、アプリのコンテナ イメージにタグを付けて、作成した Artifact Registry リポジトリに push します。次のコマンドを実行します。

  • docker tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG]
  • docker push TARGET_IMAGE[:TAG]

結果は次のスクリーンショットのようになります。

1e498feb4e88be9f.png

おめでとうございます 🎉🎉🎉。次のレベルに進むことができます。それまでに、2 分ほどかけてアップロード、ログイン、ログアウトを試し、アプリのエンドポイントに慣れておいてください。これらは後で必要になります。

発生する可能性があるエラー

コンテナ化エラーが発生した場合は、Gemini を使用してエラーの説明と修正を試み、次の情報を提供します。

  • 現在の Dockerfile
  • 発生したエラー
  • [必要に応じて] 実行されている PHP コード。

アップロード権限。/upload.php エンドポイントを試して、画像をアップロードしてみてください。以下のエラーが表示されることがあります。その場合は、Dockerfile で chmod/chown の修正を行う必要があります。

Warning: move_uploaded_file(uploads/image (3).png): failed to open stream: Permission denied in /var/www/html/upload.php on line 11

PDOException "could not find driver"(または "Errore di connessione: could not find driver")。Dockerfile に、DB に接続するための適切な mysql(pdo_mysql)用 PDO ライブラリがあることを確認します。こちらのソリューションを参考にしてください。

リクエストをバックエンドに転送できません。ポート 8080 のサーバーに接続できませんでした。これは、間違ったポートを公開している可能性があることを意味します。Apache / Nginx が実際に提供しているポートを公開していることを確認してください。これは簡単なことではありません。可能であれば、ポート 8080 に設定します(Cloud Run での作業が簡単になります)。ポート 80 を維持したい場合(Apache がそのように設定している場合など)は、別のコマンドを使用して実行します。

$ docker run -it -p 8080:80 # force 80

# Use the PORT environment variable in Apache configuration files.

# https://cloud.google.com/run/docs/reference/container-contract#port

RUN sed -i 's/80/${PORT}/g' /etc/apache2/sites-available/000-default.conf /etc/apache2/ports.conf

5. モジュール 3: Cloud Run にアプリをデプロイする

9ffca42774f6c5d1.png

Cloud Run を選ぶ理由

ごもっともな質問です。数年前であれば、Google App Engine を選択していたでしょう。

簡単に言うと、現在の Cloud Run は、より新しい技術スタックを備え、デプロイが簡単で、費用が安く、使用しないときは 0 までスケールダウンします。ステートレス コンテナを柔軟に実行でき、さまざまな Google Cloud サービスと統合できるため、最小限のオーバーヘッドと最大限の効率でマイクロサービスや最新のアプリケーションをデプロイするのに最適です。

具体的には、Cloud Run は Google Cloud のフルマネージド プラットフォームであり、サーバーレス環境でステートレスなコンテナ化アプリケーションを実行できます。すべてのインフラストラクチャを自動的に処理し、受信トラフィックに合わせてゼロからスケールアップし、アイドル状態のときはスケールダウンするため、費用対効果が高く効率的です。Cloud Run は、コンテナにパッケージ化されている限り、あらゆる言語やライブラリをサポートしているため、開発の柔軟性が大幅に向上します。他の Google Cloud サービスとの統合性に優れており、サーバー インフラストラクチャを管理することなく、マイクロサービス、API、ウェブサイト、イベント ドリブン アプリケーションを構築するのに適しています。

前提条件

このタスクを完了するには、ローカルマシンに gcloud がインストールされている必要があります。表示されない場合は、こちらの手順をご覧ください。Google Cloud Shell を使用している場合は、何もする必要はありません。

デプロイする前に...

ローカル環境で作業している場合は、次のコマンドを使用して Google Cloud に対する認証を行います。

  • $ gcloud auth login –update-adc # not needed in Cloud Shell

これにより、ブラウザで OAuth ログインを介して認証されます。Google Cloud にログインして課金を有効にしているユーザー(例: vattelapesca@gmail.com)と同じユーザーで Chrome にログインしていることを確認します。

次のコマンドを使用して Cloud Run API を有効にします。

  • $ gcloud services enable run.googleapis.com cloudbuild.googleapis.com

この時点で、Cloud Run にデプロイする準備がすべて整いました。

gcloud を使用してアプリを Cloud Run にデプロイする

Cloud Run にアプリをデプロイするためのコマンドは gcloud run deploy です。目標を達成するために設定できるオプションはいくつかあります。最小限のオプション セット(コマンドラインで指定するか、ツールがインタラクティブ プロンプトで尋ねる)は次のとおりです。

  1. Cloud Run サービスの名前: アプリ用にデプロイする Cloud Run サービスの名前。Cloud Run サービスは、アプリのエンドポイントを提供する URL を返します。
  2. アプリが実行される Google Cloud リージョン。(--region リージョン)
  3. アプリをラップするコンテナ イメージ。
  4. アプリの実行中に使用する必要がある環境変数。
  5. Allow-Unauthenticated フラグ。これを使用すると、追加の認証なしで誰でもアプリにアクセスできるようになります。

このオプションをコマンドラインに適用する方法については、ドキュメントをご覧ください(または、下にスクロールして考えられる解決策をご覧ください)。

デプロイには数分かかります。すべてが正しく設定されていれば、Google Cloud コンソールに次のように表示されます。

ef1029fb62f8de81.pngf7191d579c21ca3e.png

Cloud Run から提供された URL をクリックして、アプリケーションをテストします。認証されると、次のように表示されます。

d571a90cd5a373f9.png

引数なしの「gcloud run deploy」

gcloud run deploy が適切な質問をして、空白を埋めていることにお気づきかもしれません。この盛り上がり!

ただし、いくつかのモジュールでは、このコマンドを Cloud Build トリガーに追加するため、インタラクティブな質問はできません。コマンドのすべてのオプションを入力する必要があります。ゴールデン gcloud run deploy --option1 blah --foo bar --region your-fav-region を作成したいと考えています。どうすればよいですか。

  1. gcloud からの質問がなくなるまで、手順 2 ~ 4 を繰り返します。
  2. [LOOP] gcloud run deploy(これまでに検出されたオプションを含む)
  3. [LOOP] システムがオプション X を要求する
  4. [LOOP] CLI からオプション --my-option [my-value] を追加して X を設定する方法を公開ドキュメントで検索します。
  5. gcloud がこれ以上質問せずに完了しない限り、ステップ 2 に戻ります。
  6. この gcloud run deploy BLAH BLAH BLAH は素晴らしいです。このコマンドは、後の Cloud Build のステップで必要になるため、どこかに保存しておいてください。

考えられる解決策はこちらにあります。ドキュメントはこちらをご覧ください。

おめでとうございます。🎉🎉🎉 Google Cloud にアプリをデプロイし、モダナイゼーションの最初のステップを完了しました。

6. モジュール 4: Secret Manager でパスワードをクリーンアップする

95cd57b03b4e3c73.png

前のステップでは、Cloud Run にアプリをデプロイして正常に実行できました。ただし、一部のシークレットをクリアテキストで提供するという、セキュリティのバッド プラクティスを使用しました。

最初のイテレーション: ENV を使用するように config.php を更新する

config.php ファイルのコードにデータベースのパスワードを直接記述していることにお気づきかもしれません。これはテスト目的や、アプリが動作するかどうかを確認する場合には問題ありません。しかし、本番環境では、そのようなコードを commit したり使用したりすることはできません。パスワード(およびその他の DB 接続パラメータ)は動的に読み取られ、実行時にアプリに提供される必要があります。config.php ファイルを変更して、ENV 変数からデータベース パラメータを読み取るようにします。失敗した場合は、デフォルト値の設定を検討してください。これは、ENV の読み込みに失敗した場合に便利です。ページの出力で、デフォルト値が使用されているかどうかがわかります。空白を埋めて、config.php のコードを置き換えます。

<?php
// Database configuration with ENV variables. Set default values as well 
$db_host = getenv('DB_HOST') ?: 'localhost';
$db_name = getenv('DB_NAME') ?: 'image_catalog';
$db_user = getenv('DB_USER') ?: 'appmod-phpapp-user';
$db_pass = getenv('DB_PASS') ?: 'wrong_password';
// Note getenv() is PHP 5.3 compatible
try {
    $pdo = new PDO("mysql:host=$db_host;dbname=$db_name", $db_user, $db_pass);
    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
} catch (PDOException $e) {
    die("Errore di connessione: " . $e->getMessage());
}

session_start();
?>

アプリはコンテナ化されているため、ENV 変数をアプリに提供する方法を指定する必要があります。これには、次のいくつかの方法があります。

  • ビルド時に Dockerfile で。ENV DB_VAR=ENV_VAR_VALUE 構文を使用して、前の Dockerfile に 4 つのパラメータを追加します。これにより、実行時にオーバーライドできるデフォルト値が設定されます。たとえば、「DB_NAME」と「DB_USER」は、他の場所ではなく、ここで設定できます。
  • 実行時。これらの変数は、CLI または UI から Cloud Run に設定できます。4 つの変数をすべて配置するのに適した場所です(Dockerfile で設定されたデフォルト値を維持する場合を除く)。

localhost では、ENV 変数を .env ファイルに配置することをおすすめします(solutions フォルダを確認してください)。

また、.env が .gitignore に追加されていることを確認してください。シークレットを GitHub に push しないようにするためです。

echo .env >> .gitignore

その後、インスタンスをローカルでテストできます。

docker run -it -p 8080:8080 --env-file .env my-php-app-docker

これで、次のことが完了しました。

  1. アプリは ENV から変数を動的に読み取ります
  2. コードからデータベースのパスワードを削除したため、セキュリティが向上しました。

これで、Cloud Run に新しいリビジョンをデプロイできるようになりました。UI に移動して、環境変数を手動で設定しましょう。

  • https://console.cloud.google.com/run に移動します。
  • アプリをクリックします。
  • [新しいリビジョンの編集とデプロイ] をクリックします。
  • 最初のタブ [コンテナ] で、下部のタブ [変数とシークレット] をクリックします。
  • [+ 変数を追加] をクリックして、必要な変数をすべて追加します。最終的に次のようになります。

7a5fbfa448544d3.pngf2780c35585388ca.png

これで完璧でしょうか?いいえ。PASS はほとんどのオペレーターに表示されます。この問題は、Google Cloud Secret Manager で軽減できます。

2 回目のイテレーション: Secret Manager

パスワードがコードから消えました。成功です。しかし、これで安全になったのでしょうか?

パスワードは、Google Cloud コンソールにアクセスできるユーザーに引き続き表示されます。実際、Cloud Run YAML デプロイ ファイルにアクセスすると、この情報を取得できます。また、新しい Cloud Run リビジョンを編集またはデプロイしようとすると、以下のスクリーンショットに示すように、[変数とシークレット] セクションにパスワードが表示されます。

Google Cloud の Secret Manager は、API キー、パスワード、証明書、その他のシークレットなどの機密情報を管理するための安全な一元化されたサービスです。

きめ細かい権限と堅牢な暗号化により、シークレットの保存、管理、アクセスを可能にします。Secret Manager は Google Cloud の Identity and Access Management(IAM)と統合されており、特定のシークレットにアクセスできるユーザーを制御できるため、データ セキュリティと規制遵守を確保できます。

また、シークレットの自動ローテーションとバージョン管理もサポートしているため、シークレットのライフサイクル管理が簡素化され、Google Cloud サービス全体のアプリケーションのセキュリティが強化されます。

Secret Manager にアクセスするには、ハンバーガー メニューから [セキュリティ] サービスに移動し、下のスクリーンショットに示すように [データ保護] セクションで探します。

6df83a1c3cb757f6.png

次の画像のように、Secret Manager API を有効にします。

a96c312e2c098db1.png

  • [シークレットを作成] をクリックします。わかりやすい名前を付けましょう。
  • 名前: php-amarcord-db-pass
  • Secret 値: 「DB のパスワード」(「ファイルをアップロード」の部分は無視してください)。
  • このシークレット リンクにアノテーションを付けます。projects/123456789012/secrets/php-amarcord-db-pass のようになります。これは、シークレットの一意のポインタです(Terraform、Cloud Run など)。この番号は、一意のプロジェクト番号です。

ヒント: シークレットには一貫した命名規則を使用し、左から右に特化するようにしてください。例: cloud-devrel-phpamarcord-dbpass

  • 組織(会社)
  • チーム(組織内)
  • アプリケーション(チーム内)
  • 変数名(アプリ内)

これにより、簡単な正規表現を使用して、1 つのアプリのすべてのシークレットを検索できます。

新しい Cloud Run リビジョンを作成する

新しい Secret が用意できたので、DB_PASS 環境変数を削除して、新しい Secret に置き換える必要があります。それによって次のようになります。

  • Google Cloud コンソールを使用した Cloud Run へのアクセス
  • アプリを選択します。
  • [Edit & Deploy a New Revision] をクリックします。
  • [変数とシークレット] タブを見つけます。
  • [+ Secret を参照] ボタンを使用して、DB_PASS 環境変数をリセットします。
  • 参照される Secret に同じ「DB_PASS」を使用し、最新バージョンを使用します。

9ed4e35be7654dcb.png

完了すると、次のエラーが表示されます。

da0ccd7af39b04ed.png

修理方法を調べてみます。この問題を解決するには、[IAM と管理] セクションにアクセスして、付与する権限を変更する必要があります。デバッグをお楽しみください。

原因が判明したら、Cloud Run に戻り、新しいリビジョンを再デプロイします。結果は次の図のようになります。

e89f9ca780169b6b.png

ヒント: Developer Console(UI)は、権限の問題を指摘するのに適しています。時間をかけて、Cloud エンティティのすべてのリンクに移動してください。

7. モジュール 5: Cloud Build を使用して CI / CD を設定する

ba49b033c11be94c.png

CI / CD パイプラインが必要な理由

これまでに、gcloud run deploy を数回入力し、同じ質問に何度も答えたことがあるかもしれません。

gcloud run deploy を使用してアプリを手動でデプロイすることにうんざりしていませんか?Git リポジトリに新しい変更を push するたびに、アプリが自動的にデプロイされたら便利だと思いませんか?

CI / CD パイプラインを使用するには、次の 2 つが必要です。

  1. 個人の Git リポジトリ: 幸い、ステップ 2 でワークショップ リポジトリを GitHub アカウントにフォークしているはずです。まだの場合は、戻ってその手順を完了してください。フォークされたリポジトリは次のようになります。https://github.com/<YOUR_GITHUB_USER>/app-mod-workshop
  2. Cloud Build。この素晴らしい安価なサービスを使用すると、Terraform、Docker 化されたアプリなど、ほぼすべてのビルド自動化を構成できます。

このセクションでは、Cloud Build の設定に焦点を当てます。

Cloud Build の登場

これを行うには、Cloud Build を使用します。

  • ソースをビルドする(Dockerfile を使用)。これは、ビルドと実行に必要なすべてのもの(「ビルド アーティファクト」)を含む「大きな .zip ファイル」のようなものです。
  • このアーティファクトを Artifact Registry(AR)に push します。
  • 次に、AR から Cloud Run にアプリ「php-amarcord」のデプロイを発行します。
  • これにより、既存のアプリの新しいバージョン(「リビジョン」)が作成されます(新しいコードを含むレイヤと考えてください)。push が成功すると、トラフィックが新しいバージョンに転送されるように構成されます。

php-amarcord アプリのビルドの例を次に示します。

f30f42d4571ad5e2.png

これらすべてをどのように実現するのでしょうか。

  1. 1 つの完璧な YAML ファイルを作成する: cloudbuild.yaml
  2. Cloud Build ビルドトリガーを作成する。
  3. Cloud Build UI を介して GitHub リポジトリに接続する。

トリガーを作成する(リポジトリを接続する)

  • https://console.cloud.google.com/cloud-build/triggers に移動します。
  • [トリガーを作成] をクリックします。
  • コンパイル:
  • 名前: on-git-commit-build-php-app のようなわかりやすい名前
  • イベント: ブランチに push する
  • ソース: 「新しいリポジトリに接続」代替テキスト
  • 右側に [リポジトリを接続] ウィンドウが開きます。
  • ソース プロバイダ: 「Github」(最初)
  • 「続けて」
  • [Authenticate] をクリックすると、GitHub のウィンドウが開き、相互認証が行われます。フローに沿って、辛抱強く対応します。リポジトリが多い場合は、時間がかかることがあります。
  • [Select repo] でアカウント / リポジトリを選択し、[I understand...] の部分にチェックを入れます。
  • 「GitHub アプリは、どのリポジトリにもインストールされていません」というエラーが表示された場合は、[Google Cloud Build をインストール] をクリックして、手順に沿って操作します。
  • 23e0e0f1219afea3.png[接続] をクリックします。
  • bafd904ec07122d2.png
  • 当たり!リポジトリが接続されました。
  • トリガー部分に戻ります。
  • 構成: 自動検出(*)
  • [詳細]: サービス アカウント「[PROJECT_NUMBER]- compute@developer.gserviceaccount.com」を選択します。
  • xxxxx はプロジェクト ID です。
  • デフォルトのコンピューティング サービス アカウントは、ラボのアプローチには適していますが、本番環境では使用しないでください。(詳細)。
  • その他の設定はすべてそのままにします。
  • [作成] ボタンをクリックします。

(*)これは、Dockerfile または cloudbuild.yaml を確認する最も簡単な方法です。ただし、cloudbuild.yaml を使用すると、どのステップで何を行うかを決定できます。

パワーを手に入れた!

Cloud Build サービス アカウント(サービス アカウントとは、タスクを代行する「ロボット」のメールアドレス。この場合は、クラウドでビルドを行うロボットです。

SA がビルドとデプロイを行えるように権限を付与しないと、SA はビルドとデプロイを行えません。幸い、これは簡単に解決できます。

  • [Cloud Build] > [設定] に移動します。
  • "[PROJECT_NUMBER]- compute@developer.gserviceaccount.com" サービス アカウント
  • 次のチェックボックスをオンにします。
  • Cloud Run
  • Secret Manager
  • サービス アカウント
  • Cloud Build
  • [優先サービス アカウントとして設定] もオンにします。

8715acca72286a46.png

Cloud Build YAML はどこにありますか?

独自の Cloud Build YAML の作成に時間をかけることを強くおすすめします。

ただし、時間がない場合や、時間をかけたくない場合は、ソリューション フォルダ .solutions でヒントを得ることができます。

これで、変更を GitHub に push して、Cloud Build の動作を確認できるようになりました。

Cloud Build の設定は複雑になることがあります。次のようなやり取りが予想されます。

  • https://console.cloud.google.com/cloud-build/builds;region=global でログを確認する
  • エラーの確認。
  • コードを修正し、git commit / git push を再発行する。
  • エラーがコードではなく、構成にある場合もあります。その場合は、UI([Cloud Build] > [トリガー] > [実行])から新しいビルドを発行できます。

97acd16980a144ab.png

このソリューションを使用する場合でも、まだいくつかの作業が必要です。たとえば、新しく作成した dev/prod エンドポイントの ENV 変数を設定する必要があります。

3da8723e4ff80c0a.png

作成する方法は次の 2 つです。

  • UI を使用 - ENV 変数を再度設定する
  • CLI を介して、最適なスクリプトを作成する。例については、gcloud-run-deploy.sh をご覧ください。エンドポイントやプロジェクト番号など、いくつかの調整が必要です。プロジェクト番号は Cloud の概要で確認できます。

GitHub にコードを commit するにはどうすればよいですか?

GitHub に git push する最適な方法を説明することは、このワークショップの範囲外です。ただし、Cloud Shell で行き詰まった場合は、次の 2 つの方法があります。

  1. CLI。SSH 認証鍵をローカルに追加し、git@github.com:YOUR_USER/app-mod-workshop.git(http ではなく)を使用してリモートを追加します。
  2. VSCode。Cloud Shell エディタを使用する場合は、[ソース管理](Ctrl+Shift+G)タブを使用し、[変更を同期] をクリックして、手順に沿って操作します。GitHub アカウントを VS Code で認証すれば、そこから pull や push を簡単に行えるようになります。

f0d53f839c7fa3b6.png

他のファイルの中で git add clodubuild.yaml を忘れないでください。そうしないと機能しません。

「開発 / 本番環境の一致」の深さ [省略可]

こちらからモデル バージョンをコピーした場合は、DEV バージョンと PROD バージョンが同一になります。これは素晴らしいことで、The Twelve-Factor App のルール 10 に沿っています。

ただし、2 つの異なるウェブ エンドポイントを使用して、アプリが同じデータベースを指すようにしています。これはワークショップには十分ですが、実際の環境では、適切な本番環境の作成に時間をかける必要があります。つまり、2 つのデータベース(開発用と本番環境用)を用意し、障害復旧 / 高可用性のためにそれらを配置する場所を選択します。これはこのワークショップの範囲外ですが、参考までに紹介します。

「詳細」バージョンの本番環境を作成する時間がある場合は、複製する必要があるすべてのリソースを考慮してください。

  • Cloud SQL データベース(およびおそらく SQL インスタンス)。
  • GCS バケット
  • Cloud Functions。
  • 開発環境では Gemini 1.5 Flash(より安価で高速)をモデルとして使用し、Gemini 1.5 Pro(より強力)を使用することもできます。

一般的に、アプリに対して何かを行うたびに、本番環境に同じ値が必要かどうかを批判的に考える必要があります。そうでない場合は、同じ作業を繰り返します。もちろん、Terraform を使用すると、環境(-dev、-prod)をリソースのサフィックスとして挿入できるため、この作業ははるかに簡単になります。

8. モジュール 6: Google Cloud Storage に移行する

a680e0f287dd2dfb.png

ストレージ

dc3a4b8ea92aaef6.png

現在、アプリは状態を Docker コンテナに保存しています。マシンが故障したり、アプリがクラッシュしたり、単に新しいリビジョンを push したりすると、新しいリビジョンがスケジュールされ、新しい空のストレージが作成されます。🙈

この問題を解決するには、さまざまなアプローチがあります。

  1. 画像を DB に保存する。以前の PHP アプリでは、最終的にそうしました。複雑さが増さないため、これが最も簡単な解決策です。しかし、DB のレイテンシと負荷が増加することは間違いありません。
  2. Cloud Run アプリをストレージに適したソリューション(GCE + 永続ディスク)に移行しますか?GKE + Storage でしょうか?注: 制御性が向上する一方で、俊敏性は低下します。
  3. GCS に移動します。Google Cloud Storage は、Google Cloud 全体で最高水準のストレージを提供し、最もクラウドに適したソリューションです。ただし、PHP ライブラリを扱う必要があります。GCS 用の PHP 5.7 ライブラリはありますか?PHP 5.7 は Composer をサポートしていますか(Composer でサポートされている最も古いバージョンは PHP 5.3.2 のようです)。
  4. Docker サイドカーを使用する。
  5. または、GCS の Cloud Run ボリューム マウントを使用します。これは素晴らしいですね。

🤔 ストレージの移行(自由回答)

[自由回答] この演習では、画像をなんらかの方法で永続化して移動するソリューションを見つけてください。

受け入れテスト

解決策を教えるのではなく、次のような結果を求めています。

  1. newpic.jpg をアップロードします。アプリに表示されます。
  2. アプリを新しいバージョンにアップグレードする。
  3. newpic.jpg は引き続き表示されます。

💡 可能な解決策(GCS Cloud Run ボリューム マウント)

これは非常に洗練されたソリューションであり、コードにまったく手を加えることなく、ステートフルなファイル アップロードを実現できます(画像の説明を表示する部分は除きますが、これは些細なことで、見た目を良くするためだけのものです)。

これにより、Cloud Run から GCS にフォルダをマウントできるようになります。

  1. GCS にアップロードされたすべてのファイルが、アプリに表示されます。
  2. アプリへのアップロードはすべて、実際には GCS にアップロードされます。
  3. GCS にアップロードされたオブジェクトに魔法がかけられます(第 7 章)。

注: FUSE の詳細をお読みください。パフォーマンスが問題となる場合は、これは適切ではありません。

GCS バケットを作成する

GCS は、Google Cloud のどこにでも存在するストレージ サービスです。これは実証済みであり、ストレージを必要とするすべての GCP サービスで使用されています。

Cloud Shell は PROJECT_ID を GOOGLE_CLOUD_PROJECT としてエクスポートします。

$ export PROJECT_ID=$GOOGLE_CLOUD_PROJECT

#!/bin/bash

set -euo pipefail

# Your Cloud Run Service Name, eg php-amarcord-dev
SERVICE_NAME='php-amarcord-dev'
BUCKET="${PROJECT_ID}-public-images"
GS_BUCKET="gs://${BUCKET}"

# Create bucket
gsutil mb -l "$GCP_REGION" -p "$PROJECT_ID" "$GS_BUCKET/"

# Copy original pictures there - better if you add an image of YOURS before.
gsutil cp ./uploads/*.png "$GS_BUCKET/"

/uploads/ フォルダにバケットをマウントするように Cloud Run を構成する

ここからが洗練された部分です。ボリューム php_uploads を作成し、MOUNT_PATH(/var/www/html/uploads/ など)で FUSE マウントを行うように Cloud Run に指示します。

#!/bin/bash

set -euo pipefail

# .. keep variables from previous script..

# Uploads folder within your docker container.
# Tweak it for your app code.
MOUNT_PATH='/var/www/html/uploads/'

# Inject a volume mount to your GCS bucket in the right folder.
gcloud --project "$PROJECT_ID" beta run services update "$SERVICE_NAME" \
    --region $GCP_REGION \
    --execution-environment gen2 \
    --add-volume=name=php_uploads,type=cloud-storage,bucket="$BUCKET"  \
    --add-volume-mount=volume=php_uploads,mount-path="$MOUNT_PATH"

次に、Cloud Storage を参照するすべてのエンドポイントに対して、この手順を繰り返します。

UI からも同じことができます。

  1. [ボリューム] タブで、バケットを指すボリューム マウント(タイプは「Cloud Storage バケット」、名前は「php_uploads」など)を作成します。
  2. [コンテナ] > [ボリューム マウント] で、作成したボリュームをアプリからリクエストされたボリューム ポイントにマウントします。これは Dockerfile によって異なりますが、var/www/html/uploads/ のようになります。

いずれにしても、正常に動作すれば、新しい Cloud Run リビジョンを編集すると次のように表示されます。

6c2bb98fc1b0e077.png

新しいアプリケーションをテストして、1 つの新しい画像を /upload.php エンドポイントにアップロードします。

PHP を 1 行も記述することなく、画像が GCS にシームレスに流れるようにする必要があります。

70032b216afee2d7.png

何が起きたのでしょうか?

とても不思議なことが起こりました。

古いコードを含む古いアプリケーションがまだ動作しています。新しい最新のスタックにより、アプリ内のすべての画像 / 写真をステートフルな Cloud バケットに快適に保存できるようになりました。今や、可能性は無限大です。

  • 「危険」または「ヌード」の画像が届くたびにメールを送信したい場合は、これは、PHP コードに触れることなく行うことができます。
  • 画像が入力されるたびに Gemini マルチモーダル モデルを使用して画像を説明し、その説明とともに DB にアップロードしたい場合は、これは、PHP コードに触れることなく行うことができます。信じてくれないの?第 7 章に進んでください。

これにより、大きな可能性が開かれました。

9. モジュール 7: Google Gemini でアプリを強化する

c00425f0ad83b32c.png

これで、クラウド化されたストレージを備えた、最新の洗練された新しい PHP アプリ(2024 年の Fiat 126 のようなもの)が完成しました。

用途

前提条件

前の章では、モデル ソリューションを使用して GCS に画像 /uploads/ をマウントし、アプリ ロジックを画像ストレージから事実上分離しました。

この演習では、次の作業が必要です。

  • 第 6 章(ストレージ)の演習を完了している。
  • 画像アップロード用の GCS バケットを用意します。ユーザーがアプリに画像をアップロードすると、画像がバケットに転送されます。

Cloud Functions の関数を設定する(Python)

イベント ドリブン型のアプリケーションを実装する方法について考えたことはありますか?たとえば、次のように定義します。

  • <イベント> が発生したとき => メールを送信する
  • <event> が発生したとき => <condition> が true の場合、データベースを更新します。

イベントは、BigQuery で利用可能な新しいレコード、GCS のフォルダで変更された新しいオブジェクト、Pub/Sub のキューで待機している新しいメッセージなど、何でもかまいません。

Google Cloud は、これを実現するための複数のパラダイムをサポートしています。特に注目すべきは、

この演習では、Cloud Functions の関数を詳しく調べて、非常に優れた結果を得ます。また、オプションの演習も用意されています。

サンプルコードは .solutions/ で提供されています。

Cloud Functions の関数(🐍 Python)を設定する

私たちは、非常に野心的な GCF を作成しようとしています。

  1. GCS で新しいイメージが作成されると、(おそらく、誰かがアプリにアップロードしたためですが、それだけではありません)
  2. .. Gemini を呼び出して画像の説明を生成し、画像のテキスト形式の説明を取得します ..(MIME を確認して、PDF、MP3、テキストではなく画像であることを確認することをおすすめします)
  3. .. and update the DB with this description. (これには、DB にパッチを適用して images テーブルに description 列を追加することが必要になる場合があります)。

DB にパッチを適用して、description をイメージに追加します。

  1. Cloud SQL Studio を開きます。

b92b07c4cba658ef.png

  1. Images DB のユーザーとパスワードを入力します。
  2. 次の SQL を挿入して、画像の説明用の列を追加します。

ALTER TABLE images ADD COLUMN description TEXT;

3691aced78a6389.png

そして、ビンゴ!今すぐ試して、動作するかどうかを確認します。

SELECT * FROM images;

新しい説明列が表示されます。

bed69d6ad0263114.png

Gemini の f(x) を記述する

注: この関数は、実際には Gemini Code Assist の支援機能を使用して作成されました。

注: この関数を作成すると、IAM 権限エラーが発生する可能性があります。一部は、以下の「考えられるエラー」の段落に記載されています。

  1. API を有効にする
  2. https://console.cloud.google.com/functions/list に移動します。
  3. [関数を作成] をクリックします。
  4. API ウィザードから API を有効にします。

d22b82658cfd4c48.png

GCF は、UI またはコマンドラインから作成できます。ここではコマンドラインを使用します。

使用可能なコードは .solutions/ で確認できます。

  1. コードをホストするフォルダ(「gcf/」など)を作成します。フォルダを入力します。
  2. requirements.txt ファイルを作成します。
google-cloud-storage
google-cloud-aiplatform
pymysql
  1. Python 関数を作成します。サンプルコードは gcf/main.py にあります。
#!/usr/bin/env python

"""Complete this"""

from google.cloud import storage
from google.cloud import aiplatform
import vertexai
from vertexai.generative_models import GenerativeModel, Part
import os
import pymysql
import pymysql.cursors

# Replace with your project ID
PROJECT_ID = "your-project-id"
GEMINI_MODEL = "gemini-1.5-pro-002"
DEFAULT_PROMPT = "Generate a caption for this image: "

def gemini_describe_image_from_gcs(gcs_url, image_prompt=DEFAULT_PROMPT):
    pass

def update_db_with_description(image_filename, caption, db_user, db_pass, db_host, db_name):
    pass

def generate_caption(event, context):
    """
    Cloud Function triggered by a GCS event.
    Args:
        event (dict): The dictionary with data specific to this type of event.
        context (google.cloud.functions.Context): The context parameter contains
                                                event metadata such as event ID
                                                and timestamp.
    """
    pass
  1. 関数を push します。gcf/push-to-gcf.sh のようなスクリプトを使用できます。

注 1. ENV を正しい値でソースするか、上部(GS_BUCKET=blah、..)に追加してください。

注 2。これにより、すべてのローカルコード(.)が push されるため、コードを特定のフォルダに格納し、.gcloudignore をプロのように使用して、巨大なライブラリが push されないようにしてください。(例)。

#!/bin/bash

set -euo pipefail

# add your logic here, for instance:
source .env || exit 2 

echo "Pushing ☁️ f(x)☁ to 🪣 $GS_BUCKET, along with DB config.. (DB_PASS=$DB_PASS)"

gcloud --project "$PROJECT_ID" functions deploy php_amarcord_generate_caption \
    --runtime python310 \
    --region "$GCP_REGION" \
    --trigger-event google.cloud.storage.object.v1.finalized \
    --trigger-resource "$BUCKET" \
    --set-env-vars "DB_HOST=$DB_HOST,DB_NAME=$DB_NAME,DB_PASS=$DB_PASS,DB_USER=$DB_USER" \
    --source . \
    --entry-point generate_caption \
    --gen2

注: この例では、generate_caption が呼び出されるメソッドであり、Cloud Functions は関連するすべての情報(バケット名、オブジェクト名など)とともに GCS イベントをこのメソッドに渡します。このイベントの Python 辞書をデバッグする時間を取ってください。

関数のテスト

単体テスト

この関数には多くの可動部分があります。すべての単一のものをテストできるようにしたい場合があります。

例については、gcf/test.py をご覧ください。

Cloud Functions UI

また、UI で関数を確認してみてください。すべてのタブを調べる価値がありますが、特に Source(私のお気に入り)、Variables、Trigger、Logs は重要です。Logs では、エラーのトラブルシューティングに多くの時間を費やすことになります(このページの下部にある、発生する可能性のあるエラーもご覧ください)。また、Permissions も確認してください。

cf3ded30d532a2c7.png

E2E テスト

関数を手動でテストしてみましょう。

  1. アプリに移動してログインします。
  2. 画像をアップロードします(大きすぎないもの。大きな画像では問題が発生することがあります)。
  3. UI で写真がアップロードされていることを確認します。
  4. Cloud SQL Studio で、説明が更新されていることを確認します。ログインして、クエリ SELECT * FROM images を実行します。

43a680b12dbbdda0.png

そして、すでに高い効果が確認されています。また、その説明を表示するようにフロントエンドを更新することもできます。

PHP を更新して [省略可] を表示する

アプリが動作することは確認済みです。ただし、ユーザーもその説明を確認できると便利です。

index.php に説明を追加するために、PHP のエキスパートである必要はありません。このコードは次の処理を行います(これも Gemini が作成してくれました)。

<?php if (!empty($image['description'])): ?>
    <p class="font-bold">Gemini Caption:</p>
    <p class="italic"><?php echo $image['description']; ?></p>
<?php endif; ?>

このコードを foreach 内の任意の位置に配置します。

次のステップでは、Gemini Code Assist のおかげで、より洗練された UI バージョンも確認できます。整形されたバージョンは次のようになります。

fdc12de0c88c4464.png

まとめ

GCS に新しいオブジェクトが追加されると Cloud Functions の関数がトリガーされ、人間が行うように画像の内容にアノテーションを付け、データベースを自動的に更新します。すごい!

次のステップ: 同じ理由で、2 つの優れた機能を実現できます。

[省略可] その他の Cloud Functions を追加 [自由回答形式]

他にもいくつか機能が考えられます。

📩 メールトリガー

メールトリガー。誰かが写真を送信するたびにメールが送信されます。

  • 頻度が高すぎる?さらに制約を追加します。大きな画像、または Gemini コンテンツに「ヌード / 暴力」という単語が含まれている画像。
  • これについては EventArc を確認してください。

🚫 不適切な写真を自動的に管理

現在、人間の管理者が「不適切」な画像にフラグを付けています。Gemini に手間のかかる作業を任せて、スペースを管理してもらうのはどうでしょうか?不適切なトリガー コンテンツにフラグを立て、前の関数で学んだように DB を更新するテストを追加します。つまり、基本的には前の関数を取得し、プロンプトを変更して、回答に基づいて DB を更新します。

注意点。生成 AI の出力は予測不可能です。Gemini からの「クリエイティブな出力」が「レール上」に配置されていることを確認します。0 ~ 1 の信頼スコア、JSON などの決定論的な回答を求めることができます。これは、さまざまな方法で実現できます。たとえば、* Python ライブラリ pydantic、langchain などを使用する。* Gemini 構造化出力を使用する。

ヒント: 複数の関数を使用することも、JSON 形式の回答を強制する単一のプロンプトを使用することもできます(前述の「Gemini 構造化出力」でうまく機能します)。

これを生成するためのプロンプトはどのようなものになりますか。

{
    "description": "This is the picture of an arrosticino",
    "suitable": TRUE
}

プロンプトにフィールドを追加して、次のような分析情報を取得することもできます。悪い点この場所に見覚えはありますか?テキストがある場合(OCR がかつてないほど簡単に):

  • goods: 「美味しそうな食べ物ですね」
  • bads: 「不健康な食品のように見える」
  • OCR: 「Da consumare preferibilmente prima del 10 Novembre 2024」
  • location: "Pescara, Lungomare"

通常は N 個の結果に対して N 個の関数を用意する方がよいのですが、10 個の処理を行う関数を 1 つ作成することは非常に有意義です。方法については、Riccardo 氏によるこちらの記事をご覧ください。

発生する可能性のあるエラー(主に IAM / 権限)

このソリューションを最初に開発したとき、IAM 権限の問題が発生しました。共感を示し、解決方法のアイデアを提供するために、ここに記載します。

エラー: サービス アカウントに十分な権限がない

  1. GCS バケットをリッスンする GCF 関数をデプロイするには、図のように、ジョブに使用するサービス アカウントに適切な権限を設定する必要があります。

22f51012fa6b4a24.png

EventArc API を有効にする必要がある場合もあります。完全に利用可能になるまで数分かかります。

エラー: Cloud Run 起動元がない

  1. GCF 権限付与の UI からの別のコメントは次のとおりです(Cloud Run 起動元ロール)。

be72e17294f2d3f3.png

このエラーは、イメージでコマンドを実行することで解決できます。これは fix-permissions.sh と同様です。

この問題については、https://cloud.google.com/functions/docs/securing/authenticating で説明されています。

エラー: メモリ上限を超えています

最初に実行したとき、ログには「メモリ上限 244 MiB を超え、270 MiB が使用されました。メモリ上限の引き上げを検討してください。https://cloud.google.com/functions/docs/configuring/memory をご覧ください。ここでも、GCF に RAM を追加します。これは UI で非常に簡単に行うことができます。以下は、フォローアップの例です。

bed69d6ad0263114.png

または、Cloud Run デプロイ スクリプトを修正して MEM/CPU を増やすこともできます。この処理には少し時間がかかります。

エラー: PubSub が公開されました

GCF v1 でトリガーを作成すると、次のエラーが発生しました。

e5c338ee35ad4c24.png

この問題も、IAM に移動してサービス アカウントに「Pub/Sub パブリッシャー」ロールを付与することで簡単に解決できます。

エラー: Vertex AI が使用されていない

このエラーが表示された場合:

Permission Denied: 403 Vertex AI API has not been used in project YOUR_PROJECT before or it is disabled. 有効にするには、https://console.developers.google.com/apis/api/aiplatform.googleapis.com/overview?project=YOR_PROJECT にアクセスしてください。

Vertex AI API を有効にするだけで、必要な API をすべて有効にする最も簡単な方法は次のとおりです。

  1. https://console.cloud.google.com/vertex-ai
  2. [すべての推奨 API を有効にする] をクリックします。

492f05ac377f3630.png

エラー: EventArc トリガーが見つかりません。

このエラーが発生した場合は、関数を再デプロイしてください。

8ec4fc11833d7420.png

エラー: 400 サービス エージェントがプロビジョニングされています

400 個のサービス エージェントをプロビジョニングしています(https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)。指定された Cloud Storage ファイルを読み取るには、サービス エージェントが必要です。数分後にもう一度お試しください。

この場合は、しばらく待つか、Google 社員に問い合わせてください。

10. モジュール 8: 可用性 SLO を作成する

この章では、次のことを実現します。

  1. SLI の作成
  2. SLI に基づく SLO の作成
  3. SLO に基づくアラートの作成

f63426182c052123.png

Riccardo は Google Cloud の SRE / DevOps 分野で働いているため、これは著者にとって非常に関心の高いトピックです。

(自由回答)このアプリの SLI と SLO を作成する

アプリがダウンしたときにそれを知ることができなければ、アプリの価値は半減します。

SLO とは

偶然ですね。SLO は Google が考案したものです。詳細については、以下をご覧ください。

ステップ 1: 可用性 SLI / SLO を作成する

まずは、可用性 SLO から始めましょう。これは最も簡単で、おそらく最も重要な測定対象です。

幸いなことに、Cloud Run には Istio のおかげで、事前構築済みの SLO サポートが付属しています。

アプリが Cloud Run にデプロイされていれば、この作業は 30 秒で完了します。

  • [Cloud Run] ページに移動します。
  • アプリをクリックまたは選択します。
  • [SLOs] タブを選択します。
  • [+ SLO を作成] をクリックします。
  • 可用性、リクエスト ベース
  • 続行
  • 暦月 / 99%
  • 「SLO を作成」をクリックします。

e471c7ebdc56cdf6.png

ステップ 2: この SLO のアラートを設定する

次の 2 つのアラートを作成することをおすすめします。

  1. 1 つは、バーンレートが低い(「スローバーン」)場合にメールでアラートを送信する(優先度の低いチケットをシミュレートする)ためのものです。
  2. 1 つは、バーンレートが高い(「Fastburn」)場合に SMS でアラートを送信する(優先度の高いチケット / ページャーをシミュレートする)

先ほどの SLO tab に移動します。

この操作を 2 回行います。

314bfd6b9ef0a260.png

  • [SLO アラートを作成](右側のプラス記号付きの 🔔 ボタン)をクリックします。
  • ルックバック期間、バーンレートのしきい値:
  • [高速モード]。初回: 60 分 / 10 回
  • [SLOW]。2 回目: 720 分 / 2 回
  • 通知チャンネル: [通知チャンネルを管理] をクリックします。
  • まず、[メール] -> [新規追加] -> ..
  • 次に、[SMS] -> [新規追加] -> スマートフォンで確認します。
  • ヒント: 名前には絵文字を使用することをおすすめします。デモに最適です。
  • 完了したら、右上の大きな X をクリックします。
  • 最初に電話(迅速)、次にメール(低速)を選択します。
  • 次のようなサンプル ドキュメントを追加します。
  • [PHP Amarcord] Riccardo told me to type sudo reboot or to check documentation in http://example.com/playbooks/1.php but I guess he was joking。

当たり!

最終結果

1 つの SLO と 2 つのアラートが可用性に対して機能し、メールとスマートフォンにアラートが送信されるようになったら、この演習は完了です。

必要に応じて、レイテンシ(強く推奨)や、さらに複雑な指標を追加することもできます。レイテンシには、妥当と思われるレイテンシを選択します。判断に迷った場合は、[200ms] を選択します。

11. 次のステップ

すべて完了しているのに、何が足りないのでしょうか?

以下に、検討すべき点をいくつか挙げます。

Gemini で話しながらプレイ

Gemini は次の 2 つの方法で使用できます。

  1. Vertex AI。 「エンタープライズ向けの方法」は、第 7 章(GCF + Gemini)で説明したように、GCP と連携しています。すべての認証が魔法のように機能し、サービスが美しく相互接続されます。
  2. Google AI。「コンシューマー向けの方法」。こちらから Gemini API キーを取得し、すでに使用しているワークロード(独自のワーク、他のクラウド、ローカルホストなど)に関連付けることができる小さなスクリプトの作成を開始します。API キーを置き換えるだけで、コードが魔法のように動作し始めます。

ご自身の個人プロジェクトで(2)を試してみることをおすすめします。

UI のリフティング

UI は苦手です。しかし、Gemini は違います。1 つの PHP ページを取得して、次のように記述できます。

I have a VERY old PHP application. I want to touch it as little as possible. Can you help me:

1. add some nice CSS to it, a single static include for tailwind or similar, whatever you prefer
2. Transform the image print with description into cards, which fit 4 per line in the canvas?

Here's the code:

-----------------------------------
[Paste your PHP page, for instance index.php - mind the token limit!]

これは、Cloud Build を 1 回実行するだけで、5 分以内に簡単に取得できます。:)

Gemini からの回答は完璧でした(つまり、何も変更する必要がありませんでした)。

8a3d5fe37ec40bf8.png

作成者の個人用アプリの新しいレイアウトは次のとおりです。

81620eb90ae3229a.png

注: コードは画像として貼り付けられています。これは、コードをそのまま使用するのではなく、独自のクリエイティブな UI / フロントエンドの制約を Gemini に指定して、Gemini にコードを記述してもらうことをおすすめするためです。その後は、ごくわずかな変更を加えるだけで済みます。

セキュリティ

このアプリを適切に保護することは、この 4 時間のワークショップの目標ではありません。このワークショップを完了するまでの時間が 1 ~ 2 桁増加するためです。

しかし、このトピックは非常に重要です。SECURITY にいくつかのアイデアをまとめました。

12. 完了

お疲れさまでした。Google Cloud を使用して、レガシー PHP アプリケーションをモダナイズできました。

24cb9a39b1841fbd.png

この Codelab では、次のことを学習しました。

  • Google Cloud SQL にデータベースをデプロイする方法と、既存のデータベースをそこに移行する方法。
  • Docker と Buildpacks を使用して PHP アプリケーションをコンテナ化し、そのイメージを Google Cloud Artifact Registry に保存する方法
  • コンテナ化されたアプリを Cloud Run にデプロイし、Cloud SQL で実行する方法
  • Google Secret Manager を使用して機密性の高い構成パラメータ(DB パスワードなど)を秘密裏に保存 / 使用する方法
  • Google Cloud Build を使用して CI / CD パイプラインを設定し、GitHub リポジトリにコードが push されるたびに PHP アプリを自動的にビルドしてデプロイする方法。
  • Cloud Storage を使用してアプリリソースを「クラウド化」する方法
  • サーバーレス テクノロジーを活用して、アプリコードに触れることなく Google Cloud 上に優れたワークフローを構築する方法。
  • 適切なユースケースに Gemini マルチモーダル機能を使用する。
  • Google Cloud 内で SRE の原則を実装する

Google Cloud を使用したアプリケーションのモダナイゼーションへの取り組みの第一歩として、このラボは最適です。

🔁 フィードバック

このワークショップに関するご意見、ご感想がございましたら、こちらのフィードバック フォームにご記入ください。

皆様からのフィードバックをお待ちしております。また、特に自信のあるコードについては、PR をお寄せください。

🙏 ありがとうございます

この記事の執筆とソリューションのテストにご協力いただいた Datatonic の Mirko Gilioli 氏と Maurizio Ipsale 氏に感謝いたします。