Pub/Sub トピックとサブスクリプションを構成する

Application Design Center では、Pub/Sub トピックとサブスクリプションを構成して、メッセージを生成するサービス プロデューサーとメッセージを処理するサービスを切り離す、スケーラブルな非同期メッセージングを提供できます。GitHub の terraform-google-pubsub Terraform モジュールに基づいて、トピックとサブスクリプションのコンポーネント接続と構成パラメータをカスタマイズできます。

コンポーネントの接続

次の表に、Pub/Sub トピックまたはサブスクリプションに接続できるコンポーネントと、その結果としてアプリケーションとその生成された Terraform コードに適用される更新を示します。

連結成分 アプリケーションの更新 背景情報

Compute Engine インスタンス テンプレート

  • Compute Engine インスタンスは、Pub/Sub トピックにメッセージをパブリッシュし、Pub/Sub トピックからメッセージを受信できます。
  • Pub/Sub トピック ID が Compute Engine インスタンス テンプレートのメタデータに追加されます。
インスタンス テンプレート

サービス アカウント

  • このサービス アカウントは、Pub/Sub トピックを管理し、サブスクリプションからメッセージを pull できます。
  • サービス アカウントに roles/pubsub.editor ロールが付与されている。
  • サービス アカウントの名前とメールアドレスの情報が Pub/Sub pull サブスクリプションに追加されます。
Identity and Access Management(IAM)によるアクセス制御

BigQuery

  • Pub/Sub サブスクリプションは、BigQuery データセット内のテーブルにメッセージを書き込むことができます。
  • BigQuery のデータセットとテーブルの情報が Pub/Sub サブスクリプション フィールドに追加されます。
BigQuery サブスクリプション

Cloud Run

  • Cloud Run サービスは、メッセージを受信したり、Pub/Sub トピックにパブリッシュしたりできます。
  • Pub/Sub トピック ID が Cloud Run の環境変数に追加されます。
  • roles/pubsub.publisher ロールと roles/pubsub.subscriber ロールが Cloud Run サービス アカウントに付与されている。
  • Cloud Run サービスが Pub/Sub の push サブスクリプション フィールドと pull サブスクリプション フィールドに追加されます。
Cloud Run で Pub/Sub を使用するチュートリアル

Cloud Storage

  • Pub/Sub サブスクリプションは、Cloud Storage バケットにメッセージを書き込むことができます。
  • Cloud Storage バケットの情報が Pub/Sub サブスクリプションのフィールドに追加されます。
Cloud Storage のサブスクリプション

必須の構成パラメータ

テンプレートに Pub/Sub コンポーネントが含まれている場合は、デプロイする前に次のパラメータを構成する必要があります。

パラメータ名 説明と制約 背景情報

プロジェクト ID

Pub/Sub リソースをデプロイするプロジェクト。

コンポーネントを構成する

トピック

name トピック、サブスクリプション、スキーマ、スナップショットの名前に関するガイドライン

オプションの構成パラメータ

次のパラメータは省略可能です。詳細パラメータを表示するには、[構成] 領域で [詳細フィールドを表示] を選択します。

