Ops Manager 资源规范

外部连接设置

本节介绍与MongoDB Ops Manager中的外部连接相关的可选设置。 有关多集群MongoDB Ops Manager部署的特定可选外部连接设置，请参阅多集群设置。

spec.externalConnectivity

类型：集合

启用与MongoDB Ops Manager 的外部连接的配置对象。 如果提供， Kubernetes Operator 将创建一个Kubernetes 服务，允许来自Kubernetes集群外部的流量到达MongoDB Ops Manager应用程序。

如果未提供，Kubernetes Operator 不会创建 Kubernetes 服务。 您必须手动创建一个解决方案，或使用第三方解决方案，使您能够将外部流量路由到 Kubernetes 集群中的 Ops Manager 应用程序。

spec.externalConnectivity.type

类型：字符串

在Kubernetes之外公开MongoDB Ops Manager 的Kubernetes服务 ServiceType。

Required if spec.externalConnectivity.type is present.

接受的值为： LoadBalancer和NodePort 。 如果您的云提供商支持，则建议使用LoadBalancer 。 使用NodePort进行本地部署。

spec.externalConnectivity.port

类型：整型

指示 Kubernetes 服务公开 Ops Manager 应用程序的端口应用于外部流量的值。

• If spec.externalConnectivity.type is NodePort:

  • Kubernetes 服务通过此端口向外部流量公开 Ops Manager 应用程序。

  • If you don't provide a spec.externalConnectivity.port value, the Kubernetes service routes traffic to the Ops Manager Application from an available port selected randomly from the following default range: 30000-32767.

    注意

    您必须将网络的防火墙配置为允许通过此端口的流量。

• If spec.externalConnectivity.type is LoadBalancer:

  • 云提供商创建的负载均衡器资源通过此端口公开 Ops Manager 应用程序。

  • 如果您不提供 值， Kubernetes服务将通过默认HTTPspec.externalConnectivity.port ()8080 或 HTTPS8443 () 端口向外部流量公开Ops Manager 应用程序。

spec.externalConnectivity.loadBalancerIP

类型：字符串

Kubernetes Operator 创建LoadBalancer Kubernetes 服务时使用的 IP 地址。

This setting can only be used if your cloud provider supports it and spec.externalConnectivity.type is LoadBalancer. To learn more about the Type LoadBalancer, see the Kubernetes documentation.

spec.externalConnectivity.externalTrafficPolicy

类型：字符串

将外部流量路由到 Ops Manager Kubernetes 服务的策略。该服务根据此设置的值将外部流量路由到节点本地或集群范围的端点。

接受的值为： Cluster和Local 。 要了解哪些值可以满足您的要求，请参阅 Kubernetes 中的源 IP 在 Kubernetes 文档中。

注意

如果您选择Cluster ，则客户端的Source-IP在 Kubernetes 网络边界发生的网络跳跃期间会丢失。

spec.externalConnectivity.annotations

类型：集合

键值对，允许您提供特定于云提供商的配置设置。

要了解有关 注解 的更多信息Amazon Web Services 上的 TLS 支持 ，请参阅Kubernetes 文档。

备份设置

本节介绍与MongoDB Ops Manager中的备份相关的可选设置。 有关特定于多集群MongoDB Ops Manager部署的可选备份设置，请参阅多集群设置。

spec.backup.assignmentLabels

类型：字符串数组

备份守护程序服务进程的分配标签列表。 使用分配标签来标识与特定项目相关联的特定备份守护进程。 如果使用Kubernetes Operator 设置分配标签，则在Kubernetes配置文件中为分配标签设置的值将覆盖MongoDB Ops Manager用户界面中定义的值。 未使用Kubernetes Operator 设置的分配标签将继续使用MongoDB Ops Manager用户界面中设置的值。

spec.backup.enabled

类型：布尔值

为 Ops Manager 资源启用备份的标志。设置为false时，将禁用备份。

默认值为true 。

spec.backup.encryption

类型：对象

包含备份加密配置设置的对象。

spec.backup.encryption.kmip

类型：对象

包含 KMIP 备份加密配置设置的对象。要了解更多信息，请参阅为 Ops Manager 配置 KMIP 备份加密。

注意

If you set this parameter, the API key linked with the value of spec.credentials must have the Global Owner role.

spec.backup.encryption.kmip.server

类型：对象

包含KMIP备份加密服务器配置设置的对象。

spec.backup.encryption.kmip.server.ca

类型：字符串

Human-readable label that identifies the ConfigMap that contains an entry for the CA certificate (ca.pem) to use for KMIP authentication.

spec.backup.encryption.kmip.server.url

类型：字符串

URL for the KMIP server that uses the hostname.port format (for example, 192.168.1.3:5696 or my-kmip-server.mycorp.com:5696).

spec.backup.headDB

类型：集合

头部数据库的配置设置。Kubernetes Operator 创建具有指定配置的持久卷声明。

标量	数据类型	说明
labelSelector	字符串	用于将已安装卷绑定到目录的标签。
storage	字符串	应安装的持久卷的最小大小。此值以整数表示，后跟采用 JEDEC 表示法的存储单位。 默认值为30Gi 。 要学习；了解更多信息，请参阅备份守护程序硬件要求。 示例，如果头部数据库需要60 GB 的存储空间，设立将该值设置为60Gi 。
storageClass	字符串	持久卷声明中指定的存储类型。您可以将此存储类型创建为 StorageClass 对象，然后再在此对象规范中使用。 Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.backup.jvmParameters

