Description

Le module webui-module-service-weather permet au module WebUI ( l'interface de Visualisation ) du Broker d'afficher la vue météo des services
( Pour plus d'information voir : Vue : La météo des services )

Il gère :

  • L'affichage des pages pour la météo des services,

  • L’édition de ces pages,

  • La possibilité d'avoir des liens extérieurs à Shinken qui pointent sur une météo des services,

  • Le mécanisme de cache,


Pour que la météo des services apparaisse dans l'interface, il faut absolument que ce module soit activé.


Si vous avez plusieurs WebUI présentes dans votre architecture, n'oubliez pas d'activer ce module dans chaque configuration de WebUI.

Exemple : 

  • Plusieurs WebUIs sur le même Broker.

  • Des WebUIs dans différents royaumes qui auraient besoin d'avoir une météo des services.

Si vous avez activé une météo sur une WebUI, vous n'avez aucune obligation technique de l'activer sur toutes les autres.
Ce n'est qu'un choix fonctionnel ( nécessaire pour un royaume et pas l'autre ).


Activation du module

Activer le module webui-module-service-weather livré par défaut

Par défaut, l’installation ou la mise à jour de Shinken Entreprise va mettre à disposition une définition du module de type webui_module_service_weather

  • La configuration de ce module se trouve par défaut dans le fichier : /etc/shinken/modules/webui_module_service_weather.cfg
  • Vérifier que le nom "webui-module-service-weather" est présent dans le paramètre modules du fichier /etc/shinken/modules/webui.cfg.
    • Ce module est normalement présent dans la liste des modules livrés par défaut.

    • S'il n'y est pas ( car modifié ), vous pouvez le rajouter pour qu'il soit de nouveau actif.

      Exemple:

      define module {
    [...]

    module_name               webui

    [...]

    modules                   Module 1, Module 2, Module 3, webui-module-service-weather
    
	[...]
}


  • Pour prendre en compte le changement de configuration, redémarrez l'Arbiter:

    service shinken-arbiter restart



Il ne peut y avoir qu'un seul module de type webui_module_service_weather par module webui.


Si vous avez plusieurs modules webui présents dans votre architecture, n'oubliez pas d'activer le module de type webui_module_service_weather dans la configuration de chacune d'elles.


Définir vos propres modules de type webui_module_service_weather

Définir plusieurs modules de type webui_module_service_weather permet d'avoir une configuration différente pour chaque module de type webui. En fonction de votre besoin, il n'est pas nécessaire de créer plusieurs modules de type webui_module_service_weather.

Exemple:

  • J'ai envie que l'affichage de mes météos des services soit uniforme:  Il vaut mieux définir un seul fichier de configuration de module de type webui_module_service_weather puis le déclarer dans tous les modules de type webui.
  • J'ai plusieurs clients qui ont besoin d'options d'affichage différentes:  Il est intéressant de définir plusieurs modules de type webui_module_service_weather afin d'avoir des configurations différentes sur chaque module de type webui.


Pour configurer votre module de type webui_module_service_weather, commencez par choisir un nom à lui donner.

  • Pour l'exemple, nous allons l'appeler "Mon-Module-Webui-Module-Service-Weather".
  • Remplacer dans l'exemple le mot "webui-module-service-weather" par le nom que vous aurez choisi.


Des fichiers de configuration d'exemple sont fournis pour vous aider à configurer votre module.

Pour cela, vous devez : 

  • Copier le fichier de définition du module d'exemple : /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/webui_module_service_weather/webui_module_service_weather.cfg dans le répertoire de définition des modules /etc/shinken/modules/ et modifier son nom pour lui donner le nom que vous avez choisi.

    Exemple : /etc/shinken/modules/webui_module_service_weather__Mon_Module_Webui_Module_Service_Weather.cfg

    cp /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/modules/webui_module_service_weather/webui_module_service_weather.cfg /etc/shinken/modules/webui_module_service_weather__Mon_Module_Webui_Module_Service_Weather.cfg


  • Dans ce nouveau fichier, changer le nom du module :

    ...     
	# ─── Module name [ Must be unique ]                                                      [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_name                                         Mon-Module-Webui-Module-Service-Weather
...


  • Une fois que le fichier a été édité, vérifier que le fichier possède comme droits utilisateurs shinken. Si ce n'est pas le cas, effectuez la commande suivante : 

    chown -R shinken:shinken /etc/shinken/modules/webui_module_service_weather__Mon_Module_Webui_Module_Service_Weather.cfg


  • Ajouter le nom de votre module de type webui_module_service_weather au module webui en modifiant le paramètre modules du fichier /etc/shinken/modules/webui.cfg.

    define module { 
	[...] 
	modules       					Module 1, Module 2, Module 3, Mon-Module-Webui-Module-Service-Weather
	[...] 
}


  • Redémarrez l'Arbiter pour que le Broker puisse prendre en compte ce nouveau module.

    service shinken-arbiter restart


Configuration

La configuration de ce module est découpée en plusieurs parties, le détail de la configuration se trouve dans les pages suivantes :

Cas d'utilisation de plusieurs modules

Les modules webui et les modules webui_module_service_weather doivent être les mêmes pour éviter des problèmes de conflits pour le calcul ou l'affichage.



Si vous possédez plusieurs modules webui_module_service_weather, vous possédez donc obligatoirement plusieurs module WebUI.

Il est important de garder une configuration identique entre les modules WebUI. En effet, certains paramètres, comme "tiles_background", sont utilisés par défaut par le module "webui_module_service_weather". Avoir donc deux valeurs différentes entrainerait deux affichages différents entre les modules webui_module_service_weather.