MongoDB搜索和向量搜索设置

用于连接到外部副本集的设置

spec.source.external.hostAndPorts

类型：字符串数组

外部副本集的主机名和端口列表。这是MongoDB副本集的托管种子列表。mongot 以副本集模式连接数据库，并使用 db.hello() 获取所有其他节点的列表。

此字段与 spec.source.external.shardedCluster 互斥。使用 hostAndPorts 作为副本集源，使用 shardedCluster 作为分片集群源。

例子

hostAndPorts:
  - mdbc-rs-0.my-external-domain.example.com:27017
  - mdbc-rs-1.my-external-domain.example.com:27017
  - mdbc-rs-2.my-external-domain.example.com:27017

spec.source.external.tls

类型：对象

mongot 连接到外部MongoDB 数据库时必须使用的 TLS 设置。

spec.source.external.tls.ca.name

类型：字符串

包含颁发 mongod 节点使用的 TLS 证书的证书颁发机构的可信链的 ConfigMap 名称。

例子

spec:
  source:
    external:
      tls:
        ca:
          name: trusted-ca

您必须在此 ConfigMap 中的 ca.crt 密钥下指定证书（或证书链）。

例子

kind: ConfigMap
apiVersion: v1
metadata:
  name: trusted-ca
data:
  ca.crt: |
    -----BEGIN CERTIFICATE-----
    MIIDBTCCAe2gAwIBAgIIH3EOUAGAsx0wDQYJKoZIhvcNAQELBQAwFTETMBEGA1UE
    [...]
    U/4rN8Ias/FONYFRtGfs9uXHmo2MP04BF+9ED2dlbNDUbat+6XCozLJj98nI4VEi
    qaV3JrVFHTgN
    -----END CERTIFICATE-----

用于连接到外部分片集群的设置

只有在配置与外部MongoDB分片集群的连接时才需要以下设置。它们扩展了现有的 spec.source.external 设置。

spec.source.external.shardedCluster

类型：对象

声明外分片的MongoDB 集群作为 mongot 的数据源。包含 mongos 路由器和每分片副本集节点的配置。

仅当MongoDB分片集群部署在Kubernetes外部且不受Kubernetes Operator托管，才使用此选项。对于使用 MongoDB CRD 部署的操作符托管的集群，请改用 spec.source.mongodbResourceRef。Kubernetes Operator 自动发现分片拓扑结构。

例子

spec:
  source:
    external:
      shardedCluster:
        router:
          hosts:
            - "mongos1.external:27017"
            - "mongos2.external:27017"
        shards:
          - shardName: "shard-0"
            hosts:
              - "shard0-node1.external:27018"
              - "shard0-node2.external:27018"
          - shardName: "shard-1"
            hosts:
              - "shard1-node1.external:27018"
              - "shard1-node2.external:27018"

spec.source.external.shardedCluster.router

类型：对象

外分片集群的 mongos（路由器）实例的配置。

spec.source.external.shardedCluster.router.hosts

类型：字符串数组

host:port 格式的 mongos 路由器实例的终结点列表。所有 mongot 实例都连接到这些路由器。至少指定一个条目。

例子

router:
  hosts:
    - "mongos1.external:27017"
    - "mongos2.external:27017"

spec.source.external.shardedCluster.shards

类型：对象数组

外部MongoDB 集群中所有分片的列表。每个条目描述一个分片的副本集。Kubernetes 操作符 为每个分片创建一个 mongot StatefulSet，其中每个 StatefulSet 包含 spec.clusters[].replicas 中指定数量的 Pod。指定至少一个分片条目。

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

类型：字符串

分片的逻辑名称。Kubernetes 操作符 使用此名称来命名Kubernetes资源（StatefulSet、Services、Secret）。该值可以与MongoDB分片名称不同。

命名约束：

• 在所有分片中必须是唯一的。

• 必须符合 Kubernetes DNS 标签名称规则 (RFC 1123)，该规则允许使用小写字母数字字符和连字符 (-)，并要求名称以字母数字字符开头和结尾。不允许使用句点 (.) 和下划线 (_)。最大长度为 63 个字符。

