Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
MongoDB 助手

MongoDB 助手设置

在此页面上

  • 配置文件与设置位置
  • MongoDB 助手设置
  • LoggingSettings
  • 连接设置
  • HTTP 代理设置
  • 配置备份设置
  • Cloud Manager TLS 设置
  • 推送实时迁移设置
  • 源自外部的配置设置
  • 透明大页面 (THP) 设置
  • 自动化设置
  • MongoDB Kerberos 设置
  • 监控设置
  • 日志设置
  • 自定义设置
  • 备份设置
  • 日志设置
  • 自定义设置

本页介绍 MongoDB Agent 的可能设置。这些值是在首次启动 Cloud Manager 后设置的，而不是通过手动编辑这些文件来设置的。

警告

如果您在 Cloud Manager 界面中通过 Settings或Deployments编辑身份验证或TLS设置，这些更改将覆盖此配置文件中的任何手动更改。

配置文件与设置位置

MongoDB Agent配置文件的位置是 C:\MMSData\Automation\automation-agent.config。

注意

MongoDB 助手配置文件命名为 automation-agent.config，以便使用传统代理的用户更容易升级。

MongoDB Agent 配置文件的位置是 /etc/mongodb-mms/automation-agent.config。

注意

MongoDB 助手配置文件命名为 automation-agent.config，以便使用传统代理的用户更容易升级。

MongoDB Agent 配置文件的位置是 /etc/mongodb-mms/automation-agent.config。

注意

MongoDB 助手配置文件命名为 automation-agent.config，以便使用传统代理的用户更容易升级。

MongoDB Agent 配置文件的位置是 /path/to/install/local.config。

您可以通过Cloud Manager控制台配置其他监控设置和备份设置。

MongoDB 助手设置

需要进行以下设置。 所有其他设置均设为默认值。

mmsGroupId

类型：字符串

必需。

指定 Cloud Manager 项目的 ID。 要找到该值，请执行以下操作：

  1. 在MongoDB Cloud Manager中， Go项目的 Deployment 页面。

    1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

    2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

    3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

      显示“部署”页面。

  2. 单击部署的Agents标签页。

    显示“代理”页面。

  3. 在Downloads & Settings下选择适当的操作系统。

  4. 要直接复制该值，请在Install Agent Instructions框中单击。

此设置通常在安装 MongoDB Agent 时进行设置，并且需要将服务器绑定到项目。

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
mmsApiKey

类型：字符串

必需。

指定 Cloud Manager 项目的 Cloud Manager 代理API密钥。

您可以使用已经为项目生成的 Agent API 密钥。如果没有的话，您可以生成新的 Agent API 密钥。一个项目可以有多个代理 API 密钥，并且该项目的任何代理都可以使用任何密钥。有关更多信息，请参阅管理代理 API 密钥。

要生成代理API密钥，请Go Agent API Keys标签页。 要导航到此标签页，请执行以下操作：

  1. 在MongoDB Cloud Manager中， Go项目的 Deployment 页面。

    1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

    2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

    3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

      显示“部署”页面。

  2. 单击部署的Agents标签页。

    显示“代理”页面。

  3. 单击 Agent API Keys 标签页。

重要

当你生成一个代理API密钥时，Cloud Manager 仅显示一次。您必须复制此密钥。 将其视为密码；将其存放在安全的地方。 Cloud Manager 不再显示完整密钥。

此设置通常在安装 MongoDB Agent 时进行设置，并且需要将服务器绑定到项目。

注意

要使MongoDB Agent 能够从 命令请求助手API shellmmsApiKeyExec密钥，请在配置文件中设置 选项，而不是设置mmsApiKey 选项。

mmsApiKey=8zvbo2s2asigxvmpnkq5yexf
mmsBaseUrl

类型：字符串

指定 Cloud Manager 的 URL。

重要

此值是默认设置，不应修改。

mmsBaseUrl=https://api-agents.mongodb.com

LoggingSettings

logFile

类型：字符串

指定 Cloud Manager 应写入 MongoDB Agent 日志的路径。

默认路径取决于您的平台。无论部署是否使用自动化，MongoDB 助手都会使用默认文件名 automation-agent.log。

重要

