Configurações do MongoDB Agent

Nesta página

Arquivo de configuração e locais de configurações

Configurações do MongoDB Agent
Configurações de registro
Configurações de conexão
Configurações de proxy HTTP
Configurações de backup de configuração
Configurações deTLS do Cloud Manager
Configurações de migração push live
Definições de configuração de origem externa
Configurações de hugepage transparente (THP)
Configurações de automação
Configurações do MongoDB Kerberos
Configurações de monitoramento
Configurações de registro
Configurações personalizadas
Configurações de backup
Configurações de registro
Configurações personalizadas

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

Esta página descreve possíveis configurações para o MongoDB Agent. Esses valores são definidos após a primeira inicialização do Cloud Manager e não por meio da edição manual desses arquivos.

Aviso

Se você editar as configurações de autenticação ou TLS por meio Settings ou Deployments na interface do Cloud Manager, essas alterações substituirão quaisquer alterações manuais nesse arquivo de configuração.

Arquivo de configuração e locais de configurações

A localização do arquivo de configuração do MongoDB Agent é C:\MMSData\Automation\automation-agent.config.

Observação

O arquivo de configuração do MongoDB Agent é chamado automation-agent.config como uma forma de facilitar as atualizações para aqueles que usam agentes legados.

A localização do arquivo de configuração do MongoDB Agent é /etc/mongodb-mms/automation-agent.config.

Observação

O arquivo de configuração do MongoDB Agent é chamado automation-agent.config como uma forma de facilitar as atualizações para aqueles que usam agentes legados.

A localização do arquivo de configuração do MongoDB Agent é /etc/mongodb-mms/automation-agent.config.

Observação

O arquivo de configuração do MongoDB Agent é chamado automation-agent.config como uma forma de facilitar as atualizações para aqueles que usam agentes legados.

A localização do arquivo de configuração do MongoDB Agent é /path/to/install/local.config.

Você pode definir configurações adicionais de monitoramento e backup por meio do Console do Cloud Manager.

Configurações do MongoDB Agent

As seguintes configurações são necessárias. Todas as outras configurações são definidas para valores padrão.

mmsGroupId

Tipo: string

Obrigatório.

Especifica o ID do seu projeto do Cloud Manager. Para localizar esse valor:

No MongoDB Cloud Manager, acesse a página Deployment do seu projeto.
1. Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
3. Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
  A página Sistema é exibida.
Clique na aba Agents para sua implantação.
A página Agentes é exibida.
Selecione o sistema operacional apropriado em Downloads & Settings.
Para copiar este valor diretamente, na caixa Install Agent Instructions , clique em .

Essa configuração geralmente é definida quando o MongoDB Agent é instalado e é necessário para vincular o servidor a um projeto.

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf

mmsApiKey

Tipo: string

Obrigatório.

Especifica a chave de API do agente do Cloud Manager do seu projeto Cloud Manager.

Você pode usar uma chave de API do agente que já tenha gerado para o projeto. Caso contrário, você pode gerar uma nova chave de API do agente. Um projeto pode ter mais de uma chave de API do agente, e qualquer um dos agentes do projeto pode usar qualquer uma das chaves. Para obter mais informações, consulte Gerenciar chaves de API do agente.

Para gerar uma chave de API do agente, acesse a guia Agent API Keys . Para navegar até a aba:

No MongoDB Cloud Manager, acesse a página Deployment do seu projeto.
1. Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
3. Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
  A página Sistema é exibida.
Clique na aba Agents para sua implantação.
A página Agentes é exibida.
Clique na aba Agent API Keys.

Importante

Quando você gera uma chave de API do agente, o Cloud Manager a exibe somente uma vez. Você deve copiar esta chave. Trate isso como uma senha; guarde-o em um local seguro. O Cloud Manager nunca mais exibe a chave completa.

Essa configuração geralmente é definida quando o MongoDB Agent é instalado e é necessário para vincular o servidor a um projeto.

Observação

Para habilitar o MongoDB Agent para solicitar a chave API do agente de um comando de shell, defina a opção mmsApiKeyExec no arquivo de configuração em vez de definir a opção mmsApiKey .

mmsApiKey=8zvbo2s2asigxvmpnkq5yexf

mmsBaseUrl

Tipo: string

