rougail/doc/README.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

2021-02-06 16:01:35 +01:00
# Rougail
2021-02-14 10:12:42 +01:00
Rougail est un bibliothèque python3 qui permet de charger des dictionnaires (fichiers au format XML), de charger les variables dans Tiramisu et de générer des templates.
## La bibliothèque
- [Utiliser la bibliothèque](dev/README.md)
- [Personnaliser la configration de la bibliothèque](dev/config.md)
2021-02-12 18:08:28 +01:00
## Les dictionnaires
2021-02-14 10:12:42 +01:00
Un dictionnaire est un fichier XML donc la structure est expliqué ci-dessous.
Un dictionnaire contient en ensemble de variable, utilisable à tout moment, notamment dans des templates.
Il est possible d'avoir plusieurs espace de nom pour classer les variables (appeler aussi "extra") mais il est aussi possible, à l'interieur de ce espace de nom de mettre des familles pour classer les variables.
2021-02-12 18:08:28 +01:00
2021-02-14 10:12:42 +01:00
Les familles et les variables peuvent être défini dans plusieurs dictionnaires. Ces dictionnaires s'aggrège alors. Il est possible de rajouter des familles des variables, des services, des éléments à un service et des contraintes.
Il est également possible de redéfinir des éléments pour changer les comportement d'une variable ou d'un service.
2021-02-15 15:17:23 +01:00
FIXME expliquer les noms des variables dans les extras
2021-02-14 10:12:42 +01:00
### Les variables
2021-02-06 16:01:35 +01:00
2021-02-06 17:13:55 +01:00
- [Les familles](family/README.md)
2021-02-06 17:33:08 +01:00
- [Les variables](variable/README.md)
2021-02-06 16:01:35 +01:00
2021-02-14 10:12:42 +01:00
### Les services
2021-02-10 08:19:33 +01:00
- [La gestion d'un fichier](service/file.md)
- [La gestion d'un fichier de service systemd](service/override.md)
- [La gestion d'un port](service/port.md)
- [La gestion d'une ip](service/ip.md)
2021-02-14 10:12:42 +01:00
### Les contraintes
2021-02-06 16:01:35 +01:00
2021-02-10 08:19:33 +01:00
- [Les calcules automatiques](fill/README.md)
- [Les vérifications des valeurs](check/README.md)
- [Les conditions](condition/README.md)
2021-02-15 15:17:23 +01:00
- [Les variables meneuses ou suiveuses](variable/leadership.md)
2021-02-14 10:12:42 +01:00
## Les templates
- Type creole
2021-02-15 18:23:57 +01:00
FIXME :
- une variable avec nom unique sauf pour extra