类型：字符串数组

可选。 传递给容器中 Ops Manager 备份服务的JVM参数。

此 Kubernetes Operator 参数默认为空列表。

spec:
  backup:
    jvmParameters: ["-XX:+UseStringCache"]

警告

更改 Java虚拟机（JVM） 内存堆值，需您自担风险

Kubernetes Operator calculates the JVM memory heap values of the backup service based on the container's memory. Changing the -Xms and -Xmx values can cause issues with Ops Manager.

spec.backup.members

类型：整型

Optional. Number of backup daemon services to deploy in Kubernetes. If not specified, defaults to 1. To ensure high availability for your backup service, deploy multiple backup daemons in Ops Manager.

spec.backup.opLogStores

类型：集合

如果启用备份，则为必填项。 用于备份的oplog存储数组。 大量中的每个项目都引用Kubernetes Operator 在Kubernetes集群中部署的MongoDB 数据库资源。

spec.backup.opLogStores.assignmentLabels

类型：字符串数组

oplog 存储的分配标签列表。 使用分配标签来标识特定 oplog 存储与特定项目相关联。 如果使用Kubernetes Operator 设置分配标签，则在Kubernetes配置文件中为分配标签设置的值将覆盖MongoDB Ops Manager用户界面中定义的值。 未使用Kubernetes Operator 设置的分配标签将继续使用MongoDB Ops Manager用户界面中设置的值。

spec.backup.opLogStores.name

类型：字符串

如果启用备份，则为必填项。 oplog 存储的名称。

重要

一旦指定，请勿编辑 oplog 存储的名称。

spec.backup.opLogStores.mongodbResourceRef.name

类型：字符串

如果启用备份，则为必填项。 您创建的用于存储oplog切片的MongoDB资源或MongoDBMultiCluster资源的名称。 您必须将此资源部署在与MongoDB Ops Manager资源相同的命名空间中。

Oplog 数据库仅支持SCRAM身份验证机制。 您无法启用其他身份验证机制。

如果在 oplog 数据库上启用SCRAM身份验证，则必须：

• 创建 MongoDB 资源以将 Ops Manager 连接到 oplog 数据库。

• Specify the name of the user in the Ops Manager resource definition.

如果不存在具有此名称的 MongoDB database 资源，则backup资源将进入Pending状态。Kubernetes 操作符每 10 秒重试一次，直到创建具有此名称的 MongoDB database 资源。

注意

当您对此设置中引用的数据库资源进行安全更改时，Kubernetes 操作符开始自动协调 Ops Manager 资源。Kubernetes 操作符根据您的更改更新 Ops Manager 配置中的mongoUri和ssl标志。

spec.backup.opLogStores.mongodbUserRef.name

类型：字符串

SCRAM如果在 上启用了Oplog Store Database 身份验证，则为必填项。MongoDB用于连接 的Oplog Store Database 用户资源的名称。将此用户资源部署在与MongoDB Ops Manager资源相同的命名空间中，并具有以下所有角色：

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

spec.backup.blockStores

类型：集合

如果启用使用块存储的备份，则为必填项。 用于备份的块存储数组。 数组中的每个项目都引用MongoDB database KubernetesKubernetesOperator 在 集群中部署的 资源。

spec.backup.blockStores.assignmentLabels

类型：字符串数组

块存储的分配标签列表。 使用分配标签来标识特定的块存储与特定项目相关联。 如果使用Kubernetes Operator 设置分配标签，则在Kubernetes配置文件中为分配标签设置的值将覆盖MongoDB Ops Manager用户界面中定义的值。 未使用Kubernetes Operator 设置的分配标签将继续使用MongoDB Ops Manager用户界面中设置的值。

spec.backup.blockStores.name

类型：字符串

如果使用块存储启用备份，则为必填项。 块存储的名称。

重要

指定后，请勿编辑块存储的名称。

spec.backup.blockStores.mongodbResourceRef.name

类型：字符串

如果使用块存储启用备份，则为必填项。 您为块存储创建的MongoDB database资源的名称。 您必须将此数据库资源部署在与MongoDB Ops Manager资源相同的命名空间中。

块存储数据库仅支持SCRAM身份验证机制。 您无法启用其他身份验证机制。

如果在块存储数据库上启用SCRAM身份验证，则必须：

• 创建 MongoDB 用户资源以将 Ops Manager 连接到块存储数据库。

• Specify the name of the user in the Ops Manager resource definition.

如果不存在具有此名称的 MongoDB database 资源，则backup资源将进入Pending状态。Kubernetes 操作符每 10 秒重试一次，直到创建具有此名称的 MongoDB database 资源。

注意

当您对此设置中引用的数据库资源进行安全更改时，Kubernetes 操作符开始自动协调 Ops Manager 资源。Kubernetes 操作符根据您的更改更新 Ops Manager 配置中的mongoUri和ssl标志。

spec.backup.blockStores.mongodbUserRef.name

类型：字符串

如果在块存储数据库上启用了 SCRAM 身份验证，则为必填项。 用于连接块存储数据库的 MongoDB 用户资源的名称。 将此用户资源部署在与MongoDB Ops Manager资源相同的命名空间中，并具有以下所有角色：

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

