Voir la configuration du module ( ldap-import : mode openldap )

Présentation

L'onglet de configuration afficher les paramètres de configuration définie dans le fichier de configuration de votre module peut être consultée dans cet onglet ( voir la page Collecteur de type ldap-import ( pour Open LDAP ) ) :

La configuration du collecteur définie dans le fichier de configuration de la source ( pour la source par défaut : /etc/shinken/sources/openldap.cfg ) peut être consultée dans cet onglet :

Elle est divisée en 5 chapitres :

• Configuration générale.
• Options de mélange des sources.
• Choix de l'espace où seront placé les éléments importés.
• Paramètres spécifiques à la source.
• Clé de synchronisation ( sync_key ).

Remarque : Cet onglet ne permet pas encore d'éditer la configuration ( => Sera implémenté dans une prochaine version )

Configuration générale

Ce chapitre contient tous les paramètres pour le chargement et fonctionnement des sources en général.

source_name 

module_type 

order

import_interval

Options de mélange des sources

Mode de mélange des sources

Grâce au paramètre "Mode de mélange des sources" ( merge_mode dans le fichier de configuration de la source ), il est possible de modifier la gestion d'une source lors de l'étape du mélange des sources ( voir la page Le mélange des sources & les clés de synchronisation (sync-key) ).

La valeur par défaut est : all

Les valeurs possibles sont : 

merge_mode

Détecter les nouveaux éléments

Les éléments proposés par la source sont soumis au calcul des nouveautés ( voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ).

compute_new_element

Calculer les différences

Les éléments proposés par la source sont soumis au calcul des différences ( voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ).

compute_element_difference

Suppression des éléments absents

Détecter les éléments qui ne sont plus présent dans la source

Permets de proposer en suppression, les éléments qui ne sont plus présents dans la ou les source/s.

compute_deleted_element_not
_in_source

Choix de l'espace où seront placé les éléments importés

Mettre dans l'espace

Permet d'appliquer les différences et d'importer les nouveaux éléments de cette source directement en Staging ou Production ou bien de les laisser dans l'espace de calcul des sources comme par défaut.

put_in

Utilisateur utilisé pour la sauvegarde des changements

Option qui permet de choisir l'utilisateur qui apparaîtra comme étant le dernier à avoir mis à jour les éléments.

put_in_user

Clés spécifiques à la source

Ce chapitre liste tous les paramètres qui sont spécifiques au fonctionnement de cette source.

Format des fichiers JSON chargés par le module

Dans cette source, plusieurs fichiers JSON seront à configurer. Ils respectent tous le même format que voici :

