De nombreux composants de Shinken Entreprise peuvent être installés et configurés de manière à former une architecture hautement disponible. Dans la page Haute disponibilité des démons de Shinken Entreprise sont décrites les procédures permettant de mettre en place des démons Shinken de remplacement pour améliorer la disponibilité.
Cependant, un certain de nombre de ces démons et leurs modules associés s'appuient sur une base Mongo pour fonctionner. Pour améliorer la résistance aux pannes de la plateforme Shinken dans son ensemble, on peut également s'assurer que la base Mongo soit plus robuste.
L'objectif de cette page de documentation est d'expliquer pas à pas la mise en place d'un cluster Mongo.
Dans cette documentation est décrite de manière détaillée comment mettre en place des mécanismes de haute disponibilité pour la base Mongo.
Avant d'aborder les étapes de configuration et les détails techniques, cette section présente quelques points importants à savoir avant de continuer.
Voici un lexique décrivant certains termes utilisés dans la suite de cette documentation:
Dans la procédure d'installation, des commandes doivent être lancées. On distingue 2 types de commandes :
Les commandes shell Linux qui, sauf mention contraire, doivent être lancées en tant que root. Elles seront présentées comme suit:
echo "commande shell" |
Les commandes Mongo doivent être lancées dans un shell Mongo (les instructions pour ouvrir le bon shell Mongo seront présentées avant ces commandes). Elles seront présentées comme suit:
commande mongo |
Ce qui est mis en place dans cette documentation est la haute disponibilité (réplication) de la base Mongo, et non une répartition de charge entre plusieurs nœuds Mongo (sharding).
Un load balancing entre plusieurs nœuds Mongo permet d'améliorer la disponibilité de la base lorsqu'elle est soumise à des contraintes importantes (de nombreux utilisateurs en parallèle) en répartissant la charge mise sur chaque nœud Mongo.
On se concentre ici plutôt sur la haute disponibilité, qui essaye de garantir l'intégrité des données et leur accès. Les données sont donc répliquées entre plusieurs nœuds Mongo, au lieu d'être réparties sur plusieurs nœuds.
Cette nuance a la conséquence suivante sur l'architecture mise en place:
| Il est donc conseillé d'avoir des machines identiques pour chaque nœud du cluster Mongo |
Dans une installation Mongo classique, une machine fait fonctionner un démon qui se charge du stockage des données (mongod). Ce démon représente dans ce cas là la base Mongo en elle même.
Pour obtenir une architecture distribuée permettant de mettre en place de la haute disponibilité, il faut répartir l'installation de Mongo sur plusieurs machines, qu'on appelle "nœuds" dans la suite de cette documentation.
Chaque nœud Mongo fait fonctionner plusieurs démons Mongo qui permettent de gérer la base de données. Dans l'exemple décrit dans ce document, on a 3 nœuds:
Dans une architecture distribuée hautement disponible, il faut des démons supplémentaires pour que Mongo puisse gérer la réplication. Sur chaque nœud, les démons utilisés sont les suivants:
Le schéma ci-contre présente l'architecture d'un noeud Mongo
Dans ce schéma, on a donc les 3 démons présents:

L'interaction des noeuds du cluster est décrite sur le schéma ci-contre.
Les démons présentés ci-dessus s'exécutent sur chacun des noeuds du cluster. Shinken effectue ses requêtes de manière locale sur le démon mongos, qui ensuite s'occupe de l'aspect cluster de Mongo et du bon traitement et acheminement des données.
Du point de vue de Shinken, la transformation de Mongo en un cluster Mongo est transparente.
Les requêtes sont toujours faites sur le même port et Shinken n'a pas conscience de la haute disponibilité de Mongo. Cela permet d'avoir 2 systèmes plus indépendants et leur association plus facilement configurable.
Il est possible d'utiliser une VIP de type HAProxy pour ce type de configuration