spec.backup.queryableBackupSecretRef.name

类型：字符串

包含来自 的 Queryable.pem MongoDB Ops Manager文件的密钥名称，您将使用该文件根据部署的 TLS 要求访问和查询备份。PEM 文件包含公钥证书及其关联的私钥，访问和查询所需的在 中对备份快照运行查询。MongoDB Ops Manager要查询备份，请指定此参数的值。 如果未设置，备份不受影响，但无法查询。

spec.backup.statefulSet.spec

类型：集合

MongoDB Controllers for Kubernetes Operator 为 备份守护进程服务 创建的 StatefulSet 规范。

To review which fields you can add to spec.backup.statefulSet.spec, see StatefulSetSpec v1 apps in the Kubernetes documentation.

spec.backup.statefulSet.spec.template

类型：集合

Template for the Kubernetes Pods in the StatefulSet that the MongoDB Controllers for Kubernetes Operator creates for the backup daemon service.

注意

The Kubernetes Operator doesn't validate the fields you provide in spec.backup.statefulSet.spec.template.

spec.backup.statefulSet.spec.template.metadata

类型：集合

Kubernetes Operator 的MongoDB控制器为备份守护进程服务创建的 StatefulSet 中Kubernetes Pod 的元数据。

To review which fields you can add to spec.backup.statefulSet.spec.template.metadata, see the Kubernetes documentation.

spec.backup.statefulSet.spec.template.spec

类型：集合

Kubernetes Operator 的MongoDB控制器为备份守护进程服务创建的 StatefulSet 中Kubernetes Pod 的规范。

To review the complete list of fields you can add to spec.backup.statefulSet.spec.template.spec, see the Kubernetes documentation.

以下示例spec.backup.statefulSet.spec.template.spec 定义了 MongoDB Controllers for Kubernetes Operator 部署的一个 备份守护进程服务 容器的最小和最大 CPU 和内存容量：

提示

有关运行 Ops Manager 组件的主机的硬件、软件和网络要求的更多信息，请参阅 Ops Manager 系统要求 在 Ops Manager 文档中。

statefulSet:
  spec:
    template:
      spec:
        containers:
        - name: mongodb-backup-daemon
          resources:
            requests:
              cpu: "4"
              memory: "8Gi"
            limits:
              cpu: "8"
              memory: "16Gi"

spec.backup.statefulSet.spec.template.spec.containers

类型：集合

属于MongoDB Controllers for Kubernetes Operator 为备份守护进程服务创建的 StatefulSet 中Kubernetes Pod 的容器列表。

To modify the specifications of the backup daemon service container, you must provide the exact name of the container using the name field, as shown in the following example:

backup:
 statefulSet:
   spec:
     template:
       spec:
         containers:
         - name: mongodb-backup-daemon

注意

当您将容器添加到spec.backup.statefulSet.spec.template.spec.containers时，Kubernetes Operator 会将它们添加到 Kubernetes Pod 中。 这些容器附加到 Pod 中的备份守护程序服务容器。

spec.backup.statefulSet.spec.template.spec.containers.resources.requests.cpu

类型：字符串

Kubernetes节点上托管备份守护进程服务必须提供的最小 CPU容量。

The requested value must be less than or equal to spec.backup.statefulSet.spec.template.spec.containers.resources.limits.cpu.

spec.backup.statefulSet.spec.template.spec.containers.resources.limits.cpu

类型：字符串

Maximum CPU capacity for the node being created to host the backup daemon service. If omitted, this value is set to spec.backup.statefulSet.spec.template.spec.containers.resources.requests.cpu.

spec.backup.statefulSet.spec.template.spec.containers.resources.requests.memory

类型：字符串

Kubernetes 节点 上必须可用的最小内存容量 在Kubernetes上托管 备份守护进程服务 。该值以整数表示，后跟采用JEDEC表示法的内存单位。

注意

将此值至少设置为4.5Gi 。 小于4.5Gi的值可能会导致错误。

The requested value must be less than or equal to spec.backup.statefulSet.spec.template.spec.containers.resources.limits.memory.

spec.backup.statefulSet.spec.template.spec.containers.resources.limits.memory

类型：字符串

Maximum memory capacity for the node being created to host the backup daemon service. If omitted, this value is set to spec.backup.statefulSet.spec.template.spec.containers.resources.requests.memory.

Kubernetes Operator 根据容器内存计算并设置 Java 堆大小的参数。

警告

将此值限制为小于 32 GB

将此值设置为大于 32 GB ( 32Gi ) 的值可能会导致备份服务出现问题。 过多的堆可能会在 Ops Manager 中导致不可预知的结果。

S3 设置

您可以将Ops Manager配置为使用 S3 存储 oplog 和备份快照，并使用自定义 CA 颁发的密钥通过 TLS 保护与 S3 的连接。

To configure custom CA keys, use the ConfigMap with which you configured TLS for your Application Database as described on the TLS-Encrypted Connection (HTTPS) tab of Deploy an Ops Manager Resource. Set spec.applicationDatabase.security.tls.ca to this ConfigMap.

您可以将 TLS 同时用于 S3 和应用程序数据库，或仅用于 S3。

• To use TLS for both, get certificates for both purposes from the same ca-pem referenced in the ConfigMap.

