Voir la configuration du module ( type listener-rest )

Sommaire

Présentation

Dans cet onglet, vous trouverez :

Les paramètres de configuration définies dans le fichier de configuration de votre listener ( Voir la page Ecouteur de type listener-rest )
- Pour modifier la valeur des paramètres, vous devrez modifier le fichier de configuration.
Les paramètres de sécurité pour l'API REST qui sont uniquement configurables dans cette page.
- Ces paramètres sont éditables uniquement dans cette page afin qu'ils ne soient pas en clair dans le fichier de configuration de la source.

Indépendamment d’où ils sont définis, les paramètres peuvent être classés en cinq grand sujets :

Identification du listener
Options de mélange des sources
Choix de l'espace où seront placé les éléments importés
Communication avec l'API
Paramètres de sécurité

Configuration générale

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

Nom du paramètre dans l'interface	Nom du paramètre dans le fichier	Description
listener_name	listener_name	Nom de la source affichée dans l'interface de configuration en page d'accueil. Doit être unique Doit commencer par une lettre D'une longueur maximum à 40 caractères Ne doit pas contenir les caractères ?, &, ", ', $, /, #, \, ;
Type de Module	module_type	Type de module chargé par le Synchroniser. Pour cette source le module_type est "listener-rest".
Ordre	order	L'ordre de la source dans l'interface de configuration, qui a un impact dans la fusion des données lors des imports de sources. ( Voir la page Synchronizer ) Un nombre Remarque : Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier cfg sera mis à jour.
Description	description	Contient une description de la source qui vous permet de retrouver l'objectif de cette source

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 comment est gérée une source lors de l'étape du mélange des sources. ( Voir la page Concept général et utilisation des sources )

La valeur par défaut est : all

Les valeurs possibles sont :

Nom du paramètre dans l'interface	Nom du paramètre dans le fichier .cfg de configuration
merge_mode	merge_mode	Ce paramètre peut avoir les valeurs suivantes :
		Valeurs dans le fichier	Description
		dont_merge_with_other	Les éléments récoltés par cette source seront importés, mais pas fusionnés avec les autres sources. Ce qui implique que si un élément de cette source possède une clé de synchronisation commune avec une autre source alors ces éléments ne pourront être importés et provoquera un conflit. A utiliser si votre source vous donne un élément complet et qui ne doit pas être modifié ni par l'interface de configuration ni d'autre sources.
		only_with_syncui	Si un élément importé par cette source est aussi récolté par "Syncui", ils seront fusionnés pour ne donner qu'un élément. A utiliser si votre source vous donne un élément complet et que vous vous voulez le modifier via l'interface de configuration.
		all_without_syncui	Si un même élément est importé par plusieurs sources ( à part "Syncui" ), alors les éléments seront fusionnés pour n'en donner qu'un. A utiliser si votre source vous donne un élément à compléter avec d'autres sources mais qui ne doit pas être modifié par l'interface de configuration.
		all (valeur par défaut)	Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour n'en donner qu'un. Cas par défaut : les éléments de cette source seront complétés avec les autres sources et l'interface de configuration.

Syncui est une source qui importe tous les éléments de l'interface de configuration.

Chaque fois qu'une source est importée, Syncui l'est aussi.
Si une source ne se mélange pas avec Syncui, les modifications sur l'interface de configuration ne seront pas prises en compte .

Les sources désactivés ne sont pas prises en compte lors du mélange des sources.

Détecter les nouveaux éléments

Les éléments proposés par la source sont soumis au calcul des nouveautés ( Voir la page Les Modules de détection et de qualification ).

Nom du paramètre dans l'interface	Nom du paramètre dans le fichier
compute_new_element	compute_new_element	Ce paramètre peut avoir les valeurs suivantes :
		Valeurs dans le fichier	Description
		authorized (valeur par défaut)	Activée => le mécanisme de calcul des nouveautés analysera les éléments de la source pour identifier les nouveaux éléments par rapport à l'espace de données Staging.
		never_new	Désactivée => les éléments de la source n’apparaîtront pas en tant que nouveau, même s'ils n'ont jamais été importés par rapport à l'espace de données Staging.

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.

