データベース

Cloud Run を利用して大規模に Cloud Spanner で PostgreSQL ドライバを使用する方法

2023年10月25日

Google Cloud Japan Team

※この投稿は米国時間 2023 年 10 月 14 日に、Google Cloud blog に投稿されたものの抄訳です。

金融サービス、ゲーム、小売など多くの業界の先進的なお客様が Cloud Spanner を使用して、ダウンタイムがなくスケーリングが必要な、要件の厳しいリレーショナルデータベースのワークロードに対応しています。Google の分散インフラストラクチャ上に構築された Cloud Spanner は、あらゆるスケールにおいて最高レベルの整合性と可用性を備えたフルマネージドエクスペリエンスを提供します。Cloud Spanner の PostgreSQL Interface を使用すると、Spanner の機能をオープンソースの PostgreSQL エコシステムから利用できます。

Cloud Run はフルマネージドのランタイムで、コンテナ内のコードをゼロから適切な数のインスタンスに自動スケールして、すべての受信リクエストに対応できるようにします。Cloud Spanner と Cloud Run を併用することで、オペレーショナルアプリケーションにおいてエンドツーエンドのスケーリングと可用性を実現できます。サイドカーコンテナはメインコンテナと並行的に実行されるコンテナで、既存コンテナの変更を伴わずに機能を追加します。Cloud Run もサイドカーをサポートするようになり、ウェブリクエストを処理するメインコンテナの他に、独立したサイドカーコンテナを起動して実行できるようになりました。

Cloud Spanner PGAdapter は軽量のプロキシで、PostgreSQL ネットワークプロトコルを Cloud Spanner gRPC プロトコルに変換します。これにより、アプリケーションは PostgreSQL の標準ドライバとフレームワークを使用して Cloud Spanner PostgreSQL データベースに接続できます。

このブログ記事では、PGAdapter を Cloud Run のサイドカーとして構成する方法について説明します。この設定では、アプリケーションと PGAdapter 間のレイテンシが可能な限り低く抑えられ、PGAdapter のインスタンス数がアプリケーションのインスタンス数に応じて自動スケールされます。

概要

Cloud Run インスタンス内のコンテナはすべて同じネットワーク名前空間を共有し、localhost:port 経由で相互に通信できます。また、共有ボリュームを使用して、コンテナ間でファイルを共有できます。アプリケーションコンテナはインターネットからのトラフィックを受信するコンテナです。PGAdapter はサイドカーコンテナとして設定されます。サイドカーはメインコンテナと並行して実行される追加のコンテナで、Cloud Run インスタンス内からのアクセスのみが認められます。

https://storage.googleapis.com/gweb-cloudblog-publish/images/1_-_Overview_PGAdapter_Cloud_Run_Sidecar.max-800x800.jpg

アプリケーションが PGAdapter に接続するには、次のいずれかの方法を利用します。

localhost:5432（または PGAdapter 用に指定した任意のポート）での TCP 接続
インメモリ共有ボリュームを使用する Unix ドメインソケット

この例では、Unix ドメインソケットを使用する方法について説明します。この方法の場合、アプリケーションコンテナと PGAdapter の間のレイテンシを可能な限り低く抑えることができます。

構成

現在、Cloud Run のサイドカーを構成するには、service.yaml ファイルを使用する必要があります。このセクションでは、次の内容について説明します。

PGAdapter をサイドカーとして構成する方法
共有インメモリボリュームを Unix ドメインソケット用に設定する方法
PGAdapter の起動プローブを設定する方法

PGAdapter をサイドカーとして構成する

Cloud Run にサイドカーコンテナを作成するには、コンテナリストに複数のコンテナを追加します。コンテナポートを指定するコンテナがメインコンテナになります。コンテナポートを指定できるコンテナは 1 つのみです。他のコンテナはすべてサイドカーコンテナになります。

読み込んでいます...

この 2 つのコンテナはループバックネットワークインターフェースを共有します。これにより、アプリケーションコンテナは標準の PostgreSQL ドライバを使用して、localhost:5432 にあるデフォルトの PGAdapter ポートに接続できます。

共有ボリュームを Unix ドメインソケット用に構成する

PostgreSQL ドライバはほとんどが Unix ドメインソケットを使用する接続をサポートしています。Unix ドメインソケットは、同じホストマシン上で実行されるプロセス同士が通信するためのエンドポイントです。通信チャネルとして通常はファイルを使用します。Unix ドメインソケットのレイテンシは TCP 接続よりも低くなります。

PGAdapter も Unix ドメインソケットをサポートしています。Unix ドメインソケットを利用するために、両方のコンテナからアクセスできるボリュームが必要になります。Cloud Run はこれを共有インメモリボリュームという形で実現します。次の例では、ここまでの設定に共有ボリュームを追加します。

読み込んでいます...

この構成により、次のものが追加されます。

sockets-dir という名前を持つ共有インメモリボリューム。
共有ボリュームをアプリケーションコンテナにマウントするためのマウントパス /sockets。
共有ボリュームを PGAdapter コンテナにマウントするためのマウントパス /sockets。
PGAdapter のコマンドライン引数 -dir /sockets。これは Unix ドメインソケットの受信をこのパスでリッスンするように PGAdapter に指示します。

PGAdapter の起動プローブを構成する