Especifica a URL do Cloud Manager.

Importante

Este valor é definido por padrão e não deve ser modificado.

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

Configurações de registro

logFile

Tipo: string

Especifica o caminho para o qual o Cloud Manager deve escrever o registro do MongoDB Agent.

O caminho padrão depende da sua plataforma. O MongoDB Agent usa o nome de arquivo padrão automation-agent.log se a sistema usa ou não Automação.

Importante

A rotação automática dos registros do MongoDB Agent ocorre somente quando é feita uma atualização no arquivo de log. Para rotacionar manualmente os registros do MongoDB Agent, consulte Rotacionar manualmente os registros do MongoDB Agent para obter mais informações.

Plataforma	Caminho padrão
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

Tipo: string

Especifica o nível de granularidade de registro.

Escolha entre os seguintes níveis de gravidade, da maior para a menor quantidade de informações:

DEBUG
INFO
WARN
ERROR
FATAL

Por padrão, logLevel é INFO.

logLevel=ROUTINE

Cada nível inclui os itens de log incluídos nos níveis seguintes.

Exemplo

Se você escolher DEBUG, o MongoDB Agent registrará todas as mensagens, incluindo INFO, WARN, ERROR e FATAL.
Se você escolher FATAL, o MongoDB Agent somente registrará FATAL mensagens.

maxLogFiles

Tipo: inteiro

Especifica o número máximo de arquivos de registro rotacionados a serem mantidos.

Por padrão, o valor de maxLogFiles é configurado para 10. Você pode alterar o valor para manter um número diferente de arquivos de log rotacionados.

maxLogFiles=15

maxLogFileDurationHrs

Tipo: flutuação

Especifica o número de horas após as quais osregistros são girados.

Observação

Girar manualmente osregistros do MongoDB Agent

Em sistemas baseados em UNIX e Linux, você pode girar manualmente os registros do MongoDB Agent. Emitir um comando kill com o sinal SIGUSR1 para o processo do agente:

kill -SIGUSR1 <AgentID>

Em sistemas baseados em Windows, você pode reiniciar manualmente o MongoDB Agent com um serviço reiniciado:

Clique no menu Start.
Pesquise por services.
Encontre o MongoDB Agent.
Clique com o botão direito do mouse no agente e clique em Restart.

Isso gira os registros do MongoDB Agent.

maxLogFileSize

Tipo: inteiro

Especifica o tamanho máximo, em bytes, de um arquivo de registro antes de rotacionar os registros. Se não especificado, o MongoDB Agent não gira registros com base no tamanho do arquivo.

Por padrão, o valor de maxLogFileSize é configurado para 268435456 bytes. Você pode alterar o valor para atribuir um tamanho máximo diferente para um arquivo de log.

maxLogFileSize=536870912

maxUncompressedLogFiles

Tipo: inteiro

Especifica o número máximo de arquivos de log rotacionados para manter a descompactação. MongoDB Agent comprime automaticamente quaisquer arquivos de log retidos adicionais até o valor maxLogFiles .

Por padrão, o valor de maxUncompressedLogFiles é configurado para 2. Você pode alterar o valor para comprimir um número diferente de arquivos de log rotacionados.

maxUncompressedLogFiles=10

Configurações de conexão

dialTimeoutSeconds

Tipo: inteiro

Especifica o número de segundos de espera antes que uma conexão expire. Por padrão, as conexões atingem o tempo limite após 40 segundos. No entanto, o MongoDB Agent pode frequentemente atingir o tempo limite das conexões por um ou mais dos seguintes motivos:

Alta latência de rede
Alta carga do servidor
Chaves TLS grandes
Falta de acelerador TLS
Velocidade insuficiente da CPU

O MongoDB recomenda aumentar gradualmente o valor da configuração dialTimeoutSeconds do MongoDB Agent para evitar tempos limite de conexão prematuros frequentes.

dialTimeoutSeconds=40

Observação

Aumentar esse valor também aumenta o tempo necessário para implantar alterações de configuração no MongoDB Agent. Experimente com pequenos aumentos incrementais até determinar o valor ideal para sua sistema.

serverSelectionTimeoutSeconds

Tipo: inteiro