• Kubernetes Operator 将 metadata.name、集群索引和 shardName 组合到它创建的 Kubernetes 资源的名称中（例如 {name}-search-{clusterIndex}-{shardName}），并验证每个生成的名称都符合 Kubernetes DNS 对标签的 63 个字符和对子域名称的 253 个字符的限制。使 shardName 足够短以适应这些限制。

例子

shards:
  - shardName: "shard-0"
    hosts:
      - "shard0-node1.external:27018"

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

类型：字符串数组

此分片的 mongod副本集的终结点列表，采用 host:port 格式。mongot 实例从这些托管复制数据。至少指定一个条目。

每个副本集（分片）都有自己的 mongot 实例群组，这些实例仅从该副本集获取数据。不同的分片从不股票相同的 mongot 实例。

例子

shards:
  - shardName: "shard-0"
    hosts:
      - "shard0-node1.external:27018"
      - "shard0-node2.external:27018"
      - "shard0-node3.external:27018"

大小调整和存储

spec.clusters[].replicas

类型：整型

要在此 Kubernetes 集群中部署的 mongot 节点数。对于副本集源，这是 mongot 节点的总数。对于分片集群源，这是每个分片的 mongot 节点数。

如果 spec.clusters[].replicas 大于 1，则还必须配置 spec.clusters[].loadBalancer，在 mongod 和多个 mongot 实例之间路由流量。

如果将 spec.clusters[].replicas 设置为 0，则 Kubernetes 操作符 会将此集群中的 mongot 部署离线。Kubernetes 操作符将 StatefulSet 扩展到零个节点，并保留 MongoDBSearch 资源及其他 Kubernetes 资源。

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

例子

spec:
  clusters:
    - replicas: 2

spec.clusters[].resourceRequirements

类型：core/v1/ResourceRequirements

mongodb-search容器可以请求和限制使用的 CPU 和内存。我们建议使用此字段自定义资源分配，而不是使用 spec.clusters[].statefulSet 覆盖。

如果您没有覆盖 spec.clusters[].jvmFlags 中的Java虚拟机（JVM）堆大小， Kubernetes 操作符会将默认堆大小 (-Xmx) 设置为 mongot 容器内存请求的 50%。相应地调整 spec.clusters[].resourceRequirements 以控制 Pod 资源和Java虚拟机（JVM）堆大小。

如果省略， Kubernetes Operator 将使用以下默认值：

requests:
  cpu: 2
  memory: 4Gi

spec.clusters[].resourceRequirements.limits

类型：对象

mongodb-search容器可消耗的资源（CPU和内存）的上限。默认情况下，未设置任何限制。如果省略，则不会限制该节点，因此可能会使用节点上的所有资源。我们建议根据工作负载设置限制。

spec.clusters[].resourceRequirements.requests

类型：对象

为 mongodb-search 容器请求的 CPU 和内存量。如果您仅指定 cpu 或 memory 之一，Kubernetes 操作符 将应用另一个的默认值。如果省略，Kubernetes 操作符 将使用以下默认值：

requests:
  cpu: 2
  memory: 4Gi

spec.clusters[].persistence.single

类型：对象

MongoDB Search 和 Vector Search 持久卷的存储配置，其中存储MongoDB Search 和 Vector Search 索引。每个搜索实例(pod) 都有自己独立的存储来维护索引，该存储不与MongoDB 数据库共享。只有索引元数据（定义）存储在数据库中。

标量	数据类型	说明
labelSelector	字符串	用于将挂载卷绑定到目录的标签。
storage	字符串	要安装的 持久卷的最小大小。此值以整数表示，后跟采用 JEDEC 表示法的存储单位。 默认值为16G 。 例如，如果 副本集 需要 60 GB 的存储空间，则将该值设置为 60G。
storageClass	字符串	持久卷声明中指定的存储类型。您可以在此 对象 规范中使用此存储类型之前，将其创建为 StorageClass 对象。 确保将StorageClass reclaimPolicy设立为Retain。这可确保在删除持久卷声明时保留数据。