只有在更新日志文件时，才会自动轮换 MongoDB 助手日志。要手动轮换 MongoDB 助手日志，请参阅手动轮换 MongoDB 助手日志，获取更多信息。

平台
默认路径
Linux
/var/log/mongodb-mms-automation/automation-agent.log
Windows
C:\MMSAutomation\log\mongodb-mms-automation\automation-agent.log
logFile=/path/to/mongodb-mms-automation/automation-agent.log
logLevel

类型：字符串

指定日志记录粒度的级别。

从以下严重性级别中选择（信息量从多到少）：

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • FATAL

默认， logLevel为INFO 。

logLevel=ROUTINE

每个级别都包含后续级别中包含的日志项。

例子

  • 如果选择 DEBUG（调试），则 MongoDB 助手会记录所有消息，包括 INFO、WARN、ERROR 和 FATAL。

  • 如果您选择 FATAL，则 MongoDB 助手仅记录 FATAL 消息。

maxLogFiles

类型：整型

指定要保留的轮换日志文件的最大数量。

默认， maxLogFiles的值设立为10 。 您可以更改该值以保留不同数量的轮换日志文件。

maxLogFiles=15
maxLogFileDurationHrs

类型：浮点

指定距离下一次日志轮换的小时数。

注意

手动轮换 MongoDB 助手日志

在基于 UNIX 和 Linux 的系统上，您可以手动轮换 MongoDB 助手日志。为代理进程发出带有 SIGUSR1 信号的 kill 命令：

kill -SIGUSR1 <AgentID>

在基于 Windows 的系统上，您可以通过服务重启来手动重启 MongoDB 助手：

  1. 单击 Start（启动）菜单。

  2. 搜索 services（服务）。

  3. 找到 MongoDB 助手。

  4. 右键单击该代理，然后单击 Restart（重新启动）。

这将轮换 MongoDB 助手日志。

maxLogFileSize

类型：整型

指定日志轮换前日志文件的最大大小（以字节为单位）。如果未指定，MongoDB 助手不会根据文件大小轮换日志。

默认情况下， maxLogFileSize的值设置为268435456字节。 您可以更改该值，为日志文件指定不同的最大大小。

maxLogFileSize=536870912
maxUncompressedLogFiles

类型：整型

指定要保持未压缩状态的轮换日志文件的最大数量。 MongoDB Agent会自动将任何额外保留的日志文件压缩到maxLogFiles值。

默认情况下， maxUncompressedLogFiles的值设置为2 。 您可以更改该值以压缩不同数量的轮换日志文件。

maxUncompressedLogFiles=10

连接设置

dialTimeoutSeconds

类型：整型

指定连接超时前的等待秒数。默认情况下，连接会在 40 秒后超时。但是，MongoDB 助手可能会由于以下一个或多个原因而频繁出现连接超时：

  • 高网络延迟

  • 服务器负载过高

  • 大型 TLS 密钥

  • 缺少 TLS 加速器

  • CPU 速度不足

MongoDB建议逐渐增加dialTimeoutSeconds MongoDB Agent配置设置的值，以防止连接频繁地过早超时。

dialTimeoutSeconds=40

注意

增加此值，还会增加将配置更改部署到 MongoDB 助手所需的时间。尝试小幅递增，直到确定部署的最佳值。

serverSelectionTimeoutSeconds

类型：整型

指定 MongoDB 助手在停止尝试与 MongoDB 进程建立连接之前等待的秒数。默认情况下，MongoDB 助手会在 10 秒后放弃建立连接的尝试。

serverSelectionTimeoutSeconds=10

HTTP 代理设置

httpProxy

类型：字符串

指定 MongoDB 助手可以使用的 HTTP 代理服务器的 URL。

httpProxy=http://proxy.example.com:8080

配置备份设置

mmsConfigBackup

类型：字符串

指定 Cloud Manager配置备份文件的路径。此文件描述部署的所需状态。

如果不指定mmsConfigBackup设置， MongoDB Agent会将 mongodb-mms-automation-cluster-backup.json 文件写入操作系统上的临时文件夹。

如果将enableLocalConfigurationServer设置为 true，则MongoDB Agent不会写入mmsConfigBackup文件。

mmsConfigBackup=/path/to/mms-cluster-config-backup.json

Cloud Manager TLS 设置

