MongoDBSearch リソースの仕様

データソース設定

spec.source

型: オブジェクト

mongot のMongoDBソースを記述する設定。ソースはレプリカセットとシャーディングされたクラスターにすることができます。この設定は、次の場合に必要です。

• MongoDB は外部です

• MongoDB は とは異なる名前を持ちます MongoDBSearch

MongoDBSearch リソースは常に MongoDB 配置に接続されている必要があります。MongoDB または MongoDBCommunity CRD とともに Kubernetes Operator を使用して配置し、かつ spec.source が空の場合、Kubernetes Operator は metadata.name に基づいて次のコマンドを使用して Kubernetes 内のデータベースを検索します。

• 同じ名前空間で、MongoDBSearch の metadata.name に設定した名前と同じ名前の MongoDB または MongoDBCommunity リソースを見つけます。

• <MongoDBSearch.metadata.name>-<username>-password シークレットから mongot ユーザーのパスワード シークレットを見つけます。デフォルトのユーザー名の場合は <MongoDBSearch.metadata.name>-search-sync-source-password になります。

spec.source.mongodbResourceRef.name

型: string

この MongoDB Search およびベクトル検索リソースに関連付ける MongoDB または MongoDBCommunity リソースの名前。Kubernetes Operator は、レプリカセットとシャーディングされたクラスターの両方をサポートしています。同じ MongoDB または MongoDBCommunity リソースを参照する MongoDBSearch リソースを複数持つことはできません。

このフィールドは、MongoDB または MongoDBCommunity リソースが同じ Kubernetes クラスターに配置され、かつ MongoDBSearch リソースと同じ名前空間にある場合にのみ使用します。データベースが Kubernetes 外に配置されている場合、または別の名前空間にある場合は、spec.source.external を使用してデータベースへの接続を構成します。両方のフィールドを設定すると、spec.source.external が優先されます。

省略した場合、Kubernetes 演算子は、この MongoDBSearchリソースと同じ名前を持つ MongoDB または MongoDBCommunityリソースを検索します。

spec.source.mongodbResourceRef.namespace

型: string

spec.source.mongodbResourceRef.name が参照する MongoDB または MongoDBCommunity リソースの名前空間。Kubernetes 演算子は現在このフィールドを無視し、常に MongoDBSearch リソースの名前空間を使用します。クロス名前空間参照はサポートされていません。データベースが別の名前空間にある場合は、spec.source.external を使用します。

spec.source.username

型: string

mongod で mongot を認証するために使用するユーザー名。指定されたユーザーには searchCoordinator ロールが必要です。省略した場合、Kubernetes演算子はユーザー名が search-sync-source であると想定します。

spec.source.passwordSecretRef.name

型: string

mongot が mongod で認証するために使用する必要があるパスワードを含むシークレットの名前。省略した場合、デフォルトは <MongoDBSearch.metadata.name>-<username>-password になります。ここで <username> は spec.source.username の値です。デフォルトのユーザー名 search-sync-source の場合、これは <MongoDBSearch.metadata.name>-search-sync-source-password を返します。

spec.source.passwordSecretRef.key

型: string

パスワード値がシークレットで保存されるキー。省略した場合、デフォルトは password になります。

x509 認証設定

spec.source.x509

型: オブジェクト

mongot 同期ソース接続の x509クライアント証明書認証を構成します。このフィールドを に設定すると、mongot はユーザー名とパスワードの代わりに x509 を使用してMongoDBに認証します。

このフィールドは、spec.source.passwordSecretRef、spec.source.username、spec.source.tls と相互に排他的です。x509 とパスワード認証の両方を指定すると、Kubernetes 演算子は構成を拒否します。

spec.source.x509.clientCertificateSecretRef

型: オブジェクト

MongoDB同期ソースに認証するための x509クライアント証明書とキーを含むシークレット。シークレット には次のキーが含まれている必要があります。

• tls.crt — クライアント証明書

• tls.key — 秘密キー

秘密キーがパスワードで暗号化されている場合は、パスワードを別の Secret に保存し、spec.source.x509.keyFilePasswordSecretRef で参照します。

spec.source.x509 を設定する場合は、このフィールドを指定する必要があります。

spec.source.x509.keyFilePasswordSecretRef

型: オブジェクト