Cette option peut être activée que si cette source met directement dans l'espace "Staging" ou "Production" ses éléments importés.

Nom du paramètre dans l'interface	Nom du paramètre dans le fichier
compute_deleted_element_not _in_source	compute_deleted_element_not _in_source	Ce paramètre peut avoir les valeurs suivantes :
		Valeurs dans le fichier	Description
		disabled (valeur par défaut)	Les éléments qui ne sont plus présents dans la(les) source(s) ne seront pas proposés à la suppression.
		delete_if_missing_in _all_sources	Les éléments, qui ne sont plus présents dans cette source et qui n'existent pas dans les autres sources (sauf Syncui), seront proposés à la suppression.
		delete_if_missing_in _this_source	Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression.

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

Mettre dans l'espace

Permets 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.

Nom du paramètre dans l'interface	Nom du paramètre dans le fichier
put_in	put_in	Ce paramètre peut avoir les valeurs suivantes :
		Valeurs dans le fichier	Description
		source_space (valeur par défaut)	Les éléments sont sauvegardés dans l'espace de donnée "Sources". Cette espace sera comparée avec l'espace de données "Staging" afin de calculer les nouveautés et les différences.
		staging	Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources" et "Staging".
		production	Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production".
		production_and_reload_arbiter	Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production". L'Arbiter est redémarré afin de soumettre les changements à la supervision.

À noter: Une source avec le paramètre "put in" à la valeur "production" ou "production_and_reload_arbiter" ne poussera en production que les changements qui proviennent de la source et non tous les changements à appliquer en production (tous les changements visibles dans la page de production).

Ce qui implique que si un utilisateur supprime un élément importer par une source avec le paramètre "put_in" à la valeur "production" ou "production_and_reload_arbiter" alors que l'élément est réimporté par la source : il y aura en production 2 éléments avec le même nom, car la suppression manuelle de l'élément ne sera pas prise en compte ce qui provoquera une erreur.
Une source avec l'option put_in à production_and_reload_arbiter ne redémarrera l'Arbiter que si elle a des modifications à pousser en production.

Utilisateur qui sera responsable des changements sur les éléments importés

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

À Noter: l'utilisateur doit être obligatoirement un administrateur Shinken.

Nom du paramètre dans l'interface	Nom du paramètre dans le fichier	Description
put_in_user	put_in_user	Les nouveaux éléments et les éléments différents importés par cette source auront la valeur de cette clé comme utilisateur faisant la dernière modification.

Communication avec l'API

Permet de préciser comment communiquer avec l'API ( son adresse et son port ).

Nom du paramètre dans l'interface	Nom du paramètre dans le fichier	Description
host	host	Interface réseau sur laquelle l'API REST va écouter. Il n'est possible de mettre qu'une seule valeur. Remarque : L'adresse 0.0.0.0 correspond à toutes les interfaces réseau.
port	port	Le port réseau sur lequel l'API REST va écouter.

Paramètres de sécurité

La sécurité sur un écouteur peut être renforcée par deux moyens.

Ces deux options peuvent être modifiées sur l'interface sans redémarrer le Synchronizer.
Elles peuvent être utilisées conjointement ou séparément pour sécuriser les communications entre le client et l'écouteur.

A noter que cette partie de la configuration n'est quand base de données et ne peux pas être défini dans le fichier de configuration.

Authentification Simple

L'authentification simple permet de configurer un identifiant et un mot de passe pour pouvoir se connecter avec l'écouteur.

Cette authentification permet de limiter les connexions aux personnes qui connaissent le couple identifiant/mot de passe. En revanche, sans la deuxième option (SSL), ces données transiteront en clair sur le réseau.
Cela correspond au ( 1 ) dans l'image

Pour le paramétrer :

cochez la case Authentification
saisissez l'identifiant et le mot de passe souhaité
soumettez le formulaire (3).

Utilisation du SSL

Il est possible d'utiliser un certificat SSL pour chiffrer les connexions entre le client et l'écouteur.

Avec cette option, les communications ne transiteront pas en clair sur le réseau.
Cela correspond au ( 2 ) dans l'image