Ops Manager 应用程序设置

Web Server

URL to Access Ops Manager

类型：字符串

Ops Manager 应用程序的 FQDN 和端口号。

要使用 8080 以外的端口，请参阅管理 Ops Manager 主机名和端口。

http://mms.example.com:8080

对应 mms.centralUrl。

重要

如果计划使用其 IPv6 地址访问 Ops Manager 应用程序，则必须将 IPv6 地址括在方括号（[ ]）中，以将其与其端口号分隔开。

例如：

http://[2600:1f16:777:8700:93c2:b99c:a875:2b10]:8080

HTTPS PEM Key File

类型：字符串

包含 Ops Manager 应用程序的有效证书和私钥的 PEM 文件的绝对路径。如果 Ops Manager 应用程序使用 HTTPS 加密 Ops Manager 应用程序、代理和 Web 界面之间的连接，则需要 PEM 文件。

对MongoDB Ops Manager 应用程序进行 HTTPS 访问的默认端口为8443 ，如<install_dir>/conf/mms.conf 文件中设置的那样。如果更改此默认值，则还必须更改 URL to Access Ops Manager设置中指定的端口。

对应 mms.https.PEMKeyFile。

HTTPS PEM Key File Password

类型：字符串

HTTPS PEM 密钥文件的密码。如果 PEM 密钥文件包含加密私钥，则须包含此设置。

对应 mms.https.PEMKeyFilePassword。

Client Certificate Mode

类型：字符串

默认：无

指定 Ops Manager 是否要求客户端在连接到它时提供有效的 TLS/SSL 客户端证书。接受的值为：

• None

• Required for Agents Only

• Required for All Requests

对应 mms.https.ClientCertificateMode。

CA File

类型：字符串

在以下情况下为必填项：

• 你正在使用私有证书颁发机构。

• 将 Client Certificate Mode 设置为 Required for Agents Only 或 Required for All Requests。

• 您可以在已启用 TLS 的混合模式下运行 Ops Manager。

指定包含可接受客户端证书列表的专用证书颁发机构文件的文件系统位置。Ops Manager 应用程序对来自带有此文件中描述的证书的客户端的 HTTPS 请求进行身份验证。

/path/to/ca_file.pem

对应 mms.https.CAFile。

Load Balancer Remote IP Header

类型：字符串

如果您将负载均衡器与 Ops Manager 应用程序一起使用，请将其设为负载均衡器用于识别 Ops Manager 主机的原始客户端 IP 地址的 HTTP 标头字段。指定 Load Balancer Remote IP Header 时，不允许客户端直接连接到任何 Ops Manager 主机。位于 Ops Manager 主机前面的负载均衡器不得返回已缓存的内容。

设置Load Balancer Remote IP Header后， MongoDB Ops Manager将启用以下HTTP标头：

HTTP 标头	转发到 Ops Manager
X-Forwarded-Host	客户端在主机 HTTP 请求标头中请求的原始主机。
X-Forwarded-Proto	用于发出 HTTP 请求的协议。
X-Forwarded-Server	代理服务器的主机名。
X-Proxied-Https	请求的 HTTPS 状态。

要了解详细信息，请参阅配置高可用性 Ops Manager 应用程序。

对应 mms.remoteIp.header。

电子邮件

必须设置以下电子邮件地址。 您必须先定义这些设置，然后才能使用 Ops Manager 应用程序。

From Email Address

类型：字符串

用于发送常规电子邮件（如 Ops Manager 警报）的电子邮件地址。你可以在电子邮件地址中包含别名。

Ops Manager Alerts <mms-alerts@example.com>

对应 mms.fromEmailAddr。

Reply To Email Address

类型：字符串

用于回复常规电子邮件的电子邮件地址。

对应 mms.replyToEmailAddr。

Admin Email Address

类型：字符串

Ops Manager 管理员的电子邮件地址。此地址接收与 Ops Manager 问题相关的电子邮件。

