Comment créer sa propre source
Chemin des fichiers
Avant de pouvoir importer des éléments, les sources demandent d'être préalablement configurées.
- Chaque source est définie par un fichier de configuration contenant différentes propriétés tel que l'adresse de serveurs distants, des identifiants, ou d'autres informations.
- Pour connaître l'emplacement de ce fichier et des informations à définir, référez-vous à la documentation de chaque type de source.
Certaines sources sont pré-configurées, comme par exemple la source Nagios.
- Ces sources sont des sources d'exemple pour vous aider à prendre en main la configuration des sources.
- Pour finaliser la configuration de cette source, voir Importer ses propres fichiers CFG.
Conseil
Il est recommandé de ne jamais directement modifier les sources d'exemple proposées, mais plutôt de les copier puis les renommer pour créer une nouvelle source.
Nous verrons par la suite comment faire en sorte que seule la source copiée soit visible dans l'interface.
Structure de base d'un fichier de source
Chaque source contient un certain nombre d'options communes à toutes les sources et d'autres spécifiques au fonctionnement d'un type de source en particulier ( exemple : les écouteurs ).
Toutes les sources partagent les champs suivants:
| Nom de l'option | Valeurs possibles | Effet sur le fonctionnement de la source |
|---|---|---|
| source_name ou listener_name ou analyser_name | < un nom > | Sera le nom affiché de la source dans l'interface. Ce nom ne doit pas dépasser 40 caractères. Un nom trop long empêchera le Synchronizer de démarrer. Contrainte sur le nom (qui empêche le Synchronizer de démarrer) Ce nom ne doit pas dépasser 40 caractères. Caractère interdit ",',/,\,&,?,#,; et $ Ce paramètre est obligatoire |
| module_type | < un nom de module > | Définit quel est le type de source, par exemple cfg-file-import pour un import de fichier. |
| import_interval | < un entier > | Définit à quel intervalle, en minutes, l'import de la source est activée. 0 signifie activation manuelle uniquement. |
| enabled | < 0 ou 1 > | Définit si la source est activée. L'import d'une source activée aura lieu régulièrement, selon l'import_interval. |
| order | < un entier > | Définit l'ordre de priorité de la source. Il est préférable d'utiliser l'interface plutôt que le fichier pour définir ce paramètre. |
| description | < une description > | Une description optionnelle de la source. |
| cfg_path | < un chemin > | Chemin vers le fichier de configuration principal nagios/shinken qui relie toutes les définitions d’objets |
| not_stored_properties | < liste de champs > | Ce paramètre permet de définir un ou plusieurs champs qui ne seront pas importés dans shinken. Cela peut être utile pour exclure une propriété ou bien utiliser des champs personnalisés utiles pour la gestion de vos fichiers .cfg |
| put_in_staging | < 0 ou 1 > | Ce paramètre permet d'importer directement les éléments de la source et accepter les éventuelles différences en staging. Ce paramètre est à utiliser avec le paramètre suivant. |
| put_in_staging_user | < un nom d'administrateur Shinken > | Permet de préciser le nom de l'utilisateur qui sera utilisé pour accepter les différences et importer les nouveaux éléments en staging. cet utilisateur doit être administrateur Shinken. |
Les différents types de sources ( module_type ) fournis par Shinken Enterprise déterminent quelles seront les autres options spécifiques au module, qui seront présentes dans la configuration.
- Par exemple, une source d'import de fichier nécessite un chemin vers des fichiers de configuration.
- Certaines sources plus complexes ( LDAP, Active directory, VMWare, etc...) nécessitent des fichiers supplémentaires de configuration, qui seront également listés en tant qu'option.
Afficher la source dans l'interface
Pour afficher votre source dans l'interface de configuration, il faut modifier le fichier de votre Synchronizer dans le répertoire /etc/shinken/synchronizers/.
- Dans le fichier de configuration, chercher le paramètre "sources" et ajouter le nom de votre source.
- Pour que cette modification soit prise en compte, il faut redémarrer le Synchronizer.
Si vous souhaitez masquer ou supprimer une source, vous devrez enlever son nom de la source de cette liste.
Si vous supprimez une source sans retirer son nom de la liste cela empêchera le démon Synchronizer de démarrer, puisqu'il cherchera à la charger.
Comment organiser ses sources
Quel que soit le type de source configurée, il est possible de les réordonner afin de prioriser l'import d'une source par rapport à une autre.
Cela peut être défini dans les fichiers de définitions des sources avec la clé order, mais il est préférable de le réaliser sur l'interface sans avoir à redémarrer le Synchronizer.
Pour cela, sur la page principale, dans la zone des modules de détection et qualification :
- Cliquez sur le bouton "Changer l'ordre des sources" ( 1 )
- Une fois en mode Changer l'ordre des sources, la liste de toutes les sources, quel que soit leur type, est affichée en fonction de l'ordre de priorité
- Pour changer l'ordre de la source, sélectionnez la ligne de celle-ci en maintenant le clic à l'aide de souris et faite un glissez et déposer vers l'endroit où vous souhaitez la déplacer
- Une fois le clic relâché , un clignotement bleu dans la colonne "Ordre" vous indique que le changement d'ordre a eu lieu ( 2 )
- Vous pouvez revenir sur la vue par défaut des sources en cliquant sur "Voir les sources par type" ( 3 ).