MongoDB Search 仅支持 single 持久性模式，该模式为所有数据使用一个卷。虽然 CRD 模式也包含 spec.clusters[].persistence.multiple 字段，但 Kubernetes Operator 不会应用它。如果您省略 persistence，Kubernetes 操作符 会将 spec.clusters[].persistence.single.storage 设置为 16G。

负载均衡

spec.clusters[].loadBalancer

类型：对象

在 mongod（或 mongos）和 mongot 之间实现 L7 负载平衡的配置。如果 spec.clusters[].replicas 大于 1，则此字段为必填项。如果 spec.clusters[].replicas 为 1，则此字段为可选字段。您甚至可以为单个 mongot实例配置负载负载均衡器，为以后扩展做好准备。

必须设立managed 或 unmanaged 之一。

spec.clusters 中的所有条目必须在负载均衡器模式上达成一致：每个条目都设置 loadBalancer.managed，每个条目都设置 loadBalancer.unmanaged，或没有条目设置 loadBalancer。Kubernetes 操作符拒绝混合模式。多集群部署仅支持托管模式。

负载负载均衡器会影响 mongod 客户端看到哪些 TLS 证书以及这些证书必须包含哪些主机名：

• 如果没有负载负载均衡器，mongod 会直接连接到 mongot。向 mongod 提供的 TLS 证书是 mongot 自己的证书。如果MongoDB 集群位于Kubernetes外部，则 mongot 服务将在外部域上公开。您必须在 mongot TLS 证书的 SAN（主题备用名称）字段中包含该外部域。

• 使用托管负载均衡器(spec.clusters[].loadBalancer.managed)，Envoy 代理是唯一直接连接到 mongot 的组件。Envoy 代理通过内部服务 FQDN 访问 mongot：

  • 副本集: <name>-search-<clusterIndex>-svc.<ns>.svc.cluster.local

  • 分片集群: <name>-search-<clusterIndex>-<shard>-svc.<ns>.svc.cluster.local

  我们建议您将这些服务 FQDN 包含在 mongot TLS 证书的 SAN 字段中。操作符管理的 Envoy 代理目前仅针对证书权限验证 mongot 证书，不匹配 SAN 主机名。外部 mongod 进程会看到 Envoy 代理的 TLS 证书，因此请将外部域名包含在 Envoy 证书的 SAN 中，而不是 mongot 证书中。

提示

即使您最初部署单个 mongot Pod，也要启用托管负载负载均衡器。负载负载均衡器就位后，如果您稍后扩展spec.clusters[].replicas，TLS 证书中的域将保持稳定，因为负载负载均衡器已经存在于 mongod 和 mongot 之间。

spec.clusters[].loadBalancer.managed

类型：对象

配置 Operator 托管的Envoy负载负载均衡器。Kubernetes 操作符 通过正确的路由、mTLS 和HTTP/2+gRPC流固定来部署和托管 Envoy 代理。将此字段设置为空对象({}) 以使用默认值。

此字段与 spec.clusters[].loadBalancer.unmanaged 互斥。

对于分片集群源，如果使用托管负载均衡器，还必须配置 spec.security.tls。Envoy 代理使用 SNI 将流量路由到正确的分片，这需要 TLS。

例子

spec:
  clusters:
    - loadBalancer:
        managed: {}

spec.clusters[].loadBalancer.managed.externalHostname

类型：字符串

Envoy 代理期望用于传入请求的 SNI 匹配的主机名。Kubernetes Operator 使用此值来配置路由规则，以匹配传入 mongod 连接中的 TLS SNI字段。Envoy TLS服务器证书必须在其 SAN（主题备用名称）字段中包含此主机名。

对于分片集群源，该值必须包含 {shardName} 占位符，Kubernetes 操作符会按分片进行扩展。每个分片都有自己的主机名，Envoy TLS 服务器证书必须在其 SAN 中包含所有扩展的分片主机名。您可以使用通配符证书以单个证书覆盖所有分片，并在添加分片时避免重新颁发。对于副本集源，请勿使用 {shardName} 占位符。

