Skip to main content
Neste exemplo, você aprenderá a configurar um cluster ClickHouse simples com replicação de dados. Há cinco servidores configurados. Dois são usados para hospedar cópias dos dados. Os outros três servidores são usados para coordenar a replicação dos dados.
A arquitetura do cluster que você vai configurar é mostrada abaixo:
Embora seja possível executar o ClickHouse Server e o ClickHouse Keeper juntos no mesmo servidor, recomendamos fortemente usar hosts dedicados para o ClickHouse Keeper em ambientes de produção, e essa é a abordagem que demonstraremos neste exemplo.Os servidores do Keeper podem ser menores, e 4 GB de RAM geralmente bastam para cada servidor do Keeper até que seus servidores ClickHouse atinjam grande porte.

Pré-requisitos

1

Configurar a estrutura de diretórios e o ambiente de teste

Arquivos de exemploAs etapas a seguir vão orientar você na configuração do cluster do zero. Se preferir pular essas etapas e ir direto para executar o cluster, você pode obter os arquivos de exemplo no repositório de exemplos, no diretório ‘docker-compose-recipes’.
Neste tutorial, você usará o Docker compose para configurar o cluster do ClickHouse. Esta configuração pode ser adaptada para funcionar em máquinas locais separadas, máquinas virtuais ou instâncias de nuvem também.Execute os seguintes comandos para configurar a estrutura de diretórios deste exemplo:
Adicione o seguinte arquivo docker-compose.yml ao diretório cluster_1S_2R:
docker-compose.yml
Crie os seguintes subdiretórios e arquivos:
  • O diretório config.d contém o arquivo de configuração do servidor ClickHouse config.xml, no qual é definida a configuração personalizada de cada nó do ClickHouse. Essa configuração é combinada com o arquivo de configuração padrão config.xml do ClickHouse, incluído em toda instalação do ClickHouse.
  • O diretório users.d contém o arquivo de configuração de usuários users.xml, no qual é definida a configuração personalizada dos usuários. Essa configuração é combinada com o arquivo de configuração padrão users.xml do ClickHouse, incluído em toda instalação do ClickHouse.
Diretórios de configuração personalizadosÉ uma prática recomendada usar os diretórios config.d e users.d ao criar sua própria configuração, em vez de modificar diretamente a configuração padrão em /etc/clickhouse-server/config.xml e etc/clickhouse-server/users.xml.A linha
garante que as seções de configuração definidas nos diretórios config.d e users.d substituam as seções de configuração padrão definidas nos arquivos padrão config.xml e users.xml.
2

Configurar nós do ClickHouse

Configuração do servidor

Agora modifique cada arquivo de configuração vazio config.xml localizado em fs/volumes/clickhouse-{}/etc/clickhouse-server/config.d. As linhas que estão destacadas abaixo precisam ser alteradas para serem específicas de cada nó:
Cada seção do arquivo de configuração acima é explicada em mais detalhes a seguir.

Rede e logging

A comunicação externa pela interface de rede é habilitada ao ativar a configuração listen_host. Isso garante que o host do servidor ClickHouse possa ser acessado por outros hosts:
A porta da API HTTP está configurada como 8123:
A porta TCP usada para comunicação pelo protocolo nativo do ClickHouse entre clickhouse-client e outras ferramentas nativas do ClickHouse, e entre clickhouse-server e outros clickhouse-servers é definida como 9000:
O logging é definido no bloco <logger>. Esta configuração de exemplo fornece um log de depuração que será rotacionado a cada 1000M, até três vezes:
Para obter mais informações sobre configuração de logging, consulte os comentários incluídos no arquivo de configuração padrão do ClickHouse.

Configuração do cluster

A configuração do cluster é definida no bloco <remote_servers>. Aqui é definido o nome do cluster cluster_1S_2R.O bloco <cluster_1S_2R></cluster_1S_2R> define o layout do cluster, utilizando as configurações <shard></shard> e <replica></replica>, e serve como um template para consultas de DDL distribuído, que são queries executadas em todo o cluster por meio da cláusula ON CLUSTER. Por padrão, as consultas de DDL distribuído são permitidas, mas também podem ser desativadas com a configuração allow_distributed_ddl_queries.internal_replication está definido como true para que os dados sejam gravados em apenas uma das réplicas.
Para cada servidor, os seguintes parâmetros são especificados:

Configuração do Keeper