• 要仅将 TLS 用于 S3，请不要在 ConfigMap 中定义 spec.security.applicationDatabase.certsSecretPrefix。

spec.backup.s3OpLogStores.assignmentLabels

类型：字符串数组

S3 oplog存储的分配标签列表。使用分配标签来标识特定的 S3 oplog存储与特定项目相关联。如果使用Kubernetes Operator设立分配标签，则在Kubernetes配置文件中为分配标签设立的值将覆盖Ops Manager用户界面中定义的值。未使用Kubernetes Operator设立的分配标签将继续使用Ops Manager 用户界面中设立的值。

spec.backup.s3OpLogStores.customCertificate

类型：布尔值

Deprecated. Use spec.backup.s3OpLogStores.customCertificateSecretRefs instead.

指示是否使用 AppDB 证书 (appdb-ca) 作为 S3 oplog存储的自定义 TLS 证书的标志。默认值为 False。

spec.backup.s3OpLogStores.customCertificateSecretRefs

类型：对象数组

使用Kubernetes密钥的 S3 oplog存储的自定义证书列表。 base64 编码的 x.509 证书必须已存在于带有密钥的Kubernetes密钥中，并且必须可由Java CertifcateFactory 进行解析。您不能在一个密钥中指定链中的多个证书。如果您在一个密钥中指定链中的多个证书， Kubernetes Operator 仅使用链中的第一个证书。如果您还提供了 customCertificate 设置， Kubernetes Operator 将使用 spec.applicationDatabase.security.tls.ca 作为备份的自定义证书。

Each entry in the list specifies the name and the key. If you specify multiple secrets, Kubernetes Operator uses all the certificates in the specified secrets.

如果您不提供此设置，Ops Manager 将使用 Ops Manager 使用的JVM默认信任存储。

spec.backup.s3OpLogStores.customCertificateSecretRefs.name

类型：字符串

需要为 S3 oplog存储使用自定义证书。包含自定义证书的Kubernetes密钥。

spec.configuration.mms.mongoDbUsage.defaultUsageType

类型：字符串

Kubernetes 服务的默认服务器类型。

spec.backup.s3OpLogStores.customCertificateSecretRefs.key

类型：字符串

需要为 S3 oplog存储使用自定义证书。表示包含 base64-encoded x.509 证书的密钥中密钥的文件。如果不指定此设置， Kubernetes Operator 无法将自定义证书用于 S3 oplog存储备份。

spec.backup.s3OpLogStores.irsaEnabled

类型：布尔值

启用在 AWS EKS 中使用服务帐户的 AWS IAM 角色来配置 S3 oplog存储的标志。默认值为 False。如果您不使用 AWS EKS，则此标志无效。当设立为 False 时，将禁用使用 EKS 中服务帐户的 AWS IAM 角色配置 S3 oplog存储。要学习；了解更多信息，请参阅 EKS 中服务账户的 IAM 角色。

spec.backup.s3OpLogStores.name

类型：字符串

使用 S3存储来存储oplog是必需的。 S3 oplog存储的名称。

spec.backup.s3OpLogStores.mongodbResourceRef.name

类型：字符串

您创建的用于存储S3 oplog存储的元数据的 MongoDB 数据库资源的名称。您必须将此数据库资源部署在与Ops Manager资源相同的命名空间中。

注意

省略此设置可使用应用程序数据库存储S3 oplog存储的元数据。

If you omit this setting, you must also omit the spec.backup.s3OpLogStores.mongodbUserRef.name setting. The Kubernetes Operator handles SCRAM user authentication internally.

如果您对此数据库启用SCRAM身份验证，则必须：

• 创建 MongoDB 用户资源以将 Ops Manager 连接到数据库。

• Specify the name of the user in the Ops Manager resource definition.

spec.backup.s3OpLogStores.mongodbUserRef.name

类型：字符串

如果您创建了MongoDB 数据库资源来存储S3 oplog元数据并且在此数据库上启用了SCRAM，则为必填项。用于连接到 S3 oplog存储的元数据数据库的MongoDB用户资源的名称。将此用户资源部署在与Ops Manager资源相同的命名空间中，并具有以下所有角色：

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

指定后，请勿编辑 S3元数据oplog存储用户名名 的名称。

spec.backup.s3OpLogStores.s3SecretRef.name

类型：字符串

如果 spec.backup.s3OpLogStores.irsaEnabled 未设立为 true，则需要使用 S3存储来存储oplog 。

包含 accessKey 和 secretKey 字段的密钥名称。备份守护进程服务使用这些字段的值作为凭证来访问权限AWS S3 或 S3 兼容存储桶。要配置 S3 oplog存储，您必须在密钥中指定两个密钥。

如果将 spec.backup.s3OpLogStores.irsaEnabled设立为 true，则无需设立s3SecretRef，因为Amazon Web Services S3凭证将作为 Pod 环境变量安装。

spec.backup.s3OpLogStores.pathStyleAccessEnabled

类型：布尔值

指示存储桶端点 URL 的样式。

值	说明	例子
true	路径样式 URL	s3.amazonaws.com/<bucket>
false	虚拟主机样式 URL	<bucket>.s3.amazonaws.com

To learn more about annotations and TLS support on AWS, see the Kubernetes documentation.

默认值为true 。