如果MongoDB由外部托管（不是由Kubernetes 操作符 部署），则此字段为必填项。如果MongoDB在同一集群中由 Operator 托管，则省略此字段，因为Kubernetes Operator 会自动配置路由。

在多集群部署中，每个集群条目通常使用不同的主机名。但是，Kubernetes 操作符允许在集群之间共享一个主机名，例如，如果跨可用区的故障转移代理前置多个集群的 Envoy 代理。

例子

# Replica set with external MongoDB
spec:
  clusters:
    - loadBalancer:
        managed:
          externalHostname: "search.apps.example.com"
# Sharded cluster with external MongoDB
spec:
  clusters:
    - loadBalancer:
        managed:
          externalHostname: "{shardName}.search.example.com"

spec.clusters[].loadBalancer.managed.routerHostname

类型：字符串

mongos 路由器用于通过托管的 Envoy 负载均衡器以 host:port 格式访问此集群的 mongot 实例的终结点。Kubernetes 操作符在集群级路由链上使用主机名进行 SNI 匹配，因此 Envoy TLS 服务器证书必须在其 SAN 中包含此主机名。

如果使用带有外部分片 MongoDB 源 (spec.source.external.shardedCluster) 的托管式负载均衡器，则此字段为必填字段。Kubernetes Operator 会忽略副本集源和操作符托管的 MongoDB 的此字段。

与 externalHostname 不同，Kubernetes 操作符使用此值的字面值，因此该值不得包含 {shardName} 占位符。此终结点是 mongos 的分片无关入口点。

在多集群部署中，每个集群条目通常使用不同的值。然而，Kubernetes 操作符允许跨集群共享一个值，例如，如果一个跨越可用区的故障转移代理前端接入了多个集群的 Envoy 代理。

例子

spec:
  clusters:
    - loadBalancer:
        managed:
          externalHostname: "{shardName}.search.example.com"
          routerHostname: "search-router.example.com:27028"

spec.clusters[].loadBalancer.managed.replicas

类型：整型

要在此 Kubernetes 集群中部署的 Envoy 代理节点数。该值必须大于或等于 1。如果省略，则默认值为 1。

spec.clusters[].loadBalancer.managed.resourceRequirements

类型：core/v1/ResourceRequirements

Envoy容器可以请求和限制的 CPU 和内存。如果指定此设置， Kubernetes 操作符 会完全替换默认值。

如果省略， Kubernetes Operator 将使用以下默认值：

requests:
  cpu: 100m
  memory: 128Mi
limits:
  cpu: 500m
  memory: 512Mi

例子

spec:
  clusters:
    - loadBalancer:
        managed:
          resourceRequirements:
            requests:
              cpu: "200m"
              memory: "256Mi"
            limits:
              cpu: "1"
              memory: "1Gi"

spec.clusters[].loadBalancer.managed.deployment

类型：对象

覆盖 Kubernetes Operator 合并到 Operator 创建的 Envoy 部署中的操作符。遵循与MongoDB资源上的 spec.statefulSet 相同的约定。如果省略， Kubernetes 操作符 将使用 Envoy 部署的默认值。

该对象包含两个字段：

• metadata — 包含 Kubernetes 操作符合并到 Envoy 部署元数据中的 labels 和 annotations 字段。

• spec — apps/v1/DeploymentSpec对象。Kubernetes 操作符 将这些覆盖合并到 Envoy 部署规范中。

例子

spec:
  clusters:
    - loadBalancer:
        managed:
          deployment:
            spec:
              template:
                spec:
                  nodeSelector:
                    kubernetes.io/os: linux

spec.clusters[].loadBalancer.managed.retryPolicy

类型：对象

Envoy 代理对上游 mongot 实例的单个 gRPC 流应用的重试行为。Envoy 代理会将每个重试尝试发送到与失败尝试不同的 mongot 主机。

如果忽略此字段，Envoy 代理将使用默认值重试：2 次重试，每次重试超时为 60s。

