Ops Manager 资源规范

外部连接设置

This section describes optional settings related to external connectivity in Ops Manager. For optional external connectivity settings specific to your multi-cluster Ops Manager deployment, see Multi-Cluster Settings.

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 应用程序。

  • If you don't provide a spec.externalConnectivity.port value, the Kubernetes service exposes the Ops Manager Application to external traffic through the default HTTP (8080) or HTTPS (8443) port.

spec.externalConnectivity.loadBalancerIP

类型：字符串

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

仅当您的云提供商支持且 spec.externalConnectivity.type 为 LoadBalancer 时，才能使用此设置。要学习；了解有关类型 LoadBalancer 的更多信息，请参阅Kubernetes文档。

spec.externalConnectivity.externalTrafficPolicy

类型：字符串

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

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

注意

如果您选择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

类型：对象

Object that contains the KMIP backup encryption configuration settings. To learn more, see Configure KMIP Backup Encryption for Ops Manager.

注意

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

类型：字符串

人类可读标签，用于标识包含用于 KMIP 身份验证的 CA 证书 () 的条目的 ConfigMap。ca.pem

spec.backup.encryption.kmip.server.url

类型：字符串

KMIP 服务器的 URLhostname.port 192.168.1.3:5696my-kmip-server.mycorp.com:5696，该 URL 采用 格式 (示例如 或)。

spec.backup.headDB

类型：集合

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

标量	数据类型	说明
labelSelector	字符串	用于将挂载卷绑定到目录的标签。
storage	字符串	应安装的持久卷的最小大小。此值以整数表示，后跟采用 JEDEC 表示法的存储单位。 默认值为30Gi 。 要学习；了解更多信息，请参阅备份守护程序硬件要求。 示例，如果头部数据库需要60 GB 的存储空间，设立将该值设置为60Gi 。
storageClass	字符串	持久卷声明中指定的存储类型。您可以先将此存储类型创建为StorageClass对象，然后再用于此对象规范。 确保将StorageClass reclaimPolicy设立为Retain。这可确保在删除持久卷声明时保留数据。

spec.backup.jvmParameters

类型：字符串数组

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

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

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

警告

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

Kubernetes 操作符根据容器的内存计算备份服务的 Java虚拟机（JVM） 内存堆值。更改 -Xms 和 -Xmx 值可能会导致 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

类型：集合

Required if you enable backup. Array of oplog stores used for backup. Each item in the array references a MongoDB database resource deployed in the Kubernetes cluster by the Kubernetes Operator.

spec.backup.opLogStores.assignmentLabels

类型：字符串数组

A list of assignment labels for the oplog store. Use assignment labels to identify that specific oplog stores are associated with particular projects. If you set assignment labels using the Kubernetes Operator, the values that you set in the Kubernetes configuration file for assignment labels override the values defined in the Ops Manager UI. Assignment labels that you don't set using the Kubernetes Operator continue to use the values set in the Ops Manager UI.

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

类型：集合

Required if you enable Backup using a blockstore. Array of blockstores used for Backup. Each item in the array references a MongoDB database resource deployed in the Kubernetes cluster by the Kubernetes Operator.

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

类型：字符串

Name of the secret that contains the queryable.pem file from Ops Manager that you will use for accessing and querying backups based on your deployment's TLS requirements.The PEM file contains a public key certificate and its associated private key that are needed to access and run queries on backup snapshots in Ops Manager. To query backups, specify the value for this parameter. If not set, backups are not affected, but you can't query them.

spec.backup.statefulSet.spec

类型：集合

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

要查看可以向 spec.backup.statefulSet.spec 添加哪些字段，请参阅Kubernetes文档中的 StatefulSetSpec v1 apps。

spec.backup.statefulSet.spec.template

类型：集合

MongoDB Controllers for Kubernetes Operator 为备份守护进程服务创建的 StatefulSet 中Kubernetes Pod 的模板。

注意

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 的元数据。

要查看可以添加到 spec.backup.statefulSet.spec.template.metadata 的字段，请参阅Kubernetes文档。

spec.backup.statefulSet.spec.template.spec

类型：集合

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

要查看可添加到 spec.backup.statefulSet.spec.template.spec 的字段的完整列表，请参阅Kubernetes文档。

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

提示

For more information on the hardware, software, and networking requirements for the hosts that run the Ops Manager components, see Ops Manager System Requirements in the Ops Manager Documentation.

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

类型：字符串

为托管备份守护进程服务而创建的节点的最大 CPU容量。如果省略，则该值设立为 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

类型：字符串

为托管备份守护进程服务而创建的节点的最大内存容量。如果省略，则该值设立为 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。

• 要对两者都使用 TLS，请从 ConfigMap 中引用的同一个 ca-pem 获取用于这两种目的的证书。

• 仅对 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

类型：字符串

The Kubernetes service's default server type.

spec.backup.s3OpLogStores.customCertificateSecretRefs.key

类型：字符串

Required to use custom certificates for your S3 oplog store. File that represents the key in the secret that contains the base64-encoded x.509 certificate. If you don't specify this setting, the Kubernetes Operator can't utilize the custom certificate for S3 oplog store backups.

spec.backup.s3OpLogStores.irsaEnabled

类型：布尔值

Flag that enables using AWS IAM roles for service accounts in AWS EKS to configure an S3 oplog store. The default is False. If you aren't using AWS EKS, this flag has no effect. When set to False, using AWS IAM roles for service accounts in EKS to configure an S3 oplog store is disabled. To learn more, see IAM roles for service accounts in EKS.