spec.backup.s3OpLogStores.s3BucketEndpoint

类型：字符串

使用 S3存储来存储oplog是必需的。托管oplog存储的 AWS S3 存储桶或 S3 兼容存储桶的URL 。

注意

If your endpoint doesn't include a region in its URL, specify the s3RegionOverride field.

spec.backup.s3OpLogStores.s3BucketName

类型：字符串

使用 S3存储来存储oplog是必需的。托管oplog存储的 AWS S3 存储桶或 S3 兼容存储桶的名称。

spec.backup.s3OpLogStores.s3RegionOverride

类型：字符串

S3 兼容存储桶所在的区域。仅当 S3 oplog存储的 s3BucketEndpoint 不支持地区作用域时才使用此字段。地区范围是指您的端点在其URL中不包含地区。

请勿将此字段与 AWS S3 存储桶一起使用。有关更多信息，请参阅 S3 块存储配置。

spec.backup.s3Stores.assignmentLabels

类型：字符串数组

存储数据库备份快照的 S3 或 S3 兼容存储桶的分配标签列表。使用分配标签来标识特定的 S3 存储与特定项目相关联。如果使用Kubernetes Operator设立分配标签，则在Kubernetes配置文件中为分配标签设立的值将覆盖Ops Manager用户界面中定义的值。未使用Kubernetes Operator设立的分配标签将继续使用Ops Manager 用户界面中设立的值。

spec.backup.s3Stores.customCertificate

类型：布尔值

Deprecated. Use spec.backup.s3Stores.customCertificateSecretRefs instead.

指示是否使用应用程序数据库的证书 (appdb-ca) 作为 S3 备份的自定义 TLS 证书的标志。默认值为 False。

spec.backup.s3Stores.customCertificateSecretRefs

类型：对象数组

使用Kubernetes密钥的 S3快照存储的自定义证书列表。 base64 编码的 x.509 证书必须已存在于带有密钥的Kubernetes密钥中，并且必须可由Java CertifcateFactory 进行解析。您不能在一个密钥中指定链中的多个证书。如果您在一个密钥中指定链中的多个证书， Kubernetes Operator 仅使用链中的第一个证书。如果您还提供了 spec.backup.s3Stores.customCertificate 设置， Kubernetes Operator 将使用 spec.applicationDatabase.security.tls.ca 作为备份的自定义证书。

Each entry in the list specifies the name and the key. If you specify multiple secrets, Kubernetes Operator uses all the specified secrets.

如果您不提供此设置，Kubernetes 操作符将使用 Ops Manager 使用的Java虚拟机（JVM）默认信任存储进行备份。

spec.backup.s3Stores.customCertificateSecretRefs.name

类型：字符串

Required to use custom certificates for your S3 oplog store. Kubernetes secret that contains the custom certificate.

spec.backup.s3Stores.customCertificateSecretRefs.key

类型：字符串

需要为 S3 oplog存储使用自定义证书。表示包含 base64-encoded x.509 证书的密钥中密钥的文件。如果不指定此设置， Kubernetes Operator 无法将自定义证书用于 S3快照存储，而默认为Ops Manager使用的默认信任存储。

spec.backup.s3Stores.irsaEnabled

类型：布尔值

启用在 AWS EKS 中使用服务帐户的 AWS IAM 角色来配置 S3快照存储的标志。默认值为 False。如果您不使用 AWS EKS，则此标志无效。当设立为 False 时，将禁用使用 EKS 中服务帐户的 AWS IAM 角色配置 S3快照存储。要学习；了解更多信息，请参阅 EKS 中服务账户的 IAM 角色。

spec.backup.s3Stores.name

类型：字符串

使用 S3存储来存储oplog是必需的。 S3快照存储的名称。

重要

指定后，请勿编辑 S3快照存储的名称。如果备份使用旧名称，此更改可能会失败。成功变革的后果是不可预测的。

spec.backup.s3Stores.mongodbResourceRef.name

类型：字符串

您创建的用于存储S3快照存储存储元数据的MongoDB资源或 MongoDBMultiCluster资源的名称。您必须将此数据库资源部署在与Ops Manager资源相同的命名空间中。

注意

省略此设置可使用应用程序数据库存储S3快照存储的元数据。

If you omit this setting, you must also omit the spec.backup.s3Stores.mongodbUserRef.name setting. The Kubernetes Operator handles SCRAM user authentication internally.

如果您对此数据库启用SCRAM身份验证，则必须：

• 创建 MongoDB 用户资源以将 Ops Manager 连接到数据库。

• Specify the name of the user in the Ops Manager resource definition.

重要

Once specified, don't edit the name of the S3 snapshot store. This change will likely fail if backups use the old name. The consequences of a successful change are unpredictable.

如果不存在具有此名称的 MongoDB database 资源，则backup资源将进入Pending状态。Kubernetes 操作符每 10 秒重试一次，直到创建具有此名称的 MongoDB database 资源。

注意

当您对此设置中引用的数据库资源进行安全更改时，Kubernetes 操作符开始自动协调 Ops Manager 资源。Kubernetes 操作符根据您的更改更新 Ops Manager 配置中的mongoUri和ssl标志。

spec.backup.s3Stores.mongodbUserRef.name

类型：字符串

