doc et fix

2025-07-25 08:43:38 +02:00
parent ef25716679
commit 3da2f37938
4 changed files with 42 additions and 22 deletions
--- a/README.md
+++ b/README.md
@ -1,6 +1,6 @@
 # kaz-vagrant

-[Kaz](https://kaz.bzh/) est un CHATONS du Morbihan. Nous proposons ici un moyen de le répliquer dans une VM. Il y a des éléments de configuration à définir avant d'initialiser ce simulateur. 
+[Kaz](https://kaz.bzh/) est un CHATONS du Morbihan. Nous proposons ici un moyen de le répliquer dans une VM.
 Le principe est de faire fonctionner un simulateur de notre CHATONS dans une VirtualBox pour mettre au point nos différents services.

 Nous utilisons :
@ -10,7 +10,7 @@ Nous utilisons :
  * LXC pour faire tourner ces services dans des conteneurs distincts (ie, kaz-prod est un conteneur LXC)
  * Docker pour chaque service de notre serveur

-À la fin, nous obtenons une maquette d'un petit internet simulé, avec du DNS, des mails tiers, et nos serveurs hoster-a-kaz1 et hoster-b-kaz2 dans un coin.
+À la fin, nous obtenons une maquette d'un petit internet simulé, avec du DNS, des mails tiers, et nos serveurs hoster-a-kaz1 (principal) et hoster-b-kaz2 (secondaire) dans un coin.

 ![topologie](/doc/images/topologie.png)

@ -47,7 +47,7 @@ Les utilisateurs créés sont

 Se connecter en root/root

-Lors du démarrage de la VM, il faut lancer SNSTER :
+Lors du démarrage de la VM, il faut lancer SNSTER (normalement c'est automatique ?) :
 ```bash
 cd /root/snster-kaz
 snster start
@ -65,18 +65,15 @@ Vous pouvez alors (toutes les commandes snster doivent être exécutées dans `/
    * `https://www.kaz.sns`, le Kaz interne à la VM
    * `https://listes.kaz.sns`, le sympa interne à la VM
    * `https://pad2.kaz.sns`, le pad sur kaz2
-    * `https://www.kaz.bzh`, le vrai Kaz
+    * `https://www.kaz.bzh`, le vrai Kaz (.bzh)
  * Ouvrir claws-mail et retrouver les comptes mails configurés :
    * `contact1@kaz.sns` à `contact4@kaz.sns`, hébergés sur le kaz-prod de la VM
    * `email@isp-a.sns`, hébergé dans le conteneur LXC isp-a-infra
 * Travailler sur hoster-a-kaz1 : `snster attach hoster-a-kaz1`
 * Afficher un plan de réseau : `snster print`
-* Le système de fichiers de hoster-a-kaz1 est accessible directement dans la VM:
-  * `/kaz1-prod/` [VM] correspond à `/` [hoster-a-kaz1]
-  * `/kaz` [VM] correspond à `/kaz` [hoster-a-kaz1]
-* Il est probablement pratique d'installer son environnement de développement sur la VM, avec ses clés SSH et son éditeur favori.
-
-Dans Vagrantfile, existent des répertoires partagés entre le host et le VM mais pour qu'ils soient visibles depuis la VM, il faut démarrer la VM non pas avec VirtualBox mais avec Vagrant up.
+* Les systèmes de fichiers de hoster-a-kaz1 / hoster-b-kaz2 sont accessibles directement dans la VM :
+  * `/kaz1/` [VM] correspond à `/` [hoster-a-kaz1]
+  * `/kaz2/` [VM] correspond à `/` [hoster-b-kaz2]

 Il y a un aperçu de l'état des services avec l'url https://kaz.sns/status/allServices.html

@ -90,11 +87,11 @@ Vous pouvez également démarrer firefox avec les URL suivantes:
  * https://tableur.kaz.sns
  * https://pad.kaz.sns
  * https://depot.kaz.sns
-  * https://agora.kaz.sns/login (compte contact1@kaz.local créé, mot de passe toto)
-  * https://cloud.kaz.sns/login (compte contact1@kaz.local créé, mot de passe totototototototo1234 )
+  * https://agora.kaz.sns/login (compte contact1@kaz.local créé, mot de passe totototototototo1234)
+  * https://cloud.kaz.sns/login (compte contact1@kaz.local créé, mot de passe totototototototo1234)
  * https://sondage.kaz.sns

-Il vous faudra accepter les éventuelles alertes de sécurité pour certificat absent (web et messagerie)
+Il vous faudra accepter les éventuelles alertes de sécurité pour certificat absent (web et messagerie) (normalement il n'y en a plus ?)

 ## Mise au point

@ -103,12 +100,41 @@ Pour réinstaller Kaz sur kaz1 (avec suppression de /kaz, des volumes dockers et
 snster attach hoster-a-kaz1 -x "/root/kaz.sh"
 ```

+Pour reconstruire le conteneur kaz1 complètement, depuis la VM :
+```bash
+snster destroy hoster-a-kaz1
+snster create
+```
+
 Pour détruire la VM et recommencer, depuis l'hôte :
 ```bash
 vagrant destroy
 vagrant up
 ```

+## Développement de Kaz avec la VM
+
+La VM peut être utilisée pour développer Kaz. Il existe différentes façons, chacun ses goûts, voici une possibilité. Cette méthode permet de développer dans son éditeur classique, sur son PC hôte, et d'avoir un SSH vers le conteneur Kaz.
+
+### SSH vers le conteneur Kaz
+
+Depuis l'hôte, dans le dossier `vagrant`, pour obtenir un shell sur le conteneur Kaz :
+```bash
+`vagrant ssh`     # ssh vers la VM
+`sudo su`         # passage root
+`cd /root/snster-kaz`
+`snster attach hoster-a-kaz1`
+```
+
+### Édition depuis l'hôte
+
+On va faire du sshfs pour voir les dossiers de la VM depuis l'hôte. Par exemple pour monter la racine du conteneur `hoster-a-kaz1` dans le dossier `vm` du dossier courant de l'hôte (rappel, le dossier `/kaz1` sur la VM est un lien symbolique vers le filesystem du conteneur `hoster-a-kaz1`) :
+```bash
+sshfs -p 2222 root@localhost:/kaz1/ vm/
+```
+
+Ainsi, on peut éditer sur son PC et exécuter dans un terminal hors VM.
+
 Accélération de la construction avec un proxy cache local
 ---------------------------------------------------------

--- a/5
+++ b/5
@ -20,11 +20,6 @@ Vagrant.configure("2") do |config|
  end


-
-  #permet d'avoir un répertoire partagé entre la VM et le host
-  config.vm.synced_folder "/tmp/", "/tmp_host"
-  config.vm.synced_folder "files/", "/root/kaz-vagrant"
-
 config.vm.provision "shell" do |s|
    s.inline = "/vagrant/files/vm-provision.sh"
    s.env   = {"KAZGUARD" => "true", "HOSTLANG" => ENV['LANG'], "NOKAZ" => ENV['NOKAZ'], "KAZBRANCH" => ENV['KAZBRANCH']}
--- a/files/snster-kaz/hoster-a/kaz1/createUser.txt
+++ b/files/snster-kaz/hoster-a/kaz1/createUser.txt
@ -19,7 +19,7 @@
 #   --
 #   NOM ; PRENOM ; EMAIL_SOUHAITE ; EMAIL_SECOURS ; ORGA ; ADMIN_ORGA ; NC_ORGA ; GARRADIN_ORGA ; WP_ORGA ; AGORA_ORGA ; WIKI_ORGA ; NC_BASE ; GROUPE_NC_BASE ; EQUIPE_AGORA ; QUOTA

-Hello1;Contact1;contact1@kaz.sns;contact2@kaz.sns; ;N;N;N;N;N;N;N; ; ;1;tototototo
+Hello1;Contact1;contact1@kaz.sns;contact2@kaz.sns; ;N;N;N;N;N;N;N; ; ;1;totototototototo1234
 Hello2;Contact2;contact2@kaz.sns;contact2@kaz.sns; ;N;N;N;N;N;N;N; ; ;1;tototototo
 Hello3;Contact3;contact3@kaz.sns;contact2@kaz.sns; ;N;N;N;N;N;N;N; ; ;10;tototototo
 Hello4;Contact4;contact4@kaz.sns;contact2@kaz.sns; ;N;N;N;N;N;N;N; ; ;10;tototototo
--- a/files/vm-provision.sh
+++ b/files/vm-provision.sh
@ -197,9 +197,8 @@ auth:


    # On lie le filesystem de kaz-prod dans le /kaz de la VM pour le dév
-    ln -s /var/lib/lxc/kaz-hoster-a-kaz1/rootfs/ /kaz1-prod
-    ln -s /var/lib/lxc/kaz-hoster-b-kaz2/rootfs/ /kaz2-prod
-    ln -s /kaz-prod1/kaz /kaz
+    ln -s /var/lib/lxc/kaz-hoster-a-kaz1/rootfs/ /kaz1
+    ln -s /var/lib/lxc/kaz-hoster-b-kaz2/rootfs/ /kaz2

    # On met le KAZGUARD pour la mise au point
    echo "export KAZGUARD='true'" >> /root/.bashrc