A seção <ZooKeeper> informa ao ClickHouse onde o ClickHouse Keeper (ou ZooKeeper) está em execução. Como estamos usando um cluster do ClickHouse Keeper, cada <node> do cluster precisa ser especificado, junto com seu hostname e número de porta, usando as tags <host> e <port>, respectivamente.A configuração do ClickHouse Keeper é explicada na próxima etapa do tutorial.
Embora seja possível executar o ClickHouse Keeper no mesmo servidor que o ClickHouse Server, em ambientes de produção, recomendamos fortemente que o ClickHouse Keeper seja executado em servidores dedicados.

Configuração de macros

Além disso, a seção <macros> é usada para definir substituições de parâmetros para tabelas replicadas. Elas são listadas em system.macros e permitem o uso de substituições como {shard} e {replica} em queries.
Eles serão definidos de maneira específica, dependendo da configuração do cluster.

Configuração de usuário

Agora modifique cada arquivo de configuração vazio users.xml localizado em fs/volumes/clickhouse-{}/etc/clickhouse-server/users.d com o seguinte conteúdo:
/users.d/users.xml
Neste exemplo, o usuário padrão é configurado sem senha para simplificar. Na prática, isso não é recomendado.
Neste exemplo, cada arquivo users.xml é idêntico em todos os nós do cluster.
3

Configurar o ClickHouse Keeper

Configuração do ClickHouse Keeper

Para que a replicação funcione, é necessário configurar e implantar um cluster do ClickHouse Keeper. O ClickHouse Keeper fornece o sistema de coordenação para a replicação de dados, atuando como um substituto direto do ZooKeeper, que também pode ser usado. No entanto, o ClickHouse Keeper é recomendado, pois oferece melhores garantias e confiabilidade, além de usar menos recursos do que o ZooKeeper. Para alta disponibilidade e para manter o quórum, recomenda-se executar pelo menos três nós do ClickHouse Keeper.
O ClickHouse Keeper pode ser executado em qualquer nó do cluster junto com o ClickHouse, embora seja recomendável executá-lo em um nó dedicado, o que permite escalar e gerenciar o cluster do ClickHouse Keeper independentemente do cluster do banco de dados.
Crie os arquivos keeper_config.xml para cada nó do ClickHouse Keeper usando o comando abaixo a partir da raiz da pasta de exemplo:
Modifique os arquivos de configuração vazios criados em cada diretório de nó fs/volumes/clickhouse-keeper-{}/etc/clickhouse-keeper. As linhas destacadas abaixo precisam ser ajustadas para cada nó:
/clickhouse-keeper/keeper_config.xml
Cada arquivo de configuração conterá a seguinte configuração exclusiva (mostrada abaixo). O server_id usado deve ser exclusivo para esse nó específico do ClickHouse Keeper no cluster e corresponder ao <id> do servidor definido na seção <raft_configuration>. tcp_port é a porta usada pelos clientes do ClickHouse Keeper.
A seção a seguir é usada para configurar os servidores que participam do quórum do algoritmo de consenso Raft:
ClickHouse Cloud simplifica o gerenciamentoClickHouse Cloud elimina a carga operacional associada ao gerenciamento de shards e réplicas. A plataforma cuida automaticamente da alta disponibilidade, da replicação e do escalonamento. Compute e armazenamento são separados e escalam conforme a demanda, sem exigir configuração manual nem manutenção contínua.Leia mais
4

Teste a configuração

Certifique-se de que o Docker esteja em execução na sua máquina. Inicie o cluster usando o comando docker-compose up na raiz do diretório cluster_1S_2R:
Você deverá ver o Docker começar a baixar as imagens do ClickHouse e do Keeper, e depois iniciar os contêineres:
Para verificar se o cluster está em execução, conecte-se a clickhouse-01 ou clickhouse-02 e execute a consulta a seguir. O comando para se conectar ao primeiro nó é mostrado abaixo:
Se a operação for bem-sucedida, você verá o prompt do cliente ClickHouse:
Execute a seguinte consulta para verificar quais topologias de cluster estão definidas em quais hosts:
Query
Response
Execute a consulta a seguir para verificar o status do cluster do ClickHouse Keeper:
Query
Response
O comando mntr também é comumente usado para verificar se o ClickHouse Keeper está em execução e para obter informações de estado sobre a relação entre os três nós do Keeper. Na configuração usada neste exemplo, há três nós trabalhando juntos. Os nós elegerão um líder, e os nós restantes serão seguidores.O comando mntr fornece informações relacionadas ao desempenho e indica se um determinado nó é seguidor ou líder.
Talvez seja necessário instalar o netcat para enviar o comando mntr ao Keeper. Consulte a página nmap.org para obter informações de download.
Execute o comando abaixo em um shell no clickhouse-keeper-01, clickhouse-keeper-02 e clickhouse-keeper-03 para verificar o status de cada nó do Keeper. O comando para clickhouse-keeper-01 é mostrado abaixo:
A resposta abaixo mostra um exemplo de resposta de um nó seguidor:
Response
A resposta abaixo mostra um exemplo de resposta de um nó líder:
Response
Com isso, você configurou com sucesso um cluster do ClickHouse com um único shard e duas réplicas. Na próxima etapa, você criará uma tabela no cluster.
5

