Page History

Concept

Le module MongoDB est un module qui permet au module WebUI ( l'interface de visualisation ) du Broker d'accéder aux données stockées dans la base de données MongoDB.

• Il permet d'afficher les portails sauvegardées sauvegardés ( voir la page Vue - Les Portails ) par l'utilisateur et les favoris des utilisateurs ( voir la page Volet Favoris ( Gestion des Vues ) ).
• Il doit donc être listé dans la liste des modules du module WebUI ( cf  voir la page  Module WebUI, propriété " modules"  )
  
  

Activation du module

• L'activation du module s'effectue en ajoutant le nom de ce du module dans le fichier de la configuration du module WebUIparent.
  • Pour
  se faire, ouvrez
  • cela, il faut ouvrir le fichier de configuration du module
  WebUI à l'emplacement /etc/shinken/modules/nom_du_module_webui.cfg, et ajouter le nom de votre module.

Exemple: par défaut, nous livrons un module dont le nom est "Mongodb":

• • parent ( de type "webui"), et ajouter dans le paramètre modules, le nom du module de type "mongodb".
    
    
• Il est possible de faire plusieurs modules de type "mongodb".
  • Cela permet, par exemple, d'avoir des configurations différentes en fonction des royaumes.
    
    
• S'il y a plusieurs modules de type "webui" présents dans l'architecture, il ne faut pas oublier d'activer le module de type "mongodb" dans la configuration de chacun d'eux.
  
  
• Contraintes :
  • Activable uniquement sur un module de type "webui" ( voir la page Configuration du module WebUI ).
  • Il ne peut y avoir qu'un seul module de type "mongodb" sur un module de type "webui".

Pour prendre en compte le changement de configuration, il faut redémarrer l'Arbiter :

service shinken-arbiter restart

Configuration

La configuration du module se trouve par défaut dans le fichier /etc/shinken/modules/mongodb.cfg

• Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/mongodb-example.cfg

Exemple de fichier de configuration

Exemple d'activation du module nommé "Mongodb" sur le module nommé "WebUI" ( configuration livrée par défaut par Shinken )

L'exemple suivant

• active le module "Mongodb"
• sur le module "WebUI",dont la configuration est dans le fichier /etc/shinken/modules/webui.cfg

Modification dans le fichier du module /etc/shinken/modules/webui.cfg :

define module {
    [...]
    modules                   Module 1, Module 2, Module 3, Mongodb
    [...]
}

Puis redémarrage de l'Arbiter

Créer un nouveau module de type MongoDB

Pour pouvoir configurer un module de type "MongoDB", il faut faire un nouveau fichier de configuration grâce au fichier d'exemple fourni par défaut.

• Pour commencer, il faut choisir le nom du nouveau module.
  • Pour l'exemple, on l'appelle "Mon-Module-MongoDB".
  • Remplacer dans l'exemple le mot "Mon-Module-MongoDB" par le nom qui a été choisi.
• Puis il faut créer le fichier de configuration :

  • Copier le fichier de définition du module d'exemple /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/mongodb/mongodb-example.cfg dans le répertoire de définition des modules /etc/shinken/modules.
    ( Exemple :  /etc/shinken/modules/MongoDB__Mon-Module-MongoDB.cfg )

    Code Block
    language text theme Emacs
    cp /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/mongodb/mongodb-example.cfg /etc/shinken/modules/MongoDB__Mon-Module-MongoDB.cfg

• Ensuite, il faut modifier le fichier nouvellement créé pour configurer le nouveau module

  • Il faut vérifier que le fichier appartienne à l'utilisateur shinken et qu'il possède le droit d'édition. Si ce n'est pas le cas, il faut effectuer les commandes suivantes :
    

    Code Block
    language js theme Confluence
    chown -R shinken:shinken /etc/shinken/modules/MongoDB__Mon-Module-MongoDB.cfg chmod u+w /etc/shinken/modules/MongoDB__Mon-Module-MongoDB.cfg

  • On change le nom du module en "Mon-Module-MongoDB" dans le fichier /etc/shinken/modules/MongoDB__Mon-Module-MongoDB.cfg
    

    Code Block
    language js theme Confluence
    ... # ─── Module name [ Must be unique ]

• • [ MANDATORY ] ─── #

• • ───

• • ─── module_name

• • Mon-Module-MongoDB ...

• Ensuite, il faut ajouter le nouveau module dans le module de type "WebUI" correspondant.

  • Dans notre exemple, on ajoute le module "Mon-Module-MongoDB" au module "WebUI" définie dans le fichier /etc/shinken/modules/webui.cfg
    

    Code Block
    language js theme Confluence
    define module { [...] modules

Détails des sections composant le fichier de configuration

Identification du module

• • Module 1, Module 2, Module 3, Mon-Module-MongoDB       [...] }

• Pour finir il faut redémarrer l'Arbiter pour que le Broker puisse prendre en compte ce nouveau module.

  Excerpt Include
  Fichier de configuration ( shinken.cfg ) Fichier de configuration ( shinken.cfg ) page DefaultLink[destination=Optional[PageResourceIdentifier[spaceKey=<null>,title=Fichier de configuration ( shinken.cfg )]],body=Optional.empty,tooltip=Optional.empty,anchor=Optional.empty,target=Optional.empty] nopanel true

Configuration

La configuration du module se trouve par défaut dans le fichier  /etc/shinken/modules/mongodb.cfg.

• un exemple dans /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/mongodb-example.cfg.

Exemple de fichier de configuration

Accès à la base MongoDB

Cette configuration s'effectue dans le fichier de configuration du module. 

Pour se connecter à la base MongoDB utilisée pour le stockage des données, 2 méthodes sont disponibles:

• Connexion directe : Par défaut, mais non sécurisée.
• Tunnel SSH : Shinken se connecte à la base MongoDB au travers d'un module SSH pour plus de sécurité

Configuration des paramètres communs aux deux méthodes

	#======== Database connection =========
    # mongodb uri definition for connecting to the mongodb database. You can find the mongodb uri
    # syntax at https://docs.mongodb.com/manual/reference/connection-string/
    uri             mongodb://localhost/?safe=true
 
	[...]
 
    # Which database is used to store sla data
    database        shinken

 uri 

Vous pouvez trouver la syntaxe de l'uri de MongoDB à l'adresse https://docs.mongodb.com/manual/reference/connection-string/

 database 

Nom de la base de données où sont stockés les données SLA

Connexion directe au serveur MongoDB

Par défaut, le module se connecte de manière directe à la base MongoDB  définie avec les paramètres communs listés ci-dessus pour y lire et écrire les données.

Dans la configuration du module, on sait que la connexion se fait de manière directe lorsque le paramètre "use_ssh_tunnel" est à 0.

Cette méthode de connexion a pour avantage d'être facile à configurer au niveau de Shinken. Par contre, elle oblige à permettre l'accès à la base MongoDB au monde extérieur, et donc s'exposer à des problèmes de sécurité.

La sécurisation de la base MongoDB est bien sur toujours possible (voir Sécurisation des connexions aux bases MongoDB) mais bien plus complexe à mettre en place. La méthode de connexion par SSH est donc préférable pour des raisons pratiques et de sécurité.

Connexion par SSH au serveur MongoDB

Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type "mongodb" dans l'architecture Shinken.

• Chaque instance devra avoir un nom unique.

module_name 

module_type 

Accès à la base MongoDB

Cette configuration s'effectue dans le fichier de configuration du module. 

Pour se connecter à la base MongoDB utilisée pour le stockage des données, 2 méthodes sont disponibles :

• Connexion directe  : Par défaut, mais non sécurisée.
• Tunnel SSH  : Shinken se connecte à la base MongoDB au travers d'un module SSH pour plus de sécurité

Configuration de l'URI de connexion et de l'authentification par mot de passe

Connexion directe au serveur MongoDB

Par défaut, le module se connecte de manière directe à la base MongoDB définie avec les paramètres communs listés ci-dessus pour y lire et écrire les données.

Dans la configuration du module, on sait que la connexion se fait de manière directe lorsque le paramètre "use_ssh_tunnel" est à 0.

Cette méthode de connexion a pour avantage d'être facile à configurer au niveau de Shinken. Par contre, elle oblige à permettre l'accès à la base MongoDB au monde extérieur, et donc s'exposer à des problèmes de sécurité.

La sécurisation de la base MongoDB est bien sûr toujours possible ( voir la page Sécurisation des connexions aux bases MongoDB ) mais bien plus complexe à mettre en place. La méthode de connexion par SSH est ainsi préférable pour des raisons pratiques et de sécurité.

Connexion par SSH au serveur MongoDB

Le module peut également se connecter par tunnel SSH à la base MongoDB, pour des raisons de sécurité.

En effet, le paramétrage de MongoDB permet de définir sur quelle interface réseau ce dernier écoute les requêtes.
En n'autorisant seulement interface réseau avec l'adresse 127.0.0.1, cela évite d'ouvrir la base de données au monde extérieur.

Dans la configuration de la base MongoDB (/etc/mongod.conf), il faut vérifier que le paramètre " bind_ip " est positionné pour n'écouter que sur l'interface locale :

• bind_ip=127.0.0.1

Dans cette configuration, la base MongoDB écoute que sur l'interface réseau local, pour que le module se connecte, il faut passer par un tunnel SSH. Pour ce faire, activer les options suivantes :

use_ssh_tunnel

use_ssh_retry_failure

ssh_user

ssh_keyfile

 mongo_timeout 

Gestion de la reconnexion automatique

La reconnexion automatique permet au module de se reconnecter à Mongo dans le cas où :

• Il y a une perte de connexion suite à un problème réseau ou à un redémarrage de mongo.
• Dans le cas de l'utilisation d'un cluster MongoDB, lorsque le membre Primaire devient inaccessible, une nouvelle élection est déclenchée, ce qui provoque une coupure temporaire de l'accès à la base.

Dans le but de ne pas interrompre le service lorsque l'un de ces cas survient, le module "mongodb" va se reconnecter automatiquement.
Pour cela, il va faire un nombre d'essais égal au paramètre "mongodb__database__retry_connection_X_times_before_considering_an_error " avec une pause de X secondes entre chaque essai ( correspondant au paramètre "mongodb__database__wait_X_seconds_before_reconnect"

).

Le module peut également se connecter par tunnel SSH à la base MongoDB, pour des raisons de sécurité.

En effet, le paramétrage de MongoDB permet de définir sur quelle interface réseau ce dernier écoute les requêtes.
En n'autorisant seulement interface réseau avec l'adresse 127.0.0.1, cela évite d'ouvrir la base de données au monde extérieur.

Dans la configuration de la base MongoDB (/etc/mongod.conf), assurez-vous que le paramètre "bind_ip" est positionné pour n'écouter que sur l'interface locale :

• bind_ip=127.0.0.1

use_ssh_tunnel

• 1 : Connection par tunnel SSH
• 0 : Connection direct

use_ssh_retry_failure

Spécifie le nombre supplémentaire de tentatives lors de l'établissement du tunnel SSH si ce dernier n'arrive pas à être établi

ssh_user

ssh_keyfile

 mongo_timeout 

  mongodb__database__retry_connection_X_times_before_considering_an_error 

 mongodb__database__wait_X_seconds_before_reconnect 

Les valeurs par défauts du fichier laissent 25 secondes, ce qui est amplement suffisant avec la configuration par défaut de MongoDB.