spec.source.x509.clientCertificateSecretRef 内のパスワード暗号化された秘密キーを複号化するパスワードを含むシークレット。シークレットには keyFilePassword キーの下にパスワードを含める必要があります。秘密キーが暗号化されていない場合は、このフィールドを省略します。

SCRAM TLS クライアント証明書設定

spec.source.tls

型: オブジェクト

SCRAM（ユーザー名とパスワード）認証を使用する場合、mongot 同期ソース接続の TLS クライアント証明書を構成します。このフィールドを設定すると、mongot はソース MongoDB 配置との TLS ハンドシェイク中にクライアント証明書を提示します（相互 TLS トランスポート）。mongot は、ユーザー名とパスワードを使用して引き続き認証します。

このフィールドは SCRAM 認証 (spec.source.passwordSecretRef) のみで使用します。このフィールドは spec.source.x509 と排他関係にあります。クライアント証明書自体を認証資格情報として使用する場合は、代わりに spec.source.x509 を使用します。

spec.source.tls.clientCertificateSecretRef

型: オブジェクト

ソース MongoDB 配置との TLS ハンドシェイク中に mongotが提示する TLS クライアント証明書とキーを含むシークレット。シークレットには、次のキーが含まれている必要があります。

• tls.crt — クライアント証明書

• tls.key — 秘密キー

spec.source.tls を設定する場合は、このフィールドを指定する必要があります。

spec.source.tls.keyFilePasswordSecretRef

型: オブジェクト

spec.source.tls.clientCertificateSecretRef 内のパスワード暗号化された秘密キーを複号化するパスワードを含むシークレット。シークレットには keyFilePassword キーの下にパスワードを含める必要があります。秘密キーが暗号化されていない場合は、このフィールドを省略します。

外部MongoDB 設定

spec.source.external

型: オブジェクト

外部データソースを説明する設定。Kubernetes 演算子を使用して配置されていない外部 MongoDB に接続したい場合のみ、これらの設定を指定します。これらの設定を指定すると、spec.source.mongodbResourceRef より優先されます。

spec.source.external.hostAndPorts

タイプ: 文字列の配列

外部レプリカセットのホスト名とポートのリスト。このフィールドは spec.source.external.shardedCluster と排他関係にあります。レプリカセットソースには hostAndPorts を使用し、シャーディングされたクラスターソースには shardedCluster を使用します。

spec.source.external.shardedCluster

型: オブジェクト

外部のシャーディングされたMongoDBクラスターを mongot のデータソースとして宣言します。mongos ルーターとシャードごとのレプリカセットの構成が含まれます。

spec.source.external.shardedCluster.router.hosts

タイプ: 文字列の配列

host:port形式の mongos ルーター インスタンスのエンドポイントとなる接続されたデバイスのリスト。すべての mongot インスタンスがこれらのルーターに接続します。少なくとも 1 つのエントリを指定します。

spec.source.external.shardedCluster.shards

タイプ: オブジェクトの配列

外部 MongoDB クラスター内のすべてのシャードのリスト。各エントリには、1 つのシャードのレプリカセットが記述されています。Kubernetes 演算子 は、各シャードに 1 つの mongot StatefulSet を作成します。少なくとも 1 つのシャードエントリを指定します。

spec.source.external.shardedCluster.shards[*].shardName

型: string

シャードの論理名。名前はすべてのシャードで一意である必要があり、Kubernetes DNS ラベル名のルール (RFC 1123) に準拠している必要があります。小文字の英数字とハイフン (-) を使用し、英数字で始まり、英数字で終わり、最大長は 63 文字です。ピリオド (.) とアンダースコア (_) は使用できません。

Kubernetes 演算子は、metadata.name、クラスター インデックス、およびshardNameを組み合わせて、作成するKubernetesリソースの名前にします。また、生成されたすべての名前がラベルのKubernetes DNS制限の63文字、サブドメイン名の253文字の範囲内に収まっていることを検証します。shardNameをこれらの制限に収まる程度に短くします。

spec.source.external.shardedCluster.shards[*].hosts

タイプ: 文字列の配列

このシャードの mongod レプリカセットのノードのエンドポイントとなる接続されたデバイスのリスト（ host:port形式 ）。少なくとも 1 つのエントリを指定します。各シャードには独自の mongot インスタンスのグループがあり、そのシャードのレプリカセットからのみデータをソースとします。

spec.source.external.keyfileSecretRef

型: オブジェクト