spec.backup.s3OpLogStores.name

类型：字符串

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

spec.backup.s3OpLogStores.mongodbResourceRef.name

类型：字符串

您创建的 MongoDB 数据库资源的名称，该资源用于存储用于 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，则必须进行此操作。MongoDB 用户资源的名称，用于连接到 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

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

默认值为true 。

spec.backup.s3OpLogStores.s3BucketEndpoint

类型：字符串

必须使用 S3 存储来存储 oplog。URL 地址，用于托管 oplog 存储的 Amazon Web Services S3 存储桶或 S3兼容存储桶。

注意

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

类型：字符串

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

spec.backup.s3Stores.customCertificateSecretRefs.key

类型：字符串

Required to use custom certificates for your S3 oplog store. File that represents the key in the secret that contains the base64-encoded x.509 certificate. If you don't specify this setting, Kubernetes Operator can't utilize the custom certificate for S3 snapshot store and defaults to the default trust store used by Ops Manager.

spec.backup.s3Stores.irsaEnabled

类型：布尔值

Flag that enables using AWS IAM roles for service accounts in AWS EKS to configure an S3 snapshot store. The default is False. If you aren't using AWS EKS, this flag has no effect. When set to False, using AWS IAM roles for service accounts in EKS to configure an S3 snapshot store is disabled. To learn more, see IAM roles for service accounts in EKS.

spec.backup.s3Stores.name

类型：字符串

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

重要

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

spec.backup.s3Stores.mongodbResourceRef.name

类型：字符串

MongoDB 资源或 MongoDBMultiCluster 资源的名称，您创建用于存储 S3 快照存储的元数据。您必须在与MongoDB 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.

重要

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

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

注意

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

spec.backup.s3Stores.mongodbUserRef.name

类型：字符串

如果创建了 MongoDB 数据库资源用于存储 |s3| 快照元数据，并在此数据库上启用了 SCRAM，则需要此项。MongoDB 用户资源的名称，用于连接到 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 存储启用备份，则必须进行此操作。托管快照存储的 Amazon Web Services S3 存储桶或 S3兼容存储桶的名称。

spec.backup.s3Stores.s3RegionOverride

类型：字符串

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

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

Prometheus 设置

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

spec.applicationDatabase.prometheus

类型：数组

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

spec.applicationDatabase.prometheus.metricsPath

类型：字符串

默认值："/metrics"

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

spec.applicationDatabase.prometheus.passwordSecretRef

类型：对象

包含基本HTTP身份验证密钥详细信息的条件对象。如果要将 Prometheus 与应用程序数据库一起使用，则必须指定此设置。

spec.applicationDatabase.prometheus.passwordSecretRef.key

类型：字符串

默认值："password"

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

spec.applicationDatabase.prometheus.passwordSecretRef.name

类型：字符串

可选的

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

spec.applicationDatabase.prometheus.port

类型：整型

默认值：9216

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

spec.applicationDatabase.prometheus.tlseSecretKeyRef

类型：对象

可选。包含 TLS身份验证密钥详细信息的对象。

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

类型：集合

Conditional. Details of selected Kubernetes member clusters in a multi-Kubernetes cluster where you intend to deploy Ops Manager or Backup Daemon instances. See also the example of the resource specification.

• 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

类型：字符串

可选。特定Ops Manager成员集群的 spec.clusterDomain 覆盖。如果省略此值，则默认为 spec.clusterDomain 中设立的值。 Kubernetes为每个 Pod 分配一个 FQDN。 Kubernetes Operator 使用提供的 clusterDomain 值计算每个 Pod 的 FQDN。 Kubernetes不提供用于查询这些主机名的API 。

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.

• Kubernetes Operator 创建一个名为 <om-name>-svc-ext 的Kubernetes服务，该服务允许来自Kubernetes集群外部的流量到达此成员集群上的MongoDB Ops Manager应用程序。

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

spec.clusterSpecList.statefulSet.spec

类型：集合

可选。 Kubernetes Operator 的MongoDB控制器为多 Kubernetes集群Ops Manager部署中的特定成员集群创建的 StatefulSet 规范。此参数将覆盖 spec.statefulSet.spec。如果省略， Kubernetes Operator 将使用 spec.statefulSet.spec 中的值。示例，您可以使用此参数为多 Kubernetes集群MongoDB 部署中的每个Ops Manager集群指定不同的存储值。

要查看可以向 spec.clusterSpecList.statefulSet.spec 添加哪些字段，请参阅Kubernetes文档中的 StatefulSetSpec v1 apps。

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。允许自定义特定成员集群中备份守护程序的值。要查看可以向 spec.clusterSpecList[*].backup.statefulSet 添加哪些字段，请参阅Kubernetes文档中的 StatefulSetSpec v1 apps。

应用程序数据库所需设置

本部分介绍必须用于应用程序数据库的多集群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

类型：字符串

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

默认情况下，每个副本集节点使用 Kubernetes Pod 的FQDN (*.svc.cluster.local) 作为默认主机名。不过，如果您将一个外部域添加到该设置中，副本集将使用作为指定域的子域的主机名。此主机名使用以下格式：

<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 的成员更有可能成为主节点。

A member with a memberConfig.priority of 0 is ineligible to become the primary. To learn more, see Member Priority.

spec.applicationDatabase.clusterSpecList.memberConfig.tags

类型：地图

Map of replica set tags for directing read and write operations to specific members of your Application Database replica set.

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.