Especifica o número de segundos que o MongoDB Agent espera antes de parar de tentar estabelecer uma conexão com um processo MongoDB. Por padrão, o MongoDB Agent abandona as tentativas de estabelecer uma conexão após 10 segundos.

serverSelectionTimeoutSeconds=10

Configurações de proxy HTTP

httpProxy

Tipo: string

Especifica a URL de um servidor proxy HTTP que o MongoDB Agent pode usar.

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

Configurações de backup de configuração

mmsConfigBackup

Tipo: string

Especifica o caminho para o arquivo de backup de configuração do Cloud Manager. Este arquivo descreve o estado desejado da sistema.

Se você não especificar a configuração do mmsConfigBackup , o MongoDB Agent gravará o arquivo mongodb-mms-automation-cluster-backup.json em uma pasta temporária no sistema operacional.

Se você configurar enableLocalConfigurationServer para true, o MongoDB Agent não gravará o arquivo mmsConfigBackup .

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

Configurações de TLS doCloud Manager

Especifique as configurações que o MongoDB Agent usa ao se comunicar com o Cloud Manager usando TLS.

httpsCAFile

Tipo: string

Especifica o caminho absoluto que contém os certificados de Autoridade de Certificação confiáveis no formato PEM . Este certificado verifica se o MongoDB Agent está se comunicando com a instância designada do Cloud Manager.

httpsCAFile=/path/to/ca.pem

Observação

Adicione a autoridade de certificação para o certificado downloads.mongodb.com a este arquivo .pem se você:

Precisa que seus MongoDB Agents baixem seus instaladores MongoDB da Internet,
Use TLS para criptografar conexões, e
Assinou os seus certificados com uma Autoridade de Certificação privada. (Você definiu a opção httpsCAFile.)

Para saber como baixar certificados TLS de outro site, consulte a entrada OpenSSL Cookbook.

Importante

Quando o Cloud Manager é iniciado, ele armazena em cache a autoridade de certificação fornecida. Se você alterar seu certificado de autoridade de certificação, reinicie o Cloud Manager.

sslRequireValidMMSServerCertificates: Tipo: booleano
Importante
Obsoleto. Em vez disso, use tlsRequireValidMMSServerCertificates .

tlsRequireValidMMSServerCertificates

Tipo: booleano

Especifica se o MongoDB Agent deve validar certificados TLS apresentados pelo Cloud Manager.

Aviso

Definir essa opção como false desativa a verificação de certificados e torna as conexões entre o MongoDB Agent e o Cloud Manager suscetíveis a ataques intermediários . Definir essa opção como false só é recomendado para fins de teste.

tlsRequireValidMMSServerCertificates=true

Configurações de migração push live

agentFeatureCloudMigrationEnabled

Tipo: booleano

Opcional.

Especifica se o MongoDB Agent no host de migração está configurado para executar o processo de migração em produção de uma sistema do Cloud Manager de origem para um cluster de destino no Atlas.

Essa opção tem como padrão false, o que impede o uso do MongoDB Agent nesse host para a migração ao vivo para o Atlas.

Para habilitar o processo de migração ao vivo, provisione um host de migração e defina agentFeatureCloudMigrationEnabled como true.

cloudMigrationOplogPath

Tipo: string

Opcional.

Caminho para os arquivos oplog . Se especificada, essa configuração armazena em buffer a janela inicial do oplog de sincronização no disco. Provisione armazenamento suficiente no diretório especificado para o armazenamento em buffer do oplog .

Definições de configuração de origem externa

enableLocalConfigurationServer

Tipo: booleano

Especifica se o MongoDB Agent armazena os arquivos de configuração do processo MongoDB em disco ou em cache na memória.

Esta opção padroniza para false, que armazena os arquivos de configuração no disco. Definir esta opção para true armazena em cache a configuração na memória.

Se você definir essa opção como true, o MongoDB Agent não gravará o arquivo mmsConfigBackup .

Não defina essa opção como true se seus bancos de dados do MongoDB estiverem executando o FCV 4.2 ou anterior.

Aviso

Configurar esta opção para true afeta a disponibilidade da sua sistema.

