Introduction

La génération des vues de l'architecture est de la responsabilité de l'addon "nagvis-shinken-architecture".

Les sections suivantes décrivent son comportement, comment l'activer/désactiver, et les différents paramètres de configuration disponibles.

Activation et désactivation de l'addon

Activation automatique

Lors d'une installation ou d'une mise à jour depuis une version antérieure à la V02.05.00, l'addon est automatiquement installé. Son activation dépend ensuite du type de machine sur laquelle Shinken est installé.

• L'addon "nagvis-shinken-architecture" analyse la configuration reçue par l'Arbiter pour ensuite générer les vues graphiques des royaumes et les hôtes correspondants.
• Pour cette raison, activer cet addon sur un machine ou aucun démon Arbiter n'est actif n'a pas de sens.
  • Sur une machine n'ayant qu'un démon Poller actif par exemple, l'addon ne sera donc pas activé.
  • Sur la machine principale d'une installation Shinken ( c'est à dire celle qui contient l'Arbiter ), l'addon "nagvis-shinken-architecture" sera automatiquement activé lors d'une installation ou mise à jour depuis une version antérieure à la V02.05.00.

Activer/désactiver la fonctionnalité

Si cette fonctionnalité ne correspond pas à un besoin dans votre utilisation de Shinken Entreprise, elle peut bien sûr être désactivée et réactivée selon les envies.

• Les sections suivantes décrivent de manière succincte les différentes commandes permettant de manipuler les addons.
• Plus de détails sur ces commandes se trouvent dans la page de documentation dédiée: Activation - désactivation des outils supplémentaires ( addons )

Vérifier l'état d'activation des addons

Activer l'addon

Les addons peuvent être activés avec la commande "shinken-addons-enable". Par exemple, pour activer l'addon "nagvis-shinken-architecture", la commande est la suivante:

shinken-addons-enable nagvis-shinken-architecture

Désactiver l'addon

Les addons peuvent être désactivés avec la commende "shinken-addons-disable". Avec le même exemple que précédemment, la commande est la suivante:

shinken-addons-disable nagvis-shinken-architecture

Visualiser l'état de l'addon

Configuration de l'addon

Manipulation et étapes de configuration

L'activation et désactivation de la fonctionnalité de visualisation de l'architecture Shinken s'effectue via l'addon "nagvis-shinken-architecture".

• La configuration de cet addon s'effectue via le fichier de configuration du module "architecture-export", situé dans "/etc/shinken/modules/architecture-export.cfg" ( voir Module architecture-export ).

Fonctionnement du module

L'export de l'architecture s'effectue grâce au module "architecture-export". Le fonctionnement de ce module est séparé en 2 parties:

• Envoi: Lorsqu'un changement d'architecture est détecté, le module envoie la description de l'architecture de l'installation Shinken sur laquelle il est installé à une liste de modules destinataires.
• Réception: Le module reste également en attente de données. Lorsqu'il reçoit des données correspondant à une description d'architecture, il génère les vues détaillées des royaumes et l'arbre des royaumes correspondants.

Dans le module, ces 2 aspects peuvent donc être configurés.

Aussi, le module est positionné sur l'Arbiter. On aura donc un seul module "architecture-export" par installation Shinken.

Différents paramètres de configuration

Nom de l'architecture

Port et interface d'écoute du module

Lors d'un changement de l'architecture, la description de cette architecture est envoyée à un ou plusieurs autres modules. Il est possible de modifier les paramètres d'écoute du module, comme le port et l'interface d'écoute :

define module {
    .
    .
    .
	(contenu)
    .
    .
    .

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

    .
    .
    .
    (suite du fichier)
}

Sécurisation de la communication (SSL)

Il est également possible de forcer la connexion au module en HTTPS. Pour activer une communication sécurisée, il faut positionner le paramètre use_ssl à 1 (par défaut 0).

Pour utiliser son propre certificat, il faudra le spécifier avec les paramètres ssl_cert et ssl_key. Par défaut, le certificat livré avec Shinken est utilisé.

define module {
    ...
    # 0 = Use HTTP, 1 = Use HTTPS
    use_ssl                 0
    ssl_cert                /etc/shinken/certs/server.cert
    ssl_key                 /etc/shinken/certs/server.key
    ...
}

URL d'accès dans la visualisation

Dans certains cas, il se peut que cette adresse soit incorrecte. C'est le cas par exemple si l'adresse de l'Arbiter est l'adresse d'une interface locale utilisée pour la communication entre démons, tandis que NagVis et les interfaces de Configuration et Visualisation sont présentées sur une interface publique.

Dans le fichier de configuration du module, le paramètre map_base_url permet de spécifier la base de l'adresse utilisée pour la construction des adresses d'accès aux cartes. Pour être fonctionnelle, cette adresse doit correspondre à l'adresse de la machine qui héberge l'Arbiter.

define module {
    ...
    # Base of URL used to display links in the Visualization UI
    # Defaults to Arbiter URL if empty
    # map_base_url  http://example.com/
    ...
}

Liste des destinataires

Enfin, lorsqu'un changement d'architecture est détecté, la description de l'architecture est envoyé à une liste de destinataires. Par défaut, le module "architecture-export" s'envoie les informations de l'architecture pour générer l'arbre des royaumes et les vues détaillées, mais il est également possible d'envoyer l'architecture à d'autres modules "architecture-export". Il faudra, dans la liste des destinataires, prendre en compte le port ainsi que l'utilisation de SSL.

define module {
    ...
    # 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,https://addressemodule2:1234
    ...
}

Il n'est pas non plus obligatoire d'envoyer la description de l'architecture sur 127.0.0.1. Si on omet cette adresse dans la liste des destinataires, les vues détaillées et l'arbre des royaumes ne seront pas générées sur l'installation Shinken actuelle, mais seulement sur celles spécifiées dans la liste des destinataires.

Pour un cas d'application concret, voir la page Exemple pratique: Mise en place automatisée d'une plateforme de supervision secondaire

Communiquer avec Graphite

Dans le cas où vous avez choisi une installation distribuée pour Graphite, l'architecture export doit être configurée de sorte à le détecter. Pour cela, il faut établir une communication avec la machine où Graphite est installée afin que l'architecture export puisse créer les hôtes associés à celle-ci, y ajouter les checks correspondant et l'afficher sur la carte nagvis.
Il est donc possible d'ajouter 4 paramètres spécifiant les différentes informations de connexion en SSH à votre machine.

define module {
    ...
    # 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
    ...
}

Dans le cas où ces paramètres ne sont pas renseignés, il sera impossible pour l'architecture export de recenser l'architecture Graphite.

Trier les royaumes

Les royaumes peuvent être affichés soit par ordre alphabétique, soit par taille.  

Pour cela, il faut ajouter le paramètre map_realm_layout dans :

define module {
    ...
    # Sort order for realms in the NagVis maps
    # - sort_by_name
    # - sort_by_size (default)
    map_realm_layout sort_by_name
    ...
}

Communication entre Nagvis et Shinken

Afin d'afficher les statuts des objets Shinken et de correctement rediriger vers la WebUI en cas de clic sur un objet, Nagvis doit pouvoir communiquer avec deux modules du Broker : Livestatus et WebUI.

A l'installation, Nagvis communiquera avec les modules du broker par défaut à savoir le broker-master.

Il vous est cependant possible de modifier ceci via 4 paramètres du module "architecture-export".

architecture_export__broker_connection__broker_name

architecture_export__broker_connection__broker_livestatus

architecture_export__broker_connection__broker_webui

architecture_export__broker_connection__broker_webui_redirect

define module {
    ...
    # ===================================    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
    ...
}