Introduction

Le module architecture-export permet de recevoir et envoyer la description de l'architecture d'installations Shinken, et d'en générer des cartes NagVis et hôtes Shinken associés pour la supervision.


Une description détaillée de ce module, son utilité et son utilisation sont présentes dans les pages de documentations associées: Visualiser l'architecture de son installation Shinken


Ci-dessous sont présentées de manière synthétique les différentes options de configuration de ce module, leur rôle ainsi que leurs valeurs par défaut.

Configuration du module

Le module architecture-export est configurable via le fichier de configuration suivant: /etc/shinken/modules/architecture-export.cfg


Les paramètres modifiables dans le fichier sont les suivants:

#===============================================================================
# Architecture-Export
#===============================================================================
# Module that export daemon map from arbiter:
#===============================================================================
 
define module {
 
    #======== Module identity =========
    # Module name. Must be unique
    module_name             architecture-export
 
    # Module type (to load module code). Do not edit.
    module_type             architecture_export
 
 
 
    #======== File path =========
    # path: Path of NagVis installation to save the maps configuration files in. Default value is defined by Shinken installation.
    path                    /etc/shinken/external/nagvis
 
    #======== Architecture description communication =========
    # This module opens a listening socket on which other shinken installations will send their architecture description.
    # When an architecture description is received by the module, it creates corresponding hosts and NagVis maps.
 
    # host: interface used for the listening socket (0.0.0.0 = all interfaces)
    host                    0.0.0.0
 
    # Port to use for the listening socket
    port                    7780
 
    # 0 = Use HTTP, 1 = Use HTTPS
    use_ssl                 0
    ssl_cert                /etc/shinken/certs/server.cert
    ssl_key                 /etc/shinken/certs/server.key
 
    # Name with which this Shinken installation will be identified in the NagVis maps
    # The following characters are forbidden in the architecture name: ~!$%^&*"'|<>?,()=/+
    architecture_name       Shinken
 
    # Base of URL used to display links in the Visualization UI
    # Defaults to Arbiter URL if empty
    # map_base_url  http://example.com/
 
    # Architecture description recipients
    #   When the architecture of this Shinken installation changes (realms and daemons configuration),
    #   and the arbiter is restarted the architecture description will be sent to the following hosts.
    send_my_architecture_to_recipients   http://127.0.0.1:7780
    # Connection to the shinken-listener
    #   if the connexion parameter to the shinken-listener has been changed, set the new value here.
    #listener_use_ssl                     0
    #listener_login                       login
    #listener_password                    pass
 
 
    # SSH Settings for graphite hosts discovery
    #ssh_port                              22
    #ssh_user                              shinken
    #ssh_key_file                          /var/lib/shinken/.ssh/id_rsa.pub
    #ssh_timeout                           5
 
    # Sort order for realms in the NagVis maps
    # - sort_by_name
    # - sort_by_size (default)
    #map_realm_layout sort_by_size

    # ===================================    Broker connection parameters    ============================================== #
    #                                                                                                                       #
    # --- These parameters are used to allow nagvis to communicate with the Broker and modules you want                   ---

    # --- Name of the Broker holding the modules you want nagvis to communicate with                                      ---
    # >>> DEFAULT : broker-master                                                                                         ---
    # architecture_export__broker_connection__broker_name                                        broker-master

    # --- Name of the Livestatus module you want nagvis to communicate with to retrieve objects information               ---
    # >>> DEFAULT : Livestatus                                                                                            ---
    # architecture_export__broker_connection__broker_livestatus                                  Livestatus

    # --- Name of the WebUI module you want nagvis to redirect you when clicking on object on the map                     ---
    # --- This parameter cannot be used with the parameter architecture_export__broker_connection__broker_webui_redirect  ---
    # >>> DEFAULT : WebUI                                                                                                 ---
    # architecture_export__broker_connection__broker_webui                                       WebUI

    # --- Custom WebUI redirection. It allows you to specify a custom address to your WebUI                               ---
    # --- This parameter cannot be used with the parameter architecture_export__broker_connection__broker_webui           ---
    # >>> DEFAULT : None                                                                                                  ---
    # architecture_export__broker_connection__broker_webui_redirect                              127.0.0.1:7767
}


Le rôle de chaque paramètre et les valeurs possibles sont décrites dans le tableau suivant:

Nom du paramètre

Description

Valeur par défaut