機能 パラメータ名 説明と制約情報 背景情報
トピックを作成する デフォルトでは、トピックが作成されます。トピックを作成しない場合は、チェックボックスをオフにします。 トピックの作成
サブスクリプションを作成する デフォルトでは、サブスクリプションが作成されます。サブスクリプションを作成しない場合は、チェックボックスをオフにします。 サブスクリプションの概要
トピックラベル Key(キー) labels ラベル付き使用状況の報告
トピックラベル 値 labels ラベル付き使用状況の報告
push サブスクリプション 名前 name トピック、サブスクリプション、スキーマ、スナップショットの名前に関するガイドライン
push サブスクリプション 確認応答期限(秒) ackDeadlineSeconds 確認応答期限
push サブスクリプション push エンドポイント pushEndpoint Endpoints
push サブスクリプション X-goog-version push されたメッセージの Pub/Sub API 形式。例: v1beta1 attributes
push サブスクリプション OIDC サービス アカウントのメールアドレス serviceAccountEmail 認証
push サブスクリプション 対象 者 認証
push サブスクリプション 有効期限ポリシー expirationPolicy 有効期限
push サブスクリプション デッドレター トピック deadLetterTopic デッドレター トピック
push サブスクリプション 確認応答済みメッセージを保持する retainAckedMessages 確認済みメッセージを保持する
push サブスクリプション メッセージ保持期間 messageRetentionDuration メッセージ保持期間
push サブスクリプション 最大配信試行回数 maxDeliveryAttempts デッドレター トピック
push サブスクリプション 最大バックオフ maximumBackoff 再試行ポリシー
push サブスクリプション 最小バックオフ minimumBackoff 再試行ポリシー
push サブスクリプション フィルタ filter サブスクリプション フィルタ
push サブスクリプション メッセージの順序指定を有効にする enableMessageOrdering メッセージの順序指定
pull サブスクリプション 名前 name トピック、サブスクリプション、スキーマ、スナップショットの名前に関するガイドライン
pull サブスクリプション 確認応答期限(秒) ackDeadlineSeconds 確認応答期限
pull サブスクリプション デッドレター トピック deadLetterTopic デッドレター トピック
pull サブスクリプション 最大配信試行回数 maxDeliveryAttempts デッドレター トピック
pull サブスクリプション 確認応答済みメッセージを保持する retainAckedMessages 確認済みメッセージを保持する
pull サブスクリプション メッセージ保持期間 messageRetentionDuration メッセージ保持期間
pull サブスクリプション 最大バックオフ maximumBackoff 再試行ポリシー
pull サブスクリプション 最小バックオフ minimumBackoff 再試行ポリシー
pull サブスクリプション フィルタ filter サブスクリプション フィルタ
pull サブスクリプション メッセージの順序指定を有効にする enableMessageOrdering メッセージの順序指定
pull サブスクリプション サービス アカウント サブスクリプションに対する roles/pubsub.subscriber ロールが付与されているサービス アカウント。 IAM を使用したアクセス制御
pull サブスクリプション 1 回限りの配信を有効にする enableExactlyOnceDelivery 1 回限りの配信
BigQuery サブスクリプション 名前 name トピック、サブスクリプション、スキーマ、スナップショットの名前に関するガイドライン
BigQuery サブスクリプション テーブル テーブル BigQuery サブスクリプションを作成する
BigQuery サブスクリプション トピック スキーマを使用する useTopicSchema トピック スキーマを使用する
BigQuery サブスクリプション テーブル スキーマを使用する useTableSchema テーブル スキーマを使用する
BigQuery サブスクリプション メタデータを書き込む writeMetadata メタデータを書き込む
BigQuery サブスクリプション 不明なフィールドを削除する dropUnknownFields 不明な項目を削除する
BigQuery サブスクリプション 確認応答期限(秒) ackDeadlineSeconds 確認応答期限
BigQuery サブスクリプション 確認応答済みメッセージを保持する retainAckedMessages 確認済みメッセージを保持する
BigQuery サブスクリプション メッセージ保持期間 messageRetentionDuration メッセージ保持期間
BigQuery サブスクリプション メッセージの順序指定を有効にする enableMessageOrdering メッセージの順序指定
BigQuery サブスクリプション 有効期限ポリシー expirationPolicy 有効期限
BigQuery サブスクリプション フィルタ filter サブスクリプション フィルタ
BigQuery サブスクリプション デッドレター トピック deadLetterTopic デッドレター トピック
BigQuery サブスクリプション 最大バックオフ maximumBackoff 再試行ポリシー
BigQuery サブスクリプション 最小バックオフ minimumBackoff 再試行ポリシー
Cloud Storage サブスクリプション 名前 name トピック、サブスクリプション、スキーマ、スナップショットの名前に関するガイドライン
Cloud Storage サブスクリプション バケット バケット バケット名
Cloud Storage サブスクリプション ファイル名の接頭辞 filenamePrefix ファイル名の接頭辞、接尾辞、日時
Cloud Storage サブスクリプション ファイル名の接尾辞 filenameSuffix ファイル名の接頭辞、接尾辞、日時
Cloud Storage サブスクリプション ファイル名の日時形式 filenameDatetimeFormat ファイル名の接頭辞、接尾辞、日時
Cloud Storage サブスクリプション 最大再生時間 maxDuration ファイルのバッチ処理
Cloud Storage サブスクリプション 最大バイト数 maxBytes ファイルのバッチ処理
Cloud Storage サブスクリプション 最大メッセージ数 maxMessages ファイルのバッチ処理
Cloud Storage サブスクリプション 出力形式 textConfig または avroConfig ファイル形式
Cloud Storage サブスクリプション メタデータを書き込む writeMetadata ファイル形式
Cloud Storage サブスクリプション トピック スキーマを使用する useTopicSchema ファイル形式
Cloud Storage サブスクリプション 確認応答期限(秒) ackDeadlineSeconds 確認応答期限
Cloud Storage サブスクリプション 確認応答済みメッセージを保持する retainAckedMessages 確認済みメッセージを保持する
Cloud Storage サブスクリプション メッセージ保持期間 messageRetentionDuration メッセージ保持期間
Cloud Storage サブスクリプション メッセージの順序指定を有効にする enableMessageOrdering メッセージの順序指定
Cloud Storage サブスクリプション 有効期限ポリシー expirationPolicy 有効期限
Cloud Storage サブスクリプション フィルタ filter サブスクリプション フィルタ
Cloud Storage サブスクリプション デッドレター トピック deadLetterTopic デッドレター トピック
Cloud Storage サブスクリプション 最大バックオフ maximumBackoff 再試行ポリシー
Cloud Storage サブスクリプション 最小バックオフ minimumBackoff 再試行ポリシー
サブスクリプション ラベル Key(キー) labels ラベル付き使用状況の報告
サブスクリプション ラベル 値 labels ラベル付き使用状況の報告
トピック メッセージの保持期間 topicMessageRetentionDuration メッセージ保持期間
トピックの KMS 鍵名 kmsKeyName 顧客管理の暗号鍵(CMEK)を使用する
BigQuery プロジェクト ロールを付与する デフォルトでは、BigQuery メタデータ閲覧者(roles/bigquery.metadataViewer)ロールと BigQuery データ編集者(roles/bigquery.dataEditor)ロールがデフォルトの Pub/Sub サービス アカウントに付与されます。これらのロールを付与しない場合は、チェックボックスをオフにします。 サービス アカウントに IAM ロールを付与する
トークン作成者を付与する デフォルトでは、サービス アカウント トークン作成者のロールがデフォルトの Pub/Sub サービス アカウントに付与されます。このロールを付与しない場合は、チェックボックスをオフにします。 Pub/Sub の認証を設定する
スキーマ 名前 name スキーマに関する重要な情報
スキーマ 型 type スキーマの種類
スキーマ 定義 定義 スキーマの種類
スキーマ エンコード エンコード スキーマをトピックに関連付けるためのガイドライン