From 8d37de105bfecfad4756c46c3360d50287b46c93 Mon Sep 17 00:00:00 2001 From: Pierre-Olivier Mercier Date: Sun, 22 Oct 2023 13:09:06 +0200 Subject: [PATCH] Document fickit-deploy usage --- content/root/fickit-deploy.md | 53 +++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 content/root/fickit-deploy.md diff --git a/content/root/fickit-deploy.md b/content/root/fickit-deploy.md new file mode 100644 index 0000000..240e6a1 --- /dev/null +++ b/content/root/fickit-deploy.md @@ -0,0 +1,53 @@ +--- +date: 2023-10-22T10:04:12+02:00 +title: L'image fickit-deploy +weight: 20 +--- + +L'image `nemunaire/fickit-deploy` permet de démarrer en PXE les serveurs pour les installer initiallement (lorsque les disques sont vierges) et de mettre à jour les images. + +## Arborescence attendue + +L'image a besoin des derniers artifacts d'un build fickit réussi : + +``` +fickit-backend-squashfs.img +fickit-boot-initrd.img +fickit-boot-kernel +fickit-frontend-squashfs.img +fickit-prepare-initrd.img +fickit-update-initrd.img +``` + +Ainsi que des métadonnées du challenge. +Celles-ci peuvent être générées en utilisant le script `configs/gen_metadata.sh`. + + +## Usage + +1. Éteindre son pare-feu. +2. Lancer le conteneur : + +``` +docker run --network host -v $(pwd):/srv nemunaire/fickit-deploy +``` + +### Variables + +Le chemin `$(pwd)` doit correspondre au dossier où l'on trouve les artifacts et les métadonnées. + +Il est possible de changer le comportement de l'image avec les variables suivantes : + +- `PXE_IFACE` : nom de l'interface à utiliser (par défaut l'interface possédant la route par défaut) ; +- `DEPLOY_NETWORK` : préfixe de l'adresse IP à utiliser (par défaut `192.168.255`). + + +## Qu'est-ce que ça fait ? + +`fickit-deploy` est une image permettant de lancer : + +- un serveur DHCP sur 192.168.255.0/24 +- un serveur TFTP sur 192.168.255.2 +- un serveur HTTP sur 192.168.255.2 + +L'IP 192.168.255.2 est ajoutée automatiquement sur l'interface par défaut si elle n'est pas déjà configurée.