Skip to main content
Dans cet exemple, vous allez apprendre à mettre en place un cluster ClickHouse simple avec réplication des données. Cinq serveurs sont configurés. Deux servent à héberger des copies des données. Les trois autres servent à coordonner la réplication des données.
L’architecture du cluster que vous allez mettre en place est présentée ci-dessous :
Bien qu’il soit possible d’exécuter ClickHouse Server et ClickHouse Keeper sur le même serveur, nous recommandons vivement d’utiliser des hôtes dédiés pour ClickHouse Keeper dans les environnements de production. C’est l’approche que nous allons illustrer dans cet exemple.Les serveurs Keeper peuvent être plus modestes, et 4 Go de RAM suffisent généralement pour chaque serveur Keeper jusqu’à ce que vos serveurs ClickHouse prennent de l’ampleur.

Prérequis

1

Configurer la structure de répertoires et l’environnement de test

Fichiers d’exempleLes étapes suivantes vous guideront dans la configuration du cluster à partir de zéro. Si vous préférez ignorer ces étapes et passer directement à l’exécution du cluster, vous pouvez récupérer les fichiers d’exemple dans le dépôt examples, dans le ‘répertoire docker-compose-recipes’.
Dans ce tutoriel, vous utiliserez Docker compose pour configurer le cluster ClickHouse. Cette configuration peut également être adaptée pour fonctionner sur des machines locales distinctes, des machines virtuelles ou des instances Cloud.Exécutez les commandes suivantes pour configurer l’arborescence de répertoires de cet exemple :
Ajoutez le fichier docker-compose.yml suivant dans le répertoire cluster_1S_2R :
docker-compose.yml
Créez les sous-répertoires et fichiers suivants :
  • Le répertoire config.d contient le fichier de configuration du serveur ClickHouse config.xml, dans lequel est définie la configuration personnalisée de chaque nœud ClickHouse. Cette configuration est fusionnée avec le fichier de configuration ClickHouse config.xml par défaut fourni avec chaque installation de ClickHouse.
  • Le répertoire users.d contient le fichier de configuration utilisateur users.xml, dans lequel est définie la configuration personnalisée des utilisateurs. Cette configuration est fusionnée avec le fichier de configuration ClickHouse users.xml par défaut fourni avec chaque installation de ClickHouse.
Répertoires de configuration personnalisésIl est recommandé d’utiliser les répertoires config.d et users.d lors de la rédaction de votre propre configuration, plutôt que de modifier directement la configuration par défaut dans /etc/clickhouse-server/config.xml et etc/clickhouse-server/users.xml.La ligne
garantit que les sections de configuration définies dans les répertoires config.d et users.d remplacent les sections de configuration par défaut définies dans les fichiers config.xml et users.xml.
2

Configurer les nœuds ClickHouse

Configuration du serveur

Modifiez maintenant chaque fichier de configuration vide config.xml situé dans fs/volumes/clickhouse-{}/etc/clickhouse-server/config.d. Les lignes surlignées ci-dessous doivent être adaptées à chaque nœud :
Chaque section du fichier de configuration ci-dessus est expliquée plus en détail ci-dessous.

Réseau et journalisation

La communication externe via l’interface réseau est activée en configurant le paramètre listen host. Cela garantit que l’hôte du serveur ClickHouse est accessible depuis d’autres hôtes :
Le port de l’API HTTP est configuré sur 8123 :
Le port TCP utilisé pour la communication via le protocole natif de ClickHouse entre clickhouse-client et d’autres outils natifs de ClickHouse, ainsi qu’entre clickhouse-server et d’autres clickhouse-servers, est défini sur 9000:
La journalisation est définie dans le bloc <logger>. Cet exemple de configuration génère un journal de débogage qui effectuera une rotation à 1 000 Mo, trois fois :
Pour plus d’informations sur la configuration de la journalisation, consultez les commentaires inclus dans le fichier de configuration ClickHouse par défaut.

Configuration du cluster

La configuration du cluster est définie dans le bloc <remote_servers>. Le nom du cluster cluster_1S_2R y est défini.Le bloc <cluster_1S_2R></cluster_1S_2R> définit la disposition du cluster, à l’aide des paramètres <shard></shard> et <replica></replica>, et sert de template pour les requêtes DDL distribuées, c’est-à-dire les requêtes qui s’exécutent sur l’ensemble du cluster via la clause ON CLUSTER. Par défaut, les requêtes DDL distribuées sont autorisées, mais peuvent également être désactivées avec le paramètre allow_distributed_ddl_queries.internal_replication est défini sur true afin que les données ne soient écrites que sur l’une des répliques.
Pour chaque serveur, les paramètres suivants sont définis :

Configuration de Keeper

La section <ZooKeeper> indique à ClickHouse où ClickHouse Keeper (ou ZooKeeper) s’exécute. Comme nous utilisons un cluster ClickHouse Keeper, chaque <node> du cluster doit être spécifié, avec son hostname et son numéro de port via les tags <host> et <port> respectivement.La configuration de ClickHouse Keeper est décrite à l’étape suivante du tutoriel.
Bien qu’il soit possible d’exécuter ClickHouse Keeper sur le même serveur que ClickHouse Server, dans les environnements de production, nous recommandons vivement d’exécuter ClickHouse Keeper sur des hôtes dédiés.