对应 mms.adminEmailAddr。

Email Delivery Method Configuration

类型：字符串

默认：SMTP 电子邮件服务器

要使用的电子邮件接口。

此设置以不同方式标记用户界面和配置文件。

发送方式	用户界面设置
AWS SES	AWS Simple Email Service
SMTP	SMTP 电子邮件服务器

如果将其设置为 SMTP 电子邮件服务器，则必须设置：

• Transport

• SMTP Server Hostname

• SMTP Server Port

• Username

• Password

• Use SSL

如果将此项目设为 AWS Simple Email Service，则必须设置：

• AWS Endpoint

• AWS Access Key

• AWS Secret Key

对应 mms.emailDaoClass。

用户身份认证

Username Validation

类型：字符串

默认：false

确定 Ops Manager 是否要求用户名必须是电子邮件地址。

值	说明
false	（默认）用户名不必为电子邮件地址。
loose	用户名必须包含一个 @ 符号，且后跟一个句点。
strict	用户名必须遵循严格的电子邮件地址验证正则表达式。

如果设置为 strict ，Ops Manager 将使用以下正则表达式来验证电子邮件地址是否符合 RFC-3696: 第 3 节中的要求

^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

例子

jane.smith@example.com 是有效的。jane.smith@ex@mple.com 是无效的。

要验证用户名，必须在 Admin 界面 Ops Manager 配置页面的 Custom 标签页添加 mms.email.validation 作为自定义属性。

对应 mms.email.validation。

User Authentication Method

类型：字符串

默认值：Application Database

选择将身份验证档案存储在 Ops Manager 应用程序数据库还是 LDAP 目录中。

接受的值为：

• Application Database

• LDAP

• SAML

对应 mms.userSvcClass。

用户界面显示不同的设置，具体取决于您将凭据存储在 Ops Manager 应用程序数据库还是外部身份验证源中。

多重身份验证 (MFA)

Multi-factor Auth Level

类型：字符串

默认：关闭

配置双重身份验证“级别”：

设置	说明
OFF	禁用双重身份验证。Ops Manager 不使用双重身份验证。
OPTIONAL	用户可选择为其 Ops Manager 帐户设置双重身份验证。
REQUIRED_FOR_GLOBAL_ROLES	拥有全局角色的用户必须设置双重身份验证。所有其他用户均可选择使用双重身份验证。
REQUIRED	所有用户都必须为其 Ops Manager 帐户设置双重身份验证。

建议使用双重身份验证，以确保 Ops Manager 部署的安全性。

警告

如果通过配置文件启用 mms.multiFactorAuth.level，则必须先创建用户账户，然后再更新配置文件。否则，你将无法登录到 Ops Manager。

注意

如果启用了 Twilio 集成（可选），则请确保 Ops Manager 服务器可访问 twilio.com 域名。

对应 mms.multiFactorAuth.level。

Multi-factor Auth Allow Reset

类型：布尔值

默认：false

设置为 true 时，Ops Manager 允许用户通过电子邮件重置其双重身份验证设置，其方式与重置密码类似。

要重置双重身份验证，用户必须：

• 能够通过与用户帐户关联的地址接收电子邮件。

• 知道用户帐户密码。

• 知道用户所属每个 Ops Manager 项目的代理 API 密钥。

对应 mms.multiFactorAuth.allowReset。

Multi-factor Auth Issuer

类型：字符串

如果 Google 身份验证器提供双重身份验证，则此字符串是 Google 身份验证器应用中的 issuer。如果留空，则 issuer 是 Ops Manager 安装的域名。

对应 mms.multiFactorAuth.issuer。

其他身份验证选项

ReCaptcha Enabled On Registration

默认：false

表示你希望新用户在注册使用 Ops Manager 时使用 reCaptcha 验证来验证自己。

设置为 true 以要求在新用户注册时进行 reCaptcha 验证。

此设置需要 reCaptcha 帐户。