例子

spec:
  clusters:
    - loadBalancer:
        managed:
          retryPolicy:
            numRetries: 2
            perTryTimeout: "60s"

spec.clusters[].loadBalancer.managed.retryPolicy.numRetries

类型：整型

每个请求的最大重试次数。该值必须大于或等于 1。如果省略，则默认为 2，这样每个请求共可重试三次。

spec.clusters[].loadBalancer.managed.retryPolicy.perTryTimeout

类型：字符串

包括原始请求在内的每个单独尝试的超时，表示为持续时间字符串（例如 "30s"）。如果省略，则默认为 "60s"。

spec.clusters[].loadBalancer.managed.minMongotReadyReplicas

类型：整型

mongot 组（例如，一个分片的 mongot 实例）在 Envoy 代理将流量路由到它之前必须具备的就绪 mongot 副本的最小数量。当组低于此阈值时，Envoy 代理会将旨定发送到该组的流量转发到健康的 mongot 组，并使用 routed_from_another_shard 头标记请求。这些请求返回空结果而不是错误。

该值必须为 1 或更大。如果省略，则默认为 1。

spec.clusters[].loadBalancer.unmanaged

类型：对象

配置用户提供的（自带）L7 负载负载均衡器。您负责在外部部署和配置负载负载均衡器。

此字段与 spec.clusters[].loadBalancer.managed 互斥。多集群部署不支持非托管负载均衡器。

spec.clusters[].loadBalancer.unmanaged.endpoint

类型：字符串

BYO 负载均衡器的终结点，以 host:port 格式。如果配置 spec.clusters[].loadBalancer.unmanaged，则必须指定此字段。

如果 Kubernetes 操作符托管 MongoDB 部署（使用 spec.source.mongodbResourceRef），则 Kubernetes 操作符会将此值作为 mongotHost 和 searchIndexManagementHostAndPort 写入 mongod 配置。如果 MongoDB 是外部的，则您可以使用相同值自行配置 mongod 参数。

对于外部分片集群源，该值必须包含 Kubernetes 操作符为每个分片扩展的 {shardName} 占位符，并且必须包含除占位符以外的内容。对于外部副本集源，该值不得包含 {shardName} 占位符。

例子

# Replica set example
spec:
  clusters:
    - loadBalancer:
        unmanaged:
          endpoint: "search-lb.corp.example.com:443"
# Sharded cluster example
spec:
  clusters:
    - loadBalancer:
        unmanaged:
          endpoint: "{shardName}-lb.corp.example.com:443"

每分片覆盖

spec.clusters[].shardOverrides

类型：对象数组

覆盖会导致此集群入口内的特定分片大小与集群默认值不同。使用此字段为单个分片提供比集群其他部分更多或更少的 mongot 副本、资源或存储。

您只能将此字段与外部分片集群源 (spec.source.external.shardedCluster) 一起使用。您引用的每个分片名称都必须存在于 spec.source.external.shardedCluster.shards[*].shardName，并且每个分片在每个集群条目中最多可以被覆盖一次。

如果在覆盖中设置 replicas、resourceRequirements、persistence 或 jvmFlags，它们将替换指定分片的集群值。Kubernetes 操作符将 statefulSet 深度合并到集群值。未设置的字段将继承集群值。

例子

spec:
  clusters:
    - replicas: 2
      shardOverrides:
        - shardNames:
            - shard-0
          replicas: 3
          resourceRequirements:
            requests:
              cpu: "4"
              memory: 8Gi

spec.clusters[].shardOverrides[*].shardNames

类型：字符串数组

此集群入口中应用覆盖的分片名称。此字段为必填字段，且必须包含至少一个入口。

spec.clusters[].shardOverrides[*].replicas

类型：整型

替换指定分片的集群 mongot 副本计数。0 的值会将这些分片的 mongot 个实例置于脱机状态。

spec.clusters[].shardOverrides[*].resourceRequirements

类型：core/v1/ResourceRequirements

替换集群对指定分片的 CPU 和内存请求和限制。

