f-80: doc: commandes, chemins et codes alignés sur le code, répertoire uefi, route reflectors, schémas régénérés #80

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
GnomeZworc 2026-10-23 13:48:15 +02:00
commit 48f12958cf
Signed by: nicolas.boufideline
GPG key ID: 4406BBBF8845D632
30 changed files with 271 additions and 190 deletions

View file

@ -48,9 +48,10 @@ Trois règles pour un appelant robuste :
borne les opérations qui attendent une transition ; l'appelant doit avoir sa propre borne.
* **Traiter ``error`` comme terminal, pas comme un échec transitoire.** Un ``Execute`` en échec
ne se rejoue pas tout seul.
* **Ne pas enchaîner sans vérifier.** Créer un subnet dont le VPC est encore en ``creating``
échoue en 422 ; démarrer une VM sur un subnet en ``creating`` ou ``running`` est en revanche
accepté.
* **Savoir ce qui s'enchaîne.** Créer un subnet dont le VPC est encore en ``creating``, ou
démarrer une VM sur un subnet en ``creating``, est accepté : l'``Execute`` attend que le parent
passe ``running``, dans la limite de ``dispatcher.timeout_seconds`` ; au-delà, la ressource passe
en ``error``. Le refus en 422 ne vaut que pour un parent absent, en ``error`` ou en ``deleting``.
Codes de retour
---------------
@ -66,15 +67,23 @@ Codes de retour
* - ``200``
- lecture réussie (``GET``)
* - ``400``
- champ obligatoire manquant, corps invalide, ``iface_type`` inconnu, base64 invalide
- champ obligatoire manquant, corps invalide, base64 invalide ; CIDR de VPC invalide,
``l3vni`` hors plage ; ``interface_ip`` absent (``bridge``, ``public_ip``) ou fourni
(``vxlan``) ; interface de VM sans ``mac``, nombre d'interfaces ``primary`` différent de 1
* - ``404``
- ressource inexistante
* - ``405``
- méthode non prise en charge ; corps ``{"error": "method not allowed"}``, mais servi en
``text/plain`` par ``/vpcs`` et ``/subnets`` (et leurs ``/{name}``), en JSON par ``/vms``
* - ``409``
- conflit d'existence ou d'état : ressource déjà créée, ou suppression depuis un état qui
ne l'autorise pas ; pour un VPC, subnets encore présents ; pour un subnet, VM non
supprimées qui l'utilisent encore
ne l'autorise pas ; pour un VPC, subnets encore présents, ``l3vni`` déjà utilisée par un
autre VPC, ou ``l3vni`` demandée sans section ``bgp`` ; pour un subnet, VM non supprimées
qui l'utilisent encore
* - ``422``
- dépendance absente ou pas prête : VPC parent d'un subnet, subnet d'une VM
- dépendance absente ou inutilisable : VPC parent d'un subnet, subnet d'une VM, absent, en
``error`` ou en ``deleting`` ; ``mode`` de subnet inconnu ; CIDR ``vxlan`` invalide ou plus
petit que ``/29`` ; IP de VM hors du CIDR du subnet ou réservée
* - ``500``
- erreur interne

View file

@ -173,7 +173,7 @@ Metadata et QEMU
qemu:
ovmf_code_path: "/usr/share/OVMF/OVMF_CODE.fd"
ovmf_vars_template: "/usr/share/OVMF/OVMF_VARS.fd"
uefi_vars_dir: "/run/two/vms/efi"
uefi_vars_dir: "/run/two/vms/uefi"
serial_dir: "/run/two/vms/serial"
monitor_dir: "/run/two/vms/monitor"
qmp_dir: "/run/two/vms/qmp"
@ -257,6 +257,7 @@ Watchdog
interval_seconds: 60
Vérification périodique **en lecture seule** — voir :doc:`/exploitation/observabilite`.
**Désactivée par défaut** (``enabled: false``) : sans cette section, aucun contrôle ne tourne.
Journalisation
--------------

View file