指定 MongoDB Agent 在使用TLS与 Cloud Manager 通信时使用的设置。

httpsCAFile

类型：字符串

指定包含PEM格式的受信任证书颁发机构证书的绝对路径。 此证书可验证 MongoDB Agent 是否正在与指定的 Cloud Manager 实例通信。

httpsCAFile=/path/to/ca.pem

注意

如果您执行以下操作，请将 downloads.mongodb.com 证书的证书颁发机构添加到此 .pem 文件：

  1. 需要 MongoDB 助手从互联网上下载 MongoDB 安装程序，

  2. 使用 TLS 加密连接，以及

  3. 使用私人证书颁发机构签署证书。（您设置了 httpsCAFile 选项。）

要了解如何从其他网站下载 TLS 证书，请参阅 OpenSSL Cookbook 条目。

重要

当 Cloud Manager 启动时，它会缓存您提供的证书颁发机构。如果更改证书颁发机构证书，请重新启动 Cloud Manager。

sslRequireValidMMSServerCertificates

类型：布尔值

重要

已弃用。 请改用tlsRequireValidMMSServerCertificates 。

tlsRequireValidMMSServerCertificates

类型：布尔值

指定 MongoDB Agent 是否应验证 Cloud Manager 提供的TLS证书。

警告

将此选项设置为false会禁用证书验证，并使 MongoDB Agent 和 Cloud Manager 之间的连接容易受到中间人攻击。建议仅出于测试目的将此选项设置为false 。

tlsRequireValidMMSServerCertificates=true

推送实时迁移设置

agentFeatureCloudMigrationEnabled

类型：布尔值

可选。

指定迁移主机上的 MongoDB Agent 是否配置为运行从源 Cloud Manager 部署到 Atlas 中目标集群的实时迁移进程。

此选项默认为 false，这将阻止在此主机上使用 MongoDB 助手进行到 Atlas 的实时迁移。

要启用实时迁移进程，请预配迁移主机并将 agentFeatureCloudMigrationEnabled 设置为 true。

cloudMigrationOplogPath

类型：字符串

可选。

oplog文件的路径。 如果指定，此设置会将初始同步oplog窗口缓冲到磁盘。 在指定目录中为oplog缓冲预配足够的存储空间。

源自外部的配置设置

enableLocalConfigurationServer

类型：布尔值

指定 MongoDB 助手是将 MongoDB 进程配置文件存储在磁盘上还是缓存在内存中。

此选项默认为 false，将配置文件存储在磁盘上。将此选项设置为 true 会将配置缓存在内存中。

如果将此选项设立为 true，则MongoDB Agent不会写入mmsConfigBackup文件。

如果 MongoDB 数据库运行的是FCV 4.2或更早版本，请勿将此选项设置为true 。

警告

将此选项设置为 true 会影响部署的可用性。

启用此功能后，MongoDB Agent不会将MongoDB进程配置存储在磁盘上。如果 Cloud Manager 服务器不可用，并且 MongoDB Agent 尝试重新启动，则 MongoDB Agent 会停止运行，因为它没有必要的配置信息。如果 MongoDB 进程在 MongoDB Agent 未运行时崩溃，则 MongoDB Agent 无法重新启动该进程。

enableLocalConfigurationServer=false

提示

另请参阅：

配置 MongoDB 助手如何管理配置文件和密码

keepUnusedMongodbVersions

类型：布尔值

指示MongoDB Agent是否保留其下载的未使用的MongoDB版本二进制文件的标志。 默认， keepUnusedMongodbVersions为 false。

keepUnusedMongodbVersions=false
localConfigurationServerPort

类型：整型

指定使用本地配置服务器时为 MongoDB 进程配置提供服务的端口。 要设置此选项， enableLocalConfigurationServer必须为true 。

如果未指定，则 MongoDB 助手会自动选择可用端口。

localConfigurationServerPort=20128
mmsApiKeyExec

类型：字符串

指定 shell 命令以调用 Cloud Manager 项目的 Cloud Manager 代理API密钥。

mmsApiKeyExec=echo $myKey

透明大页面 (THP) 设置

