utilisation de vault et des informations sensibles

.gitignore

@@ -0,0 +1,2 @@
+.venv
+build/*

source/data_description.rst

@@ -88,7 +88,7 @@ Identifiants
 
 .. index:: Albret, Alençon, Armagnac, Berry, Bourbon, Bourgogne, Bretagne, Orléans, Savoie
 
-- Chaque maison princière a un identifiant : 
+- Chaque maison princière a un identifiant :
 
 .. list-table:: Identifiants des maisons princières
    :widths: 25 25
@@ -127,63 +127,65 @@ Identifiants
    :widths: 25 25
    :header-rows: 1
 
-   * - Prénom    
+   * - Prénom
      - Code
-   * - Alain     
-     - al  
-   * - Amédée    
-     - am  
-   * - Arthur    
-     - ar  
-   * - Bernard   
-     - be  
-   * - Charles   
-     - ch  
-   * - Édouard   
-     - ed  
-   * - François  
-     - fr  
-   * - Jean      
-     - je  
-   * - Louis     
-     - lo  
-   * - Philippe  
-     - ph  
-   * - Pierre    
-     - pi  
-   * - René      
-     - re  
-   * - Anne      
-     - ann 
-   * - Agnès     
-     - agn 
-   * - Béatrice  
-     - bea 
-   * - Blanche   
-     - bla 
-   * - Bonne     
-     - bon 
-   * - Catherine 
-     - cat 
-   * - Françoise 
-     - fra  
-   * - Isabelle 
-     - isa 
-   * - Jeanne    
-     - jea 
+   * - Alain
+     - al
+   * - Amédée
+     - am
+   * - Arthur
+     - ar
+   * - Bernard
+     - be
+   * - Charles
+     - ch
+   * - Édouard
+     - ed
+   * - François
+     - fr
+   * - Jean
+     - je
+   * - Louis
+     - lo
+   * - Philippe
+     - ph
+   * - Pierre
+     - pi
+   * - René
+     - re
+   * - Anne
+     - ann
+   * - Agnès
+     - agn
+   * - Béatrice
+     - bea
+   * - Blanche
+     - bla
+   * - Bonne
+     - bon
+   * - Catherine
+     - cat
+   * - Françoise
+     - fra
+   * - Isabelle
+     - isa
+   * - Jeanne
+     - jea
    * - Marguerite
-     - mag 
-   * - Marie     
-     - mar  
-   * - Yolande     
-     - yol 
+     - mag
+   * - Marie
+     - mar
+   * - Yolande
+     - yol
+   * - Isabelle
+     - isa
 
-- Chaque prince ou princesse a un numéro d'ordre, en romain minuscule : `i`, `ii`, `iii`, `iv`, etc. 
+- Chaque prince ou princesse a un numéro d'ordre, en romain minuscule : `i`, `ii`, `iii`, `iv`, etc.
 
 - L'identifiant des actes (`@xml:id` de `<TEI>`) est composé des trois éléments séparés d'un underscore et suivi de la date et d'une lettre.
 
 	- Actes de Charles Ier de Bourbon du 28 août 1427 : `brb_ch_i_1427_08_24a`.
-	
+
 Les fichiers CSV de corpus
 --------------------------
 
@@ -278,9 +280,9 @@ Les fichiers XML
     - Une ou plusieurs mentions hors teneur dans une ou des `<div>` de troisième niveau (avec `@type="MHT"`). Un `@subtype` peut venir préciser l'emplacement de la mention hors teneur ;
 
     - Une ou plusieurs signatures dans une ou des `<div>` de troisième niveau (avec `@type="sign"`).
-  
+
   - Des notes (`<note>`) peuvent également être ajoutées :
-    
+
     - Les notes paléographiques concernent l'écriture de l'acte : `<note type="paleo">` ;
 
     - Les notes critiques contextualisent ou explicitent un élément de l'édition, qu'il soit situé dans l'analyse, le tableau de la tradition ou le texte de l'acte : `<note type="bp">` (`bp` pour *bas de page*).

source/index.rst

@@ -9,6 +9,7 @@ Le projet de recherche « Actes princiers au royaume de France (XII\ :sup:`e`-XV
    data
    pipeline_actes_princiers
    install
+   secrets
    coding_standards
    deploiement
 

source/secrets.rst

@@ -0,0 +1,30 @@
+Gestion des informations d'identification
+=============================================
+
+En anglais : les *credentials*.
+
+Deux méthodes sont utilisées dans le projet, suivant que les informations
+sensibles sont contenues dans un (ou des) fichier(s) centralisés ou bien que
+les informations sensibles sont, de par la nature du projet, réparties dans tout le projet.
+
+- Le fichier non inclus dans le dépôt. C'est la méthode la plus simple,
+  on utilise le fichier `.gitignore` du projet ;
+- Dans les cas où les variables sont disséminées, on utilise un :term:`coffre`
+  pour chifrer et déchiffrer (encrypt and decrpyt) les fichiers sensibles.
+
+Typiquement dans un projet de déploiement basé sur ansible, les variables de configuration et les variables sensibles sont réparties dans les différents :term:`rôles`, dans ce cas la méthode de chiffrement est préférable.
+
+.. note:: cette méthode est à utiliser de préférence aussi
+          si on utilise des conteneurs (ex: docker), c'est la méthode utilisée
+          par les différents orchestrateurs de conteneur (ex: kubernetes).
+
+.. glossary::
+
+   coffre
+
+       Un coffre fort virtuel est un endroit où sont placé les fichiers sensibles, ou bien simplement une manière de chiffrer ces fichiers sensibles.
+
+   rôles
+
+       Les rôles ansibles sont des morceaux cohérents de configuration, par exemple si on installe un serveur web sur une machine cible, l'étape de configuration du https avec let's encrypt est une étape autonome qui peut être isolée.
+       L'intérêt est de pouvoir mieux lire les différentes étapes de l'installation de la machine cible.