对应 reCaptcha.enabled.registration。

ReCaptcha Enabled On Login

类型：布尔值

默认：false

表示您希望用户在登录 Ops Manager 时使用 reCaptcha 验证来验证自身。

设置为 true 以在用户登录时要求进行 reCaptcha 验证。

此设置需要 reCaptcha 帐户。

对应 reCaptcha.enabled。

Session Max Hours

类型：数字

针对 Ops Manager 网站的会话到期前的小时数。

注意

Session Max Hours 反映了 Ops Manager 会话的总时间，而不仅仅是空闲时间。超过 Session Max Hours 时，活动会话和空闲会话都会过期。

将此值设置为 0 以仅使用浏览器会话 Cookie。

对应 mms.session.maxHours。

New Device Login Notification

应通知用户其已从新设备登录的标识符。

对应 mms.login.newDeviceNotification.enabled。

ReCaptcha Public Key

类型：字符串

与账户关联的 ReCaptcha 公钥。

对应 reCaptcha.public.key。

ReCaptcha Private Key

类型：字符串

与账户关联的 ReCaptcha 私钥。

对应 reCaptcha.private.key。

备份快照

File System Store Gzip Compression Level

类型：整型

默认：6

确定 Ops Manager 对基于文件系统的快照应用的压缩程度。此级别介于 0 到 9（含）：

• 0 不提供压缩。

• 1 为 9 可提高压缩程度，但会损失压缩速度。1 级的压缩程度最低，但速度最快。9 级的压缩程度最大，但速度最慢。

注意

更改 File System Store Gzip Compression Level 仅影响新快照。它不会影响现有快照的压缩级别。

对应 backup.fileSystemSnapshotStore.gzip.compressionLevel。

备份快照计划

Snapshot Interval (Hours)

类型：整型

默认：24

指定两个连续快照之间的时间（以小时为单位）。

接受的值为：

6、8、12 或 24

对应 brs.snapshotSchedule.interval。

Base Retention of Snapshots (in Days)

类型：整型

默认值：2

指定间隔快照的存储天数。接受的值因 Snapshot Interval (Hours) 的值而异：

Snapshot Interval (Hours)	接受的值
< 24	2、3、4 或 5。
= 24	2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30.

对应 brs.snapshotSchedule.retention.base。

Daily Retention of Snapshots (in Days)

类型：整型

默认值：0

指定每日快照的存储天数。

接受的值为：

• 无每日保留

• 以下整数之一：3、4、5、6、7、15、30、60、90、120、180 或 360

对应 brs.snapshotSchedule.retention.daily。

Weekly Retention of Snapshots (in Weeks)

类型：整型

默认值：2

指定每周快照的存储周数。

接受的值为：

• 非每周保留

• 以下整数之一：1、2、3、4、5、6、7、8、12、16、20、24 和 52

对应 brs.snapshotSchedule.retention.weekly。

Monthly Retention of Snapshots (in Months)

类型：整型

默认值：1

指定每月快照存储的月数。

接受的值为：

• 非每月保留

• One of the following integers: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36, 48, 60, 72, or 84

对应 brs.snapshotSchedule.retention.monthly。

Restore Digest Method

类型：字符串

Default: SHA1

指定是否要为恢复存档文件生成 SHA1 校验和。

接受的值为 SHA1 或 NONE。

对应 brs.restore.digest.method。

PIT 恢复

PIT Window (In Hours)

类型：整型

默认：24

可从特定时间点 (PIT) 恢复的持续时间（以小时为单位）。

对应 brs.pitWindowInHours。

KMIP 服务器配置

KMIP Server Host

类型：字符串

默认：无

指定 KMIP 服务器的主机名。

从 MongoDB 4.2.1（和 4.0.14）开始，可以在以逗号分隔的列表中指定多个 KMIP 服务器。

重要