MongoDB Agent允许您在每个进程的基础上禁用透明大页面 (THP)，以避免意外的性能下降。 要禁用 THP，请执行以下步骤：

  1. 将MongoDB Agent版本升级到 108.0.x。

  2. 修改自动化配置文件以包含enableAgentManagingTHPSettings=true 。

  3. 重新启动MongoDB Agent以及托管的mongod和mongos进程。 现在，您可以在系统范围内启用THP。

    注意

    这可能会生成误报启动警告。

  4. （可选）升级到8.0 。

enableAgentManagingTHPSettings

类型：布尔值

默认：false

指定 是否应为MongoDB Agent 之前的 进程版本禁用mongo 透明大页 (THP)8.0 。无论操作系统级别的 THP 设置如何， MongoDB Agent都会按mongo进程禁用 THP。

自动化设置

以下配置设置用于自动集群中的身份验证。

MongoDB Kerberos 设置

如果自动化使用 Kerberos 对主机进行身份验证，请指定这些设置。要配置 Kerberos，请参阅为 Kerberos 配置 MongoDB 助手。

krb5ConfigLocation

类型：字符串

指定 Kerberos 配置文件的非系统标准位置的绝对路径。

krb5ConfigLocation=/path/to/krb_custom.conf

注意

启用Kerberos后， Cloud Manager会自动为每个代理创建Kerberos凭证（票证）缓存。 如果要覆盖 Kerberos档案缓存 的位置 ，您必须在运行代理之前设立KRB5CCNAME 环境变量设置为所需的文件名和路径。

backupAgentKrb5CCName

类型字符串

指定 MongoDB 助手为备份进程设置的 KRB5CC 环境变量。仅用于在 MongoDB 助手启动备份功能时验证 MongoDB 部署的备份。

backupAgentKrb5CCName=/path/to/credentials_cache_file
monitoringAgentKrb5CCName

类型字符串

指定 MongoDB 助手为监控功能设置的 KRB5CC 环境变量。仅用于当 MongoDB 助手启动监控功能时对 MongoDB 部署进行监控身份验证。

monitoringAgentKrb5CCName=/path/to/credentials_cache_file

监控设置

使用 Cloud Manager 界面配置监控设置。

日志设置

1

MongoDB Cloud ManagerGoDeployment在MongoDB Cloud Manager中，Go项目的 页面。

  1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

  2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

  3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

    显示“部署”页面。

2

转到 Agents（快速入门）页面。

单击部署的Agents标签页。

显示“代理”页面。

3

编辑日志设置。

  1. 单击 Downloads & Settings（连接）。

  2. 在 Agent Log Settings 部分，单击 Monitoring Log Settings 旁边的。

  3. 编辑监控日志设置：

    设置
    默认值
    控制台建议值
    Linux 日志文件路径
    /var/log/mongodb-mms-automation/monitoring-agent.log
    Windows 日志文件路径
    %SystemDrive%\MMSAutomation\log\mongodb-mms-automation\monitoring-agent.log
    轮换日志
    是
    大小阈值 (MB)
    1000
    时长阈值（小时）
    24
    最大未压缩文件数
    5
    最大磁盘百分比
    2
    日志文件总数
    0

  4. 单击 Save（连接）。

自定义设置

1

MongoDB Cloud ManagerGoDeployment在MongoDB Cloud Manager中，Go项目的 页面。

  1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

  2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

  3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

    显示“部署”页面。

2

转到 Agents（快速入门）页面。

单击部署的Agents标签页。

显示“代理”页面。

3

编辑配置。

  1. 单击 Downloads & Settings（连接）。

  2. 在 Custom Configuration（自定义配置）部分的 Edit Custom Configurations（编辑自定义配置）旁边，单击 。

  3. 输入监控配置设置和值。

  4. 单击 Save and Close（连接）。

您可以配置以下监控设置：

连接设置

mmsGroupId

类型：字符串

指定Cloud Manager项目的ID 。 要查找项目ID：

1
MongoDB Cloud ManagerGo在MongoDBProject Settings Cloud Manager中，Go 页面。

  1. 如果尚未显示，请从导航栏上的 Organizations 菜单中选择包含所需项目的组织。

  2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

  3. 在 Projects（项目）菜单旁边，展开 Options（选项）菜单，然后单击 Project Settings（项目设置）。

    显示项目设置页面。

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
mmsApiKey

类型：字符串

指定 Cloud Manager 项目的 Cloud Manager 代理 API 密钥。

