Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/ / /

replSetReconfig

Nesta página

  • Definição
  • Compatibilidade
  • Sintaxe
  • Campos de comando
  • Comportamento
  • Informações adicionais
replSetReconfig

O comando administrativo replSetReconfig modifica a configuração de um conjunto de réplica existente. Você pode usar este comando para adicionar e remover membros e alterar as opções definidas nos membros existentes. Você deve executar esse comando no banco de dados de dados admin do membroprimário do conjunto de réplicas .

Dica

Em mongosh, esse comando também pode ser executado por meio do método auxiliar rs.reconfig().

Os métodos auxiliares são práticos para os usuários mongosh, mas podem não retornar o mesmo nível de informações que os comandos do banco de dados. Nos casos em que a praticidade não for necessária ou os campos de retorno adicionais forem necessários, use o comando de banco de dados.

Esse comando está disponível em implantações hospedadas nos seguintes ambientes:

  • MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

Importante

Este comando não é suportado em M0, M2, M5 e M10+ clusters. Para obter mais informações, consulte Comandos não suportados.

  • MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB

  • MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

O comando tem a seguinte sintaxe:

db.adminCommand(
{
replSetReconfig: <new_config_document>,
force: <boolean>,
maxTimeMS: <int>
}
)

O comando usa o seguinte campo opcional:

Campo
Descrição

força

Padrão é false. Especifique true para forçar os membros do conjunto de réplica disponíveis a aceitar a nova configuração.

A reconfiguração forçada pode resultar em comportamento inesperado ou indesejado, incluindo a reversão de "majority" gravações confirmadas.

Opcional. Especifica um limite de tempo cumulativo em milissegundos para o processamento do replSetReconfig. Por padrão, o replSetReconfig espera indefinidamente que a configuração da réplica propague para a maioria dos membros do conjunto de réplica. A configuração maxTimeMS pode resultar na falha da operação antes de poder aplicar a nova configuração. Consulte Reconfiguração aguarda até que a maioria dos membros instale a configuração de réplica para mais informações.

Você também pode executar replSetReconfig com o método rs.reconfig() do shell.

A partir do MongoDB 5.0, você deve definir explicitamente a preocupação de gravação padrão global antes de tentar reconfigurar um conjunto de réplicas com uma configuração que altere a preocupação de gravação padrão implícita. Para definir a preocupação de escrita padrão global, utilize o comando setDefaultRWConcern.

O campo term é definido pelo membro primário do conjunto de réplicas. O primário ignora o campo term se definido explicitamente na operação replSetReconfig.

replSetReconfig por padrão permite adicionar ou remover não mais do que 1 voting membros de cada vez. Por exemplo, uma nova configuração pode fazer, no máximo, uma das seguintes alterações no cluster membership:

  • Adicionando um novo membro do conjunto de réplica de votação.

  • Removendo um membro do conjunto de réplica de votação existente.

  • Modificando o votes para um membro do conjunto de réplica existente.

Para adicionar ou remover vários membros votantes, emita uma série de operações replSetReconfig para adicionar ou remover um membro de cada vez.

A emissão de uma reconfiguração forçada instala imediatamente a nova configuração, mesmo que ela adicione ou remova vários membros votantes. A reconfiguração forçada pode causar um comportamento inesperado, como a reversão das operações de gravação confirmadas pelo "majority".

replSetReconfig aguarda até que a maioria dos membros votantes do conjunto de réplicas instale a nova configuração de réplica antes de retornar sucesso. Um membro votante é qualquer membro do conjunto de réplicas em que members[n].votes é 1, incluindo árbitros.

Os membros do conjunto de réplicas propagam sua configuração de réplica por meio de pulsações. Sempre que um membro descobre uma configuração com umversion e termsuperiores, ele instala a nova configuração. O processo de reconfiguração tem duas fases distintas de espera:

1) Aguarde que a configuração atual seja comprometida antes de instalar a nova configuração.

A configuração "atual" refere-se à configuração de réplica em uso pelo primário no momento em replSetReconfig é emitido.

Uma configuração é confirmada quando:

  • A maioria dos membros do conjunto de réplica de votação instalou a configuração atual e

  • Todas as gravações que foram "majority" confirmadas na configuração anterior também foram replicadas para uma maioria na configuração atual.

Normalmente, a configuração atual já foi instalada na maioria dos membros do conjunto de réplica de votação. No entanto, a maioria das gravações confirmadas na configuração anterior pode não ser confirmada na configuração atual. Delayed membros ou membros que são lagging behind os principais podem aumentar o tempo gasto nessa fase.

Se a operação tiver sido emitida com um limite de maxTimeMS e a operação exceder o limite enquanto espera, a operação retornará um erro e descartará a nova configuração. O limite é cumulativo e não é redefinido após prosseguir para a próxima fase.

2) Aguarde a maioria dos membros votantes na nova configuração instalar a nova configuração.

A configuração "nova" refere-se à configuração de réplica especificada para replSetReconfig.

O primário instala e começa a usar a nova configuração de réplica antes de propagar a configuração para os membros restantes do conjunto de réplicas. A operação aguarda apenas que a maioria dos membros votantes instale a nova configuração e não requer a espera para que a nova configuração seja confirmada.

Se a operação foi emitida com um limite maxTimeMS e a operação exceder o limite durante a espera, a operação retornará um erro , mas continuará usando e propagando a nova configuração.