在 4.0.14 或 4.2.1 之前的 MongoDB 版本中，Ops Manager 仅使用 KMIP 服务器主机名列表中的第一个 KMIP 主机名。

对应 backup.kmip.server.host。

KMIP Server Port

类型：整型

默认：5696

指定 KMIP 服务器的端口。

对应 backup.kmip.server.port。

KMIP Server CA File

类型：字符串

默认值：/opt/mongodb-mms/classes/kmip_server_test.pem

指定包含一个或多个证书颁发机构的 .PEM 格式文件。

对应 backup.kmip.server.ca.file。

可查询的快照配置

Proxy Server Port

类型：整型

默认：25999

可查询备份主机的端口。

注意

更新 Proxy Server Port 后，重启 Web 服务器以使更改生效。

对应 brs.queryable.proxyPort。

Proxy Server PEM File

类型：字符串

默认值：/etc/mongodb-mms/queryable-backup.pem

如果使用可查询快照，则为必填项。PEM 文件，其中包含一个或多个受信任证书的完整证书链及相关私钥。

Proxy Server PEM File 存在以下限制：

• 此 PEM 文件必须不同于用来与 Ops Manager 建立 HTTPS 连接的文件 (HTTPS PEM Key File)。

• 此 PEM 文件应使用大于 512 位的密钥长度。建议使用 2048 位 RSA 密钥。

• 此 PEM 文件应使用比 sha1 更强的消息摘要，例如 sha256。

注意

更新 Proxy Server PEM File 后，重启 Web 服务器以使更改生效。

对应 brs.queryable.pem。

Proxy Server PEM File Password

类型：字符串

如果 Proxy Server PEM File 已加密，则为必需。

注意

更新 Proxy Server PEM File Password 后，重启 Web 服务器以使更改生效。

对应 brs.queryable.pem.pwd。

Expiration (Hours)

类型：整型

默认：24

启动后可查询快照的持续时间（以小时为单位）。

对应 brs.queryable.expiration。

Read Cache Size (MB)

默认：512

从 JVM 堆中为全局快照缓存分配的大小（以兆字节为单位）。全局快照缓存可将针对同一快照数据的重复查询优化为可查询快照。

重要

MongoDB 不建议更改此值，除非 MongoDB 支持人员指示你更改它。

对应 brs.queryable.lruCacheCapacityMB。

Queryable Startup Timeout (Seconds)

默认：60

超时之前等待可查询快照准备的秒数。

对应 brs.queryable.mounttimeout。

Mongo Connection Timeout (Seconds)

默认值：30

连接到可查询快照 mongod 实例的等待秒数，在该秒数之后将显示为超时。

对应 brs.queryable.connecttimeout。

收集使用情况信息

切换到 On，以允许 MongoDB, Inc. 收集一般使用信息。

HTTP/HTTPS 代理

Proxy Host

类型：字符串

指定要连接的 HTTP 或 HTTPS 代理的主机名。

proxy.example.com

对应 http.proxy.host。

Proxy Port

类型：整型

指定要连接到主机的端口。要使用代理，必须同时指定 Proxy Port 和 Proxy Host。

对应 http.proxy.port。

Non Proxy Hosts

类型：字符串

指定以竖线字符分隔 (|) 的内部主机列表，以绕过已配置的传出代理。

*.foo.com|localhost

对应 http.proxy.nonProxyHosts。

Proxy Username

类型：字符串

如果代理要求进行身份验证，请使用此设置来指定用于连接到代理的用户名。

对应 http.proxy.username。

Proxy Password

类型：字符串

如果代理要求进行身份验证，请使用此设置来指定用于连接到代理的密码。

对应 http.proxy.password。

Twilio 集成

要通过短信或 2FA 代码接收警报通知，您必须拥有 Twilio 帐户。

Account SID

类型：字符串

Twilio 账户 ID。

对应 twilio.account.sid。

Twilio Auth Token

类型：字符串

Twilio API 令牌。

对应 twilio.auth.token。

