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

类型：字符串

与此MongoDB搜索和向量搜索资源关联的 MongoDB 或 MongoDBCommunity资源的名称。 Kubernetes Operator 同时支持副本集和分片的集群。不能有多个 MongoDBSearch资源引用同一 MongoDB 或 MongoDBCommunity资源。

仅当您的 MongoDB 或 MongoDBCommunity资源部署在同一Kubernetes集群中并且与 MongoDBSearch资源位于同一命名空间中时，才使用此字段。如果您的数据库部署在Kubernetes外部或位于不同的命名空间中，请使用 spec.source.external 配置与数据库的连接。如果同时设立这两个字段，则 spec.source.external 优先。

如果省略， Kubernetes Operator 会查找与此 MongoDBSearch资源同名的 MongoDB 或 MongoDBCommunity资源。

spec.source.mongodbResourceRef.namespace

类型：字符串

spec.source.mongodbResourceRef.name 引用的 MongoDB 或 MongoDBCommunity资源的命名空间。 Kubernetes Operator 目前会忽略此字段，并始终使用 MongoDBSearch资源的命名空间。不支持跨命名空间引用。如果您的数据库位于不同的命名空间中，请使用 spec.source.external。

spec.source.username

类型：字符串

用于通过 mongod 对 mongot 进行身份验证的用户名。指定的用户必须具有searchCoordinator角色。如果省略， Kubernetes 操作符 假定用户名名为 search-sync-source。

spec.source.passwordSecretRef.name

类型：字符串

包含密码的密钥名称，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

类型：字符串

将密码值存储在密钥中所使用的密钥。如果省略，则默认为 password。

x509 身份验证设置

spec.source.x509

类型：对象

为 mongot同步源连接配置 x509客户端证书身份验证。如果设立此字段，则 mongot 使用 x509 而不是用户名和密码对MongoDB进行身份验证。

该字段与 spec.source.passwordSecretRef、spec.source.username 和 spec.source.tls 互斥。如果您同时指定 x509 和 密码身份验证， Kubernetes Operator 会拒绝配置。

spec.source.x509.clientCertificateSecretRef

类型：对象

包含 x509客户端证书和密钥的密钥，用于对MongoDB同步源进行身份验证。密钥必须包含以下键：

• tls.crt — 客户端证书

• tls.key — 私钥

如果私钥使用密码加密，请将密码存储在单独的密钥中，并使用 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

类型：对象

包含 mongot 在与源MongoDB 部署的TLS 握手期间提供的 TLS客户端证书和密钥的密钥。密钥必须包含以下键：

• tls.crt — 客户端证书

• tls.key — 私钥

如果设立spec.source.tls，则必须指定此字段。

spec.source.tls.keyFilePasswordSecretRef

类型：对象

包含密码的密钥，该密码可对 spec.source.tls.clientCertificateSecretRef 中的密码加密私钥进行解密。密钥必须包含 keyFilePassword 密钥下的密码。如果私钥未加密，则省略此字段。

外部MongoDB设置

spec.source.external

类型：对象

描述外部数据源的设置。仅当您要连接到未使用Kubernetes Operator 部署的外部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 实例都连接到这些路由器。至少指定一个条目。

spec.source.external.shardedCluster.shards

类型：对象数组

外部MongoDB 集群中所有分片的列表。每个条目描述一个分片的副本集。 Kubernetes Operator 为每个分片创建一个 mongot StatefulSet。指定至少一个分片条目。

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

类型：字符串

分片的逻辑名称。该名称在所有分片中必须是唯一的，并且必须符合Kubernetes DNS 标签名称规则 1123(RFC)：小写字母数字字符和连字符- ()，以字母数字字符开头和结尾，最大长度为63 个字符。不允许使用句点. () 和下划线_ ()。

Kubernetes Operator 将 metadata.name、集群索引和 shardName 组合到其创建的Kubernetes资源的名称中，并验证每个生成的名称是否符合Kubernetes DNS 的 63 个字符字符和 253 个字符的限制用于子域名。对于这些限制，请保持 shardName 足够短。

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

类型：字符串数组

此分片的 mongod副本集节点的端点列表，采用 host:port 格式。至少指定一个条目。每个分片都有自己的 mongot 实例群组，这些实例的数据仅来自该分片的副本集。

spec.source.external.keyfileSecretRef

类型：对象

包含 mongot 用于连接到外部MongoDB 部署的mongod 密钥文件的密钥。 name字段为必填字段。 key字段为可选项。

spec.source.external.tls.ca.name

类型：字符串

