View Source

Description

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 hives sauvegardées par l'utilisateur et les favoris des utilisateurs.
Il doit donc être listé dans la liste des modules du module WebUI ( cf Module WebUI, propriété "modules" )

Ce module est obligatoire pour pouvoir accéder à l'interface de visualisation.

Si vous avez plusieurs configurations de WebUI présente dans votre architecture, n'oubliez pas d'activer le module dans chaque configuration

Ex plusieurs WebUI sur le même broker
ou une sur différents Brokers qui n'utilise pas la même définition.

Activation du module

Le module MongoDB est un module qui peut être activé seulement sur le module WebUI.

L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du module WebUI.
Pour se faire, ouvrez 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":

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

Pour prendre en compte le changement de configuration, 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.cfg

Exemple de fichier de configuration

#===============================================================================
# Mongodb
#===============================================================================
# Modules that can load this module:
# - WebUI
# This module is mandatory for the WebUI module. The WebUI use this definition to access the
# mongodb data (like hive and user shares)
#===============================================================================


define module {
# Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID             core-module-5dfa7f645adc11e5ad8e080027f08538
    _SE_UUID_HASH        9068b8f577e092efe14d185538fbdb6d
# End of Shinken Enterprise part


    #======== Module identity =========
    # Module name. Must be unique
    module_name     Mongodb

    # Module type (to load module code). Do not edit.
    module_type     mongodb



    #======== 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

    # If you want to securize your mongodb connection you can enable the ssh use_ssh_tunnel that will
    # allow all mongodb to be encrypted & authentificated with SSH
    # Should use a SSH tunnel (Default 0=False)
    # use_ssh_tunnel          0

    # If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive
    # Default: 1
    # use_ssh_retry_failure   1

    # SSH user/keyfile in order to connect to the mongodb server.
    # Default: shinken
    # ssh_user                shinken

    # Default: ~shinken/.ssh/id_rsa
    # ssh_keyfile             ~shinken/.ssh/id_rsa

    # Timeout in order to establish a connection, in seconds
    # Default: 10
    # mongo_timeout  10

    # Which database is used to store sla data
    database        shinken
}

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 votre architecture Shinken.

Chaque instance devra avoir un nom unique.

Nom

Type

Unité

Défaut

Commentaire

module_name

Texte

---

Mongodb

Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir.

Doit être unique.

module_type

Texte

---

mongodb

Ne peux être modifié.

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é

Connexion directe au serveur Mongo

Par défaut, le module se connecte de manière directe à la base MongoDB 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é.

	#======== 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

Nom

Type

Unité

Défaut

Commentaire

uri

Texte

URL

mongodb://localhost/?safe=true

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

 database

Texte

---

shinken

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

Connexion par SSH au serveur Mongo

 	# If you want to securize your mongodb connection you can enable the ssh use_ssh_tunnel that will
    # allow all mongodb to be encrypted & authentificated with SSH
    # Should use a SSH tunnel (Default 0=False)
    # use_ssh_tunnel          0
 
    # If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive
    # Default: 1
    # use_ssh_retry_failure   1
 
    # SSH user/keyfile in order to connect to the mongodb server.
    # Default: shinken
    # ssh_user                shinken
 
    # Default: ~shinken/.ssh/id_rsa
    # ssh_keyfile             ~shinken/.ssh/id_rsa
 
    # Timeout in order to establish a connection, in seconds
    # Default: 10
    # mongo_timeout  10

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ée 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

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 :

Nom

Type

Unité

Défaut

Commentaire

use_ssh_tunnel

Booléen

---

0

1 : Connection par tunnel SSH
0 : Connection direct

use_ssh_retry_failure

Entier

Nombre d'essais

1

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

Texte

utilisateur unix

shinken

L'utilisateur avec lequel le tunnel sera établi

ssh_keyfile

Texte

chemin de fichier

~shinken/.ssh/id_rsa

La clé SSH privée présente sur le serveur Shinken qui sera utilisé pour établir le tunnel.

 mongo_timeout

Entier

secondes

10

Spécifie le timeout en secondes de la connexion à MongoDB

Le tunnel SSH va permettre au module de se connecter comme si ses requêtes étaient local à la base MongoDB ( en 127.0.0.1 )

Connectez-vous avec l'utilisateur lançant le démon sur le serveur Shinken
Générez la paire de clés SSH si nécessaire
Copiez la clé publique sur le serveur MongoDB

root@serveur_shinken # su - shinken
shinken@serveur_shinken $ ssh-keygen
shinken@serveur_shinken $ ssh-copy-id user_distant@serveur_mongo 
[...]
shinken@serveur_shinken $ ssh user_distant@serveur_mongo
user_distant@serveur_mongo $

Cette manipulation est aussi nécessaire dans le cas ou la base MongoDB est sur le même serveur que le module, même si le tunnel est ouvert localement.