如果您创建了MongoDB 数据库资源来存储|s3|，则为必填项快照元数据和SCRAM在此数据库上启用。用于连接到 S3快照存储的元数据数据库的MongoDB用户资源的名称。将此用户资源部署在与Ops Manager资源相同的命名空间中，并具有以下所有角色：

• readWriteAnyDatabase

• dbAdminAnyDatabase

• clusterMonitor

重要

指定后，请勿编辑 S3元数据快照存储用户名名 的名称。

spec.backup.s3Stores.s3SecretRef.name

类型：字符串

如果使用 S3存储启用备份并且未将 spec.backup.s3Stores.irsaEnabled设立为 true，则为必填项。

包含 accessKey 和 secretKey 字段的密钥名称。备份守护进程服务使用这些字段的值作为凭证来访问权限AWS S3 或 S3 兼容存储桶。如果密钥缺少任一密钥，则无法配置 S3快照存储。

如果将 spec.backup.s3Stores.irsaEnabled设立为 true，则无需设立s3SecretRef，因为Amazon Web Services S3凭证将作为 Pod 环境变量安装。

spec.backup.s3Stores.pathStyleAccessEnabled

类型：布尔值

指示存储桶端点 URL 的样式。

值	说明	例子
true	路径样式 URL	s3.amazonaws.com/<bucket>
false	虚拟主机样式 URL	<bucket>.s3.amazonaws.com

默认值为true 。

spec.backup.s3Stores.s3BucketEndpoint

类型：字符串

如果使用 S3存储启用备份，则为必填项。托管快照存储的 AWS S3 存储桶或 S3 兼容存储桶的URL 。

注意

If your endpoint doesn't include a region in its URL, specify the s3RegionOverride field.

spec.backup.s3Stores.s3BucketName

类型：字符串

如果使用 S3存储启用备份，则为必填项。托管快照存储存储的 AWS S3 存储桶或 S3 兼容存储桶的名称。

spec.backup.s3Stores.s3RegionOverride

类型：字符串

S3 兼容存储桶所在的区域。仅当 S3 存储的 s3BucketEndpoint 不支持地区范围时才使用此字段。地区范围是指您的端点在其URL中不包含地区。

Don't use this field with AWS S3 buckets. For more information, see S3 Blockstore Configuration.

Prometheus 设置

将 Prometheus 与应用程序数据库结合使用时，以下设置应用：

spec.applicationDatabase.prometheus

类型：数组

可选。列表，其中包含用于向 Prometheus 公开指标的参数。

spec.applicationDatabase.prometheus.metricsPath

类型：字符串

默认值："/metrics"

可选。人类可读的字符串，指示指标终结点的路径。如果不指定此设置，则使用默认设置。

spec.applicationDatabase.prometheus.passwordSecretRef

类型：对象

Conditional Object that contains the details of the secret for basic HTTP authentication. If you want to use Prometheus with your Application Database, you must specify this setting.

spec.applicationDatabase.prometheus.passwordSecretRef.key

类型：字符串

默认值："password"

Optional. Human-readable string that identifies the key in the secret that stores the password for basic HTTP authentication. If you don't specify this setting, the default applies.

spec.applicationDatabase.prometheus.passwordSecretRef.name

类型：字符串

可选的

Human-readable label that identifies the secret that contains the password for basic HTTP authentication. If you want to use Prometheus with your Application Database, you must specify this setting.

spec.applicationDatabase.prometheus.port

类型：整型

默认值：9216

可选。数字，用于标识指标终结点将绑定的端口。如果不指定此设置，则使用默认设置。

spec.applicationDatabase.prometheus.tlseSecretKeyRef

类型：对象

Optional. Object that contains the details of the secret for TLS authentication.

spec.applicationDatabase.prometheus.tlseSecretKeyRef.key

类型：字符串

默认值："password"

可选。人类可读的字符串，用于标识存储 TLS身份验证密码的密钥中的密钥。如果不指定此设置，则应用默认。

spec.applicationDatabase.prometheus.tlseSecretKeyRef.name

类型：字符串

有条件。人类可读标签，用于标识包含 TLS身份验证密码的密钥。如果要将 Prometheus 与应用程序数据库一起使用并且想要使用 TLS 身份验证，则必须指定此设置。

spec.applicationDatabase.prometheus.username

类型：字符串

有条件。 人类可读标签，用于标识用户以进行基本 HTTP 身份验证。 如果要将 Prometheus 与应用程序数据库一起使用，则必须指定此设置。

MongoDB Ops Manager所需设置

除了所需的 MongoDB Ops Manager 设置之外，本部分还介绍了多集群MongoDB Ops Manager部署必须使用的MongoDB Ops Manager 。

spec.clusterSpecList.members

类型：整型

Conditional. The number of Ops Manager members in the Ops Manager cluster in a multi-Kubernetes cluster MongoDB deployment. When you set spec.topology to MultiCluster, you must specify the value for this parameter. Omit this parameter for single-cluster deployments. If you set this parameter to zero, this removes this Ops Manager member cluster from the list of member clusters in the multi-Kubernetes cluster of Ops Manager instances.

spec.topology

类型：字符串

KubernetesMongoDB Ops Manager资源的 部署类型。

• 值为SingleCluster或MultiCluster 。 如果省略，则默认值为SingleCluster 。