Quando esse recurso está habilitado, o MongoDB Agent não armazena a configuração do processo MongoDB no disco. Se o servidor de aplicativos do Cloud Manager não estiver disponível e o MongoDB Agent tentar reiniciar, o MongoDB Agent interromperá a execução porque não terá as informações de configuração necessárias. Se um processo MongoDB falhar enquanto o MongoDB Agent não estiver em execução, o MongoDB Agent não poderá reiniciar o processo.

enableLocalConfigurationServer=false

Dica

Veja também:

Configurar como o MongoDB Agent gerencia arquivos de configuração e senhas

keepUnusedMongodbVersions

Tipo: booleano

Sinalizador que indica se o MongoDB Agent retém binários de versão MongoDB não utilizados que ele baixa. Por padrão, keepUnusedMongodbVersions é falso.

keepUnusedMongodbVersions=false

localConfigurationServerPort

Tipo: inteiro

Especifica a porta para atender à configuração do processo MongoDB ao utilizar o servidor de configuração local. Para definir esta opção, enableLocalConfigurationServer deve ser true.

Se não especificado, o MongoDB Agent escolhe uma porta disponível automaticamente.

localConfigurationServerPort=20128

mmsApiKeyExec

Tipo: string

Especifica um comando shell para chamar a chave de API do agente do Cloud Manager do seu projeto do Cloud Manager.

mmsApiKeyExec=echo $myKey

Configurações de hugepage transparente (THP)

enableAgentManagingTHPSettings

Tipo: booleano

Padrão: false

Especifica se o MongoDB Agent deve desabilitar o Transparent Huge Pages (THP) para versões de processo mongo anteriores a 8.0. O MongoDB Agent desativa o THP por mongo processo, independentemente das configurações de THP no nível do sistema operacional.

Configurações de automação

As seguintes definições de configuração são usadas para autenticação em clusters automatizados.

Configurações do MongoDB Kerberos

Especifique essas configurações se a automação for autenticada para hosts usando Kerberos. Para configurar Kerberos, consulte Configurar o MongoDB Agent para Kerberos.

krb5ConfigLocation

Tipo: string

Especifica um caminho absoluto para um local não padrão do sistema para o arquivo de configuração Kerberos.

krb5ConfigLocation=/path/to/krb_custom.conf

Observação

O Cloud Manager cria um Cache de Credenciais Kerberos (Ticket) para cada agente automaticamente quando o Kerberos está habilitado. Se você deseja substituir a localização do Cache de Credenciais Kerberos, você deve definir a KRB5CCNAME variável de ambiente para o nome e o caminho de arquivo desejados antes de executar o agente.

backupAgentKrb5CCName

Digite string

Especifica a variável de ambiente do KRB5CC que o MongoDB Agent define para o processo de backup. Usado somente para autenticar o Backup para sua sistema MongoDB quando o MongoDB Agent iniciar a função Backup.

backupAgentKrb5CCName=/path/to/credentials_cache_file

monitoringAgentKrb5CCName

Digite string

Especifica a variável de ambiente do KRB5CC que o MongoDB Agent define para a função Monitoramento. Usado apenas para autenticar o monitoramento em sua sistema MongoDB quando o MongoDB Agent iniciar a função de monitoramento.

monitoringAgentKrb5CCName=/path/to/credentials_cache_file

Configurações de monitoramento

Use a interface do Cloud Manager para definir as configurações de monitoramento.

Configurações de registro

No MongoDB Cloud Manager, acesse a Deployment página do seu projeto.

Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
A página Sistema é exibida.

Vá para a Agents página .

Clique na aba Agents para sua implantação.

A página Agentes é exibida.

Edite as configurações de registros.

Clique em Downloads & Settings.
Na seção Agent Log Settings, clique em ao lado de Monitoring Log Settings.

Edite as configurações do registro de monitoramento:

Contexto	Valor padrão	Valor sugerido do console
Caminho do arquivo de registro do Linux	`/var/log/mongodb-mms-automation/monitoring-agent.log`
Caminho do arquivo de registro do Windows	`%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\monitoring-agent.log`
Rotacionar registros	sim
Limite de tamanho (MB)	1000
Limite de tempo (horas)	24
Máximo de arquivos descompactados		5
Porcentagem Máxima de Disco		2
Número total de arquivos de registro	0

Clique em Save.

Configurações personalizadas

No MongoDB Cloud Manager, acesse a Deployment página do seu projeto.

Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
A página Sistema é exibida.