mongot が外部 MongoDB 配置に接続するために使用する mongod キーファイルを含むシークレット。name フィールドは必須です。key フィールドは任意です。

spec.source.external.tls.ca.name

型: string

mongod ノードで使用される TLS 証明書を発行した証明機関の信頼できるチェーンを含む ConfigMap の名前。この ConfigMap 内の ca.crt キーの下に証明書（または証明書チェーン）を指定する必要があります。

クラスター配置設定

次の設定は、必要な spec.clusters 配列の各エントリを説明します。

spec.clusters

タイプ: オブジェクトの配列

MongoDBSearch リソースの Kubernetes クラスターごとの配置。このフィールドは必須であり、少なくとも 1 つ、多くても 50 つのエントリが含まれている必要があります。replicas、loadBalancer、resourceRequirements、persistence、jvmFlags、statefulSetなどのすべてのサイズ設定と配置設定は、clusters エントリ内に存在します。これらの設定には、トップレベルの同等のものはありません。

単一クラスター配置の場合は、1 つのエントリを指定します。name と index は省略できます。

マルチクラスター配置の場合は、mongot ポッドを実行する各 Kubernetes クラスターについて 1 つのエントリを指定します。複数のエントリを指定する場合は、次のルールが適用されます。

• name すべてのエントリで必要であり、一意である必要があります。

• index すべてのエントリで必要であり、一意である必要があります。

• MongoDB ソースは外部である必要があります (spec.source.external)。複数のクラスター配置では、演算子マネージドの MongoDB ソースはサポートされません。

• すべてのエントリで、演算子によってマネージドされるロード バランサー (loadBalancer.managed) を構成する必要があります。マルチクラスター配置は、管理されていないロード バランサーをサポートしていません。

Kubernetes 演算子は、CRD 検証ルールと調合時の検証を通じてこれらのルールを強制します。

spec.clusters[].name

型: string

このエントリの Kubernetes クラスター名。最大長さは 253 文字です。単一クラスター配置の場合、このフィールドは省略できます。

spec.clusters に複数のエントリが含まれる場合、name が必要であり、エントリ間で一意である必要があります。リソースの作成後は変更できません。

spec.clusters[].index

タイプ: 整数

このエントリの Kubernetes クラスターの安定した整数識別子。値は 0 から 999 の間であり、エントリ間で一意である必要があります。spec.clusters に複数のエントリが含まれる場合、すべてのエントリで index が必要です。

Kubernetes 演算子には、このクラスターエントリのために作成される Kubernetes リソースの名前にインデックスが含まれます。例えば、StatefulSets の場合は {name}-search-{index}、Services の場合は {name}-search-{index}-svc、ConfigMaps の場合は {name}-search-{index}-config です。シャーディングされたクラスターソースの場合、名前にはシャード名も含まれます。例 {name}-search-{index}-{shardName} と {name}-search-{index}-{shardName}-svc です。

警告

既存のエントリの index を変更しないでください。インデックスはリソース名の一部であるため、変更すると Kubernetes 演算子は新しいインデックスの下に新しいリソースを作成し、古いインデックスのリソースを孤立させます。これは、プロキシサービス ({name}-search-{index}[-{shardName}]-proxy-svc)、Envoy 配置と ConfigMap ({name}-search-lb-{index})、ロードバランサー証明書シークレット、およびメトリクスフォワーダーリソース ({name}-search-metrics-forwarder-{index})を含む、インデックスを持つすべてのリソースに適用されます。

単一クラスター配置の場合は、このフィールドを省略できます。この場合、デフォルトは 0 になります。ただし、各ノード Kubernetes クラスターで固有の Kubernetes 演算子インスタンスを実行する場合は、各クラスターの MongoDBSearch リソースで index を明示的に個別の値に設定します。個別のインデックスにより、生成されたホスト名とリソース名がクラスター間で衝突することがなくなります。

セキュリティ設定

spec.security

型: オブジェクト

mongot listenサーバーのセキュリティ設定。

spec.security.tls

型: オブジェクト

mongot の TLS 設定。省略した場合、mongot は受信接続に TLS を使用しません。

シャーディングされたクラスターソースでマネージドロードバランサーを使用する場合、このフィールドは必須です。Envoy プロキシは、TLS ClientHello に依存する SNI を使用して正しいシャードにトラフィックをルーティングします。この構成で spec.security.tls を省略すると、Kubernetes 演算子は調和に失敗します。