host 
Adresse de l'interface utilisée pour l'écoute sur le port 7780. Pour écouter sur toutes les interfaces, utiliser l'adresse 0.0.0.00.0.0.0
port
Port utilisé pour communiquer avec le module architecture-export7780
use_ssl
Booléen (0 ou 1) qui indique si le module architecture-export doit communiquer via SSL (utiliser la valeur 1 pour forcer la communication via SSL)0
ssl_cert
Chemin vers le fichier de certificat SSL/etc/shinken/certs/server.cert
ssl_key
Chemin vers le fichier de clé SSL/etc/shinken/certs/server.key
architecture_name
Nom de l'architecture affichée dans l'interface de VisualisationShinken
map_base_url

Domaine à utiliser pour la construction des liens vers les cartes dans l'interface de Visualisation. Par défaut, l'adresse de l'Arbiter est utilisée.

Pour que les liens vers NagVis dans le menu Architecture de l'interface de Visualisation pointent vers https://mon-domaine.fr/adresse-de-nagvis..., il faut utiliser la valeur "https://mon-domaine.fr/" pour ce paramètre.

adresse de l'Arbiter
send_my_architecture_to_recipients
Liste des modules architecture-export distants auxquels il faut envoyer les informations d'architecture. Ces modules distants vont générer les hôtes et cartes NagVis dans leurs installations Shinken respectives.http://127.0.0.1:7780
listener_use_ssl
Lors de la réception d'une description d'architecture, indique si la communication avec le listener Shinken pour la création des hôtes Shinken associés à cette architecture doit se faire via SSL. Pour que cela fonctionne, il faut également que la communication via SSL soit activée dans les réglages du listener-shinken (faisable depuis l'interface de Configuration)0
listener_login
Lors de la réception d'une description d'architecture, indique le nom d'utilisateur à utiliser pour la connexion avec le listener-shinken pour la création des hôtes Shinken associés à cette architectureShinken
listener_password
Lors de la réception d'une description d'architecture, indique le mot de passe à utiliser pour la connexion avec le listener-shinken pour la création des hôtes Shinken associés à cette architecturemot de passe par défaut du listener
ssh_port
Lors de la réception d'une description d'architecture, indique le port SSH à utiliser lors de la connexion aux hôtes Graphite pour la découverte de l'architecture Graphite22
ssh_user
Lors de la réception d'une description d'architecture, indique l'utilisateur à utiliser lors de la connexion aux hôtes Graphite pour la découverte de l'architecture Graphiteshinken
ssh_key_file
Lors de la réception d'une description d'architecture, indique le chemin de la clé SSH à utiliser lors de la connexion aux hôtes Graphite pour la découverte de l'architecture Graphite/var/lib/shinken/.ssh/id_rsa.pub
ssh_timeout
Lors de la réception d'une description d'architecture, indique le timeout à utiliser lors de la connexion aux hôtes Graphite pour la découverte de l'architecture Graphite(secondes)
map_realm_layout
Lors de la création d'une carte NagVis, indique dans quel ordre seront affichés les royaumes. Les valeurs possibles sont sort_by_size (les royaumes qui comportent le plus de démons Shinken seront affichés en premier) et sort_by_name (les royaumes sont affichés par ordre alphabétique).sort_by_size
architecture_export__broker_connection__broker_nameNom du Broker sur lequel sont les modules WebUI et Livestatus avec lesquels Nagvis communiquerabroker-master
architecture_export__broker_connection__broker_livestatusNom du module Livestatus sur lequel Nagvis récupérera les informations des objets Shinken de ses cartesLivestatus
architecture_export__broker_connection__broker_webuiNom du module WebUI vers lequel Nagvis vous redirigera lorsque vous cliquerez sur un objet Shinken de la carteWebUI
architecture_export__broker_connection__broker_webui_redirectCe paramètre permet de définir une adresse personnalisée pour la redirection vers la WebUI.  Il ne peut pas être utilisé en même temps que architecture_export__broker_connection__broker_webuiAucun


Plus de détails sur le fonctionnement du module architecture-export et sur ces paramètres sont disponibles dans la page de documentation dédiée: Activation et configuration de la fonctionnalité

Envoi de la description de l'architecture

L'envoi de la description de l'architecture aux destinataires choisis (paramètre send_my_architecture_to_recipients) est déclenché au démarrage du module architecture-export, c'est-à-dire au démarrage du démon Arbiter.

Il est également possible de déclencher cet envoi manuellement, sans avoir à redémarrer le démon Arbiter, en envoyant une requête HTTP POST à l'URL suivante: 

adresse_arbiter:7780/v1/architecture/send


Par exemple, avec curl:

curl -v -X POST adresse_arbiter:7780/v1/architecture/send