Criar um banco de dados

Agora que você verificou que o cluster foi configurado corretamente e está em execução, você recriará a mesma tabela usada no tutorial do conjunto de dados de exemplo UK property prices. Esse conjunto de dados contém cerca de 30 milhões de linhas com preços pagos por imóveis na Inglaterra e no País de Gales desde 1995.Conecte-se ao cliente de cada host executando cada um dos comandos a seguir em abas ou janelas separadas do terminal:
Você pode executar a consulta abaixo no clickhouse-client de cada host para confirmar que ainda não há bancos de dados criados, além dos bancos de dados padrão:
Query
Response
No cliente clickhouse-01, execute a seguinte consulta DDL distribuída usando a cláusula ON CLUSTER para criar um novo banco de dados chamado uk:
Você pode executar novamente a mesma consulta de antes no cliente de cada host para confirmar que o banco de dados foi criado em todo o cluster, mesmo tendo executado a consulta apenas em clickhouse-01:
6

Crie uma tabela no cluster

Agora que o banco de dados foi criado, crie uma tabela no cluster. Execute a seguinte consulta em qualquer um dos hosts clientes:
Observe que ela é idêntica à consulta usada na instrução CREATE original do tutorial do conjunto de dados de exemplo UK property prices, exceto pela cláusula ON CLUSTER e pelo uso do motor ReplicatedMergeTree.A cláusula ON CLUSTER foi projetada para a execução distribuída de consultas DDL (Data Definition Language), como CREATE, DROP, ALTER e RENAME, garantindo que essas alterações de esquema sejam aplicadas em todos os nós do cluster.O motor ReplicatedMergeTree funciona exatamente como o motor de tabela MergeTree, mas também replica os dados.Você pode executar a consulta abaixo a partir do cliente clickhouse-01 ou clickhouse-02 para confirmar que a tabela foi criada em todo o cluster:
Query
Response
7

Inserir dados

Como o conjunto de dados é grande e leva alguns minutos para ser completamente ingerido, vamos inserir apenas um pequeno subconjunto inicialmente.Insira um subconjunto menor dos dados usando a consulta abaixo a partir do clickhouse-01:
Observe que os dados estão completamente replicados em cada host:
Para demonstrar o que acontece quando um dos hosts falha, crie um banco de dados de teste simples e uma tabela de teste em qualquer um dos hosts:
Assim como na tabela uk_price_paid, podemos inserir dados a partir de qualquer host:
Mas o que acontecerá se um dos hosts ficar fora do ar? Para simular isso, pare clickhouse-01 executando:
Verifique se o host está inativo executando:
Response
Com o clickhouse-01 agora inativo, insira outra linha de dados na tabela de teste e consulte a tabela:
Response
Agora reinicie o clickhouse-01 com o seguinte comando (você pode executar docker-compose ps novamente depois para confirmar):
Consulte a tabela de teste novamente em clickhouse-01 após executar docker exec -it clickhouse-01 clickhouse-client:
Query
Response
Se neste momento você quiser ingerir o conjunto de dados completo de preços de imóveis do Reino Unido para explorar, execute as seguintes consultas:
Consulte a tabela a partir de clickhouse-02 ou clickhouse-01:
Query
Response

Conclusão

A vantagem desta topologia de cluster é que, com duas réplicas, seus dados ficam em dois hosts separados. Se um host falhar, a outra réplica continua atendendo as consultas sem nenhuma perda. Isso elimina pontos únicos de falha no nível de armazenamento. Quando um host fica indisponível, a réplica restante ainda consegue:
  • Atender consultas de leitura sem interrupção
  • Aceitar novas gravações (dependendo das suas configurações de consistência)
  • Manter a disponibilidade do serviço para as aplicações
Quando o host que falhou volta a ficar online, ele consegue:
  • Sincronizar automaticamente os dados ausentes a partir da réplica íntegra
  • Retomar as operações normais sem intervenção manual
  • Restaurar rapidamente a redundância total
No próximo exemplo, veremos como configurar um cluster com dois shards, mas apenas uma réplica.
Última modificação em 23 de julho de 2026