spec.security.tls.certificateKeySecretRef.name

型: string

バージョン 1.8.0 から非推奨になりました。 : 代わりに spec.security.tls.certsSecretPrefix を使用してください。

秘密キー（tls.key）と証明書（tls.crt）を含む同じ名前空間内の TLS シークレットの名前。Kubernetes 演算子は、下位互換性のためにレプリカセットの配置でこのフィールドを引き続きサポートします。シャーディングされたクラスターの配置の場合、Kubernetes 演算子は、単一のシークレット参照ではシャードごとの証明書をカバーできないため、検証中にこのフィールドを拒否します。

spec.security.tls.certsSecretPrefix

型: string

Kubernetes Operator が命名規約により TLS シークレット名を導出するために使用する接頭辞。このフィールドを設定すると、Kubernetes Operator は次のパターンに従ってシークレットを検索します。

コンポーネント	シークレット名パターン
レプリカセットの mongotサーバー証明書	{certsSecretPrefix}-{name}-search-cert
シャーディングされた mongot 証明書（クラスターおよびシャードごと）	{certsSecretPrefix}-{name}-search-{clusterIndex}-{shardName}-cert
マネージド ロードバランサーサーバー証明書（クラスターごと、すべてのトポロジ）	{certsSecretPrefix}-{name}-search-lb-{clusterIndex}-cert
マネージド ロードバランサークライアント証明書	{certsSecretPrefix}-{name}-search-lb-{clusterIndex}-client-cert

Kubernetes Operatorは、すべてのトポロジーについて、クラスターごとに1つのマネージド ロード バランサー サーバー サーティフィケートを使用します。シャーディングされたクラスターの場合、このサーティフィケートのSANには、externalHostnameとrouterHostnameからの拡張されたすべてのシャード ホスト名が含まれている必要があります。

Kubernetes Operator は、次の順序で mongot サーバー証明書の秘密名を解決します。

1. spec.security.tls.certificateKeySecretRef.nameを設定すると、Kubernetes 演算子はその名前を使用します。

2. certsSecretPrefix を設定すると、Kubernetes 演算子は前の表の命名パスワードなしを使用します。

3. いずれのフィールドも設定しない場合、Kubernetes Operator はレプリカセット配置にデフォルト名 {name}-search-cert、シャーディング配置にシャードごとのデフォルトパスワードなし {name}-search-{clusterIndex}-{shardName}-cert を使用します。

certsSecretPrefixを設定しない場合、マネージド ロード バランサー証明書にもデフォルト名が使用されます。Kubernetes Operator は、サーバー証明書に {name}-search-lb-{clusterIndex}-cert、クライアント証明書に {name}-search-lb-{clusterIndex}-client-certをマウントします。

spec.security.tls.keyFilePasswordSecretRef

型: オブジェクト

TLS 証明書シークレットのパスワードで暗号化されたサーバーの秘密キーを複号化するパスワードを含むシークレット。シークレットには、keyFilePasswordキーの下にパスワードが含まれている必要があります。サーバーの秘密キーが暗号化されていない場合は、このフィールドを省略します。

LoggingSettings

spec.logLevel

型: string

mongot ログの冗長度。値は次のいずれかになります。

• TRACE

• DEBUG

• INFO

• WARN

• ERROR

省略した場合、デフォルトは INFO になります。

メトリクス設定

spec.observability.prometheus

型: オブジェクト

mongot の Prometheus メトリクスエンドポイントの構成。このフィールドを省略すると、Kubernetes Operator はデフォルトポート 9946 でメトリクスエンドポイントを有効にします。

spec.observability.prometheus.mode

型: string

mongot で Prometheus メトリクスエンドポイントを有効または無効にします。値は enabled または disabled になります。省略した場合、デフォルトは enabled になります。

spec.observability.prometheus.port

タイプ: 整数

Prometheus メトリクス エンドポイントとなる接続されたデバイスを有効にするポート。デフォルトでは、Prometheus メトリクス エンドポイントとなる接続されたデバイスはポート 9946 で有効になっています。

spec.observability.metricsForwarder

型: オブジェクト

Kubernetes Operator が作成して mongot Prometheus メトリクスをスクレイピングし、MongoDB Ops Manager に転送する配置であるメトリクスフォワーダーの配置。

spec.observability.metricsForwarder.mode

型: string

Kubernetes Operator がメトリクス フォワーダーを作成するかどうか。値は次のいずれかになります。