Configuration des macros

Par ailleurs, la section <macros> permet de définir des substitutions de paramètres pour les tables répliquées. Celles-ci sont répertoriées dans system.macros et permettent d’utiliser des substitutions telles que {shard} et {replica} dans les requêtes.
Ils seront définis de manière spécifique selon la topologie du cluster.

Configuration utilisateur

Modifiez maintenant chaque fichier de configuration vide users.xml situé dans fs/volumes/clickhouse-{}/etc/clickhouse-server/users.d en y ajoutant le contenu suivant :
/users.d/users.xml
Dans cet exemple, l’utilisateur par défaut est configuré sans mot de passe par souci de simplicité. En pratique, cette pratique est déconseillée.
Dans cet exemple, le fichier users.xml est identique sur tous les nœuds du cluster.
3

Configurer ClickHouse Keeper

Configuration de ClickHouse Keeper

Pour que la réplication fonctionne, un cluster ClickHouse Keeper doit être mis en place et configuré. ClickHouse Keeper fournit le système de coordination pour la réplication des données, et remplace ZooKeeper, qui peut également être utilisé. ClickHouse Keeper est toutefois recommandé, car il offre de meilleures garanties, une meilleure fiabilité et utilise moins de ressources que ZooKeeper. Pour assurer une haute disponibilité et maintenir le quorum, il est recommandé d’exécuter au moins trois nœuds ClickHouse Keeper.
ClickHouse Keeper peut s’exécuter sur n’importe quel nœud du cluster aux côtés de ClickHouse, mais il est recommandé de l’exécuter sur un nœud dédié, ce qui permet de faire évoluer et de gérer le cluster ClickHouse Keeper indépendamment du cluster de base de données.
Créez les fichiers keeper_config.xml pour chaque nœud ClickHouse Keeper à l’aide de la commande suivante depuis la racine du dossier d’exemple :
Modifiez les fichiers de configuration vides créés dans chaque répertoire de nœud fs/volumes/clickhouse-keeper-{}/etc/clickhouse-keeper. Les lignes mises en évidence ci-dessous doivent être adaptées à chaque nœud :
/clickhouse-keeper/keeper_config.xml
Chaque fichier de configuration contient la configuration unique suivante (illustrée ci-dessous). Le server_id utilisé doit être unique pour ce nœud ClickHouse Keeper dans le cluster et correspondre à l’<id> du serveur défini dans la section <raft_configuration>. tcp_port est le port utilisé par les clients de ClickHouse Keeper.
La section suivante permet de configurer les serveurs qui participent au quorum de l’algorithme de consensus Raft :
ClickHouse Cloud simplifie la gestionClickHouse Cloud allège la charge opérationnelle liée à la gestion des shards et des réplicas. La plateforme gère automatiquement la haute disponibilité, la réplication et les ajustements de capacité. La puissance de calcul et le stockage sont dissociés et s’adaptent à la demande sans nécessiter de configuration manuelle ni de maintenance continue.En savoir plus
4

Tester la configuration

Assurez-vous que Docker est en cours d’exécution sur votre machine. Démarrez le cluster à l’aide de la commande docker-compose up depuis la racine du répertoire cluster_1S_2R :
Vous devriez voir Docker commencer à télécharger les images ClickHouse et Keeper, puis démarrer les conteneurs :
Pour vérifier que le cluster fonctionne, connectez-vous à clickhouse-01 ou à clickhouse-02 et exécutez la requête suivante. La commande pour se connecter au premier nœud est indiquée :
Si tout se passe bien, vous verrez l’invite de commande du client ClickHouse :
Exécutez la requête suivante pour vérifier quelles topologies de cluster sont définies pour quels hôtes :
Query
Response
Exécutez la requête suivante pour vérifier l’état du cluster ClickHouse Keeper :
Query
Response
La commande mntr est également couramment utilisée pour vérifier que ClickHouse Keeper est en cours d’exécution et pour obtenir des informations sur l’état des relations entre les trois nœuds Keeper. Dans la configuration utilisée dans cet exemple, trois nœuds fonctionnent ensemble. Les nœuds éliront un leader, et les nœuds restants seront des followers.La commande mntr fournit des informations relatives aux performances et indique si un nœud donné est un follower ou un leader.
Il peut être nécessaire d’installer netcat afin d’envoyer la commande mntr à Keeper. Veuillez consulter la page nmap.org pour les informations de téléchargement.
Exécutez la commande ci-dessous depuis un shell sur clickhouse-keeper-01, clickhouse-keeper-02 et clickhouse-keeper-03 pour vérifier l’état de chaque nœud Keeper. La commande pour clickhouse-keeper-01 est indiquée ci-dessous :
La réponse ci-dessous présente un exemple de réponse d’un nœud follower :
Response
La réponse ci-dessous montre un exemple de réponse renvoyée par un nœud leader :
Response
Vous avez ainsi configuré avec succès un cluster ClickHouse avec un seul segment et deux répliques. À l’étape suivante, vous créerez une table dans le cluster.
5

