source_name

Concept

Cette source permet de récupérer tous les hôtes d'une installation Shinken distante.

Certaines situations nécessitent l’existence de plusieurs Shinken Entreprise que l'on voudrait connecter :

  • Découvrir les machines d'un sous-réseau sécurisé
    • Pour utiliser le collecteur discovery ( réalisant des scans réseau via nmap ) vers ce sous-réseau sécurisé, il faudrait ouvrir les flux vers tous les équipements, ce qui créerait une faille de sécurité.
    • Pour contourner cela, il est possible d'installer un Shinken dans le sous-réseau, ce dernier réalisant les scans nmap, et le connecter à un Shinken central via le synchronizer-collector-linker pour récupérer les hôtes découverts dans le sous-réseau.

  • Donner une autonomie à un administrateur Shinken qui pourrait créer ses hôtes via un Synchronizer distant et les collecter en centrale via le synchronizer-collector-linker. 


La source synchronizer-collector-linker va faire de requêtes au  listener-shinken  du Synchronizer distant pour y récupérer l'intégralité des hôtes, y compris ceux en nouveaux etdifférences.


Cette page explique comment définir ce type de collecteur et la page Collecteur de type ( synchronizer-collector-linker ) Import depuis un autre Synchronizer décrit comment l'utiliser.

Activation du collecteur

Les collecteurs de type "synchronizer-collector-linker" doivent être activés sur un démon Synchronizer.

  • L'activation du collecteur s'effectue en ajoutant le nom de ce collecteur dans le fichier de configuration du démon Synchroniser.
  • Pour cela, ouvrir le fichier de configuration du Synchroniser et ajouter le nom du collecteur de type "synchronizer-collector-linker" dans le paramètre sources.

Pour prendre en compte le changement de configuration, il faut redémarrer le Synchronizer :

service shinken-synchronizer restart

Activer le collecteur synchronizer-collector-linker livré en exemple

L'exemple suivant

  • active la source  "synchronizer-collector-linker",
  • sur le Synchronizer,dont la configuration est dans le fichier /etc/shinken/synchronizers/synchronizer-master.cfg.


L’installation ou la mise à jour de Shinken Entreprise livre un exemple de la configuration de ce collecteur dans le fichier :  /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-linker/synchronizer-collector-linker-example.cfg

  • Copier le fichier /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-linker/synchronizer-collector-linker-example.cfg
  • Coller avec un nouveau nom dans /etc/shinken/sources
    • exemple : /etc/shinken/sources/synchronizer-collector-linker.cfg
  • Attribuer l'utilisateur shinken et lui attribuer les droits d'écritures :  
    • exemple : chown shinken:shinken /etc/shinken/sources/synchronizer-collector-linker.cfg
    • exemple : chmod u+w /etc/shinken/sources/synchronizer-collector-linker.cfg
  • Modifier le paramètre source_name pour définir le nom du module modifié à accrocher aux démons
    • exemple :  synchronizer-collector-linker

Ajouter le nom de la source, synchronizer-collector-linker, dans le fichier du Synchronizer /etc/shinken/synchronizers/synchronizer-master.cfg.


define synchronizer {
    [...]
    sources                   Source 1, Source 2, Source 3, synchronizer-collector-linker
    [...]
}


Puis redémarrer le Synchronizer

service shinken-synchronizer restart

Il est possible d'avoir plusieurs collecteurs de type "synchronizer-collector-linker".  Il faut alors répéter les étapes précédentes, et donner un nom différent à chaque collecteur.

Configuration

Un exemple de configuration est disponible dans /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-linker/synchronizer-collector-linker-example.cfg.

Exemple de fichier de configuration

#===============================================================================
# synchronizer-collector-linker
#===============================================================================
# Daemons that can load this source:
# - synchronizer
# This source is about loading remote synchronizers configurations
#===============================================================================

define source {


    #======== source identity =========
    # Source name. Must be unique
    source_name         synchronizer-collector-linker-example

    # Module type (to load module code). Do not edit.
    module_type         synchronizer-collector-linker

    # order: source order for a source imply if a source is before another source when merging data
    order               2

    # import_interval:  in minutes, what is the schedule import interval for this source.
    # note: 0 = don't schedule this source, will run only if an administrator launch it from the interface
    import_interval     5

    # enabled: is this source enabled or not
    enabled             1

    # description: display a description on the interface for this source
    description         This source is about loading remote Synchronizers configurations

    #======== Properties not stored ========
    # Do not remove _SE_UUID from this property unless you want hosts retrieved from remote sites to keep their _SE_UUID
    # in the main Shinken (where synchronizer-collector-linker is present)
    not_stored_properties           _SE_UUID

}

Détails des sections composant le fichier de configuration

Identification de la source

Il est possible de définir plusieurs instances de collecteur de type "synchronizer-collector-linker" dans une architecture Shinken. Chaque collecteur doit avoir un nom différent.

    #======== source identity =========
    # Source name. Must be unique
    source_name         synchronizer-collector-linker-example

    # Module type (to load module code). Do not edit.
    module_type         synchronizer-collector-linker



NomTypeUnitéDéfautCommentaire
source_name
Texte---synchronizer-collector-linker

Il est conseillé de choisir un nom en fonction de l'utilisation du module pour que la configuration soit simple à maintenir.

Caractères autorisés : lettres, chiffres, underscore ( _ ), et trait d'union ( - )

  • Doit être unique.
  • Doit commencer par une lettre.
  • D'une longueur maximum de 40 caractères.
module_type 
Texte---synchronizer-collector-linkerNe peut pas être modifié.

Fonctionnement de la source

define source { 
	...
    order              3
    import_interval    5
    enabled            1
    description        This source is about loading remote Synchronizers configurations
    ...
}
NomTypeUnitéDéfautCommentaire
order
Entier positif

---

2

L'ordre de la source dans l'interface de configuration et dans le mélange des sources ( voir la page Le mélange des sources & les clés de synchronisation (sync-key) ).


Si l'ordre est changé depuis l'interface, le fichier .cfg sera mis à jour.

 

import_interval

Entier positif

minute0

Délai écoulé entre les imports automatiques de la source.
Si la valeur vaut 0, l'import de la source ne sera jamais exécuté automatiquement  ( uniquement manuellement ).

enabled
Booléen--- 0

Permet d'activer ou désactiver la source ( 1 pour activer, 0 pour désactiver ).

description
Texte---This source is about loading remote Synchronizers configurations

Description du module qui apparaît dans l'interface du Synchronizer.

Propriétés non récupérées

Il est possible de définir des propriétés que la source ne devra pas récupérer. Ceci est utile si vos instances Shinken distantes utilisent des propriétés propres à leur fonctionnement.

...     
    #======== Properties not stored ========
    # Do not remove _SE_UUID from this property unless you want hosts retrieved from remote sites to keep their _SE_UUID
    # in the main Shinken (where synchronizer-collector-linker is present)
    not_stored_properties           _SE_UUID 

...
NomTypeUnitéDéfautCommentaire
not_stored_properties
Texte---_SE_UUID

Empêche la récupération de certaines propriétés des hôtes récoltés.

Il est conseillé de laisser la valeur "_SE_UUID" et d'en rajouter d'autres si nécessaire. Si la valeur "_SE_UUID" est supprimée, les hôtes posséderont les mêmes "_SE_UUID" que sur le Shinken sur lesquels ils ont été récupérés.