diff --git a/doc/check/function.md b/doc/check/function.md
index c2c91583d..2966de16b 100644
--- a/doc/check/function.md
+++ b/doc/check/function.md
@@ -6,7 +6,7 @@ Une fonction de vérification est une fonction complémentaire au type qui perme
Voici un exemple simple de validation des valeurs :
-```
+```xml
@@ -19,7 +19,7 @@ Voici un exemple simple de validation des valeurs :
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
@@ -37,7 +37,7 @@ Dans cette exemple, la valeur de la variable "my_variable" va être validé par
Voici le contenu de la fonction :
-```
+```python
def islower(value):
if value is None:
return
@@ -58,7 +58,7 @@ Il est possible de définir des [paramètres](../param/README.md) à cette fonct
Dans la contrainte, il est possible de spécifier le niveau d'erreur et le mettre en avertissement :
-```
+```xml
my_variable
@@ -66,7 +66,7 @@ Dans la contrainte, il est possible de spécifier le niveau d'erreur et le mettr
En YAML :
-```
+```yml
- check:
- name: islower
level: warning
diff --git a/doc/check/redefine.md b/doc/check/redefine.md
index fedf67dfd..414ee9208 100644
--- a/doc/check/redefine.md
+++ b/doc/check/redefine.md
@@ -4,7 +4,7 @@
Dans un premier dictionnaire déclarons notre variable et sa fonction de vérification :
-```
+```xml
@@ -17,7 +17,7 @@ Dans un premier dictionnaire déclarons notre variable et sa fonction de vérifi
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
@@ -30,7 +30,7 @@ constraints:
Dans un second dictionnaire il est possible de redéfinir le calcul :
-```
+```xml
@@ -43,7 +43,7 @@ Dans un second dictionnaire il est possible de redéfinir le calcul :
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
@@ -65,7 +65,7 @@ Dans un second dictionnaire il est possible de supprimer cette vérification.
Dans un premier dictionnaire déclarons notre variable et notre fonction de vérification :
-```
+```xml
@@ -78,7 +78,7 @@ Dans un premier dictionnaire déclarons notre variable et notre fonction de vér
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
@@ -91,7 +91,7 @@ constraints:
Dans un second dictionnaire supprimer cette vérification :
-```
+```xml
@@ -99,7 +99,7 @@ Dans un second dictionnaire supprimer cette vérification :
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
diff --git a/doc/condition/condition.md b/doc/condition/condition.md
index 9821885a4..1bfdcfe4e 100644
--- a/doc/condition/condition.md
+++ b/doc/condition/condition.md
@@ -8,7 +8,7 @@ Nous allons nous concentrer ici sur la condition hidden_if_in, mais [il existe d
La condition hidden_if_in permet de cacher une variable où une famille à l'utilisateur, mais cette variable est toujours accessible dans un calcul, un vérification ou dans un template.
-```
+```xml
@@ -24,7 +24,7 @@ La condition hidden_if_in permet de cacher une variable où une famille à l'uti
En YAML :
-```
+```yml
variables:
- variable:
name: condition
@@ -51,7 +51,7 @@ Donc ici la variable est caché à l'utilisateur si la variable "condition" est
Il est également possible de mettre plusieurs paramètre :
-```
+```xml
@@ -68,7 +68,7 @@ Il est également possible de mettre plusieurs paramètre :
En YAML :
-```
+```yml
variables:
- variable:
name: condition
@@ -105,7 +105,7 @@ Ces deux comportements peuvent être changé à tout moment avec l'attribut "app
Exemple :
-```
+```xml
yes
maybe
@@ -115,7 +115,7 @@ Exemple :
En YAML :
-```
+```yml
- condition:
- name: hidden_if_in
source: condition
diff --git a/doc/condition/redefine.md b/doc/condition/redefine.md
index 664f8c90c..0ab50d75e 100644
--- a/doc/condition/redefine.md
+++ b/doc/condition/redefine.md
@@ -6,7 +6,7 @@ Dans un second dictionnaire il est possible de supprimer cette condition.
Dans un premier dictionnaire déclarons notre variable et notre calcule :
-```
+```xml
@@ -22,7 +22,7 @@ Dans un premier dictionnaire déclarons notre variable et notre calcule :
En YAML :
-```
+```yml
variables:
- variable:
name: condition
@@ -41,7 +41,7 @@ constraints:
Dans un second dictionnaire supprimer ce calcul :
-```
+```xml
@@ -49,7 +49,7 @@ Dans un second dictionnaire supprimer ce calcul :
En YAML :
-```
+```yml
variables:
- variable:
name: condition
diff --git a/doc/dev/README.md b/doc/dev/README.md
index de8d633b2..184d6b5ea 100644
--- a/doc/dev/README.md
+++ b/doc/dev/README.md
@@ -10,7 +10,7 @@ Commençons par créer un dictionnaire simple.
Voici un premier dictionnaire /srv/rougail/dictionaries/00-base.xml :
-```
+```xml
@@ -36,7 +36,7 @@ Un nouveau fichier 'example.py' va être créé dans le répertoire local
En plus du dictionnaire précédent, créons un dictionnaire extra /srv/rougail/extra_dictionaries/00-base.xml
-```
+```xml
@@ -62,7 +62,7 @@ rougail.save('example.py')
Nous créons un dictionnaire complémentaire pour ajouter notre template /srv/rougail/dictionaries/00-template.xml :
-```
+```xml
@@ -130,7 +130,7 @@ Il peut être intéressant de réaliser un patch à un template pour corriger un
Testons en créant le patch /srv/rougail/patches/example.conf.patch :
-```
+```patch
--- /srv/rougail/templates/example.conf 2021-02-13 19:41:38.677491087 +0100
+++ tmp/example.conf 2021-02-13 20:12:55.525089820 +0100
@@ -1,3 +1,5 @@
@@ -160,7 +160,7 @@ Deux choses importantes à savoir sur les patchs :
Nous créons un dictionnaire complémentaire pour ajouter un calcul à la variable "my_variable" dans /srv/rougail/dictionaries/00-fill.xml :
-```
+```xml
diff --git a/doc/dev/config.md b/doc/dev/config.md
index cff1eddc4..75426100f 100644
--- a/doc/dev/config.md
+++ b/doc/dev/config.md
@@ -38,7 +38,7 @@ Les familles et variables de ces dictionnaires sont classés, par défaut, dans
Par exemple pour ajouter l'extra "example" il faut faire :
-```
+```python
RougailConfig['extra_dictionaries']['example'] = ['/dir1', '/dir2']
```
diff --git a/doc/family/auto.md b/doc/family/auto.md
index 55f516bc0..6d2b3f7dc 100644
--- a/doc/family/auto.md
+++ b/doc/family/auto.md
@@ -5,7 +5,7 @@ Le nom et la description de la famille et des variables qu'elle contient sera en
Par exemple :
-```
+```xml
val1
val2
@@ -17,7 +17,7 @@ Par exemple :
En YAML :
-```
+```yml
variables:
- variable:
name: variable
diff --git a/doc/family/leadership.md b/doc/family/leadership.md
index 838267c12..bf35edb71 100644
--- a/doc/family/leadership.md
+++ b/doc/family/leadership.md
@@ -33,7 +33,7 @@ Les variables meneuses et suiveuses doivent dans une famille de type "leadership
Voici un exemple de définition d'une variable meneuse et de deux variables meneuses :
-```
+```xml
@@ -45,7 +45,7 @@ Voici un exemple de définition d'une variable meneuse et de deux variables mene
En YAML :
-```
+```yml
variables:
- family:
name: family
@@ -65,7 +65,7 @@ variables:
Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre groupe, rien de plus simple, il suffit définir une ou des nouvelles variables dans la famille :
-```
+```xml
@@ -75,7 +75,7 @@ Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre group
En YAML :
-```
+```yml
variables:
- family:
name: family
diff --git a/doc/family/simple.md b/doc/family/simple.md
index c3f545c14..89426357b 100644
--- a/doc/family/simple.md
+++ b/doc/family/simple.md
@@ -4,20 +4,20 @@ Une famille est un conteneur de variables. Elle peut contenir également des fam
Pour décrire une famille il faut mettre au minimum un nom :
-```
+```xml
```
En YAML :
-```
+```yml
- family:
name: my_family
```
Cette famille doit être placé dans une balise [variables](../variables.md) :
-```
+```xml
@@ -25,7 +25,7 @@ Cette famille doit être placé dans une balise [variables](../variables.md) :
En YAML :
-```
+```yml
variables:
- family:
name: my_family
@@ -33,7 +33,7 @@ variables:
Ou dans une autre famille :
-```
+```xml
@@ -43,7 +43,7 @@ Ou dans une autre famille :
En YAML :
-```
+```yml
variables:
- family:
name: my_family
@@ -58,13 +58,13 @@ Attention, une famille vide sera automatiquement supprimée.
En plus d'un nom, il est possible de mettre une "description" à la famille. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette famille :
-```
+```xml
```
En YAML :
-```
+```yml
variables:
- family:
name: my_family
@@ -73,13 +73,13 @@ variables:
En plus de la description, il est possible de préciser une aide complémentaire :
-```
+```xml
```
En YAML :
-```
+```yml
variables:
- family:
name: my_family
@@ -94,13 +94,13 @@ Changer le [mode](../mode.md) d'une famille permet de définir le [mode](../mode
Pour définir le [mode](../mode.md) :
-```
+```xml
```
En YAML :
-```
+```yml
- family:
name: my_family
mode: expert
@@ -115,13 +115,13 @@ Par contre ces variables sont accessibles lorsqu'on va utiliser ces variables.
Pour cacher une famille :
-```
+```xml
```
En YAML :
-```
+```yml
- family:
name: my_family
hidden: true
diff --git a/doc/fill/examples.md b/doc/fill/examples.md
index 64808705b..58ad6bc4b 100644
--- a/doc/fill/examples.md
+++ b/doc/fill/examples.md
@@ -4,7 +4,7 @@
Créeons deux variables multiples, une pour accueillir la liste des éléments du nom variable (ici `zones_list`), la seconde étant le nom du fichier calculé (ici `netwokd_configurations`) :
-```
+```xml
zone1
@@ -17,7 +17,7 @@ Créeons deux variables multiples, une pour accueillir la liste des éléments d
En YAML :
-```
+```yml
variables:
- variable:
name: zones_list
@@ -36,7 +36,7 @@ variables:
Calculons la valeur de la seconde variable à partir de la première :
-```
+```xml
/systemd/network/10-
@@ -51,7 +51,7 @@ Calculons la valeur de la seconde variable à partir de la première :
En YAML :
-```
+```yml
constraints:
- fill:
- name: calc_value
@@ -76,7 +76,7 @@ Le contenu de la variable `netwokd_configurations` sera alors :
Enfin déclarer une balise file en utilisant ces deux variables :
-```
+```xml
netwokd_configurations
@@ -86,7 +86,7 @@ Enfin déclarer une balise file en utilisant ces deux variables :
En YAML :
-```
+```yml
services:
- service:
- name: systemd-networkd
diff --git a/doc/fill/redefine.md b/doc/fill/redefine.md
index 42fd5a49e..d85b21b45 100644
--- a/doc/fill/redefine.md
+++ b/doc/fill/redefine.md
@@ -4,7 +4,7 @@
Dans un premier dictionnaire déclarons notre variable et notre calcule :
-```
+```xml
@@ -17,7 +17,7 @@ Dans un premier dictionnaire déclarons notre variable et notre calcule :
En YAML :
-```
+```yml
variables:
- variable:
name: my_calculated_variable
@@ -30,7 +30,7 @@ constraints:
Dans un second dictionnaire il est possible de redéfinir le calcul :
-```
+```xml
@@ -43,7 +43,7 @@ Dans un second dictionnaire il est possible de redéfinir le calcul :
En YAML :
-```
+```yml
variables:
- variable:
name: my_calculated_variable
@@ -65,7 +65,7 @@ Dans un second dictionnaire il est possible de supprimer ce calcul.
Dans un premier dictionnaire déclarons notre variable et notre calcule :
-```
+```xml
@@ -78,7 +78,7 @@ Dans un premier dictionnaire déclarons notre variable et notre calcule :
En YAML :
-```
+```yml
variables:
- variable:
name: my_calculated_variable
@@ -91,7 +91,7 @@ constraints:
Dans un second dictionnaire supprimer ce calcul :
-```
+```xml
@@ -99,7 +99,7 @@ Dans un second dictionnaire supprimer ce calcul :
En YAML :
-```
+```yml
variables:
- variable:
name: my_calculated_variable
diff --git a/doc/fill/value.md b/doc/fill/value.md
index effe360c1..d32e30379 100644
--- a/doc/fill/value.md
+++ b/doc/fill/value.md
@@ -4,7 +4,7 @@
Créons une variable dont la valeur est retournée par la fonction "return_no" :
-```
+```xml
@@ -17,7 +17,7 @@ Créons une variable dont la valeur est retournée par la fonction "return_no" :
En YAML :
-```
+```yml
variables:
- variable:
name: my_calculated_variable
@@ -30,7 +30,7 @@ constraints:
Puis créons la fonction "return_no" :
-```
+```python
def return_no():
return 'no'
```
@@ -41,7 +41,7 @@ Dans ce cas, la valeur par défaut est la valeur retournée par la fonction (ici
Attention, si une valeur par défaut est définit dans la variable "my_calculated_variable" :
-```
+```xml
yes
@@ -49,7 +49,7 @@ Attention, si une valeur par défaut est définit dans la variable "my_calculate
En YAML :
-```
+```yml
variables:
- variable:
name: my_calculated_variable
@@ -65,13 +65,13 @@ Il est possible de définir des [paramètres](../param/README.md) à cette fonct
En ajoutant le paramètre "hidden" à "True" dans la variable précédente, l'utilisateur n'aura plus la possibilité de modifié la valeur. La valeur de la variable sera donc systématiquement calculée :
-```
+```xml
```
En YAML :
-```
+```yml
variables:
- variable:
name: my_calculated_variable
@@ -90,7 +90,7 @@ Si la variable n'est pas multiple, il ne faut pas que le calcule retourne une li
Il est également possible de calculer [une variable d'une famille dynamique](../family/auto.md) à partir d'une variable standard :
-```
+```xml
val1
@@ -115,7 +115,7 @@ Il est également possible de calculer [une variable d'une famille dynamique](..
En YAML :
-```
+```yml
variables:
- variable:
name: suffixes
@@ -159,7 +159,7 @@ Si c'est ce que vous cherchez à faire, il faudra prévoir un traitement particu
Dans ce cas, il faut explicitement demander la valeur du suffix dans la fonction :
-```
+```xml
my_variable
@@ -171,7 +171,7 @@ Dans ce cas, il faut explicitement demander la valeur du suffix dans la fonction
En YAML :
-```
+```yml
constraints:
- fill:
- name: return_value_suffix
@@ -185,7 +185,7 @@ constraints:
Et ainsi faire un traitement spécifique pour ce suffix :
-```
+```python
def return_value_suffix(value, suffix):
if suffix == 'val1':
return value
diff --git a/doc/param/information.md b/doc/param/information.md
index 0b53e8447..2afc86568 100644
--- a/doc/param/information.md
+++ b/doc/param/information.md
@@ -4,13 +4,13 @@
Le paramètre peut être la valeur est issue d'une information de la configuration :
-```
+```xml
server_name
```
En YAML :
-```
+```yml
param:
- type: information
text: server_name
@@ -23,14 +23,14 @@ Si l'information n'existe pas, la paramètre aura la valeur "None".
Le paramètre peut être la valeur est issue d'une information de la cible du calcul :
-```
+```xml
test
help
```
En YAML :
-```
+```yml
param:
- type: target_information
text: test
diff --git a/doc/param/positional.md b/doc/param/positional.md
index 65f789deb..b3911dc3d 100644
--- a/doc/param/positional.md
+++ b/doc/param/positional.md
@@ -2,20 +2,20 @@
Déclarons un paramètre positionnel :
-```
+```xml
no
```
En YAML :
-```
+```yml
param:
- text: no
```
Créons la fonction correspondante :
-```
+```python
def return_value(value):
return value
```
@@ -26,13 +26,13 @@ La variable "value" de la fonction "return_value" aura donc "no" comme valeur pu
Déclarons maintenant un paramètre nommée :
-```
+```xml
no
```
En YAML :
-```
+```yml
param:
- name: valeur
text: no
diff --git a/doc/param/simple.md b/doc/param/simple.md
index 9890d5204..e682df373 100644
--- a/doc/param/simple.md
+++ b/doc/param/simple.md
@@ -2,13 +2,13 @@
Déclarons un paramètre avec une string :
-```
+```xml
no
```
En YAML :
-```
+```yml
param:
- type: string
text: no
@@ -20,13 +20,13 @@ C'est le type par défaut pour un paramètre.
Déclarons un paramètre avec un nombre :
-```
+```xml
1
```
En YAML :
-```
+```yml
param:
- type: number
text: '1'
@@ -34,7 +34,7 @@ param:
Créons la fonction correspondante :
-```
+```python
def return_value_with_number(value):
if value == 1:
return 'no'
@@ -47,13 +47,13 @@ La variable aura donc "no" comme valeur puisque le paramètre aura la valeur fix
Déclarons un paramètre avec un booléen :
-```
+```xml
True
```
En YAML :
-```
+```yml
param:
- type: boolean
text: true
@@ -63,13 +63,13 @@ param:
Le paramètre peut être une valeur null (None en python) :
-```
+```xml
```
En YAML :
-```
+```yml
param:
- type: nil
```
@@ -78,13 +78,13 @@ param:
Les paramètres sont chargés en supprimer les espaces en début ou fin de chaîne. Ce qui rend impossible d'avoir un paramètre " ". Avec le type "space", le paramètre sera donc un simple espace :
-```
+```xml
```
En YAML :
-```
+```yml
param:
- type: space
```
diff --git a/doc/param/variable.md b/doc/param/variable.md
index 5e6e1ac64..bda316189 100644
--- a/doc/param/variable.md
+++ b/doc/param/variable.md
@@ -2,13 +2,13 @@
Imaginons que la variable "my_variable" pré-existe. La valeur de la variable sera utilisé comme paramètre :
-```
+```xml
my_variable
```
En YAML :
-```
+```yml
param:
- type: variable
text: my_variable
@@ -22,13 +22,13 @@ Suivant le contexte une variable peut exister ou ne pas exister.
Un paramètre de type "variable" peut être "optional" :
-```
+```xml
unknow_variable
```
En YAML :
-```
+```yml
param:
- type: variable
optional: true
@@ -45,13 +45,13 @@ Si une variable est désactivé, l'utilisation de cette variable peut poser prob
Il est possible de ne pas générer d'erreur si une variable est désactivé en utilisant le paramètre "propertyerror" :
-```
+```xml
variable1
```
En YAML :
-```
+```yml
param:
- type: variable
propertyerror: false
@@ -66,13 +66,13 @@ Il est possible de faire un calcul avec comme paramètre [une variable d'une fam
Par exemple :
-```
+```xml
vardynval1
```
En YAML :
-```
+```yml
param:
- type: variable
text: vardynval1
@@ -82,13 +82,13 @@ Dans ce cas, la valeur du paramètre de la fonction sera la valeur de la variabl
Il peut être utile de récupérer la valeur du suffix dans la fonction, pour cela il suffit de mettre un paramètre de type suffix :
-```
+```xml
```
En YAML :
-```
+```yml
param:
- type: suffix
```
diff --git a/doc/service/README.md b/doc/service/README.md
index c5f07d7b7..02bab8fe6 100644
--- a/doc/service/README.md
+++ b/doc/service/README.md
@@ -8,7 +8,7 @@ Cette balise permet de définir tous les éléments ([fichier](file.md), [IP](ip
Il faut, à la création du service, préciser son nom :
-```
+```xml
@@ -19,7 +19,7 @@ Il faut, à la création du service, préciser son nom :
En YAML :
-```
+```yml
version: '0.10'
services:
- service:
@@ -35,13 +35,13 @@ Les services peuvent être de plusieurs type :
- swap : fichier utilisé par systemd-swap
- timer : tâche planifié pour systemd
-```
+```xml
```
En YAML :
-```
+```yml
- service:
- name: dev-disk-by\x2dpartlabel-swap
type: swap
@@ -51,13 +51,13 @@ En YAML :
Active le service systemd pour une target systemd déterminé. Par défaut, l'activation du service n'est pas gérer par rougail.
-```
+```xml
```
En YAML :
-```
+```yml
- service:
- name: squid
target: multi-user
@@ -73,13 +73,13 @@ Deux types de template sont aujourd'hui disponible :
- creole
- jinja2
-```
+```xml
```
En YAML :
-```
+```yml
- service:
- name: dev-disk-by\x2dpartlabel-swap
type: swap
@@ -92,13 +92,13 @@ Dans ce cas, rougail utilisera le template "dev-disk-by\x2dpartlabel-swap.swap"
Un service peut être factice, donc non géré par le système de service du système :
-```
+```xml
```
En YAML :
-```
+```yml
- service:
- name: ldap_client
manage: false
@@ -110,13 +110,13 @@ Un service factice est généralement une service qui n'existe pas réellement (
Il est possible de désactiver un service. Pour cela il faut rajouter l'attribut "disabled" à True :
-```
+```xml
```
En YAML :
-```
+```yml
- service:
- name: test
disabled: true
@@ -126,7 +126,7 @@ Dans ce cas, le service et les éléments qu'il compose ([fichier](file.md), [IP
Il est possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise service :
-```
+```xml
@@ -144,7 +144,7 @@ Il est possible de définir une [condition](../condition/README.md) de type "dis
En YAML :
-```
+```yml
services:
- service:
- name: test
@@ -172,13 +172,13 @@ La désactivation du service va créé un lien symbolique vers /dev/null.
Si vous ne voulez juste pas créer le fichier de service et ne pas faire de lien symbolique, il faut utiliser l'attribut undisable :
-```
+```xml
```
En YAML :
-```
+```yml
- service:
- name: test
disabled: true
diff --git a/doc/service/file.md b/doc/service/file.md
index 168061b4e..927f0faea 100644
--- a/doc/service/file.md
+++ b/doc/service/file.md
@@ -8,7 +8,7 @@ La déclaration du fichier permet de générer un fichier à partir d'un templat
Il est nécessaire, au minimum, de spécifier le chemin complet du fichier :
-```
+```xml
/etc/squid/squid.conf
@@ -18,7 +18,7 @@ Il est nécessaire, au minimum, de spécifier le chemin complet du fichier :
En YAML :
-```
+```yml
services:
- service:
- name: squid
@@ -30,13 +30,13 @@ Dans ce cas, le nom du template est déduit du nom du fichier, ici cela sera "sq
Si le template a un nom différent (par exemple si plusieurs template se retrouve avec le même nom), il est possible de changer le nom du template avec l'attribut source :
-```
+```xml
/etc/squid/squid.conf
```
En YAML :
-```
+```yml
file:
- source: template-squid.conf
text: /etc/squid/squid.conf
@@ -46,7 +46,7 @@ file:
Il est possible également de définir le nom du fichier dans une variable :
-```
+```xml
my_variable
@@ -61,7 +61,7 @@ Il est possible également de définir le nom du fichier dans une variable :
En YAML :
-```
+```yml
services:
- service:
- name: squid
@@ -82,7 +82,7 @@ Dans le cas des fichiers dynamique, la source est obligatoire.
Il est même possible de définir une variable de type multiple, ce qui génèrera plusiers fichiers :
-```
+```xml
my_variable
@@ -98,7 +98,7 @@ Il est même possible de définir une variable de type multiple, ce qui génère
En YAML :
-```
+```yml
services:
- service:
- name: squid
@@ -125,7 +125,7 @@ Dans ce cas il y a deux possibilités :
En effet, il est possible de passer le contenu d'une variable au template :
-```
+```xml
my_variable1
@@ -145,7 +145,7 @@ En effet, il est possible de passer le contenu d'une variable au template :
En YAML :
-```
+```yml
services:
- service:
- name: squid
@@ -179,13 +179,13 @@ Par défaut les droits du fichier généré sont "0644" avec comme utilisateur "
Il est possible de définir les droits, l'utilisateur ou le groupe d'un fichier généré :
-```
+```xml
/etc/squid/squid.conf
```
En YAML :
-```
+```yml
file:
- mode: '0640'
owner: nobody
@@ -199,13 +199,13 @@ Il est possible de personnaliser les droits par défaut dans la [configuration d
Il est possible de désactiver la génération d'un fichier avec l'attribut "disabled" :
-```
+```xml
/etc/squid/squid.conf
```
En YAML :
-```
+```yml
file:
- disabled: true
text: /etc/squid/squid.conf
@@ -213,7 +213,7 @@ file:
Il est aussi possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise fichier :
-```
+```xml
/etc/squid/squid.conf
@@ -232,7 +232,7 @@ Il est aussi possible de définir une [condition](../condition/README.md) de typ
En YAML :
-```
+```yml
services:
- service:
- name: text
@@ -260,23 +260,32 @@ Dans ce cas, tous les fichiers avec un attribut filelist à "squid" seront désa
Il est possible de redéfinir les éléments d'un fichier dans un dictionnaire différent en utilisant l'attribut redefine :
-```
+```xml
/etc/squid/squid.conf
```
+En YAML :
+
+```yml
+file:
+- source: template-squid.conf
+ redefine: true
+ text: /etc/squid/squid.conf
+```
+
## Choix du moteur de templating
Par défaut, le moteur de templating est le moteur de templating compatible avec "creole".
Il est possible de désactiver la templatisation du fichier (il sera alors uniquement copié) :
-```
+```xml
/etc/squid/squid.conf
```
En YAML :
-```
+```yml
file:
- engine: 'none'
text: /etc/squid/squid.conf
@@ -284,13 +293,13 @@ file:
Ou d'utiliser le moteur "jinja2" :
-```
+```xml
/etc/squid/squid.conf
```
En YAML :
-```
+```yml
file:
- engine: jinja2
text: /etc/squid/squid.conf
@@ -338,14 +347,14 @@ template content
Et déclaront ces deux templates :
-```
+```xml
/etc/squid/squid.conf
/etc/squid/squid.d/squid.conf
```
En YAML :
-```
+```yml
file:
- text: /etc/squid/squid.conf
- included: name
@@ -385,14 +394,14 @@ template content
Et déclaront ces deux templates :
-```
+```xml
/etc/squid/squid.conf
squid.d/squid.conf
```
En YAML :
-```
+```yml
file:
- text: /etc/squid/squid.conf
- included: content
diff --git a/doc/service/ip.md b/doc/service/ip.md
index b1f2d98e5..8209f2dbd 100644
--- a/doc/service/ip.md
+++ b/doc/service/ip.md
@@ -8,13 +8,13 @@ La déclaration de l'attribut permet d'associer une IP autorisé à accéder au
Il est nécessaire, au minimum, de spécifier le nom d'une variable de type "IP" :
-```
+```xml
variable_ip
```
En YAML :
-```
+```yml
ip:
- ip_type: variable_ip
text: variable_ip
@@ -24,13 +24,13 @@ ip:
L'adresse peut être de type réseau ("network") :
-```
+```xml
variable_ip
```
En YAML :
-```
+```yml
ip:
- netmask: variable_netmask
text: variable_ip
@@ -42,7 +42,7 @@ Attention, dans ce cas il faut préciser une variable de type "netmask" dans l'a
Il est possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise IP :
-```
+```xml
variable_ip
@@ -62,7 +62,7 @@ Il est possible de définir une [condition](../condition/README.md) de type "dis
En YAML :
-```
+```yml
services:
- service:
- name: test
diff --git a/doc/service/override.md b/doc/service/override.md
index 4d986c406..3a1486dd4 100644
--- a/doc/service/override.md
+++ b/doc/service/override.md
@@ -8,7 +8,7 @@ La balise override permet de redéfinir facilement un service systemd.
Il suffit d'avoir un template dont le nom est par défaut le nom du service avec l'extension "service" et de déclarer la balise :
-```
+```xml
@@ -18,7 +18,7 @@ Il suffit d'avoir un template dont le nom est par défaut le nom du service avec
En YAML :
-```
+```yml
services:
- service:
- name: squid
@@ -29,13 +29,13 @@ Dans cette exemple, le template associé doit s'appeler squid.service
Si le fichier service a un nom différent (par exemple si plusieurs template se retrouve avec le même nom), il est possible de changer le nom du template avec l'attribut source :
-```
+```xml
```
En YAML :
-```
+```yml
override:
- source: test.service
```
@@ -48,26 +48,26 @@ Par défaut, le moteur de templating est le moteur de templating compatible avec
Il est possible de désactiver la templatisation du fichier (il sera alors uniquement copié) :
-```
+```xml
```
En YAML :
-```
+```yml
override:
- engine: 'none'
```
Ou d'utiliser le moteur "jinja2" :
-```
+```xml
```
En YAML :
-```
+```yml
override:
- engine: 'jinja2'
```
diff --git a/doc/services.md b/doc/services.md
index d5e096585..e6e11b9a1 100644
--- a/doc/services.md
+++ b/doc/services.md
@@ -4,7 +4,7 @@ La balise "services" est le conteneur de l'ensemble des [services](service/READM
Il est placé à la racine du dictionnaire :
-```
+```xml
@@ -13,7 +13,7 @@ Il est placé à la racine du dictionnaire :
En YAML :
-```
+```yml
version: '0.10'
services: none
```
diff --git a/doc/target/family.md b/doc/target/family.md
index a324ccae7..4211cd244 100644
--- a/doc/target/family.md
+++ b/doc/target/family.md
@@ -2,13 +2,13 @@
Une cible peut être de type famille :
-```
+```xml
my_family
```
En YAML :
-```
+```yml
target:
- type: family
text: my_family
@@ -16,13 +16,13 @@ target:
Mais une target peut être optionnelle. C'est à dire que si la famille n'existe pas, l'action ne sera pas associé à cette famille.
-```
+```xml
my_family
```
En YAML :
-```
+```yml
target:
- type: family
optional: true
diff --git a/doc/target/list.md b/doc/target/list.md
index b1625ebe7..3fc77d3c0 100644
--- a/doc/target/list.md
+++ b/doc/target/list.md
@@ -6,13 +6,13 @@
Une cible peut être de type [service](../service/README.md) :
-```
+```xml
example
```
En YAML :
-```
+```yml
target:
- type: servicelist
text: example
@@ -22,13 +22,13 @@ target:
Une cible peut être de type [fichier](../service/file.md) :
-```
+```xml
example
```
En YAML :
-```
+```yml
target:
- type: filelist
text: example
@@ -38,13 +38,13 @@ target:
Une cible peut être de type [ip](../service/ip.md) :
-```
+```xml
example
```
En YAML :
-```
+```yml
target:
- type: iplist
text: example
@@ -54,13 +54,13 @@ target:
Mais une target peut être optionnelle. C'est à dire que si la \*list n'existe pas, l'action ne sera pas associé.
-```
+```xml
unknown
```
En YAML :
-```
+```yml
target:
- type: filelist
optional: true
diff --git a/doc/target/variable.md b/doc/target/variable.md
index c40ce188c..826d85804 100644
--- a/doc/target/variable.md
+++ b/doc/target/variable.md
@@ -2,26 +2,26 @@
Par défaut une cible est de type variable.
-```
+```xml
my_variable
```
En YAML :
-```
+```yml
target:
- text: my_variable
```
Mais une target peut être optionnelle. C'est à dire que si la variable n'existe pas, l'action ne sera pas associé à cette variable.
-```
+```xml
my_variable
```
En YAML :
-```
+```yml
target:
- optional: true
text: my_variable
diff --git a/doc/variable/README.md b/doc/variable/README.md
index 765b1d39f..449902373 100644
--- a/doc/variable/README.md
+++ b/doc/variable/README.md
@@ -6,7 +6,7 @@ Une variable est forcement dans [variables](../variables.md) ou dans une [famill
Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la variable via ce nom.
-```
+```xml
@@ -17,7 +17,7 @@ Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
@@ -32,13 +32,13 @@ variables:
En plus d'un nom, il est possible de mettre une "description" à la variable. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette variable :
-```
+```xml
```
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
@@ -47,13 +47,13 @@ variables:
En plus de la description, il est possible de préciser une aide complémentaire :
-```
+```xml
```
En YAML :
-```
+```yml
variables:
- variable:
name: my_variable
@@ -93,13 +93,13 @@ Une variable a un type. Ce type permet de définir les valeurs acceptées par ce
Pour définir le type d'une variable :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
type: number
@@ -111,13 +111,13 @@ Par défaut une variable ne peut acceuillir qu'une seule valeur. Il peut être u
Pour définir une variable à valeur multiple :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
multi: true
@@ -132,13 +132,13 @@ Par contre cette variable sera accessibles lorsqu'on va l'utiliser.
Pour cacher une variable :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
hidden: true
@@ -152,13 +152,13 @@ Désactiver une variable signifie qu'elle ne sera pas visible lorsqu'on modifie
Pour désactiver une variable :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
disabled: true
@@ -168,13 +168,13 @@ En YAML :
Variable dont une valeur est requise :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
mandatory: true
@@ -182,13 +182,13 @@ En YAML :
Les variables booléans sont par défaut obligatoire. Pour qu'une variable booléan ne soit pas obligatoire il faut le préciser explicitement :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
type: boolean
@@ -201,7 +201,7 @@ Les variables avec une valeur par défaut (non calculée) sont également automa
Il est possible de fixer les valeurs par défaut d'une variable :
-```
+```xml
value
@@ -209,7 +209,7 @@ Il est possible de fixer les valeurs par défaut d'une variable :
En YAML :
-```
+```yml
- variable:
name: my_variable
value:
@@ -218,7 +218,7 @@ En YAML :
Pour une variable multiple, il est possible de préciser plusieurs valeurs :
-```
+```xml
value 1
value 2
@@ -227,7 +227,7 @@ Pour une variable multiple, il est possible de préciser plusieurs valeurs :
En YAML :
-```
+```yml
- variable:
name: my_variable
multi: true
@@ -252,26 +252,26 @@ Attention trois attributs ne sont redéfinisable :
Créons notre variable :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
```
Et redéfinisons là :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
redefine: true
@@ -282,13 +282,13 @@ En YAML :
Il est parfois utile de créer une variable si elle n'existe pas dans un autre dictionnaire :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
exists: false
@@ -300,13 +300,13 @@ Si cette variable existe dans un autre dictionnaire, elle ne sera pas modifié n
Parfois on veut pouvoir redéfinir une variable mais seulement dans le cas où elle existe déjà :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
exists: true
@@ -319,7 +319,7 @@ Une variable avec valeur automatiquement modifiée est une variable dont la vale
Voici une variable a valeur automatiquement modifiée :
-```
+```xml
my_value
@@ -327,7 +327,7 @@ Voici une variable a valeur automatiquement modifiée :
En YAML :
-```
+```yml
- variable:
name: my_variable
auto_save: true
@@ -348,7 +348,7 @@ Une variable avec valeur en lecture seule automatique est une variable dont la v
Voici un variable à valeur en lecture seule automatique :
-```
+```xml
False
@@ -357,7 +357,7 @@ Voici un variable à valeur en lecture seule automatique :
En YAML :
-```
+```yml
- variable:
name: server_deployed
type: boolean
@@ -383,13 +383,13 @@ Concrêtement, le contenu de cet attribut est enregister dans une "information"
Exemple :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
test: yes
@@ -397,13 +397,13 @@ En YAML :
Il est possible de préciser plusieurs valeurs avec le séparateur "|" :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
test: yes|no
@@ -423,13 +423,13 @@ Cas particuliers :
Pour définir le [mode](../mode.md) :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
mode: expert
@@ -442,13 +442,13 @@ C'est particulièrement utile si un service peut être fournit par plusieurs ser
Pour déclarer :
-```
+```xml
```
En YAML :
-```
+```yml
- variable:
name: my_variable
provider: my_variable
@@ -456,7 +456,7 @@ En YAML :
Dans le code de l'application, on pourra retrouver le chemin de la variable en faisant :
-```
+```python
print(await config.information.get('provider:my_function'))
```
diff --git a/doc/variable/choice.md b/doc/variable/choice.md
index c47d04110..69148b016 100644
--- a/doc/variable/choice.md
+++ b/doc/variable/choice.md
@@ -4,7 +4,7 @@
Il est possible d'imposer une liste de valeur pour une variable particulière :
-```
+```xml
val1
val2
@@ -14,7 +14,7 @@ Il est possible d'imposer une liste de valeur pour une variable particulière :
En YAML :
-```
+```yml
- variable:
name: my_variable
type: choice
@@ -29,7 +29,7 @@ Cette variable n'est pas obligatoire dont il est possible de mettre la valeur "N
Si la variable est obligatoire ou si une valeur est précisée (la variable passe obligatoire) alors la valeur "None" n'est plus autorisé :
-```
+```xml
val1
val2
@@ -40,7 +40,7 @@ Si la variable est obligatoire ou si une valeur est précisée (la variable pass
En YAML :
-```
+```yml
- variable:
name: my_variable
type: choice
@@ -56,7 +56,7 @@ En YAML :
Par défaut les choix sont de type "string". Il est possible de préciser des nombres, des booléens ou la valeur None :
-```
+```xml
val1
val2
@@ -68,7 +68,7 @@ Par défaut les choix sont de type "string". Il est possible de préciser des no
En YAML :
-```
+```yml
- variable:
name: my_variable
type: choice
@@ -89,7 +89,7 @@ Comme vu précédement ajouter la valeur None n'est pas utile parce qu'elle est
Pour ajouter un choix à une variable à choix existante, rien de plus simple, juste redéfinir la variable en ajoutant le choix voulu :
-```
+```xml
val4
@@ -97,7 +97,7 @@ Pour ajouter un choix à une variable à choix existante, rien de plus simple, j
En YAML :
-```
+```yml
- variable:
name: my_variable
redefine: true
@@ -109,7 +109,7 @@ En YAML :
Si on veut supprimer un choix ou redéfinir complètement la liste, il faut redéfinir cette variable et ajouter l'attribut "remove_choice" à "True" :
-```
+```xml
val1
val2
@@ -118,7 +118,7 @@ Si on veut supprimer un choix ou redéfinir complètement la liste, il faut red
En YAML :
-```
+```yml
- variable:
name: my_variable
redefine: true
@@ -134,7 +134,7 @@ Dans ce cas toutes les anciens choix ne seront plus possible. Seuls les nouveaux
Une variable à valeur multiple peut servir de source des choix :
-```
+```xml
other_variable
@@ -142,7 +142,7 @@ Une variable à valeur multiple peut servir de source des choix :
En YAML :
-```
+```yml
- variable:
name: my_variable
type: choice
@@ -156,7 +156,7 @@ Seul un choice de type "variable" est possible par variable.
## Un variable à choix provenant d'une fonction
-```
+```xml
0
@@ -168,7 +168,7 @@ Seul un choice de type "variable" est possible par variable.
En YAML :
-```
+```yml
- variable:
name: my_variable
type: choice
diff --git a/doc/variables.md b/doc/variables.md
index 734a789d3..de367004f 100644
--- a/doc/variables.md
+++ b/doc/variables.md
@@ -4,7 +4,7 @@ La balise "variables" est le conteneur de l'ensemble des [familles](family/READM
Il est placé à la racine du dictionnaire :
-```
+```xml
@@ -13,7 +13,7 @@ Il est placé à la racine du dictionnaire :
En YAML :
-```
+```yml
version: '0.10'
variables: none
```