メインコンテンツまでスキップ
バージョン: 3.18New

ネットワーク要件

注記

このページは英語版のページが機械翻訳されたものです。英語版との間に矛盾または不一致がある場合は、英語版を正としてください。

ScalarDB をデプロイする前に、通常はファイアウォールルールを設定して、クライアント、ScalarDB コンポーネント、およびその他の Scalar 製品間で必要なネットワークトラフィックが許可されるようにする必要があります。このページでは、ScalarDB Cluster の機能ごとに整理された、許可が必要な接続の一覧を、各接続の方向、デフォルトポート、ユースケースとともに示します。

注記

以下のテーブルに記載されているポート番号はデフォルト値です。設定でデフォルトポートを変更している場合は、ファイアウォールルールの設定時にカスタムポート番号を使用してください。

ScalarDB Core に関連する接続​

ScalarDB Cluster をデプロイするのではなく、ScalarDB Core をアプリケーションにライブラリとして埋め込む場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
クライアントアプリケーションバックエンドデータベースデータベースによるCoordinator テーブルのトランザクションメタデータを含む読み取り/書き込みリクエスト

Coordinator テーブルの詳細については、Consensus Commit プロトコルを参照してください。

ScalarDB Cluster に関連する接続​

ScalarDB Cluster をデプロイする場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
クライアント (ユーザーアプリケーション)ScalarDB Cluster ノード60053/TCPトランザクションの実行
ScalarDB Cluster ノードScalarDB Cluster ノード60053/TCPクラスター内部でのトランザクションリクエストのルーティング
Scalar Admin for KubernetesScalarDB Cluster ノード60053/TCPバックアップ操作のための一時停止/再開リクエストの実行
Scalar Admin for KubernetesKubernetes API サーバー443/TCPPod、Service、Deployment 情報の取得
クライアント (モニタリングツール)ScalarDB Cluster ノード9080/TCPScalarDB Cluster ノードのメトリクス収集
ScalarDB Cluster ノードバックエンドデータベースデータベースによるバックエンドデータベースへの読み取り/書き込みリクエスト
ScalarDB Cluster ノードKubernetes API サーバー443/TCPクラスターノードを検出するための Endpoints リソースの監視
クライアント (direct-kubernetes モード)Kubernetes API サーバー443/TCP接続先のクラスターノード IP アドレスの解決
ScalarDB Cluster ノードクラスター DNS (Kubernetes)53/UDP、53/TCPDNS を通じたホスト名解決
注記

以下のプロパティを設定することで、これらのデフォルトポートを変更できます:

  • scalar.db.cluster.node.port: Administrative API、Transaction API、SQL API、および管理者サービス (デフォルト: 60053)
  • scalar.db.graphql.port: GraphQL インターフェース (デフォルト: 8080)
  • scalar.db.cluster.node.prometheus_exporter_port: メトリクス (デフォルト: 9080)

scalar.db.cluster.node.admin.port を設定して、管理者サービス (pause、unpause、checkPaused) を専用ポートで実行する場合、そのポートにもアクセスできる必要があります。この場合、管理者サービスのみがそのポートで実行され、scalar.db.cluster.node.port は他の gRPC API のために引き続きアクセス可能である必要があります。

認証と認可に関連する接続​

OIDC ベースの JWT アクセストークンを認証に使用する場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
ScalarDB Cluster ノードOIDC IdPIdP によって異なるJWT アクセストークンを検証するための OpenID プロバイダーメタデータおよび JWK セットの取得

詳細については、OIDC ベースの JWT アクセストークンを用いてユーザーアクセスを制御するを参照してください。

暗号化に関連する接続​

列の値を暗号化する場合は、使用する暗号化キーのストレージタイプに応じて、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
ScalarDB Cluster ノードHashiCorp Vaultvault.address によって異なる書き込み前の列の値の暗号化 (type=vault)
ScalarDB Cluster ノードKubernetes API サーバー443/TCPKubernetes シークレットとして保存されたデータ暗号化キーの読み取り/書き込み (type=self)

詳細については、保存データの暗号化を参照してください。

GraphQL インターフェースに関連する接続​

GraphQL インターフェースを使用する場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
クライアント (ユーザーアプリケーション)ScalarDB Cluster ノード8080/TCPGraphQL クエリの実行

詳細については、ScalarDB Cluster GraphQL をはじめようを参照してください。

OpenTelemetry に関連する接続​

OpenTelemetry を使用してメトリクスとトレースをエクスポートする場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
ScalarDB Cluster ノードOTLP エンドポイント (メトリクス用 Collector)エンドポイント URL によって異なるトランザクションのメトリクスのエクスポート
ScalarDB Cluster ノードOTLP エンドポイント (トレース用 Collector)エンドポイント URL によって異なるトランザクションのトレースのエクスポート

リモートレプリケーションに関連する接続​