ConfigMap 的名称，其中包含颁发 mongod 节点使用的 TLS 证书的证书颁发机构的可信链。您必须在此 ConfigMap 中的 ca.crt 密钥下指定证书（或证书链）。

集群部署设置

以下设置描述了所需 spec.clusters大量的每个条目。

spec.clusters

类型：对象数组

MongoDBSearch资源的按 Kubernetes 集群部署配置。此字段为必填字段，必须至少包含一个条目，最多 50 个条目。所有大小和位置设置，例如 replicas、loadBalancer、resourceRequirements、persistence、jvmFlags 和 statefulSet 都位于 clusters 条目中。这些设置没有对应的顶级设置。

对于单集群部署，请指定一个条目。您可以省略 name 和 index。

对于多集群部署，请为每个运行 mongot Pod 的Kubernetes集群指定一个条目。如果指定多个条目，则应用以下规则：

• name 每个条目都需要，并且必须是唯一的。

• index 每个条目都需要，并且必须是唯一的。

• MongoDB源必须是外部源 (spec.source.external)。多集群部署不支持Operator 管理的MongoDB源。

• 每个条目都必须配置一个 Operator 托管的负载负载均衡器(loadBalancer.managed)。多集群部署不支持非托管负载均衡器。

Kubernetes Operator 通过 CRD验证规则 和 协调时验证执行这些规则。

spec.clusters[].name

类型：字符串

此条目的Kubernetes集群名称，最大长度为 253 个字符。对于单集群部署，您可以省略此字段。

如果 spec.clusters 包含多个条目，则 name 为必填项，必须在各条目中具有唯一性，并且在创建资源后无法更改。

spec.clusters[].index

类型：整型

此条目的Kubernetes集群的稳定整数标识符。该值必须介于 0 和 999 之间，并且在各条目中必须是唯一的。如果 spec.clusters 包含多个条目，则每个条目都需要 index。

Kubernetes Operator 在为此集群条目创建的Kubernetes资源名称中包含该索引，示例{name}-search-{index} 表示 StatefulSet，{name}-search-{index}-svc 表示 Services，{name}-search-{index}-config 表示 ConfigMap。对于分片集群源，名称还包括分片名称，示例{name}-search-{index}-{shardName} 和 {name}-search-{index}-{shardName}-svc。

警告

请勿更改现有条目的 index。由于索引是资源名称的一部分，因此对其进行更改会导致Kubernetes Operator 在新索引下创建新资源，并孤立旧索引下的资源。这适用于每个带有索引的资源，包括代理服务 ({name}-search-{index}[-{shardName}]-proxy-svc)、Envoy 部署和 ConfigMap ({name}-search-lb-{index})、负载负载均衡器证书密钥以及指标转发器资源 ({name}-search-metrics-forwarder-{index})。

对于单集群部署，您可以省略此字段，默认值为 0。但是，如果每个成员Kubernetes集群都运行自己的Kubernetes Operator实例，请在每个集群的 MongoDBSearch资源中将 index 显式设立为不同的值。不同的索引可防止生成的主机名和资源名称在集群之间发生冲突。

安全设置

spec.security

类型：对象

mongot 侦听服务器的安全设置。

spec.security.tls

类型：对象

的 TLS 设置。mongot如果省略，mongot 将不会对传入连接使用 TLS。

如果将托管负载负载均衡器与分片集群源一起使用，则此字段为必填字段。 Envoy 代理使用 SNI 将流量路由到正确的分片，这取决于 TLS ClientHello。如果您在此配置中省略 spec.security.tls， Kubernetes Operator 将无法进行协调。

spec.security.tls.certificateKeySecretRef.name

类型：字符串

自版本 1.8.0 起已弃用。：请改用 spec.security.tls.certsSecretPrefix。

包含私钥 (tls.key) 和证书 (tls.crt) 的同一命名空间中的 TLS 密钥的名称。 Kubernetes Operator 仍支持将此字段用于副本集部署，以实现向后兼容。对于分片集群部署， Kubernetes Operator 在验证期间拒绝此字段，因为单个密钥引用无法涵盖每个分片的证书。

spec.security.tls.certsSecretPrefix

类型：字符串

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 对所有拓扑的每个集群使用一个托管负载负载均衡器服务器证书。对于分片的集群，此证书的 SAN 必须包含 externalHostname 和 routerHostname 中的所有扩展分片主机名。

Kubernetes Operator 按以下顺序解析 mongot服务器证书密钥名称：

1. 如果设立spec.security.tls.certificateKeySecretRef.name， Kubernetes Operator 将使用该名称。

2. 如果设立certsSecretPrefix， Kubernetes Operator 将使用上表中的命名模式。

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

类型：字符串