spec.clusters[].shardOverrides[*].persistence

类型：对象

替换指定分片的集群持久卷配置。使用与 spec.clusters[].persistence 相同的模式。

spec.clusters[].shardOverrides[*].statefulSet

类型：对象

命名分片的 StatefulSet 覆盖。与其他覆盖字段不同，Kubernetes 操作符会将此值深度合并到集群的 spec.clusters[].statefulSet 值，而不是替换它。

spec.clusters[].shardOverrides[*].jvmFlags

类型：字符串数组

如果将其设置为非空列表，则替换集群用于指定分片的 spec.clusters[].jvmFlags。spec.clusters[].jvmFlags 的格式规则也适用于此字段。

同步源选择

spec.clusters[].syncSourceSelector

类型：对象

选择此集群入口中的 mongot 实例从哪些 mongod 节点同步数据。

spec.clusters[].syncSourceSelector.matchTagSets

类型：对象数组

副本集标签集的有序列表，通过副本集标签选择同步源 mongod 节点。这个 Kubernetes 操作符将列表传递给 mongot 配置。mongot 从第一个匹配的标签集选择的节点同步，并优先从节点同步。

每个条目都是标签名称到标签值的映射。空文档 ({}) 匹配任何节点，因此，如果没有早期标签集匹配，您可以添加尾随 {} 条目作为匹配任何回退。您最多可以指定 50 条目。

例子

spec:
  clusters:
    - syncSourceSelector:
        matchTagSets:
          - region: us-east-1
            workload: search
          - {}

JVM Flags

spec.clusters[].jvmFlags

类型：字符串数组

传递给 mongot进程的Java虚拟机（JVM）标志。Kubernetes Operator 使用 --jvm-flags "<all flags space-separated>" 在 mongot初创企业命令中包含未经修改的标志。

每个标志必须以 -X、-XX: 或 -D 开头，不得包含空格，且只能包含字母数字字符以及 .、_、+、:、- 和 = 字符。Kubernetes 操作符拒绝不符合这些规则的标志。

如果您未在此字段中指定 -Xms 或 -Xmx， Kubernetes 操作符 会自动计算堆大小，将两者设置为 spec.clusters[].resourceRequirements.requests.memory 的一半。如果您不指定资源要求， Kubernetes Operator 会使用默认4Gi 内存请求，产生大约 -Xmx2048m -Xms2048m。

如果您提供自己的 -Xms 或 -Xmx 值， Kubernetes 操作符 将使用它们并且不会覆盖这些值。Kubernetes Operator 始终将您提供的标志附加在 Operator 计算的标志之后。

要学习；了解更多信息，请参阅mongot的硬件大小调整。

例子

spec:
  clusters:
    - jvmFlags:
        - -Xms2g
        - -Xmx2g

StatefulSet 覆盖

spec.clusters[].statefulSet

类型：对象

Kubernetes 操作符为部署 mongot 节点而创建的 StatefulSet 的覆盖。Kubernetes 操作符始终最后应用覆盖，因此它们会覆盖 Kubernetes 操作符计算的设置。

该对象包含两个字段：

• metadata — 包含 Kubernetes 操作符合并到 StatefulSet 元数据中的 labels 和 annotations 字段。

• spec — apps/v1/StatefulSetSpec对象。Kubernetes 操作符将这些覆盖合并到 StatefulSet 规范中。

注意

请勿使用 spec.clusters[].statefulSet 来设立资源要求或持久性设置。请分别使用 spec.clusters[].resourceRequirements 和 spec.clusters[].persistence 字段。

高级 mongot 设置

spec.clusters[].advancedMongotConfigs

类型：对象

此集群入口的高级 mongot 设置。Kubernetes Operator 会在 mongot 配置文件的 advancedConfigs 密钥下逐字渲染该值，而不会读取或修改该值。此字段不会影响 Kubernetes 操作符在 mongot 配置中的其他位置生成的设置。

仅对于 MongoDBSearch 资源未作为一级字段公开的 mongot 设置使用此字段。