Twilio From Number

类型：字符串

Twilio 电话号码。

对应 twilio.from.num。

MongoDB 版本管理

以下设置确定 Ops Manager 如何了解存在哪些 MongoDB 版本，以及如何为 Ops Manager 服务器提供 MongoDB 二进制文件。在部署 MongoDB 时，自动化功能和备份守护进程使用这些二进制文件。

Installer Download Source

类型：字符串

默认值：remote

您需要选择 Source for agents to download MongoDB binaries:

remote	所有助手和 Ops Manager 主机都在后台从远程源下载 MongoDB 二进制文件。所有主机都需要互联网连接。 您可以使用 Base URL 字段指定用于下载 MongoDB 二进制文件的远程源。否则，Base URL默认为 mongodb.com 和 fastdl.mongodb.org。
hybrid	代理从 Ops Manager 获取 MongoDB 二进制文件，Ops Manager 从远程源获取二进制文件。 您可以使用 Base URL 字段指定用于下载 MongoDB 二进制文件的远程源。否则，Base URL默认为 mongodb.com 和 fastdl.mongodb.org。
local	助手从 Ops Manager 中获取 MongoDB 二进制文件，并将其保存在磁盘上。 MongoDB Ops Manager管理员必须从MongoDB 下载中心 提供安装程序 ，并将其上传到Versions Directory 中。MongoDB Ops Manager为助手主机提供安装程序。 必须手动更新版本清单。 部署中的任何主机都不需要互联网连接。

对应 automation.versions.source。

Base URL

类型：字符串

默认：mongodb.com，fastdl.mongodb.org

要从中获取 MongoDB 二进制文件的 HTTP(S) 端点。如果此端点为 HTTPS 端点，则会使用 httpsCAFile 指定的证书颁发机构文件来验证证书。如果未设置 Base URL，则 mongodb 二进制文件的远程 URL 为 mongodb.com 和 fastdl.mongodb.org。

对应 automation.versions.download.baseUrl。

Versions Directory

类型：字符串

默认值：/opt/mongodb/mms/mongodb-releases/

指定 Ops Manager 应用程序服务器上 Ops Manager 存储 MongoDB 二进制文件的目录。在部署上安装或更改 MongoDB 版本时，自动化会访问二进制文件。如果将 Version Manifest Source 设置为在 Local 模式下运行，则备份守护程序也会从该目录访问 MongoDB 二进制文件。有关详细信息，请参阅配置部署以限制互联网访问。

对应 automation.versions.directory。

Backup Versions Auto Download

类型：布尔值

默认：真

指明备份守护程序是否会自动安装备份守护程序所需 MongoDB 版本的标志。

true	守护进程通过互联网从 MongoDB Inc. 检索二进制文件。
false	备份守护程序没有互联网访问权限，需要 Ops Manager 管理员手动下载并提取备份守护程序所需的 MongoDB 版本的每个存档版本。管理员必须将提取的二进制文件放入 Ops Manager 主机上的 Versions Directory 中。

警告

当 Ops Manager 以本地模式运行时，设置为 false。

对应 mongodb.release.autoDownload。

Backup Versions Auto Download Enterprise Builds

类型：布尔值

指示备份守护程序是否自动安装备份守护程序所需的 MongoDB 企业版本的标志。需要将 Backup Versions Auto Download 设置为 true。

警告

如果计划在 Linux 主机上运行 MongoDB Enterprise，则须在安装 MongoDB 之前手动向每个主机安装一组依赖项。MongoDB 手册提供了相应命令来安装这些依赖项。

请参阅配置部署以限制互联网访问。

对应 mongodb.release.autoDownload.enterprise。

Required Module For Backup

类型：字符串

默认：企业首选

指定使用 MongoDB 社区版还是 Enterprise 版二进制文件进行备份。

接受的值为：

• Enterprise Preferred

• Enterprise Required

• Community Required