• Le fichier débute par une ligne avec seulement une accolade ouvrante : {
• Toute ligne commençant par un dièse ( # ) sera considérée comme un commentaire et ne sera pas interprétée par la source
• Chaque ligne valide ( lue par la source ) est constituée de :
  • le nom du paramètre entre guillemets : "nom_du_paramètre"
  • le symbole deux-points ( : ) séparant le nom du paramètre de sa valeur
  • la valeur du paramètre entre guillemets : "valeur du paramètre"
  • le symbole virgule ( , ) s'il ne s'agit pas de la dernière ligne de définition d'un paramètre.
• Le fichier se termine par une ligne avec seulement une accolade fermante : }

Accès au serveur et arborescence des données

Implémentation du protocole LDAP

Le module implémentant le protocole LDAP, il peut être nécessaire de lui préciser l'implémentation à utiliser. Le paramètre mode doit donc être configuré sur openldap pour notre source Collecteur Open LDAP. Ce mode gère également d'autres implémentations telles qu’Oracle Directory Server Enterprise Edition.

mode

Définition de l'accès au serveur

L'accès au serveur Open LDAP se configure dans le fichier indiqué par le paramètre connection_configuration_file.

connection_configuration_file

Le fichier indiqué dans ce paramètre ( par défaut /etc/shinken-user/source-data/source-data-openldap-sample/_configuration/openldap-connection.json ) doit respecter le format des fichiers Json ( voir page JavaScript Object Notation ). Voici les paramètres obligatoires à renseigner dans le fichier, qui permettent de définir la connexion au serveur Open LDAP :

Arborescence et filtrage des données

Import des hôtes et groupes d'hôtes

Afin d'importer des hôtes et des groupes d'hôtes, il faut spécifier au module ou rechercher ces éléments dans le serveur Open LDAP.

Import des contacts et groupes de contacts

Exemples

Voici un exemple de ce fichier

{
  # Mandatory
  "url": "ldap://192.168.1.240",
  "ldap_protocol":3,
  "base": "dc=shinkendom,dc=local",
  "username": "cn=administrateur,dc=shinkendom,dc=local",
  "password": "P@ssword1",

  # Optionnal
  "hosts_base": "OU=Serveurs,dc=shinkendom,dc=local",
  "hosts_filter": "(|(objectClass=device)(objectClass=computer))",
  "hosts_filter_with_group":"",
  
  "contacts_base": "OU=Users,dc=shinkendom,dc=local",
  "contacts_filter": "(|(objectClass=InetOrgPerson)(objectClass=user))",
  "contacts_filter_with_group": "",
  
  "hostgroups_base": "OU=Serveurs,dc=shinkendom,dc=local",
  "hostgroups_filter": "(|(objectclass=group)(objectclass=groupofnames)(objectclass=groupofuniquenames))",
  
  "contactgroups_base": "OU=Users,dc=shinkendom,dc=local",
  "contactgroups_filter": "(|(objectClass=groupOfUniqueNames)(objectClass=groupOfNames)(objectClass=posixGroup))"
 }

Le mapping des informations collectées

Le mapping des informations collectées par la source se configure dans le fichier indiqué par le paramètre mapping_configuration_file ( voir la page  Le mapping des informations collectées des champs du serveur Open LDAP vers les propriétés et les données Shinken ).

mapping_configuration_file

Les règles d'application des modèles

Les règles d'application des modèles par la source se configurent dans le fichier indiqué par le paramètre rules_configuration_file ( voir la page  Les règles d'application des modèles par rapport aux champs collectés du serveur Open LDAP ).

rules_configuration_file

Précisions techniques

Clés de synchronisation

Les clés de synchronisation sont des valeurs ( provenant de propriétés ou de données, définies par la source et spécifiques selon le type de l'élément ) permettant de déterminer quels éléments importés doivent être mélangés avec les éléments importés des autres sources ( voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ). Concrètement, plusieurs sources peuvent importer différentes informations concernant le même élément, donc si des éléments issus de sources différentes possèdent au moins une clé de synchronisation en commun, ils seront considérés comme étant le même élément et seront fusionnés lors de l’étape de mélange des sources ( voir la page Le mélange des sources & les clés de synchronisation (sync-key) ).

Les paramètres :

• properties_used_as_synckey_for_hosts
• properties_used_as_synckey_for_hostgroups
• properties_used_as_synckey_for_contacts
• properties_used_as_synckey_for_contactgroup

Permettent d’indiquer quelles propriétés dont les valeurs doivent être utilisées comme clés de synchronisation, c’est‑à‑dire celles dont la valeur servira à décider si deux éléments doivent être fusionnés. ( voir la page Collecteur de type ldap-import ( pour Open LDAP ) ).

N'importe quelle clé de Shinken peut être utilisée, cependant, pour que le mélange des éléments soit cohérent, il faut que les valeurs des clés indiquées permettent d'identifier de manière unique les différents éléments.

Par exemple :

• La clé "Activé" est une mauvaise clé de synchronisation, car elle ne peut avoir que deux valeurs différentes : "Vrai" ( 1 ) ou "Faux" ( 0 ).
• La clé "Adresse" est une bonne clé de synchronisation pour un Hôte, car il est cohérent que deux hôtes ayant la même adresse ( IP ou DNS ) soient le même élément.

Propriétés par défaut utilisé pour la construction des clés de synchronisation