Pour la mise en place du cluster Mongo, il faut que les conditions suivantes soient réunies:
Comme indiqué précédemment, il faut que chaque serveur puisse supporter la charge de requêtes Mongo à lui seul, et cela en permanence |
Pour tirer au maximum avantage de l'architecture haute disponibilité, il est plus judicieux, dans le cas ou les serveurs du cluster sont des VM, de ne pas les mettre sur le même hyperviseur. En effet, un problème sur l'hyperviseur pourrait alors affecter toutes les VM en même temps et rendre l'architecture haute disponibilité inutile. |
Avant de commencer, voici un résumé des différentes étapes nécessaires pour la configuration du cluster Mongo:
La première étape dans l'installation d'un cluster Mongo est avant tout l'installation de Mongo. Cette documentation s'appuie sur la version de Mongo installée par Shinken (v3.0.15).
Le bon fonctionnement de Shinken n'est garanti qu'avec la version de Mongo installée automatiquement lors de l'installation de Shinken. Toute autre version n'est pas supportée par Shinken et peut entrainer de nombreux bugs.
L'installation de Shinken est décrite dans la page de documentation dédiée: Guide d'installation et de mise à jour
Les versions précédentes de Shinken fournissaient Mongo 2.6.9 ; la mise à jour d'un cluster Mongo est décrite dans la page de documentation dédiée : Montée de version en Mongodb 3.0 (réalisée automatiquement sous conditions)
Pour sécuriser la communication entre les serveurs Mongo du cluster, on met en place des règles de firewall afin que seuls les serveurs mongo puissent échanger sur leurs port de communications
Sur tous les serveurs, nous n'allons autoriser les communications que vers les ports 27018 et 27019 (les seuls à être exposés sur le réseau dans une installation avec mongos) qu'entre les 3 serveurs composants notre cluster.
Nous activons le firewall et créons une nouvelle zone qui gère nos règles Mongo
# on installe iptables en tant que service et on l'active yum -y install iptables-services systemctl enable iptables # On crée une table iptables mongo pour y mettre nos règles iptables -N MONGO # création d'une nouvelle chaîne ## # Attention à bien changer les ADRESSE 1 à 3 ## iptables -A MONGO --src ADRESSE_1 -j ACCEPT iptables -A MONGO --src ADRESSE_2 -j ACCEPT iptables -A MONGO --src ADRESSE_3 -j ACCEPT iptables -A MONGO --src 127.0.0.1 -j ACCEPT iptables -A MONGO -j DROP # drop everyone else iptables -I INPUT -m tcp -p tcp --dport 27018 -j MONGO iptables -I INPUT -m tcp -p tcp --dport 27019 -j MONGO # On sauvegarde nos règles pour le redémarrage service iptables save |
Attention à bien changer ADRESSE_1, ADRESS_2, ADRESSE_3 avec les vraies adresses des serveurs |
Le premier démon mis en place est le démon mongod, qui est responsable du stockage des données.
Avant de commencer, on arrête le démon mongod sur tous les serveurs du cluster.
Sur tous les serveurs:
/etc/init.d/mongod stop |
On change aussi la configuration du démon mongod pour qu'il écoute sur le bon port, écoute sur toutes les interfaces réseau et déclare son appartenance au replicaset.
Sur tous les serveurs:
vi /etc/mongod.conf |
# network interfaces
net:
port: 27018
#bindIp: 127.0.0.1 # Listen to local interface only, comment to listen on all interfaces.
replication:
replSetName: rs-shinken |
Modifier le port, mettre en commentaire la ligne bindIp et ajouter le bloc replication
Mongo ne peut démarrer que si la base est vide sur les serveurs secondaires. On vide donc la base sur les serveurs secondaires seulement.
LA COMMANDE SUIVANTE VA SUPPRIMER TOUTE LA BASE MONGO SUR LE SERVEUR. Il faut bien s'assurer de ne pas avoir de données importantes sur ces serveurs avant de continuer. |
Sur les serveurs secondaires:
/etc/init.d/mongod stop rm -rf /var/lib/mongo/* |
La configuration du démon mongod est terminée. Ils peuvent être redémarrés.
Sur tous les serveurs:
/etc/init.d/mongod start |
Les démons mongod ne sont pour l'instant pas actifs mais sont configurés et prêts à recevoir des connexions.
On peut vérifier que ces démons ont bien été démarrés avec un netstat.
Sur tous les serveurs:
netstat -laputen | grep 27018 |
Si le démon est démarré, cette commande affiche une ligne de résultat qui indique que le démon est démarré et écoute bien sur le port 27018 comme spécifié dans la configuration.
Il faut ensuite déclarer dans Mongo que ces démons font partie du même replicaset et qu'il ne s'agit pas de démons mongod isolés.
Pour cela, on se connecte au démon mongod sur le serveur primaire pour déclarer le replicaset.
Sur le serveur primaire:
mongo --port 27018 |
Cette commande lance le Shell Mongo dans lequel vous pouvez lancer la commande suivante :
rs.initiate({
_id : "rs-shinken",
members: [
{ _id: 0, host: "node1:27018", priority: 2 },
{ _id: 1, host: "node2:27018" },
{ _id: 2, host: "node3:27018" }
]
}); |
Dans cette commande, node1, node2 et node3 font référence aux noms DNS respectivement du nœud 1, du nœud 2 et du nœud 3.
Dans Mongo, lorsqu'un replicaset est défini, un algorithme d'élection est exécuté pour déterminer quel nœud du cluster sera le nœud primaire. Pour s'assurer que le nœud 1 soit bien le nœud primaire, on lui assigne une priorité supérieure pour qu'il sorte vainqueur.
On peut vérifier ensuite que le replicaset a bien été configuré via le shell Mongo ouvert précédemment:
rs.status() |
Voilà ce que la commande au dessus devrait afficher :
rs.status()
{
"set" : "rs-shinken",
"date" : ISODate("2020-02-11T16:59:55.734Z"),
"myState" : 1,
"members" : [
{
"_id" : 0,
"name" : "HOSTMASTER:27018",
"health" : 1,
"state" : 1,
"stateStr" : "PRIMARY",
"uptime" : 214,
"optime" : Timestamp(1581440386, 1),
"optimeDate" : ISODate("2020-02-11T16:59:46Z"),
"electionTime" : Timestamp(1581440388, 1),
"electionDate" : ISODate("2020-02-11T16:59:48Z"),
"configVersion" : 1,
"self" : true
},
{
"_id" : 1,
"name" : "HOSTSLAVE1:27018",
"health" : 1,
"state" : 2,
"stateStr" : "SECONDARY",
"uptime" : 8,
"optime" : Timestamp(1581440386, 1),
"optimeDate" : ISODate("2020-02-11T16:59:46Z"),
"lastHeartbeat" : ISODate("2020-02-11T16:59:54.832Z"),
"lastHeartbeatRecv" : ISODate("2020-02-11T16:59:55.013Z"),
"pingMs" : 1,
"configVersion" : 1
},
{
"_id" : 2,
"name" : "HOSTSLAVE2:27018",
"health" : 1,
"state" : 2,
"stateStr" : "SECONDARY",
"uptime" : 8,
"optime" : Timestamp(1581440386, 1),
"optimeDate" : ISODate("2020-02-11T16:59:46Z"),
"lastHeartbeat" : ISODate("2020-02-11T16:59:54.829Z"),
"lastHeartbeatRecv" : ISODate("2020-02-11T16:59:55.034Z"),
"pingMs" : 1,
"configVersion" : 1
}
],
"ok" : 1
}
|
Le prompt du shell Mongo devrait également avoir changé pour afficher les mentions "PRIMARY" ou "SECONDARY".
Par défaut, les lectures ne sont pas autorisées sur les Mongo secondaires. On peut autoriser ces lectures via un shell Mongo.
Sur les serveurs secondaires:
mongo --port 27018 |
rs.slaveOk() |
A cette étape de la procédure de configuration, les données sont répliquées par les démons mongod. Par contre, on ne possède pas encore de moyen facile pour accéder de manière automatique à Mongo via les applications, d'ou le besoin d'un démon permettant de faire un routage des requêtes vers Mongo.
Avant de mettre en place le routage des requêtes pour les démons mongod de notre cluster, il faut mettre en place les démons serveurs de configuration qui vont permettre aux autres démons Mongo d'accéder facilement à la configuration du cluster Mongo.
Dans cette étape, on se contente de mettre en place le démon, mais pas son contenu. La configuration du cluster sera déclarée lors de la mise en place du démon de routage des requêtes Mongo.
On commence par créer le dossier qui contient la configuration du démon et lui attribuer les bons droits
Sur tous les serveurs:
mkdir /var/lib/mongo/configdb chown mongod:mongod /var/lib/mongo/configdb |
On copie ensuite le fichier de configuration par défaut du démon depuis l'archive d'installation de Shinken. le chemin vers l'archive d'installation et désigné par "tarball_shinken".
Sur tous les serveurs:
cp tarball_shinken/tools/mongo-cluster/mongo-configsrv.conf /etc/mongo-configsrv.conf vi /etc/mongo-configsrv.conf |
# Comme dans la configuration du démon mongod, on commente la ligne bind_ip pour que le démon écoute sur toutes les interfaces net: port: 27019 #bindIp: 127.0.0.1 # Listen to local interface only, comment to listen on all interfaces. |
Le fichier de configuration /etc/mongo-configsrv.conf comporte également une option replSetName. Les démons mongo-configsrv gèrent la configuration du cluster d'un point de vue global, et doivent donc être démarrés en tant que démons indépendants et non en tant que partie du replicaset. Il faut s'assurer que l'option replSetName des fichiers de configuration des démons mongo-configsrv soit bien commentée et non utilisée. |
On copie ensuite le script d'init du démon et on ajoute le démon dans la liste des services gérés par le système, ainsi que dans la liste des services à lancer au démarrage de la machine.
Sur tous les serveurs:
cp tarball_shinken/tools/mongo-cluster/mongo-configsrv /etc/init.d/mongo-configsrv chmod a+x /etc/init.d/mongo-configsrv chkconfig --add mongo-configsrv chkconfig mongo-configsrv on |
On démarre ensuite le démon sur tous les serveurs.
Sur tous les serveurs:
/etc/init.d/mongo-configsrv start |
Sur toutes les machines, 2 démons (mongod et mongo-configsrv) ont été mis en place. Les données peuvent correctement être stockées dans le cluster, et la configuration du cluster va pouvoir être gérée par les démons mongo-configsrv. La dernière étape est de configurer le démon mongos qui sert de point d'accès pour Shinken, et permet de rediriger les requêtes vers le bon nœud Mongo.
Comme pour le démon mongo-configsrv, on commence par copier le fichier de configuration par défaut
Sur tous les serveurs:
cp tarball_shinken/tools/mongo-cluster/mongos.conf /etc/mongos.conf vi /etc/mongos.conf |
# Dans le paramètre configdb, on renseigne la liste des serveurs de configuration qui constituent le cluster sharding: configDB: node1:27019,node2:27019,node3:27019 |
On copie ensuite le script d'init du démon et on ajoute le démon dans la liste des services gérés par le système, ainsi que dans la liste des services à lancer au démarrage de la machine.
Sur tous les serveurs:
cp tarball_shinken/tools/mongo-cluster/mongos /etc/init.d/mongos chmod a+x /etc/init.d/mongos chkconfig --add mongos chkconfig mongos on |
On démarre ensuite le mongos sur chaque machine.
Sur tous les serveurs:
/etc/init.d/mongos start |
Les démons mongos sont maintenant en place sur chaque machine du cluster Mongo. Il reste à déclarer à Mongo les serveurs de données qui constituent le cluster (ce sont ces informations qui seront stockées par le démon mongo-configsrv).
Sur le serveur primaire:
mongo |
sh.addShard('rs-shinken/node1:27018,node2:27018,node3:27018') |
La configuration du cluster Mongo est maintenant terminée !
La section suivante permet de vérifier que la communication entre les démons du cluster Mongo s'effectue correctement et du visualiser l'état du cluster
Une fois la procédure complétée, on peut ensuite vérifier à l'aide d'un shell Mongo l'état du replicaset.
Via le démon mongos, on peut vérifier l'ensemble des connexions du cluster.
Sur n'importe quel serveur:
mongo |
sh.status() |
On obtient alors un résumé des machines du cluster et l'ensemble des bases de données gérées par ce cluster:
--- Sharding Status ---
sharding version: {
"_id" : 1,
"version" : 4,
"minCompatibleVersion" : 4,
"currentVersion" : 5,
"clusterId" : ObjectId("5ae1b6d7e4edc5bd313ba7b7") }
shards: {
"_id" : "rs-shinken",
"host" : "rs-shinken/node1:27018,node2:27018,node3:27018" }
databases: {
"_id" : "admin",
"partitioned" : false,
"primary" : "config" }
{
"_id" : "shinken",
"partitioned" : false,
"primary" : "rs-shinken" }
{
"_id" : "synchronizer",
"partitioned" : false,
"primary" : "rs-shinken" }
{
"_id" : "test_db",
"partitioned" : false,
"primary" : "rs-shinken"
} |
Via le démon mongod, on peut vérifier l'état du replicaset. On peut alors voir l'état de chaque nœud, en particulier le nœud qui est actuellement le nœud primaire
Sur n'importe quel serveur:
mongo --port 27018 |
rs.status() |
On obtient alors un détail de l'état des différentes machines du cluster. On peut aussi facilement identifier quel nœud est primaire.
rs-shinken:SECONDARY> rs.status();
{
"set" : "rs-shinken",
"date" : ISODate("2018-05-04T07:29:15Z"),
"myState" : 2,
"syncingTo" : "node2:27018",
"members" : [
{
"_id" : 0,
"name" : "node1:27018",
"health" : 0,
"state" : 8,
"stateStr" : "(not reachable/healthy)",
"uptime" : 0,
"optime" : Timestamp(0, 0),
"optimeDate" : ISODate("1970-01-01T00:00:00Z"),
"lastHeartbeat" : ISODate("2018-05-04T07:29:13Z"),
"lastHeartbeatRecv" : ISODate("1970-01-01T00:00:00Z"),
"pingMs" : 0
},
{
"_id" : 1,
"name" : "node2:27018",
"health" : 1,
"state" : 1,
"stateStr" : "PRIMARY",
"uptime" : 81988,
"optime" : Timestamp(1525250222, 106),
"optimeDate" : ISODate("2018-05-02T08:37:02Z"),
"lastHeartbeat" : ISODate("2018-05-04T07:29:14Z"),
"lastHeartbeatRecv" : ISODate("2018-05-04T07:29:14Z"),
"pingMs" : 1,
"electionTime" : Timestamp(1525336975, 1),
"electionDate" : ISODate("2018-05-03T08:42:55Z")
},
{
"_id" : 2,
"name" : "node3:27018",
"health" : 1,
"state" : 2,
"stateStr" : "SECONDARY",
"uptime" : 81988,
"optime" : Timestamp(1525250222, 106),
"optimeDate" : ISODate("2018-05-02T08:37:02Z"),
"self" : true
}
],
"ok" : 1
} |
L'utilisation d'un cluster Mongo permet d'améliorer la stabilité de Shinken Entreprise. Lorsque le nœud principal du cluster Mongo entre en erreur, Mongo procède à l'élection d'un nouveau nœud principal dans le cluster. A ce moment, on voit alors une coupure dans Shinken pendant quelques secondes le temps qu'un nouveau nœud primaire soit élu.
Cette coupure à les incidences suivantes:
Un cluster Mongo peut être supervisé avec Shinken. Shinken Entreprise met à votre disposition un Pack MongoDB
Le modèle d'hôte "mongodb" prend également en compte les aspects de réplication de la base avec les checks "Mongodb-replicaset" et "Mongodb-replication-lag".
En pratique, pour superviser un cluster Mongo avec Shinken Entreprise, on associe un hôte Shinken à un nœud du cluster. Chaque hôte aura le modèle "mongodb" accroché, ce qui permet de superviser ces 3 nœuds de manière indépendante. On effectue également la supervision sur le port 27018 au lieu du port 27017 utilisé par défaut.
Voici un aperçu du résultat des checks concernant la réplication de Mongo, pour un nœud primaire et pour un nœud secondaire:
|
|
Le modèle d'hôte mongodb utilise par défaut une connexion directe aux démons Mongo. Suite à l'étape 1 qui consiste à mettre en place une clé d'authentification pour la communication entre les démons, les opérations possibles et vérifications effectuées par les checks échouent.
Le modèle mongodb permet d'utiliser un tunnel SSH pour la connexion aux serveurs et l'exécution des checks. L'utilisation du tunnel SSH se fait en modifiant la donnée MONGO_CONNECTION_METHOD. Précisez la valeur "ssh" au lieu de "direct".
L'utilisateur et la clé SSH utilisés pour créer ce tunnel peuvent se configurer en modifiant les données MONGO_SSH_USER et MONGO_SSH_KEY sur l'hôte.
Le modèle mongodb se connecte aux démons mongod pour effectuer les vérifications sur le cluster Mongo. Dans une installation classique, ce démon utilise le port 27017.
Dans le cas du cluster, on a dans l'étape 3 modifié le port que ce démon utilise pour utiliser le port 27018. Il faut donc également modifier le port utilisé dans Shinken en modifiant la donnée MONGO_PORT en 27018 sur l'hôte.
La configuration et le fonctionnement du pack MongoDB sont décrits en détail sur cette page.
L'installation en cluster de Mongodb apporte des avantages au niveau de l'accessibilité et de la redondance des données. Cependant, ces avantages nécessitent un système plus complexe au niveau de Mongodb et la manipulation de Mongodb présente quelques différences par rapport à une architecture classique.
Les différentes opérations de maintenance et résolutions de maintenance qui peuvent apparaître sur Mongosb sont présentées dans la page de documentation suivante: Maintenance et résolution des problèmes dans un cluster Mongodb