您可以使用已经为项目生成的 Agent API 密钥。如果没有的话，您可以生成新的 Agent API 密钥。一个项目可以有多个代理 API 密钥，并且该项目的任何代理都可以使用任何密钥。有关更多信息，请参阅管理代理 API 密钥。

要生成代理API密钥，请Go Agent API Keys标签页。 要导航到此标签页，请执行以下操作：

  1. 在MongoDB Cloud Manager中， Go项目的 Deployment 页面。

    1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

    2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

    3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

      显示“部署”页面。

  2. 单击部署的Agents标签页。

    显示“代理”页面。

  3. 单击 Agent API Keys 标签页。

重要

当你生成一个代理API密钥时，Cloud Manager 仅显示一次。您必须复制此密钥。 将其视为密码；将其存放在安全的地方。 Cloud Manager 不再显示完整密钥。

Cloud Manager 会在您安装 MongoDB Agent 时配置此设置。如果需要单独配置监控，请包含此设置。

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem
mmsBaseUrl

类型：字符串

指定 Cloud Manager 的URL 。

mmsBaseUrl=http://example.com:8080

HTTP 代理设置

httpProxy

类型：字符串

指定监控可以使用的 HTTP 代理服务器的 URL。

httpProxy=http://proxy.example.com:8080

MongoDB Kerberos 设置

如果监控使用 Kerberos 对主机进行身份验证，请指定这些设置。

要配置 Kerberos，请参阅为 Kerberos 配置 MongoDB 助手。同样的程序和要求也适用，仅使用不同的 UPN 进行监控。

注意

启用Kerberos后， Cloud Manager会自动为每个代理创建Kerberos凭证（票证）缓存。 如果要覆盖 Kerberos档案缓存 的位置 ，您必须在运行代理之前设立KRB5CCNAME 环境变量设置为所需的文件名和路径。

krb5Principal

类型：字符串

指定监控使用的 Kerberos 主体。

krb5Principal=monitoring/myhost@EXAMPLE.COM
krb5Keytab

类型：字符串

指定 Kerberos 主体的 keytab 文件的绝对路径。

krb5Keytab=/path/to/mms-monitoring.keytab
krb5ConfigLocation

类型：字符串

指定 Kerberos 配置文件的非系统标准位置的绝对路径。

krb5ConfigLocation=/path/to/krb_custom.conf
gssapiServiceName

类型：字符串

使用gssapiServiceName设置指定服务名称。

默认情况下，MongoDB 使用 mongodb 作为其服务名称。

MongoDB TLS 设置

当监控使用 TLS 连接到 MongoDB 部署时指定这些设置。

要了解详情，请参阅配置 MongoDB 助手以使用 TLS。

useSslForAllConnections

类型：布尔值

指定是否使用 TLS 加密与 MongoDB 部署的所有连接。

重要

将此项设置为true会覆盖在 Cloud Manager 界面中配置的任何每台主机TLS设置。

sslClientCertificate

类型：字符串

指定 PEM 格式的私钥、客户端证书和可选中间证书的绝对路径。监控使用客户端证书连接到使用 TLS 并需要客户端证书的任何已配置 MongoDB 部署。（部署使用 --tlsCAFile 设置运行。）

例子

如果要使用 连接到同时使用 TLS 和证书验证的 MongoDBmongosh 部署：

mongosh --tls --tlsCertificateKeyFile /path/to/client.pem --tlsCAFile /path/to/ca.pem example.net:27017

您必须在 Custom Settings 中设置这些设置：

sslTrustedServerCertificates=/path/to/ca.pem
sslClientCertificate=/path/to/client.pem
sslClientCertificatePassword

类型：字符串

指定解密sslClientCertificate文件中的私钥所需的密码。 如果您加密了客户端证书PEM文件，请包含此设置。

sslClientCertificatePassword=password
sslTrustedServerCertificates

类型：字符串

指定包含 PEM 格式的受信任证书颁发机构证书的绝对路径。这些证书可验证任何使用 TLS 运行的 MongoDB 部署所返回的服务器证书。

sslTrustedServerCertificates=/path/to/ca.pem
sslRequireValidServerCertificates

类型：布尔值

指定监控是否应验证 MongoDB 数据库提供的TLS证书。

