Le fichier de configuration Creole

Sommaire
  1. Version du fichier
  2. Représentation des variables et des valeurs associées
  3. Origine des valeurs enregistrées

Le fichier de configuration principal d'un module EOLE est enregistré dans /etc/eole/config.eol.

Ce fichier est au format JSON[1].

Attention

Bien que ce fichier semble simple et lisible, il est fortement déconseillé de l'éditer sans passer par l'interface de configuration du module.

Version du fichier

Depuis EOLE 2.4, le numéro de sous-version du module EOLE sur lequel a été enregistré le fichier de configuration est stocké dans celui-ci.

Il est associé au mot-clé réservé : ___version___.

Exemple : "___version___": "2.6.1".

Représentation des variables et des valeurs associées

Seules les variables modifiées par l'utilisateur et celles faisant l'objet d'un enregistrement obligatoire sont stockées dans le fichier sous forme d'un dictionnaire.

Les noms des différentes variables Creole sont les mot-clés du dictionnaire.

La valeur associée est elle-même un dictionnaire qui contient le propriétaire (stocké dans le mot-clé owner) et la valeur de la variable (stockée dans le mot-clé val).

En fonction du type Creole de la variable, la valeur représentée peut-être :

  • une chaîne de caractère : "numero_etab": {"owner": "gen_config", "val": "0000000A"} ;
  • un entier (si type='number') : "vm_swappiness": {"owner": "creoleset", "val": 0} ;
  • aucune valeur (possible pour certaines variables à enregistrement obligatoire) : "test_autosave": {"owner": "forced", "val": null} ;
  • une liste (si multi='True') : "ip_admin_eth0": {"owner": "gen_config", "val": ["192.168.230.0", "194.18.20.0"]}.

Remarque

Depuis la version EOLE 2.6, les valeurs des variables esclaves sont indexées :

"netmask_admin_eth0": {"owner": {"1": "gen_config", "0": "gen_config"}, "val": {"1": "255.255.255.0", "0": "255.255.255.0"}

Origine des valeurs enregistrées

Le nom de l'application et/ou de l'action ayant modifié en dernier la valeur de l'une des variable est associé au mot-clé : owner.

Exemple : "serveur_maj": {"owner": "gen_config", "val": ["test-eole.ac-dijon.fr"]}

  • default : valeur par défaut et/ou calculée (n'est jamais enregistrée dans le fichier config.eol) ;

  • forced : valeur par défaut enregistrée d'office pour les variables à verrouillage automatique (auto_freeze) ou à enregistrement obligatoire (auto_save) ;

  • gen_config : valeur modifiée par l'interface de configuration du module ;

  • creoleset : valeur modifiée avec la commande CreoleSet ;

  • zephir : valeur modifiée pour un serveur donné dans l'interface web de Zéphir ;

  • variante : valeur par défaut de la variante Zéphir ;

  • module : valeur par défaut du module dans Zéphir ;

  • import : valeur récupérée depuis un fichier de configuration importé dans l'interface de configuration du module ;

  • zephir_import : valeur récupérée depuis un fichier de configuration importé dans l'interface web de Zéphir ;

  • upgrade : valeur récupérée depuis un fichier de configuration d'une version antérieure d'EOLE ;

  • zephir_upgrade : valeur récupérée depuis un fichier de configuration d'une version antérieure d'EOLE dans l'interface web de Zéphir.