Créer une base de données

Maintenant que vous avez vérifié que le cluster est correctement configuré et fonctionne, vous allez recréer la même table que celle utilisée dans le tutoriel du jeu de données d’exemple sur les prix de l’immobilier au Royaume-Uni. Il contient environ 30 millions de lignes correspondant aux prix payés pour des biens immobiliers en Angleterre et au pays de Galles depuis 1995.Connectez-vous au client de chaque hôte en exécutant chacune des commandes suivantes dans des onglets ou fenêtres de terminal distincts :
Vous pouvez exécuter la requête ci-dessous depuis clickhouse-client sur chaque hôte afin de vérifier qu’aucune base de données n’a encore été créée, en dehors de celles par défaut :
Query
Response
Depuis le client clickhouse-01, exécutez la requête DDL distribuée suivante à l’aide de la clause ON CLUSTER pour créer une nouvelle base de données nommée uk :
Vous pouvez à nouveau exécuter la même requête qu’auparavant depuis le client de chaque hôte pour confirmer que la base de données a bien été créée sur l’ensemble du cluster, bien que la requête n’ait été exécutée que sur clickhouse-01 :
6

Créer une table sur le cluster

Maintenant que la base de données a été créée, créez une table sur le cluster. Exécutez la requête suivante depuis n’importe quel client hôte :
Notez qu’elle est identique à la requête utilisée dans l’instruction CREATE d’origine du tutoriel du jeu de données d’exemple prix de l’immobilier au Royaume-Uni, à l’exception de la clause ON CLUSTER et de l’utilisation du moteur ReplicatedMergeTree.La clause ON CLUSTER est conçue pour l’exécution distribuée des requêtes DDL (langage de définition de données) telles que CREATE, DROP, ALTER et RENAME, afin de garantir que ces modifications de schéma sont appliquées à tous les nœuds du cluster.Le moteur ReplicatedMergeTree fonctionne comme le moteur de table MergeTree classique, mais il réplique également les données.Vous pouvez exécuter la requête ci-dessous depuis le client clickhouse-01 ou clickhouse-02 pour vérifier que la table a bien été créée sur l’ensemble du cluster :
Query
Response
7

Insérer des données

Le jeu de données étant volumineux et son ingestion complète prenant quelques minutes, nous n’insérerons dans un premier temps qu’un petit sous-ensemble.Insérez un sous-ensemble réduit des données à l’aide de la requête ci-dessous depuis clickhouse-01 :
Notez que les données sont entièrement répliquées sur chaque hôte :
Pour illustrer ce qui se passe lorsque l’un des hôtes tombe en panne, créez une base de données de test simple et une table de test depuis l’un ou l’autre des hôtes :
Comme pour la table uk_price_paid, nous pouvons insérer des données depuis l’un ou l’autre hôte :
Mais que se passe-t-il si l’un des hôtes est indisponible ? Pour simuler ce scénario, arrêtez clickhouse-01 en exécutant :
Vérifiez que l’hôte est hors ligne en exécutant :
Response
clickhouse-01 étant maintenant hors ligne, insérez une nouvelle ligne de données dans la table de test et interrogez la table :
Response
Redémarrez maintenant clickhouse-01 avec la commande suivante (vous pouvez exécuter à nouveau docker-compose ps ensuite pour confirmer) :
Interrogez à nouveau la table de test depuis clickhouse-01 après avoir exécuté docker exec -it clickhouse-01 clickhouse-client :
Query
Response
Si vous souhaitez à ce stade ingérer l’intégralité du jeu de données des prix immobiliers au Royaume-Uni pour l’explorer, vous pouvez exécuter les requêtes suivantes :
Interrogez la table depuis clickhouse-02 ou clickhouse-01 :
Query
Response

Conclusion

L’avantage de cette topologie de cluster est qu’avec deux répliques, vos données sont présentes sur deux hôtes distincts. Si l’un des hôtes tombe en panne, l’autre réplique continue de servir les données sans aucune perte. Cela élimine les points de défaillance uniques au niveau du stockage. Lorsqu’un hôte tombe en panne, la réplique restante est toujours en mesure de :
  • Traiter les requêtes en lecture sans interruption
  • Accepter de nouvelles écritures (selon vos paramètres de cohérence)
  • Maintenir la disponibilité du service pour les applications
Lorsque l’hôte défaillant revient en ligne, il est en mesure de :
  • Synchroniser automatiquement les données manquantes à partir de la réplique saine
  • Reprendre un fonctionnement normal sans intervention manuelle
  • Rétablir rapidement une redondance complète
Dans l’exemple suivant, nous verrons comment configurer un cluster avec deux shards mais une seule réplique.
Dernière modification le 23 juillet 2026