sslRequireValidServerCertificates=true

默认情况下，Cloud Manager 将sslRequireValidServerCertificates设置为true 。 您需要有效的受信任证书才能使用TLS连接到 MongoDB 实例。

警告

将此设置更改为 false，将禁用证书验证，并使监控和 MongoDB 部署之间的连接容易受到中间人攻击。将此设置更改为 false，仅用于测试目的。

Cloud Manager 服务器 TLS 设置

指定使用TLS与 Cloud Manager 通信时监控使用的设置。

httpsCAFile

类型：字符串

指定包含 PEM 格式的受信任证书颁发机构证书的 绝对 路径。监控使用此证书来验证代理是否可以与指定的Cloud Manager实例通信。

默认情况下，监控使用主机上安装的受信任根证书颁发机构。

如果代理无法找到受信任的根证书颁发机构，请手动配置这些设置。

httpsCAFile=/path/to/mms-certs.pem

备份设置

使用 Cloud Manager 界面配置备份设置。

日志设置

1

MongoDB Cloud ManagerGoDeployment在MongoDB Cloud Manager中，Go项目的 页面。

  1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

  2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

  3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

    显示“部署”页面。

2

转到 Agents（快速入门）页面。

单击部署的Agents标签页。

显示“代理”页面。

3

编辑日志设置。

  1. 单击 Downloads & Settings（连接）。

  2. 在 Agent Log Settings 部分，单击 Backup Log Settings 旁边的。

  3. 编辑备份日志设置：

    设置
    默认值
    控制台建议值
    Linux 日志文件路径
    /var/log/mongodb-mms-automation/backup-agent.log
    Windows 日志文件路径
    %SystemDrive%\MMSAutomation\log\mongodb-mms-automation\backup-agent.log
    轮换日志
    是
    大小阈值 (MB)
    1000
    时长阈值（小时）
    24
    最大未压缩文件数
    5
    最大磁盘百分比
    2
    日志文件总数
    0

  4. 单击 Save（连接）。

自定义设置

1

MongoDB Cloud ManagerGoDeployment在MongoDB Cloud Manager中，Go项目的 页面。

  1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

  2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

  3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

    显示“部署”页面。

2

转到 Agents（快速入门）页面。

单击部署的Agents标签页。

显示“代理”页面。

3

编辑配置。

  1. 单击 Downloads & Settings（连接）。

  2. 在 Custom Configuration（自定义配置）部分的 Edit Custom Configurations（编辑自定义配置）旁边，单击 。

  3. 输入备份配置设置和值。

  4. 单击 Save and Close（连接）。

您可以配置以下备份设置：

连接设置

mmsGroupId

类型：字符串

指定Cloud Manager项目的ID 。 要查找项目ID：

1
MongoDB Cloud ManagerGo在MongoDBProject Settings Cloud Manager中，Go 页面。

  1. 如果尚未显示，请从导航栏上的 Organizations 菜单中选择包含所需项目的组织。

  2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

  3. 在 Projects（项目）菜单旁边，展开 Options（选项）菜单，然后单击 Project Settings（项目设置）。

    显示项目设置页面。

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
mmsApiKey

类型：字符串

指定 MongoDB Agent 的 Cloud Manager 项目的API密钥。

您可以使用已经为项目生成的 Agent API 密钥。如果没有的话，您可以生成新的 Agent API 密钥。一个项目可以有多个代理 API 密钥，并且该项目的任何代理都可以使用任何密钥。有关更多信息，请参阅管理代理 API 密钥。

要生成代理API密钥，请Go Agent API Keys标签页。 要导航到此标签页，请执行以下操作：

  1. 在MongoDB Cloud Manager中， Go项目的 Deployment 页面。

    1. 如果尚未显示，请从导航栏的 Organizations 菜单中选择包含所需项目的组织。

    2. 如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。

    3. 如果 Deployment（数据库部署）页面尚未出现，请单击侧边栏中的 Deployment（数据库）。

      显示“部署”页面。

  2. 单击部署的Agents标签页。

    显示“代理”页面。

  3. 单击 Agent API Keys 标签页。

重要

当你生成一个代理API密钥时，Cloud Manager 仅显示一次。您必须复制此密钥。 将其视为密码；将其存放在安全的地方。 Cloud Manager 不再显示完整密钥。