コンテナは一定の順番で起動するように構成できますが、起動プローブを追加して、特定のコンテナが別の特定のコンテナの起動前に起動するように構成することもできます。この方法を利用して、メインのアプリケーションコンテナが起動する前に確実に PGAdapter が起動しているように構成します。

読み込んでいます...

この構成では、PGAdapter コンテナをメインのアプリケーションコンテナの依存関係として登録します。これにより、PGAdapter が確実にアプリケーションコンテナより先に起動します。また、Cloud Run は起動プローブを使用して、PGAdapter がアプリケーションコンテナの起動前に正常に起動していることを確認します。起動プローブはポート 5432 で正常に TCP 接続できているかどうかをチェックします。このポートは PGAdapter が接続の受信をリッスンするデフォルトのポートです。

アプリケーションコード

メインのアプリケーションは PGAdapter への接続に PostgreSQL の標準ドライバを使用します。この例では、Go と pgx ドライバを使用します。他のプログラミング言語やドライバを使用するサンプルの完全なリストはこちらのディレクトリをご覧ください。

アプリケーションは PGAdapter への接続に、/sockets にマウントされている共有インメモリボリュームの Unix ドメインソケットを使用します。ホストがスラッシュで始まるため、pgx ドライバは TCP ソケットではなく Unix ドメインソケットを使用することを自動的に認識します。

接続文字列で使用される Cloud Spanner データベース名は、projects/my-project/instances/my-instance/databases/my-database という形式の完全修飾データベース名にする必要があります。

このサンプルアプリケーションはシンプルな HTTP サーバーを起動し、ポート 8080 でリッスンします。リクエストを受信するたびに PGAdapter に接続し、Hello World! を返すクエリを実行します。このメッセージは HTTP サーバーのレスポンスストリームに出力されます。

読み込んでいます...

func main() {
	project = getenv("SPANNER_PROJECT", "my-project")
	instance = getenv("SPANNER_INSTANCE", "my-instance")
	database = getenv("SPANNER_DATABASE", "my-database")
	qualifiedDatabaseName = fmt.Sprintf(
		"projects/%s/instances/%s/databases/%s",
		project, instance, database)
	databaseHost = getenv("PGADAPTER_HOST", "/sockets")
	databasePort = getenv("PGADAPTER_PORT", "5432")

log.Printf("\nConnecting to %s\n\n", qualifiedDatabaseName)

log.Print("starting server...")
	http.HandleFunc("/", handler)

// HTTP サービスのポートを決定します。
	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
		log.Printf("defaulting to port %s", port)
	}

// HTTP サーバーを起動します。
	log.Printf("listening on port %s", port)
	if err := http.ListenAndServe(":"+port, nil); err != nil {
		log.Fatal(err)
	}
}

func handler(w http.ResponseWriter, r *http.Request) {
	// PGAdapter を使用して Cloud Spanner に接続します。
	// その際、完全修飾データベース名を使用します。PGAdapter は
	// プロジェクト、インスタンス、データベース オプションなしで起動するためです。
	connString := fmt.Sprintf("host=%s port=%s database=%s",
		databaseHost, databasePort, qualifiedDatabaseName)
	ctx := context.Background()
	conn, err := pgx.Connect(ctx, connString)
	if err != nil {
		fmt.Fprintf(w, "failed to connect to PGAdapter: %v\n", err)
		return
	}
	defer conn.Close(ctx)

// Cloud Spanner でクエリを実行します。
	var greeting string
	err = conn.QueryRow(ctx, "select 'Hello world!'").Scan(&greeting)
	if err != nil {
		fmt.Fprintf(w, "failed to query Cloud Spanner: %v\n", err)
		return
	}
	fmt.Fprintf(w, 
		"\nGreeting from Cloud Spanner PostgreSQL using pgx: %v\n\n",
		greeting)
}

func getenv(key, def string) string {
	value := os.Getenv(key)
	if value == "" {
		return def
	}
	return value
}

完全なサンプルコードはこちらでご確認ください。

他のプログラミング言語の同様のサンプルはこちらからご覧いただけます。

まとめ

Cloud Run のサイドカーを導入すると、Cloud Spanner を使用するスケーラブルなアプリケーションのデプロイが大幅に簡素化します。

Cloud Spanner の PostgreSQL Interface を使用すると、デベロッパーはすでに知っている SQL を使用し、Spanner の整合性と可用性をスケールに応じて利用できます。PGAdapter を使用すると、Cloud Spanner で PostgreSQL の既製のドライバやフレームワークを使用できるようになります。現在 PostgreSQL アプリケーションで使用されているものと同じものです。Cloud Run はアプリケーションの柔軟なスケーリングで Spanner を補完します。サイドカーコンテナを追加することにより、アプリケーションの関連プロセスを自動スケールする柔軟性が得られます。サイドカーからインメモリボリュームの Unix ドメインソケットを使用すると、アプリケーションと PGAdapter の間の通信はレイテンシが可能な限り低く抑えられます。

Spanner の独自性や使用例の詳細はこちらをご覧ください。または、90 日間無料で、あるいは月額わずか $65 で、中断を伴う再構築やダウンタイムなしでビジネスの成長に合わせて拡張できる本番環境対応のインスタンスを実際にお試しください。

ーソフトウェア エンジニア Knut Olav Løite

投稿先