• 如果指定MultiCluster ：

  • 将MongoDBMultiCluster资源添加到监视的资源列表中。 这向 Kubernetes Operator 表明它应该在多 Kubernetes 集群模式下工作，并执行处理多 Kubernetes 资源所需的配置动作。

  • Specify at least one member cluster on which you want to deploy Ops Manager, using spec.clusterSpecList and its nested spec.clusterSpecList.clusterName and spec.clusterSpecList.members parameters.

  • 如果您指定MultiCluster ， Kubernetes Operator 将忽略您为spec.members设立的任何值。 请参阅资源规范的示例。

MongoDB Ops Manager可选设置

MongoDB Ops Manager资源还可以使用以下特定于多集群MongoDB Ops Manager部署的设置：

spec.clusterSpecList

类型：集合

有条件。 Kubernetes打算在其中部署Kubernetes MongoDB Ops Manager或备份守护程序实例的多 集群中所选 成员集群的详细信息。另请参阅资源规范的示例。

• When you set spec.topology to MultiCluster, you must specify the value for spec.clusterSpecList.members. All other parameters under spec.clusterSpecList are optional.

• When you set spec.topology to SingleCluster, the Kubernetes Operator ignores all parameters under spec.clusterSpecList.

spec.clusterSpecList.clusterName

类型：字符串

可选。多 Kubernetes集群MongoDB 部署中成员Kubernetes集群的名称，在该部署中， Kubernetes Operator 的MongoDB控制器为MongoDB Ops Manager或备份守护程序进程调度StatefulSet。

spec.clusterSpecList.clusterDomain

类型：字符串

Optional. An override for spec.clusterDomain for the specific Ops Manager member cluster. If you omit this value, defaults to the value set in spec.clusterDomain. Kubernetes assigns each Pod a FQDN. The Kubernetes Operator calculates the FQDN for each Pod using a provided clusterDomain value. Kubernetes doesn't provide an API to query these hostnames.

spec.clusterSpecList.configuration

类型：集合

Optional. Ops Manager configuration properties that override properties you set in spec.configuration for the specific cluster. See Ops Manager Configuration Settings for property names and descriptions. Each property takes a value of type string. For example, setting these properties allows you to change environment variables that you must pass to Ops Manager and the Backup Daemon in that particular member cluster.

If you omit specifying values, defaults to the values set in spec.configuration.

spec.clusterSpecList.jvmParameters

类型：字符串数组

可选。 传递给该成员集群的 和备份守护程序实例的 JVM 参数。MongoDB Ops Manager

• If you specify this parameter, its values override the values specified in spec.jvmParameters. For example values, see the example of the resource specification.

• If you omit this parameter, values from the spec.jvmParameters are used for the Ops Manager and Backup Daemon instances in this member cluster.

spec.clusterSpecList.externalConnectivity

类型：集合

Optional. Configuration object that enables external connectivity to Ops Manager for the specific cluster. This is an override for spec.externalConnectivity for the specific cluster.

指定此参数的值以更改MongoDB Ops Manager应用程序在不同集群中向外部公开的方式。 示例，如果您在不同云提供商的 节点上部署MongoDB Ops Manager Kubernetes，则可能需要为此参数指定特定于云提供商的值。

如果设置此参数：

• The Kubernetes Operator doesn't use spec.externalConnectivity values for this member Ops Manager cluster.

• The Kubernetes Operator creates a Kubernetes service, named <om-name>-svc-ext, that allows traffic originating from outside of the Kubernetes cluster to reach the Ops Manager application on this member cluster.

If you omit this parameter, the Kubernetes Operator uses values from spec.externalConnectivity for this member cluster.

spec.clusterSpecList.statefulSet.spec

类型：集合

Optional. Specification for the StatefulSet that the MongoDB Controllers for Kubernetes Operator creates for a specific member cluster in the multi-Kubernetes cluster Ops Manager deployment. This parameter is an override for spec.statefulSet.spec. If you omit it, the Kubernetes Operator uses the values from spec.statefulSet.spec. For example, you can use this parameter to specify different storage values for each of your Ops Manager clusters in the multi-Kubernetes cluster MongoDB deployment.

To review which fields you can add to spec.clusterSpecList.statefulSet.spec, see StatefulSetSpec v1 apps in the Kubernetes documentation.

spec.clusterSpecList[*].backup

可选。 覆盖在spec.backup下为该特定成员集群指定的值的备份设置。

• You can set these values only if spec.backup.enabled is set to true.

• 如果您省略为此参数设置任何值，则它们默认为spec.backup下的设置中指定的值。

• 此覆盖并不支持所有备份设置。 您无法覆盖以下备份设置，因为它们会全局应用于所有成员集群（如果在spec.backup下指定）：

  • externalServiceEnabled

  • headDB

  • opLogStores

  • blockStores

  • s3Stores

  • fileSystemStores

  • queryableBackupSecretRef

  • encryption

spec.clusterSpecList[*].backup.members

类型：整型

Optional. Override for spec.backup.members. The number of Backup Daemon instances to deploy in this cluster. if you omit this value or provide a value of 0, the Kubernetes Operator won't deploy Backup Daemon instances in a particular member cluster.

spec.clusterSpecList[*].backup.assignmentLabels

类型：字符串数组