Vá para a Agents página .

Clique na aba Agents para sua implantação.

A página Agentes é exibida.

Edite a configuração.

Clique em Downloads & Settings.
Na seção Custom Configuration, ao lado de Edit Custom Configurations, clique em .
Insira a definição e o valor da configuração de monitoramento.
Clique em Save and Close.

Você pode definir as seguintes configurações de monitoramento:

Configurações de conexão

mmsGroupId

Tipo: string

Especifica o ID do seu projeto do Cloud Manager. Para encontrar o ID do projeto:

No MongoDB Cloud Manager, acesse a Project Settings página .

Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Ao lado do menu Projects, expanda o menu Options e clique em Project Settings.
A página Configurações do projeto é exibida.

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf

mmsApiKey

Tipo: string

Especifica a chave de API do agente do Cloud Manager do seu projeto do Cloud Manager.

Para gerar uma chave de API do agente, acesse a guia Agent API Keys . Para navegar até a aba:

No MongoDB Cloud Manager, acesse a página Deployment do seu projeto.
1. Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
3. Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
  A página Sistema é exibida.
Clique na aba Agents para sua implantação.
A página Agentes é exibida.
Clique na aba Agent API Keys.

Importante

O Cloud Manager configura essa configuração quando você instala o MongoDB Agent. Se você precisar configurar o Monitoramento separadamente, inclua essa configuração.

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem

mmsBaseUrl

Tipo: string

Especifica a URL do Cloud Manager.

mmsBaseUrl=http://example.com:8080

Configurações de proxy HTTP

httpProxy

Tipo: string

Especifica a URL de um servidor proxy HTTP que o Monitoramento pode usar.

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

Configurações do MongoDB Kerberos

Especifique essas configurações se o Monitoramento autenticar para hosts usando Kerberos.

Para configurar Kerberos, consulte Configurar o MongoDB Agent para Kerberos. Os mesmos procedimentos e requisitos se aplicam, use somente um UPN diferente para monitoramento.

Observação

krb5Principal

Tipo: string

Especifica o principal Kerberos que o Monitoramento usa.

krb5Principal=monitoring/myhost@EXAMPLE.COM

krb5Keytab

Tipo: string

Especifica o caminho absoluto para o arquivo keytab do Kerberos principal.

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

krb5ConfigLocation

Tipo: string

Especifica o caminho absoluto para um local não padrão do sistema para o arquivo de configuração Kerberos.

krb5ConfigLocation=/path/to/krb_custom.conf

gssapiServiceName

Tipo: string

Especifica o nome do serviço com a configuração do gssapiServiceName .

Por padrão, o MongoDB usa mongodb como seu nome de serviço.

Configurações TLS do MongoDB

Especifique essas configurações quando o Monitoring se conectar a sistemas do MongoDB usando TLS.

Para saber mais, consulte Configurar o MongoDB Agent para usar TLS.

useSslForAllConnections

Tipo: booleano

Especifica se todas as conexões com sistemas do MongoDB devem ou não ser criptografadas usando TLS.

Importante

Definir isso como true substitui quaisquer configurações de TLS por host configuradas na interface do Cloud Manager.

sslClientCertificate

Tipo: string

Especifica o caminho absoluto para a chave privada, certificado do cliente e certificados intermediários opcionais no formato PEM. O monitoramento usa o certificado do cliente para se conectar a qualquer implantação configurada do MongoDB que use TLS e exija certificados do cliente. (A implantação é executada com a configuração --tlsCAFile.)

Exemplo

Se você quiser se conectar a uma implantação do MongoDB que usa TLS e validação de certificado usando mongosh:

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

Você deve definir estas configurações em seu Custom Settings:

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

sslClientCertificatePassword

Tipo: string

Especifica a senha necessária para descriptografar a chave privada no arquivo sslClientCertificate . Inclua essa configuração se você criptografou o arquivo PEM do certificado do cliente.

sslClientCertificatePassword=password

sslTrustedServerCertificates

Tipo: string

Especifica o caminho absoluto que contém os certificados confiáveis da Autoridade de Certificação no formato PEM. Esses certificados verificam o certificado do servidor retornado de qualquer sistema do MongoDB em execução com TLS.