@ -49,7 +49,7 @@ Le DHCP est servi par une instance dédiée au subnet. Quelle unit selon ``dhcp.
# Ce qu'il enverrait à une MAC donnée, sans effet de bord
echo '{"verb":"probe","mac":"00:22:33:00:00:0A"}' \
| socat - UNIX-CONNECT:/run/two/dhcp/<netns>_<bridge>.sock | jq .lease
| socat - UNIX-CONNECT:/run/two/dhcp/<netns>_<bridge>.sock | jq '{served, lease}'
``probe`` est le point de départ le plus rapide : il montre l'adresse, le masque, le routeur, les
DNS et les routes classless tels qu'ils partiraient. Une réponse ``"served": false`` signifie que
@ -111,12 +111,14 @@ user-data. Vérification dans le guest :
cloud-init query instance-id
ls /var/lib/cloud/instances/
**2. Le serveur de metadata est injoignable.** Depuis le guest :
**2. Le serveur de metadata est injoignable.** Depuis le guest — le serveur ne sert que
``/meta-data``, ``/user-data``, ``/network-config`` et ``/vendor-data``, tout autre chemin
renvoie 404 :
.. code-block:: bash
ip route
curl -s http://169.254.169.254/latest/meta-data/
curl -s http://169.254.169.254/meta-data
La route ``169.254.169.254/32`` doit être présente, avec l'``interface_ip`` du subnet comme
next-hop. Si elle est absente ou pointe ailleurs, la DNAT posée en ``PREROUTING`` dans le netns
@ -133,8 +135,9 @@ Depuis l'host, l'instance correspondante :
Le user-data est servi vide
---------------------------
Un document fourni explicitement vide est servi vide — ce n'est pas la même chose qu'un document
absent, qui retombe sur le template. Vérifier le contenu réellement écrit :
C'est le comportement attendu quand ``user_data`` est absent ou vide à la création : les deux cas
sont équivalents, et aucun template ne prend le relais pour ``user-data``. Vérifier le contenu
réellement écrit :
.. code-block:: bash
@ -150,7 +153,7 @@ La VM ne démarre pas (UEFI)
.. code-block:: bash
ls -l /usr/share/OVMF/OVMF_CODE.fd /usr/share/OVMF/OVMF_VARS.fd
ls -l /run/two/vms/efi/
ls -l /run/two/vms/uefi/
Sur Debian et Ubuntu, le paquet est ``ovmf``.

View file

@ -27,7 +27,8 @@ Watchdog
--------
Une goroutine périodique vérifie que les ressources marquées ``running`` en base existent
toujours sur le système, et **notifie les écarts sans jamais réparer**.
toujours sur le système, et **notifie les écarts sans jamais réparer**. Il est **désactivé par
défaut** (``enabled: false``) ; l'activer explicitement :
.. code-block:: yaml
@ -72,17 +73,20 @@ Journaux
journalctl -u agent -f
journalctl -u 'metadata@i-web' -n 50
tail -f /var/log/dnsmasq-vp-admin_br-sn000001.log # backend dnsmasq
journalctl -fu 'dhcp@vp-admin_br-sn000001' # backend two
tail -f /var/log/dnsmasq-vp-admin_br-000001.log # backend dnsmasq
journalctl -fu 'dhcp@vp-admin_br-000001' # backend two
Inspection de la base
---------------------
En ligne de commande, sur l'host :
En ligne de commande, sur l'host. Le binaire ``db`` n'est **ni publié dans les releases ni
déployé** par ``deploy.sh`` : il se compile depuis les sources, puis se copie sur l'host. Sans
sous-commande, il n'affiche que son usage ; ``print`` liste toute la base :
.. code-block:: bash
/opt/two/bin/db -conf /etc/two/agent.yml
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o db ./cmd/db
./db -conf /etc/two/agent.yml print
.. warning::

View file

@ -1,7 +1,8 @@
Services systemd
================
Quatre units, installées sous ``/opt/two/bin`` par ``deploy.sh``. Les deux units DHCP
Quatre units, installées dans ``/etc/systemd/system`` par ``deploy.sh`` ; les binaires et scripts
qu'elles lancent sont sous ``/opt/two/bin``. Les deux units DHCP
s'excluent : celle qui tourne dépend de ``dhcp.backend`` (voir :doc:`configuration`).
.. list-table::
@ -30,8 +31,8 @@ n'y a pas à les démarrer à la main en fonctionnement normal.
.. code-block:: bash
systemctl status agent
systemctl status 'dnsmasq@vp-admin_br-sn000001' # backend dnsmasq
systemctl status 'dhcp@vp-admin_br-sn000001' # backend two
systemctl status 'dnsmasq@vp-admin_br-000001' # backend dnsmasq
systemctl status 'dhcp@vp-admin_br-000001' # backend two
systemctl status 'metadata@i-web'
dnsmasq
@ -65,9 +66,9 @@ ignore le netns dans lequel il tourne :
.. code-block:: bash
/opt/two/bin/dhcp -conf /etc/two/agent.yml \
-interface br-sn000001 \
-state /run/two/dhcp/vp-admin_br-sn000001.state \
-socket /run/two/dhcp/vp-admin_br-sn000001.sock
-interface br-000001 \
-state /run/two/dhcp/vp-admin_br-000001.state \
-socket /run/two/dhcp/vp-admin_br-000001.sock
.. list-table::
:widths: 40 60