Optional. Override for spec.backup.assignmentLabels. If specified, the Kubernetes Operator uses the values you specify in this override for all Backup Daemon instances in a particular member cluster. If you omit values for this parameter, the values default to those specified in spec.backup.assignmentLabels for all Backup Daemon instances in a member cluster.

spec.clusterSpecList[*].backup.jvmParameters

类型：字符串数组

Optional. Override for spec.backup.jvmParameters. Allows you to customize the JVM value for Backup Daemon instances in a particular member cluster.

spec.clusterSpecList[*].backup.statefulSet

类型：字符串

可选。覆盖spec.backup.statefulSet.spec 。允许自定义特定成员集群中备份守护程序的值。要查看哪些字段可以添加到 ，请参阅Kubernetes文档中的spec.clusterSpecList[*].backup.statefulSet StatefulSetSpec v1 应用。

应用程序数据库所需设置

本部分介绍必须用于应用程序数据库的多集群MongoDB Ops Manager部署的特定设置。

spec.applicationDatabase.clusterSpecList

类型：集合

多 Kubernetes集群MongoDB 部署中选定的Kubernetes成员集群的详细信息，这些集群提供服务托管应用程序数据库的节点。

spec.applicationDatabase.clusterSpecList.clusterName

类型：字符串

多 Kubernetes集群MongoDB 部署中成员Kubernetes集群的名称，其中MongoDB Controllers for Kubernetes Operator 为应用程序数据库调度 StatefulSet。

重要

You can't convert a single cluster Ops Manager instance to a multi-Kubernetes cluster MongoDB deployment instance by modifying the topology and the clusterSpecList settings in the CRD.

spec.applicationDatabase.clusterSpecList.members

类型：数字

给定成员集群中的 StatefulSet 节点数。 成员集群是多 Kubernetes 集群 MongoDB 部署中托管应用程序数据库的成员集群之一。

spec.applicationDatabase.topology

类型：字符串

应用程序数据库的 Kubernetes 部署类型。

• 值为SingleCluster或MultiCluster 。 如果省略，则默认值为SingleCluster 。

• 如果指定MultiCluster ，则必须至少指定一名成员

• cluster on which you want to deploy the Application Database using the clusterSpecList, clusterName, members parameters.

• 如果您指定MultiCluster ， Kubernetes Operator 将忽略您为spec.applicationDatabase.members字段设立的值。

要了解更多信息，请参阅多集群资源规范示例。

应用程序数据库可选设置

本部分介绍可用于应用程序数据库的多集群MongoDB Ops Manager部署的特定设置。

spec.applicationDatabase.clusterSpecList.externalAccess

类型：字符串

用于向外部公开您的副本集部署的外部域。

By default, each replica set member uses the Kubernetes Pod's FQDN (*.svc.cluster.local) as the default hostname. However, if you add an external domain to this setting, the replica set uses a hostname that is a subdomain of the specified domain instead. This hostname uses the following format:

<replica-set-name>-<cluster-idx>-<pod-idx>.<externalDomain>

例如：

multi-replica-set-0-1.cluster-0.example.com

重要

仅当在没有服务网格的情况下部署应用程序数据库时，才使用此设置。请参阅不使用服务网格的多集群MongoDB Ops Manager。

spec.applicationDatabase.clusterSpecList.memberConfig

类型：字符串数组

多集群MongoDB Ops Manager部署中每个应用程序数据库副本集节点的规范。

重要

If you set spec.topology to SingleCluster, use spec.applicationDatabase.memberConfig instead of spec.applicationDatabase.clusterSpecList.memberConfig.

The number of elements in the memberConfig list must equal spec.applicationDatabase.clusterSpecList.members.

memberConfig列表中元素的顺序必须反映副本集成员的顺序。 示例，大量的第一个元素会影响索引0的 Pod，第二个元素会影响索引1的 Pod，依此类推。

例子

请考虑以下应用程序数据库的三成员副本集的示例规范：

spec:
  replicas: 3
  version: 8.0.0
  backup:
    enabled: true
  storage:
    resources:
      requests:
        storage: 10Gi
      storageClassName: standard
  applicationDatabase:
    clusterSpecList:
      - name: appdb
        members: 3
        memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
              tag1: "value1"
              environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
              tag2: "value2"
              environment: "prod"
          - votes: 0
            priority: "0"
            tags:
              tag2: "value2"
              environment: "prod"

spec.applicationDatabase.clusterSpecList.memberConfig.priority

类型：字符串

表示应用程序数据库副本集成员成为主节点 (primary node in the replica set)节点的相对可能性的数字。

• 要增加副本集节点成为主节点的相对可能性，请指定较高的 priority 值。

• 要降低副本集节点成为主节点的相对可能性，请指定较低的 priority 值。

例如，memberConfig.priority 为 1.5 的成员比 memberConfig.priority 为 0.5 的成员更有可能成为主节点。

memberConfig.priority 为 0 的节点没有资格成为主节点。要了解更多信息，请参阅节点优先级。

spec.applicationDatabase.clusterSpecList.memberConfig.tags

类型：地图

副本集标记映射，用于将读取和写入操作定向到应用程序数据库副本集的特定成员。

spec.applicationDatabase.clusterSpecList.memberConfig.votes

类型：数字

Determines whether an Application Database replica set member can vote in an election. Set to 1 to allow the member to vote. Set to 0 to exclude the member from an election.