sslTrustedServerCertificates=/path/to/ca.pem

sslRequireValidServerCertificates

Tipo: booleano

Especifica se o Monitoramento deve validar os certificados TLS apresentados pelos reconhecimento de data center MongoDB.

sslRequireValidServerCertificates=true

Por padrão, o Cloud Manager define sslRequireValidServerCertificates como true. Você precisa de um certificado confiável válido para se conectar às instâncias do MongoDB usando TLS.

Se o MongoDB Agent gerencia o Monitoramento, você não pode definir essa opção como false.
Se você configurar o monitoramento manualmente, poderá definir sslRequireValidServerCertificates para false.
Se você configurar sslRequireValidServerCertificates para false, não configure sslTrustedServerCertificates. O Cloud Manager não verificará os certificados.

Aviso

Alterar essa configuração para false desativa a verificação do certificado e torna as conexões entre as sistemas do Monitoring e do MongoDB suscetíveis a ataques do tipo man-in-the-middle. Altere esta configuração para false apenas para fins de teste.

Configurações de TLS do servidor do Cloud Manager

Especifique as configurações que o monitoramento usa ao se comunicar com o Cloud Manager usando o TLS.

httpsCAFile

Tipo: string

Especifica o caminho absoluto que contém os certificados de autoridade de certificação confiáveis no formato PEM . O monitoramento usa esse certificado para verificar se o agente pode se comunicar com a instância do Cloud Manager designado.

Por padrão, o Monitoramento usa a raiz confiável Autoridades de Certificado instaladas no host.

Se o agente não conseguir encontrar as Autorizações de Certificado raiz confiáveis, defina essas configurações manualmente.

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

Configurações de backup

Use a interface do Cloud Manager para definir as configurações de backup.

Configurações de registro

No MongoDB Cloud Manager, acesse a Deployment página do seu projeto.

Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
A página Sistema é exibida.

Vá para a Agents página .

Clique na aba Agents para sua implantação.

A página Agentes é exibida.

Edite as configurações de registros.

Clique em Downloads & Settings.
Na seção Agent Log Settings, clique em ao lado de Backup Log Settings.

Edite as configurações do log de backup:

Contexto	Valor padrão	Valor sugerido do console
Caminho do arquivo de registro do Linux	`/var/log/mongodb-mms-automation/backup-agent.log`
Caminho do arquivo de registro do Windows	`%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\backup-agent.log`
Rotacionar registros	sim
Limite de tamanho (MB)	1000
Limite de tempo (horas)	24
Máximo de arquivos descompactados		5
Porcentagem Máxima de Disco		2
Número total de arquivos de registro	0

Clique em Save.

Configurações personalizadas

No MongoDB Cloud Manager, acesse a Deployment página do seu projeto.

Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
A página Sistema é exibida.

Vá para a Agents página .

Clique na aba Agents para sua implantação.

A página Agentes é exibida.

Edite a configuração.

Clique em Downloads & Settings.
Na seção Custom Configuration, ao lado de Edit Custom Configurations, clique em .
Insira uma configuração e um valor de backup.
Clique em Save and Close.

Você pode definir as seguintes configurações de backup:

Configurações de conexão

mmsGroupId

Tipo: string

Especifica o ID do seu projeto do Cloud Manager. Para encontrar o ID do projeto:

No MongoDB Cloud Manager, acesse a Project Settings página .

Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Ao lado do menu Projects, expanda o menu Options e clique em Project Settings.
A página Configurações do projeto é exibida.

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf

mmsApiKey

Tipo: string

Especifica a chave de API do agente do MongoDB Agent do seu projeto do Cloud Manager.

Para gerar uma chave de API do agente, acesse a guia Agent API Keys . Para navegar até a aba:

No MongoDB Cloud Manager, acesse a página Deployment do seu projeto.
1. Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no menu Organizations na barra de navegação.
2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
3. Se a página Deployment ainda não estiver exibida, clique em Deployment na barra lateral.
  A página Sistema é exibida.
Clique na aba Agents para sua implantação.
A página Agentes é exibida.
Clique na aba Agent API Keys.

Importante

O Cloud Manager configura essa configuração quando você instala o MongoDB Agent. Se você precisar configurar o Backup separadamente, inclua essa configuração.

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem

mothership