A emissão de uma reconfiguração forçada instala imediatamente a nova configuração, independentemente do status de compromisso da configuração anterior. A reconfiguração forçada pode causar um comportamento inesperado, como a reversão das operações de gravação confirmadas pelo "majority".

Para verificar o status de compromisso da configuração atual da réplica, emita replSetGetConfig com o parâmetro commitmentStatus no conjunto de réplicas principal.

A partir do MongoDB 5.0, um secundário recém-adicionado não conta como um membro votante e não pode ser eleito até que tenha atingido o estado SECONDARY.

Quando um novo nó de votação é adicionado a um conjunto de réplicas, replSetReconfig adicionará internamente um campo newlyAdded à configuração do nó. Os nós com o campo newlyAdded não contam para o número atual de nós de votação. Quando a sincronização inicial for concluída e o nó atingir o estado SECONDARY, o campo newlyAdded será automaticamente removido.

Observação

  • As configurações que tentam adicionar um campo chamado newlyAdded apresentarão erros mesmo se executadas com { force: true }.

  • Se um nó existente tiver um campo newlyAdded, utilizar rs.reconfig() para alterar a configuração não removerá o campo newlyAdded. O campo newlyAdded será anexado à configuração fornecida pelo usuário.

  • replSetGetConfig removerá todos os campos newlyAdded de saída. Se quiser ver quaisquer campos newlyAdded, você pode fazer a query da collection local.system.replset diretamente.

Para executar o comando em sistemas que impõem controle de acesso, o usuário deve ter a ação de privilégio replSetConfigure no recurso de cluster. A role incorporada clusterManager , disponível no reconhecimento de data center admin , fornece o privilégio necessário para esse comando.

replSetReconfig obtém um bloqueio especial mutuamente exclusivo para evitar que mais de uma operação replSetReconfig ocorra ao mesmo tempo.

Aviso

Evite reconfigurar conjuntos de réplicas que contenham membros de diferentes versões do MongoDB, pois as regras de validação podem diferir entre as versões do MongoDB.

A maioria dos membros do conjunto deve estar operacional para que as alterações se propaguem corretamente.

O replSetReconfig pode acionar o primário atual para reduzir em algumas situações. A redução do primário aciona uma eleição para selecionar um novo primário:

  • Quando o novo primário aumenta, ele incrementa o campo term para distinguir as alterações de configuração feitas no novo primário das alterações feitas no primário anterior.

  • Quando o primário é desativado, ele não fecha mais todas as conexões do cliente; no entanto, as gravações que estavam em andamento são mortos. Confira os detalhes em Comportamento.

O tempo médio antes de um cluster eleger um novo primário normalmente não deve exceder 12 segundos, assumindo replica configuration settingspadrão . Isso inclui o tempo necessário para marcar a primária como indisponível e convocar e concluir uma eleição. Você pode ajustar este período de tempo modificando a opção de configuração de replicação do settings.electionTimeoutMillis. Fatores como a latência da rede podem prolongar o tempo necessário para que as eleições de conjuntos de réplicas sejam concluídas, o que, por sua vez, afeta o tempo em que o cluster pode operar sem um primário. Esses fatores dependem da arquitetura específica de seus clusters.

Durante o processo de eleição, o cluster não pode aceitar operações de gravação até que eleja o novo primário.

A lógica de conexão do seu aplicativo deve incluir tolerância para failovers automáticos e as eleições subsequentes. Os drivers do MongoDB podem detectar a perda do primário e repetir automaticamente determinadas operações de gravação uma única vez, fornecendo tratamento adicional integrado de failovers e eleições automáticas:

Drivers compatíveis permitem gravações repetíveis por padrão

Para reduzir ainda mais o impacto potencial em um cluster de produção, reconfigure somente durante os períodos de manutenção programados.

Aviso

O MongoDB não sincroniza uma reconfiguração forçada de conjunto de réplicas entre os conjuntos de réplicas em um cluster. O uso de { force: true } pode levar a uma reversão das gravações comprometidas pela maioria e a um cluster fragmentado inconsistente. Tenha cuidado ao usar essa opção.

O uso de replSetReconfig para remover um membro do conjunto de réplicas não descarta automaticamente as conexões de saída abertas de outros membros do conjunto de réplicas para o membro removido.

Por padrão, os membros do conjunto de réplicas aguardam 5 minutos antes de descartar conexões com o membro removido. Em conjuntos de réplicas fragmentadas, você pode modificar esse tempo limite usando o parâmetroShardingTaskExecutorPoolHostTimeoutMS server.

Para descartar imediatamente todas as conexões de saída do conjunto de réplicas para o nó removido, execute o comando administrativo dropConnections em cada nó restante no conjunto de réplicas:

db.adminCommand(
{
"dropConnections" : 1,
"hostAndPort" : [
"<hostname>:<port>"
]
}
)

Substitua <hostname> e <port> pelos do membro removido.

Aviso

A partir do MongDB 5.0, DNS de horizonte dividido nós que são configurados apenas com um endereço IP falham na validação de inicialização e relatam um erro. Consulte disableSplitHorizonIPCheck.

Campos de Configuração do conjunto de réplicas , Configuração autogerenciada do conjunto de réplicas, rs.reconfig() e rs.conf().

Voltar

replSetMaintenance