高可用性のためにリモートレプリケーションを使用する場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
ScalarDB Cluster ノード (プライマリ)Coordinator データベースデータベースによって異なるトランザクション状態の書き込み
ScalarDB Cluster ノード (プライマリ)レプリケーションデータベースデータベースによって異なるprepare フェーズ前のトランザクションログの書き込み
ScalarDB Cluster ノード (バックアップ)Coordinator データベースデータベースによって異なる適用前にトランザクションがコミットされたかどうかの確認
ScalarDB Cluster ノード (バックアップ)レプリケーションデータベースデータベースによって異なるトランザクションログの取得とバックアップデータベースへの適用
ScalarDB Cluster ノード (バックアップ)ScalarDB Cluster ノード (バックアップ)60054/TCP別のノードにキャッシュされた Coordinator 状態の読み取り
クライアント (Replication CLI)ScalarDB Cluster ノード60053/TCPレプリケーション状態の取得
注記

以下のプロパティを設定することで、このデフォルトポートを変更できます:

  • scalar.db.cluster.internal.node.port: 他のノードにキャッシュされた Coordinator 状態の読み取り (デフォルト: 60054)。このポートはクラスターノード間でのみアクセス可能である必要があり、通常はクライアントおよびパブリックネットワークからは制限されるべきです。

詳細については、高可用性のためのデータレプリケーションを参照してください。

Transaction Coordinator に関連する接続​

複数の ScalarDB Cluster インスタンスにわたる2フェーズコミットトランザクションを管理するために Transaction Coordinator をデプロイする場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
クライアント (ユーザーアプリケーション)Transaction Coordinator ノード60055/TCPトランザクション管理リクエストの実行
Transaction Coordinator ノードTransaction Coordinator ノード60055/TCPTransaction Coordinator クラスター内部でのトランザクションリクエストのルーティング
Transaction Coordinator ノードScalarDB Cluster ノード60053/TCPScalarDB Cluster ノード (参加者) へのトランザクション管理リクエストの送信
Transaction Coordinator ノードバックエンドデータベースデータベースによって異なるCoordinator テーブルへのトランザクションメタデータの読み取り/書き込み
Transaction Coordinator ノードKubernetes API サーバー443/TCPTransaction Coordinator ノードを検出するための Endpoints リソースの監視
Scalar Admin for KubernetesTransaction Coordinator ノード60055/TCPバックアップ操作のための一時停止/再開リクエストの実行
クライアント (モニタリングツール)Transaction Coordinator ノード9080/TCPTransaction Coordinator ノードのメトリクス収集
Transaction Coordinator ノードクラスター DNS (Kubernetes)53/UDP、53/TCPDNS を通じたホスト名解決
注記

以下のプロパティを設定することで、これらのデフォルトポートを変更できます:

  • scalar.db.cluster.transaction_coordinator.port: Transaction API (デフォルト: 60055)
  • scalar.db.cluster.transaction_coordinator.prometheus_exporter_port: メトリクス (デフォルト: 9080)

Transaction Coordinator ノードは、クライアントが使用するのと同じポート (scalar.db.cluster.transaction_coordinator.port で指定) を使って互いに通信します。そのため、このポートを Transaction Coordinator ノード間の通信のみに制限することはできません。

scalar.db.cluster.transaction_coordinator.admin.port を設定して管理者サービス (pause、unpause、checkPaused) を専用ポートで実行する場合、そのポートにもアクセスできる必要があります。この場合、管理者サービスのみがそのポートで実行され、scalar.db.cluster.transaction_coordinator.port は Transaction API のために引き続きアクセス可能である必要があります。

非推奨 – Transaction Coordinator の Envoy に関連する接続
注意

パフォーマンス上の理由から、ScalarDB Cluster の前に Envoy を使用することは非推奨になっています。

ScalarDB Cluster の前に Envoy を使用する場合は、ScalarDB Cluster に関連する接続のテーブルにあるクライアントから ScalarDB Cluster ノードへの接続の代わりに、Envoy に関連する接続で説明されている接続を許可する必要があります。

Transaction Coordinator の参加者リクエストのために ScalarDB Cluster の前に Envoy を使用する場合は、前のテーブルの Transaction Coordinator ノードから ScalarDB Cluster ノードへの接続の代わりに、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
Transaction Coordinator ノードEnvoy (ScalarDB Cluster 用)60053/TCPScalarDB Cluster ノード (参加者) へのトランザクション管理リクエストの送信

ベクトル検索インターフェースに関連する接続​

埋め込みのためにベクトル検索インターフェースを使用する場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
ScalarDB Cluster ノード埋め込みモデルプロバイダープロバイダーによって異なる指定されたテキストの埋め込みベクトルの生成
ScalarDB Cluster ノードベクトルストアストアによって異なるベクトルデータの読み取り/書き込み

詳細については、ScalarDB Cluster でベクトル検索をはじめようを参照してください。

ScalarDB Analytics に関連する接続​

ScalarDB Analytics を使用する場合は、以下の接続を許可する必要があります。

接続元接続先ポート (デフォルト)ユースケース例
クライアント (ユーザーアプリケーション)ScalarDB Analytics カタログサービス11051/TCPカタログメタデータのクエリ
クライアント (ユーザーアプリケーション)ScalarDB Analytics メータリングサービス11052/TCP使用状況メータリングデータのレポート
注記

ScalarDB Analytics に対して Apache Spark が使用するポートは、Spark クラスターのデプロイ方法によって異なります。許可が必要なポートの詳細については、Spark サービスプロバイダーのドキュメントを参照してください。