Tipo: string

Especifica o nome do host e a porta do Cloud Manager usado pelo agente de backup.

Observação

Não inclua o protocolo (http:// ou https://) na configuração mothership .

mothership=example.com:8080

mothershipResponseHeaderTimeout

Tipo: inteiro

Especifica o tempo, em segundos, de espera que o Cloud Manager responda. Se o MongoDB Agent não receber uma resposta, ele redefinirá e tentará novamente a conexão com o Cloud Manager. Este valor é padronizado para 90 segundos.

backupSocketTimeoutMs

Tipo: inteiro

Especifica o período de tempo, em milésimos de segundo, que um soquete entre o Backup e o Cloud Manager pode permanecer inativo antes que o Cloud Manager interrompa a conexão. Se omitido, o padrão é 180000 milésimos de segundo (3 minutos).

https

Tipo: booleano

Especifica se a comunicação com o servidor Web do Cloud Manager usa ou não HTTP seguro.

Configurações de proxy HTTP

httpProxy

Tipo: string

Especifica a URL de um proxy HTTP que o Backup pode utilizar.

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

Configurações do MongoDB Kerberos

Para configurar o Kerberos, consulte Configurar o MongoDB Agent para o Kerberos. Os mesmos procedimentos e requisitos se aplicam, use somente um UPN diferente para o Backup.

Observação

krb5Principal

Tipo: string

Especifica o principal Kerberos que o Backup usa.

krb5Principal=backup/myhost@EXAMPLE.COM

krb5Keytab

Tipo: string

Especifica o caminho absoluto para o arquivo de guia de chave do Kerberos principal.

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

krb5ConfigLocation

Tipo: string

Especifica o caminho absoluto para um local não padrão do sistema para o arquivo de configuração Kerberos.

krb5ConfigLocation=/path/to/krb_custom.conf

gsapiServiceName

Tipo: string

Especifica o nome do serviço com a configuração do gsapiServiceName .

Por padrão, o MongoDB usa mongodb como seu nome de serviço.

Configurações TLS do MongoDB

Especifique essas configurações quando o Backup se conectar às sistemas do MongoDB usando TLS.

Para saber mais, consulte Configurar o MongoDB Agent para usar TLS.

sslClientCertificate

Tipo: string

Especifica o caminho para a chave privada, o certificado do cliente e os certificados intermediários opcionais no formato PEM. O Backup usa o certificado do cliente ao se conectar a uma implantação do MongoDB que usa TLS e exige certificados do cliente. (A implantação é executada com a configuração --tlsCAFile.)

sslClientCertificatePassword

Tipo: string

Especifica a senha necessária para descriptografar a chave privada no arquivo sslClientCertificate . Inclua essa configuração se você criptografou o arquivo PEM do certificado do cliente.

sslTrustedServerCertificates

Tipo: string

Especifica o caminho que contém os certificados CA confiáveis no formato PEM. Esses certificados verificam o certificado do servidor retornado de qualquer sistema do MongoDB em execução com TLS.

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

sslRequireValidServerCertificates

Tipo: booleano

Especifica se o Backup deve validar os certificados TLS apresentados pelas sistemas do MongoDB.

Aviso

Alterar essa configuração para false desativa a verificação do certificado e torna as conexões entre as implantações do Backup e do MongoDB suscetíveis a ataques do tipo man-in-the-middle. Altere esta configuração para false apenas para fins de teste.

Configurações de TLS do servidor do Cloud Manager

Especifique o uso das configurações que o Backup usa ao se comunicar com o Cloud Manager usando o TLS.

sslTrustedMMSBackupServerCertificate

Especifica o caminho absoluto que contém os certificados de autoridade de certificação confiáveis no formato PEM . O backup usa esse certificado para verificar se o MongoDB Agent pode se comunicar com a instância designada do Cloud Manager.

Por padrão, o Backup usa a raiz confiável Autoridades de Certificado instaladas no sistema.

Se o Backup não conseguir encontrar as Autoridades Certificadoras raiz confiáveis, defina essas configurações manualmente.

Se o Cloud Manager usar um certificado TLS autoassinado, forneça um valor para essa configuração.

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

Voltar

Gerenciar as funções do MongoDB Agent

Acesso necessário para o MongoDB Agent