Cloud Manager 会在您安装 MongoDB Agent 时配置此设置。如果需要单独配置备份，请包含此设置。

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem
mothership

类型：字符串

指定备份代理使用的 Cloud Manager 主机名和端口。

注意

不要在mothership设置中包含协议（ http://或https:// ）。

mothership=example.com:8080
mothershipResponseHeaderTimeout

类型：整型

指定备份等待 Cloud Manager 响应的时间长度（以秒为单位）。 如果 MongoDB Agent 没有收到响应，它会重置并重试与 Cloud Manager 的连接。此值默认为90秒。

backupSocketTimeoutMs

类型：整型

指定在 Cloud Manager 断开连接之前，备份和 Cloud Manager 之间的套接字可以保持空闲状态的时间长度（以毫秒为单位）。如果省略，则默认为180000毫秒（ 3分钟）。

https

类型：布尔值

指定与 Cloud Manager Web 服务器的通信是否使用 Secure HTTP 。

HTTP 代理设置

httpProxy

类型：字符串

指定 Backup 可以使用的 HTTP 代理的 URL。

httpProxy=http://proxy.example.com:8080

MongoDB Kerberos 设置

要配置 Kerberos，请参阅为 Kerberos 配置 MongoDB Agent。同样的程序和要求也适用，只是使用不同的UPN进行备份。

注意

启用Kerberos后， Cloud Manager会自动为每个代理创建Kerberos凭证（票证）缓存。 如果要覆盖 Kerberos档案缓存 的位置 ，您必须在运行代理之前设立KRB5CCNAME 环境变量设置为所需的文件名和路径。

krb5Principal

类型：字符串

指定备份使用的 Kerberos 主体。

krb5Principal=backup/myhost@EXAMPLE.COM
krb5Keytab

类型：字符串

指定 Kerberos 主体的密钥表文件的绝对路径。

krb5Keytab=/path/to/mms-backup.keytab
krb5ConfigLocation

类型：字符串

指定 Kerberos 配置文件的非系统标准位置的绝对路径。

krb5ConfigLocation=/path/to/krb_custom.conf
gsapiServiceName

类型：字符串

使用gsapiServiceName设置指定服务名称。

默认情况下，MongoDB 使用 mongodb 作为其服务名称。

MongoDB TLS 设置

当 Backup 使用 TLS 连接到 MongoDB 部署时，请指定这些设置。

要了解详情，请参阅配置 MongoDB 助手以使用 TLS。

sslClientCertificate

类型：字符串

以 PEM 格式指定私钥、客户端证书和可选中间证书的路径。连接到使用 TLS 且需要客户端证书的 MongoDB 部署时，备份使用客户端证书。（部署使用 --tlsCAFile 设置运行。）

sslClientCertificatePassword

类型：字符串

指定解密sslClientCertificate文件中的私钥所需的密码。 如果您加密了客户端证书PEM文件，请包含此设置。

sslTrustedServerCertificates

类型：字符串

指定包含 PEM 格式的受信任 CA 证书的路径。这些证书可验证任何使用 TLS 运行的 MongoDB 部署所返回的服务器证书。

sslTrustedServerCertificates=/path/to/mongodb-certs.pem
sslRequireValidServerCertificates

类型：布尔值

指定备份是否应验证 MongoDB 部署提供的 TLS 证书。

警告

将此设置更改为 false 会禁用证书验证，并使备份和 MongoDB 部署之间的连接容易受到中间人攻击。将此设置更改为 false 仅用于测试目的。

Cloud Manager 服务器 TLS 设置

指定使用TLS与 Cloud Manager 通信时备份使用的设置。

sslTrustedMMSBackupServerCertificate

指定包含 PEM 格式的受信任证书颁发机构证书的 绝对 路径。备份使用此证书来验证 MongoDB 助手是否可以与指定的 Cloud Manager 实例通信。

默认情况下，备份使用系统上安装的受信任根证书颁发机构。

如果备份无法找到受信任的根证书颁发机构，请手动配置这些设置。

如果 Cloud Manager 使用自签名TLS证书，请为此设置提供一个值。

sslTrustedMMSBackupServerCertificate=/path/to/mms-certs.pem

后退

管理功能

来年

必需的访问权限