• auto — Kubernetes Operator は演算子マネージド MongoDB (Ops Manager バックアップ)ソースのフォワーダーを作成します。外部ソースの場合は、spec.observability.metricsForwarder.opsManager を設定した場合にのみ作成します。MongoDBCommunity ソースの場合、Kubernetes Operator はフォワーダーを作成しません。

• enabled — Kubernetes Operator は常にフォワーダーを作成します。ソースが MongoDBCommunity リソースの場合、Kubernetes Operator はフォワーダーが MongoDBCommunity ソースでサポートされていないためエラーを報告します。

• disabled — Kubernetes 演算子はフォワーダーを作成しません。

省略した場合、デフォルトは auto になります。

enabled モードと auto モードでは、Prometheus エンドポイント (spec.observability.prometheus) を有効にする必要があります。エンドポイントを無効にすると、Kubernetes Operator は Invalid メトリクス フォワーダー ステータスを報告します。

spec.observability.metricsForwarder.resourceRequirements

タイプ: Core/v1/ResourceRequirements

メトリクスフォワーダーコンテナがリクエストできる CPU とメモリ、および制限できる CPU とメモリ。省略すると、Kubernetes Operator は cpu: 100m と memory: 128Mi のリクエスト、cpu: 250m と memory: 256Mi の制限を使用します。

spec.observability.metricsForwarder.deployment

型: オブジェクト

Kubernetes 演算子が演算子作成のメトリクスフォワーダー配置に統合する上書き設定。このオブジェクトには、labels と annotations を含む metadata フィールドと、apps/v1/DeploymentSpec オブジェクトを含む spec フィールドが含まれています。

spec.observability.metricsForwarder.opsManager

型: オブジェクト

メトリクスフォワーダーがメトリクスを送信する対象の MongoDB Ops Manager プロジェクトと認証情報。省略すると、Kubernetes 演算子はソース MongoDB リソースの接続構成からプロジェクトと認証情報を導出します。ソース MongoDB リソースが存在しない外部 MongoDB ソースの場合は、このフィールドを設定します。

このフィールドを設定する場合は、agentCredentials.name (モンゴDB Ops Manager エージェント API キーを含む Secret) と projectConfigMapRef.name (モンゴDB Ops Manager プロジェクト構成を含む ConfigMap) の両方を設定する必要があります。

自動埋め込み設定

spec.autoEmbedding

型: オブジェクト

コレクション内のテキスト データ用の自動埋め込みの構成。

spec.autoEmbedding.embeddingModelAPIKeySecret.name

型: string

mongot がインデックス時とクエリ時に埋め込みを生成するために使用する必要がある埋め込みモデルAPIキーを含むシークレットの名前。シークレットには、indexing-key キーの下にインデックス時キー、query-key キーの下にクエリ時キーを含める必要があります。

embeddingModelAPIKeySecret は、spec.autoEmbedding.providerEndpoint が演算子管理のセルフホスト型 Voyage AI 埋め込みサービスを指す場合にのみ省略できます。そうでない場合、Kubernetes Operator には必要です。

spec.autoEmbedding.providerEndpoint

型: string

埋め込みを生成するための埋め込みモデルエンドポイント URL。

機能フラグ設定

spec.featureFlags

型: オブジェクト

mongotの機能フラッグ。フラッグを trueに設定すると、Kubernetes 演算子はそれを mongot構成にレンダーします。featureFlagsオブジェクトまたは個別のフラッグを省略すると、そのフラッグのスキーマデフォルトが適用されます（enableOverloadRetrySignalの場合は true）。

spec.featureFlags.enableOverloadRetrySignal

タイプ: ブール値

mongotオーバーロード再試行シグナルを有効にします。このフラッグを有効にすると、mongotは gRPC RESOURCE_EXHAUSTED応答を介してアップストリームプロキシにロードシェッディングをシグナル送信します（演算子マネージド Envoy ロードバランサーなど）。その後、プロキシは別の mongotインスタンスでリクエストを再試行します。

省略した場合、デフォルトは true になります。

その他の設定

spec.version

型: string

mongodb-search Docker イメージのバージョン。省略すると、Kubernetes Operator は、バンドルされているデフォルトの MongoDB Search バージョンを使用します。Kubernetes Operator をアップグレードする際の自動アップグレードを防止するため、バージョンを明示的に設定できます。