From bf27011cbf09a1f6937cb0f72a53345294db3db0 Mon Sep 17 00:00:00 2001 From: youness-adm Date: Mon, 27 Apr 2026 02:44:05 +0200 Subject: [PATCH] Ajouter docs/usage.md --- docs/usage.md | 203 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) create mode 100644 docs/usage.md diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..96d78a1 --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,203 @@ +# Guide d'utilisation + +## Workflow complet + +### Étape 1 — Machine INFRA : créer la VM + +```bash +cd ~/ephaitek-provisioning +./scripts/infra/deploy-vm.sh --vmid --name --vlan +``` + +**Exemple minimal (toutes valeurs par défaut) :** +```bash +./scripts/infra/deploy-vm.sh --vmid 1110 --name client1 --vlan 11 +``` + +Ce qui est créé : +- IP SVC : `10.11.0.10/24`, gateway `10.11.0.1` +- IP Admin : `10.100.0.11/24` (VLAN 100) +- Port SSH : `2211` +- CPU : 4 vCPU, RAM : 8 GB, Disque : 160 Go +- Mot de passe root et deployer : `Tyujkl46` + +--- + +### Étape 2 — Machine ADMIN : post-provisioning + +```bash +cd /root/admin_tools/post-provision/scripts/admin +export VM_ROOT_PASSWORD="Tyujkl46" +./run-all.sh --vmid --name --vlan +``` + +**Exemple :** +```bash +export VM_ROOT_PASSWORD="Tyujkl46" +./run-all.sh --vmid 1110 --name client1 --vlan 11 +``` + +--- + +## Options de deploy-vm.sh + +### Paramètres obligatoires + +| Paramètre | Description | +|-----------|-------------| +| `--vmid ` | ID de la VM dans Proxmox | +| `--name ` | Hostname court (ex: `web01`, `client1`) | +| `--vlan ` | VLAN ID — détermine tout l'adressage | + +### Personnalisation des ressources + +```bash +# VM avec plus de RAM et disque +./scripts/infra/deploy-vm.sh \ + --vmid 1110 --name client1 --vlan 11 \ + --memory 16384 \ + --disk 320 \ + --cores 8 + +# VM légère pour dev/test +./scripts/infra/deploy-vm.sh \ + --vmid 9001 --name devbox --vlan 88 \ + --cores 2 --memory 4096 --disk 80 +``` + +### Toutes les options + +| Option | Défaut | Description | +|--------|--------|-------------| +| `--cores ` | `4` | Nombre de vCPU | +| `--memory ` | `8192` (8GB) | RAM en MiB | +| `--disk ` | `160` | Taille disque en Go | +| `--ip ` | `10..0.10/24` | IP principale | +| `--gw ` | `10..0.1` | Passerelle | +| `--ssh-port ` | `22` | Port SSH | +| `--admin-ip ` | `10.100.0.` | IP réseau admin | +| `--dns ` | `8.8.8.8,1.1.1.1` | Serveurs DNS | +| `--template ` | `9000` | Template Proxmox | +| `--storage ` | `local-lvm` | Stockage Proxmox | +| `--bridge ` | `vmbr1` | Bridge réseau | +| `--force` | — | Détruire si VM existe | +| `--dry-run` | — | Simulation sans création | +| `--verbose` | — | Mode verbeux (`set -x`) | + +--- + +## Options de run-all.sh + +### Paramètres obligatoires + +Identiques à `deploy-vm.sh` : `--vmid`, `--name`, `--vlan`. + +### Options avancées + +| Option | Description | +|--------|-------------| +| `--from ` | Reprendre à partir de l'étape N | +| `--only ` | Exécuter uniquement l'étape N | +| `--dry-run` | Simulation sans modification | + +### Exemples + +```bash +# Lancement complet +./run-all.sh --vmid 1110 --name client1 --vlan 11 + +# Dry-run +./run-all.sh --vmid 1110 --name client1 --vlan 11 --dry-run + +# Reprendre après une erreur à l'étape 03 +./run-all.sh --vmid 1110 --name client1 --vlan 11 --from 03 + +# Rejouer uniquement SSSD +./run-all.sh --vmid 1110 --name client1 --vlan 11 --only 05 + +# Interface pfSense différente +./run-all.sh --vmid 1110 --name client1 --vlan 11 \ + --parent-if vtnet0 --wan-if wan +``` + +--- + +## Description des étapes + +### 01 — pfSense +**Cible :** `admin@10.11.0.1:2266` + +Crée sur pfSense via `expect` : +- Interface VLAN `vtnet1.` avec IP `10..0.1/24` +- Règles firewall : DNS (UDP+TCP) + WEB (80, 443) +- Reload complet via `php /etc/rc.reload_all` + +### 02 — DNS +**Cible :** `root@ns1.adm:2260` + +Via `expect` sur `dns1maj.sh` : +- `.svc.ephaitek.com` → `10..0.10` +- `.adm.ephaitek.com` → `10.100.0.` + +### 03 — PKI +**Cible :** `root@10.100.0.:` + +- Attend SSH de la VM (timeout 300s + 15s Cloud-Init) +- Copie `/root/admin_tools/pki/root.crt` vers le trust-store +- Exécute `update-ca-trust extract` + +### 04 — Split DNS +**Cible :** `root@10.100.0.:` + +- Génère un CSV temporaire et appelle `deploy-dns-keyv3.sh` +- Configure dnsmasq avec zones ADM/SVC +- Patch TTY : contourne le `read -s` du script + +### 05 — SSSD +**Cible :** `root@10.100.0.:` + +- Vérifie l'accès Internet avant `dnf` (3 essais) +- Installe `sssd`, `sssd-ldap`, `oddjob`, `oddjob-mkhomedir` +- Déploie `/etc/sssd/sssd.conf` (permissions `600`) +- Configure `authselect` avec profil `sssd with-mkhomedir` + +--- + +## Vérifications post-déploiement + +```bash +# Se connecter à la VM +ssh root@10.100.0. -p 22 + +# PKI — CA cert importé +trust list | grep -i ephaitek + +# PKI — TLS Vault fonctionnel +curl -s https://vault.adm.ephaitek.com:8200/v1/sys/health + +# DNS — résolution +dig +short .svc.ephaitek.com +dig +short .adm.ephaitek.com @127.0.0.1 + +# SSSD — utilisateurs LDAP +id youness-adm +getent passwd youness-adm +systemctl status sssd + +# Connexion SSH avec compte LDAP +ssh youness-adm@10.100.0. -p 22 +# mot de passe : Admin123! +# → home dir créé automatiquement +``` + +--- + +## Logs + +```bash +# Voir les logs en temps réel +tail -f /var/log/ephaitek/post-provision-*.log + +# Dernier log +ls -t /var/log/ephaitek/ | head -1 +``` \ No newline at end of file