diff --git a/doc/gitlab-markdown.gpp b/doc/gitlab-markdown.gpp index 055a81d3e0d9ed71d7a504834c44c5b01986608f..1af2eef4f4c6d0f477e91c8746673c4b5a6102d8 100644 --- a/doc/gitlab-markdown.gpp +++ b/doc/gitlab-markdown.gpp @@ -22,7 +22,8 @@ !!define{!!listoftables}{} -!!define{!!newpage}{} +!!define{!!newpage}{ +} !!define{!!chapterwithoutnumber{name}}{# !!name} @@ -30,4 +31,6 @@ - **!!short**: !!description } -!!define{!!acronym{short}}{<abbr title="!!exec{cat acronyms.md | sed -n 's/^- \*\*!!short\*\*\: //p' | pandoc --from=markdown --to=plain | tr '\n' ' '}">!!short</abbr>} +!!define{!!acronymdescription{short}}{!!exec{cat acronyms.md | sed -n 's/^- \*\*!!short\*\*\: //p' | pandoc --from=markdown --to=plain | tr '\n' ' '}} + +!!define{!!acronym{short}}{!!defeval{tmp_acronymdescription}{!!acronymdescription{!!short}}!!ifeq{!!tmp_acronymdescription}{}!!warning{No definition found for acronym '!!short'}!!endif<abbr title="!!tmp_acronymdescription">!!short</abbr>} diff --git a/doc/markdown.gpp b/doc/markdown.gpp index c6a9fa224a309dfb30342b739b7b18098fa671f5..cc72c61dfd3958ac90fbb82c52f73f16d69ff2e7 100644 --- a/doc/markdown.gpp +++ b/doc/markdown.gpp @@ -14,12 +14,12 @@ !!define{!!initacronyms}{!!defeval{tmp}{!!exec{echo '!!chapterwithoutnumber{Liste des acronymes}' > ./acronyms.md}}!!tmp} -!!define{!!defacronym{short}{description}}{!!defeval{tmp}{!!exec{FS='' echo "$(cat <<'EOF-DEFACRONYM-GPP-MACRO' +!!define{!!defacronym{short}{description}}{!!defeval{tmp_defacronym}{!!exec{FS='' echo "$(cat <<'EOF-DEFACRONYM-GPP-MACRO' !!acronymdefinition{!!short}{!!description} EOF-DEFACRONYM-GPP-MACRO -)" >> ./acronyms.md}}!!tmp} +)" >> ./acronyms.md}}!!tmp_defacronym} -!!define{!!listofacronyms}{!!defeval{tmp}{!!includemd{acronyms.md}}!!tmp} +!!define{!!listofacronyms}{!!defeval{tmp_listofacronyms}{!!includemd{acronyms.md}}!!tmp_listofacronyms} !!define{!!comment}{} diff --git a/doc/rapport.gpp.md b/doc/rapport.gpp.md index 39a10fb23677e048353ce9b87b93bdacbc12c751..d46508becfcde08cb7a75646d08361bb2308e755 100644 --- a/doc/rapport.gpp.md +++ b/doc/rapport.gpp.md @@ -16,10 +16,11 @@ author: | Professeur référent: Florent Gluck date: | Aout 2020 -geometry: margin=2.5cm +geometry: margin=2.5cm,includefoot,includehead papersize: a4 numbersections: true -monofont: JetBrains Mono +mainfont: lmroman12-regular.otf +monofont: lmmono12-regular.otf output: pdf_document linkcolor: cyan header-includes: | @@ -49,8 +50,6 @@ header-includes: | \setlength{\parindent}{0pt} \setlength{\parskip}{9pt} - - \floatplacement{figure}{H} \OnehalfSpacing abstract: | @@ -62,7 +61,6 @@ abstract: | !!endif !!initacronyms - !!defacronym{EFI}{_Extensible Firmware Interface_: interface micrologicielle extensible unifiée} !!defacronym{GPT}{_GUID Partition Table_: table de partitionnement GUID} !!defacronym{HEPIA}{Haute école du paysage, d'ingénierie et d'architecture de Genève} @@ -73,6 +71,12 @@ abstract: | !!defacronym{PXE}{_Pre-boot eXecution Environment_: environnement d'exécution pré-démarrage} !!defacronym{MBR}{_Master Boot Record_: enregistrement d'amorcage maître} !!defacronym{GRUB}{_GRand Unified Bootloader} +!!defacronym{BIOS}{_Basic Input Output System_} +!!defacronym{UEFI}{_Unified Extensible Firmware Interface_: interface micrologicielle extensible unifiée} +!!defacronym{DHCP}{_Dynamic Host Configuration Protocol_: protocole de configuration dynamique des hôtes } +!!defacronym{TFTP}{_Trivial File Transfer Protocol_: protocole simplifié de transfert de fichiers} +!!defacronym{NFS}{_Network File System_: système de fichiers en réseau} +!!defacronym{NAT}{_Network Address Translation_: traduction d'adresse réseau} !!tableofcontents !!newpage @@ -359,14 +363,14 @@ d'effectuer ces actions: La figure !!ref{diagram_components} est un diagramme qui détaille les différents composants et leurs interactions. -!!svgref{diagram_components}{Composants du système}{images/diagram_components} +!!svgref{diagram_components}{Diagramme des composants du système}{images/diagram_components} ## Processus de déploiement initial **TODO: décrire pas à pas les différentes étapes du processus de déploiement telles que montrées sur le diagramme.** -Les différentes étapes du processus de déploiement d'images sont décites +Les différentes étapes du processus de déploiement d'images sont décrites dans la figure !!ref{diagram_activity_deployment} qui est un diagrame d'activité détaillant les différentes étapes du processus de déploiement d'images. @@ -403,7 +407,7 @@ virtuelles ont été ratachées aux interfaces de la machine hôte de la manière suivante: 1. L'interface `eth0` de la machine virtuelle est ratachée à l'interface - `wlan0` de la machine hôte en utilisant le mode `NAT`. + `wlan0` de la machine hôte en utilisant le mode !!acronym{NAT}. 2. L'interface `eth1` de la machine virtuelle est ratachée à l'interface `eth0` de la machine hôte en utilisant le mode `bridged`. @@ -414,6 +418,10 @@ configuration réseau décrite ci-dessus. ## Mise en opération du projet initial +La mise en fonctionnement du système à partir de la +documentation et des fichiers du dépôt git a été fastidieuse pour +plusieurs raisons. Premièrement, + **TODO: expliquer comment le projet initial a été remis en fonctionnement. Expliquer le fait qu'il s'agisse de fichiers de configuration répartis dans des dossiers et les difficultés rencontrées diff --git a/doc/rapport.md b/doc/rapport.md index 957b150b3fc74a26108c80cafcfe7b8386ed4ae1..e3d72d34f28228066dc2f2356788152dac243efd 100644 --- a/doc/rapport.md +++ b/doc/rapport.md @@ -3,6 +3,7 @@ [[_TOC_]] + # Liste des acronymes - **EFI**: _Extensible Firmware Interface_: interface micrologicielle extensible unifiée @@ -25,6 +26,20 @@ - **GRUB**: _GRand Unified Bootloader +- **BIOS**: _Basic Input Output System_ + +- **UEFI**: _Unified Extensible Firmware Interface_: interface micrologicielle extensible unifiée + +- **DHCP**: _Dynamic Host Configuration Protocol_: protocole de configuration dynamique des hôtes + +- **TFTP**: _Trivial File Transfer Protocol_: protocole simplifié de transfert de fichiers + +- **NFS**: _Network File System_: système de fichiers en réseau + +- **NAT**: _Network Address Translation_: traduction d'adresse réseau + + + @@ -178,7 +193,7 @@ Les postes clients supportés par le système sont des ordinateurs compatibles <abbr title="Personal Computer: ordinateur personnel ">PC</abbr> x86. Ils doivent nécessairement être équipés d'une carte réseau et d'un -micrologiciel <abbr title=" ">BIOS</abbr> ou <abbr title=" ">UEFI</abbr> capables et configurés +micrologiciel <abbr title="Basic Input Output System ">BIOS</abbr> ou <abbr title="Unified Extensible Firmware Interface: interface micrologicielle extensible unifiée ">UEFI</abbr> capables et configurés pour amorcer un système d'exploitation à partir du réseau à chaque démarrage en utilisant le standard <abbr title="Pre-boot eXecution Environment: environnement d’exécution pré-démarrage ">PXE</abbr>. @@ -286,12 +301,12 @@ actions: Trois protocoles réseau standard sont utilisés pour permettre au client d'effectuer ces actions: -- <abbr title=" ">DHCP</abbr>: fournit aux clients initiant un démarrage sur le +- <abbr title="Dynamic Host Configuration Protocol: protocole de configuration dynamique des hôtes ">DHCP</abbr>: fournit aux clients initiant un démarrage sur le réseau une configuration IP, et l'adresse d'un serveur TFTP et le nom du fichier exécutable du chargeur d'amorçage à récupérer sur ce dernier -- <abbr title=" ">TFTP</abbr>: permet au clients de télécharger: +- <abbr title="Trivial File Transfer Protocol: protocole simplifié de transfert de fichiers ">TFTP</abbr>: permet au clients de télécharger: - le fichier exécutable du chargeur d'amorçage - la configuration du chargeur d'amorçage - les modules optionels du chargeur d'amorçage, téléchargés selon la @@ -301,7 +316,7 @@ d'effectuer ces actions: - le noyeau linux de l'OS de déploiement - l'image du système de fichier racine de l'OS de déploiement -- <abbr title=" ">NFS</abbr>: permet au système linux de monter un partage distant +- <abbr title="Network File System: système de fichiers en réseau ">NFS</abbr>: permet au système linux de monter un partage distant qui contient: - les scripts permettant d'effectuer le déploiement automatique - un dossier contenant les images et leurs métadonnées @@ -316,8 +331,8 @@ différents composants et leurs interactions. <figure> <a name="diagram_components"/> - -<figcaption>Composants du système</figcaption> + +<figcaption>Diagramme des composants du système</figcaption> </figure> @@ -326,7 +341,7 @@ différents composants et leurs interactions. **TODO: décrire pas à pas les différentes étapes du processus de déploiement telles que montrées sur le diagramme.** -Les différentes étapes du processus de déploiement d'images sont décites +Les différentes étapes du processus de déploiement d'images sont décrites dans la figure  qui est un diagrame d'activité détaillant les différentes étapes du processus de déploiement d'images. @@ -369,7 +384,7 @@ virtuelles ont été ratachées aux interfaces de la machine hôte de la manière suivante: 1. L'interface `eth0` de la machine virtuelle est ratachée à l'interface - `wlan0` de la machine hôte en utilisant le mode `NAT`. + `wlan0` de la machine hôte en utilisant le mode <abbr title="Network Address Translation: traduction d’adresse réseau ">NAT</abbr>. 2. L'interface `eth1` de la machine virtuelle est ratachée à l'interface `eth0` de la machine hôte en utilisant le mode `bridged`. @@ -386,6 +401,10 @@ configuration réseau décrite ci-dessus. ## Mise en opération du projet initial +La mise en fonctionnement du système à partir de la +documentation et des fichiers du dépôt git a été fastidieuse pour +plusieurs raisons. Premièrement, + **TODO: expliquer comment le projet initial a été remis en fonctionnement. Expliquer le fait qu'il s'agisse de fichiers de configuration répartis dans des dossiers et les difficultés rencontrées diff --git a/doc/rapport.pdf b/doc/rapport.pdf index f9a76930701053b8bdfeeafe9ce6c424191ccb06..4457ea7880e439087fb7c08a5e33891e7b342aad 100644 Binary files a/doc/rapport.pdf and b/doc/rapport.pdf differ