选择 Enterprise Required 或 Community Required 时，Ops Manager 仅使用这些二进制文件进行备份。选择 Enterprise Preferred 时，Ops Manager 将使用企业版二进制文件（如果可用）和社区版二进制文件（如果不可用）。

注意

选择 Enterprise Required 时，必须将 Backup Versions Auto Download Enterprise Builds 设置为 true 或者在本地模式下手动将企业版二进制文件放入 Versions Directory 中。

警告

选择 Enterprise Required 或 Community Required，但 Versions Directory 不包含所需的二进制文件时，备份会失败。

对应 mongodb.release.modulePreference。

默认监控数据保留期

Ops Manager 以 10 秒的粒度收集指标数据。Default Monitoring Data Retention表确定 Ops Manager 存储指标数据的时间。对于每个增加的粒度级别，Ops Manager 都会根据之前粒度级别的平均值来计算数据。

该表确定新组的默认设置。 如果您更改设置，Ops Manager 会提示您是否也将这些设置应用到现有组。 要在不更改 Ops Manager 默认设置的情况下更改特定群组的设置，请参阅项目。

要增加某个粒度的保留期，需要在 Ops Manager 应用程序数据库上使用更多存储空间。

Default Monitoring Data Retention 1 Minute

类型：字符串

默认：2 天

Ops Manager 以分钟粒度级别存储指标数据的时间长度。Ops Manager 根据每小时粒度级别的平均值计算该数据。

默认设置适用于新项目。 如果您更改此设置，Ops Manager 会提示您是否也将该更改应用到现有项目。 要在不更改 Ops Manager 默认设置的情况下更改特定项目的设置，请参阅项目。

接受的值为：

• 2 天

• 14 天

要增加某个粒度的保留期，需要在 Ops Manager 应用程序数据库上使用更多存储空间。

Default Monitoring Data Retention 1 Hour

类型：字符串

默认：2 个月

Ops Manager 以小时粒度级别存储指标数据的时间长度。Ops Manager 根据每日粒度级别的平均值计算该数据。

默认设置适用于新项目。 如果您更改此设置，Ops Manager 会提示您是否也将该更改应用到现有项目。 要在不更改 Ops Manager 默认设置的情况下更改特定项目的设置，请参阅项目。

接受的值为：

• 2 个月

• 12个月

要增加某个粒度的保留期，需要在 Ops Manager 应用程序数据库上使用更多存储空间。

Default Monitoring Data Retention 1 Day

类型：字符串

默认：永远

Ops Manager 以每日粒度级别存储指标数据的时间长度。

默认设置适用于新项目。 如果您更改此设置，Ops Manager 会提示您是否也将该更改应用到现有项目。 要在不更改 Ops Manager 默认设置的情况下更改特定项目的设置，请参阅项目。

要增加某个粒度的保留期，需要在 Ops Manager 应用程序数据库上使用更多存储空间。

警报

Webhook URL

对应 mms.alerts.webhook.adminEndpoint。

Webhook Secret

对应 mms.alerts.webhook.adminSecret。

Kubernetes Setup

Kubernetes Secret Setup

类型：字符串

YAML 文件的路径，其中包含编程 API 密钥（作为 Kubernetes Secret），用于在 Ops Manager 项目中创建或更新 Kubernetes 对象。

此文件必须采用 YAML 格式，并且必须存储在 /mongodb-ops-manager/ 目录下。

对应 kubernetes.templates.credentialsFilePath。

Kubernetes ConfigMap Setup

类型：字符串

YAML 文件的路径，其中包含用于链接到 Ops Manager 项目的 ConfigMap。

此文件必须采用 YAML 格式，并且必须存储在 /mongodb-ops-manager/ 目录下。

对应 kubernetes.templates.projectFilePath。

修改自定义设置

添加自定义设置：

1. 在 Key 框中输入设置。

2. 在 Value 框中输入所需的设置值。

3. 单击 Save（连接）。