Installation et mise en œuvre du module Scribe

Il est possible de lier des variables sous la forme d'une relation maître-esclave(s).

La variable maître doit obligatoirement être multi-valuée (multi='True').

Elle se définit dans l'attribut master.

Les variables esclaves sont définies entre les balises <slave>.

Les variables esclaves deviennent automatiquement multi-valuées.

Le calcul automatique permet d'associer automatiquement (par le calcul) une valeur par défaut à une variable.

Cette valeur peut être :

• éditable par l'utilisateur : balise <fill> ;
• non éditable par l'utilisateur (exemple : l'IP d'un serveur en DHCP) : balise <auto>.

L'attribut name correspond au nom de la fonction qui sera utilisée pour le calcul.

Les fonctions utilisées peuvent être :

• des fonctions natives de Tiramisu^[1] ;
• des fonctions déclarées dans le fichier eosfunc.py ;
• des fonctions ajoutées en tant que fonctions personnalisées (voir ci-dessous).

L'attribut de la balise param : optional='True' : indique que le paramètre sera ignoré si la variable associée n'existe pas. Cela permet de contourner les erreurs du type : Utilisation de la variable <param_var_name> non présente dans un calcul

L'attribut de la balise param : hidden='False' : indique que le paramètre sera ignoré si la variable possède des propriétés incompatibles avec le calcul (variable désactivée, variable obligatoire sans valeur, ...). Cela permet de contourner les erreurs du type : impossible d'effectuer le calcul, l'option <target_var_name> a les propriétés : ['disabled'] pour : <param_var_name>

Les principales fonctions de calcul utilisables avec les balises fill et auto sont les suivantes :

• calc_network : calcule l'adresse réseau par défaut à partir d'une IP et d'un masque de sous-réseau

  <fill name='calc_network' target='my_network'>

      <param type='eole' name='ip'>my_ip</param>

      <param type='eole' name='netmask'>my_netmask</param>

  </fill>

• calc_broadcast : calcule l'adresse de broadcast à partir d'une adresse IP et d'un masque de sous-réseau

  <fillname='calc_broadcast' target='my_broadcast'>

      <param type='eole' name='ip'>my_ip</param>

      <param type='eole' name='netmask'>my_netmask</param>

  </fill>

• calc_val : renvoie la valeur passée en paramètre (généralement la valeur d'une autre variable)

  <fill name='calc_val' target='nom_machine'>

      <param type='eole' name='valeur'>eole_module</param>

  </fill>

• calc_val_first_value : renvoie la valeur de la première variable définie

  <fill name='calc_val_first_value' target='eolesso_adresse'>

      <param type='eole' optional='True' hidden='False'>web_url</param>

      <param type='eole'>adresse_ip_eth0</param>

  </fill>

• calc_multi_val : renvoie les valeurs passées en paramètre en supprimant les doublons

  <fill name='calc_multi_val' target='ssl_organization_unit_name'>

      <param>110 043 015</param>

      <param type='eole'>nom_academie</param>

      <param type='eole'>numero_etab</param>

  </fill>

• concat : concaténation de plusieurs valeurs

  <fill name="concat" target='bacula_dir_name'>

      <param type='eole' name='valeur1'>nom_machine</param>

      <param name='valeur2'>-dir</param>

  </fill>

• calc_multi_condition : la valeur est déterminée en fonction d'une ou de plusieurs autres variables. Le résultat peut être une chaîne de caractères ou la valeur d'une autre variable multi ou non (si type='eole')

  <auto name='calc_multi_condition' target='variable_calculee'>

      <param>oui</param>

      <param type='eole' name='condition_1'>activer_logiciel1</param>

      <param type='eole' name='condition_2' hidden='False'>activer_logiciel2</param>

      <param name='match'>oui</param>

      <param name='mismatch' type='eole'>variablemiss</param>

      <param name='default_mismatch'>valeur_si_variablemiss_disabled</param>

  </auto>

  Il est possible d'utiliser des calc_multi_condition avec des variables non déclarées ou désactivées mais uniquement si toutes les variables testent la même condition.

  A contrario, il est possible de spécifier une condition différente pour chacune des variables en en fournissant la liste dans la première balise param : <param>['non', 'oui']</param>. Dans ce cas, il faut exactement le bon nombre de variables et que celles-ci soient accessibles.

La valeur renseignée pour une variable est validée par une fonction.

L'attribut name correspond au nom de la fonction qui sera utilisée pour le calcul.

Les fonctions utilisées peuvent être :

• des fonctions natives de Tiramisu^[1] ;
• des fonctions déclarées dans le fichier eosfunc.py ;
• des fonctions ajoutées en tant que fonctions personnalisées (voir ci-dessous).

L'attribut de la balise param : optional='True' : indique que le paramètre sera ignoré si la variable associée n'existe pas. Cela permet de contourner les erreurs du type : Utilisation de la variable <param_var_name> non présente dans un calcul

L'attribut de la balise param : hidden='False' : indique que le paramètre sera ignoré si la variable possède des propriétés incompatibles avec le calcul (variable désactivée, variable obligatoire sans valeur, ...). Cela permet de contourner les erreurs du type : impossible d'effectuer le calcul, l'option <target_var_name> a les propriétés : ['disabled'] pour : <param_var_name>

La présence de l'attribut level="warning" indique que le test de validation n'est pas bloquant.

En cas d'échec de la validation un message d'alerte apparaîtra mais la valeur sera tout de même acceptée.

Les principales fonctions de validation disponibles sont les suivantes :

• valid_enum : la valeur doit être choisie parmi celles de la liste, si checkval est à False, l'utilisateur est autorisé à entrer la valeur de son choix (liste ouverte)

  <check name="valid_enum" target="lettre">

      <param>['a','b','c']</param>

      <param name="checkval">False</param>

  </check>

• valid_regexp : la valeur doit être conforme à une expression rationnelle

  <check name='valid_regexp' target='code_ent'>

      <param>^[A-Z][0-9]$</param>

      <param name='err_msg'>L'identifiant doit etre compose d'une lettre et d'un chiffre</param>

  </check>

• valid_differ : la valeur doit être différente de celle passée en paramètre

  <check name='valid_differ' target='smb_workgroup'>

      <param type='eole' hidden='False'>smb_netbios_name</param>

  </check>

• valid_entier : la valeur doit être un entier sur lequel on peut définir un minimum et/ou un maximum

  <check name='valid_entier' target='nombre'>

      <param name='mini'>0</param>

      <param name='maxi'>50</param>

  </check>

• valid_networknetmask : vérifie la cohérence entre une variable de type network et la variable de type netmask associée

  <check name="valid_networknetmask" target="netmask_ssh_eth0">

      <param type='eole'>ip_ssh_eth0</param>

  </check>

• valid_ipnetmask : vérifie la cohérence entre une variable de type ip et la variable de type netmask associée

  <check name="valid_ipnetmask" target="adresse_netmask_eth0" level="warning">

      <param type='eole'>adresse_ip_eth0</param>

  </check>

• valid_in_network : vérifie la cohérence entre une variable de type ip et les variables de type network et netmask associées

  <check name="valid_in_network" target="adresse_ip_gw">

      <param type='eole'>adresse_network_eth0</param>

      <param type='eole'>adresse_netmask_eth0</param>

  </check>

Autre fonction de validation disponible mais non utilisée dans les dictionnaires livrés :

• valid_broadcast

Il est possible d'ajouter des librairies de fonctions personnalisées dans le répertoire /usr/share/creole/funcs.

Les librairies doivent posséder l'extension .py et contenir des fonctions python.