mongot 日志的详细程度。值可以是以下之一：

• TRACE

• DEBUG

• INFO

• WARN

• ERROR

如果省略，则默认值为 INFO。

指标设置

spec.observability.prometheus

类型：对象

mongot 中 Prometheus指标端点的配置。如果省略此字段， Kubernetes Operator 将在默认端口 9946 上启用指标端点。

spec.observability.prometheus.mode

类型：字符串

在 mongot 中启用或禁用 Prometheus指标端点。值可以是 enabled 或 disabled。如果省略，则默认为 enabled。

spec.observability.prometheus.port

类型：整型

启用Prometheus指标终结点的端口。默认情况下，在端口 9946 上启用 Prometheus 指标终结点。

spec.observability.metricsForwarder

类型：对象

指标转发器的配置，这是Kubernetes Operator 创建的用于抓取 mongot Prometheus指标并将其转发到Ops Manager 的部署。

spec.observability.metricsForwarder.mode

类型：字符串

Kubernetes Operator 是否创建指标转发器。值可以是以下之一：

• auto — Kubernetes Operator 为 Operator 托管的 MongoDB（Ops Manager支持）源创建转发器，并且仅当您设立spec.observability.metricsForwarder.opsManager 时才为外部源创建转发器。对于 MongoDBCommunity 源， Kubernetes Operator 不会创建转发器。

• enabled — Kubernetes Operator 始终会创建转发器。如果源是 MongoDBCommunity资源， Kubernetes Operator 会报告错误，因为 MongoDBCommunity 源不支持转发器。

• disabled — Kubernetes Operator 从不创建转发器。

如果省略，则默认值为 auto。

enabled 和 auto 模式需要启用 Prometheus 端点 (spec.observability.prometheus)。如果禁用端点， Kubernetes Operator 会报告 Invalid指标转发器状态。

spec.observability.metricsForwarder.resourceRequirements

类型：core/v1/ResourceRequirements

指标转发器容器可以请求和限制的 CPU 和内存。如果省略， Kubernetes Operator 将使用 cpu: 100m 和 memory: 128Mi 的请求以及 cpu: 250m 和 memory: 256Mi 的限制。

spec.observability.metricsForwarder.deployment

类型：对象

覆盖Kubernetes Operator 合并到 Operator 创建的指标转发器部署中的操作。此对象包含一个具有metadata labels和 的 字段，以及一个具有annotations specapps/v1 /DeploymentSpec对象的 字段。

spec.observability.metricsForwarder.opsManager

类型：对象

指标转发器向其发送指标的Ops Manager项目和凭证。如果省略， Kubernetes Operator 会从源MongoDB资源的连接配置中派生项目和凭证。为不存在源MongoDB资源的外部MongoDB源设置此字段。

如果设立此字段，则必须同时设立agentCredentials.name（包含Ops Manager代理API密钥的密钥）和 projectConfigMapRef.name（包含Ops Manager项目配置的 ConfigMap）。

自动嵌入设置

spec.autoEmbedding

类型：对象

在集合中自动嵌入文本数据的配置。

spec.autoEmbedding.embeddingModelAPIKeySecret.name

类型：字符串

包含嵌入模型API密钥的密钥名称， mongot必须使用该密钥在索引时和查询时生成嵌入。密钥必须包含indexing-key 键下的索引时键和query-key 键下的查询时键。

仅当 spec.autoEmbedding.providerEndpoint 指向 Operator 管理的自托管 Voyage AI嵌入服务时，才能省略 embeddingModelAPIKeySecret。否则， Kubernetes Operator 会需要它。

spec.autoEmbedding.providerEndpoint

类型：字符串

用于生成嵌入的嵌入模型端点URL 。

功能标志设置

spec.featureFlags

类型：对象

mongot 的功能标志。如果将标志设立为 true， Kubernetes Operator 会将其呈现到 mongot 配置中。如果省略 featureFlags对象或单个标志，则应用该标志的模式默认（true 表示 enableOverloadRetrySignal）。

spec.featureFlags.enableOverloadRetrySignal

类型：布尔值

启用 mongot 过载重试信号。如果启用此标志，mongot 会通过 gRPC RESOURCE_EXHAUSTED 响应向上游代理（例如 Operator 托管的 Envoy 负载负载均衡器）发出负载卸载信号。然后，代理会在另一个 mongot实例上重试该请求。

如果省略，则默认值为 true。

其他设置

spec.version

类型：字符串

mongodb-search Docker映像的版本。如果省略， Kubernetes Operator 将使用与之捆绑的默认MongoDB Search 版本。您可以在升级Kubernetes Operator 时明确设立版本以防止自动升级。