Relecture du fichier working in isolation
This commit is contained in:
Gregory Trullemans
parent
d0dc086e93
commit
b0b4c36712
|
|
@ -1,7 +1,8 @@
|
|||
|
||||
\chapter{Travailler en isolation}
|
||||
|
||||
Nous allons aborder la gestion et l'isolation des dépendances. Cette section est aussi utile pour une personne travaillant seule, que pour transmettre les connaissances à un nouveau membre de l'équipe ou pour déployer l'application elle-même.
|
||||
Nous allons aborder la gestion et l'isolation des dépendances.
|
||||
Cette section est aussi utile pour une personne travaillant seule, que pour transmettre les connaissances à un nouveau membre de l'équipe ou pour déployer l'application elle-même.
|
||||
|
||||
Il en était déjà question au deuxième point des 12 facteurs : même dans le cas de petits projets, il est déconseillé de s'en passer.
|
||||
Cela évite les déploiements effectués à l'arrache à grand renfort de \texttt{sudo} et d'installation globale de dépendances, pouvant potentiellement occasioner des conflits entre les applications déployées :
|
||||
|
|
@ -10,7 +11,7 @@ Cela évite les déploiements effectués à l'arrache à grand renfort de \textt
|
|||
\item
|
||||
Il est tout à fait envisagable que deux applications différentes soient déployées sur un même hôte, et nécessitent chacune deux versions différentes d'une même dépendance.
|
||||
\item
|
||||
Pour la reproductibilité d'un environnement spécifique, cela évite notamment les réponses type "Ca marche chez moi", puisque la construction du nouvel environnement fait partie intégrante du processus de développement et de la documentation du projet; grâce à elle, nous avons la possibilité de construire un environnement sain et d'appliquer des dépendances identiques, quelle que soit l'hôte destiné à accueillir le déploiment.
|
||||
Pour la reproductibilité d'un environnement spécifique, cela évite notamment les réponses type \textit{"Ca marche chez moi"}, puisque la construction du nouvel environnement fait partie intégrante du processus de développement et de la documentation du projet ; grâce à elle, nous avons la possibilité de construire un environnement sain et d'appliquer des dépendances identiques, quelle que soit l'hôte destiné à accueillir le déploiment.
|
||||
\end{enumerate}
|
||||
|
||||
\begin{figure}
|
||||
|
|
@ -23,7 +24,7 @@ Cela évite les déploiements effectués à l'arrache à grand renfort de \textt
|
|||
|
||||
\begin{figure}
|
||||
\centering
|
||||
\includegraphics{images/xkcd-1987.png}
|
||||
\includegraphics[scale=0.8]{images/xkcd-1987.png}
|
||||
\caption{\url{https://xkcd.com/1987}}
|
||||
\end{figure}
|
||||
|
||||
|
|
@ -34,10 +35,8 @@ Nous pensons notamment aux environnements virtuels : ils sont géniaux à utilis
|
|||
Pour créer un nouvel environnement, vous aurez donc besoin :
|
||||
|
||||
\begin{enumerate}
|
||||
\item
|
||||
D'une installation de Python - \url{https://www.python.org/}
|
||||
\item
|
||||
D'un terminal - voir le point \href{../environment/_index.xml\#un-terminal}{Un terminal}
|
||||
\item D'une installation de Python - \url{https://www.python.org/}
|
||||
\item D'un terminal - voir le point \href{../environment/_index.xml\#un-terminal}{Un terminal}
|
||||
\end{enumerate}
|
||||
|
||||
|
||||
|
|
@ -69,14 +68,10 @@ TOML (du nom de son géniteur, Tom Preston-Werner, légèrement CEO de GitHub à
|
|||
Ceci signifie que nous avons directement (et de manière standard):
|
||||
|
||||
\begin{itemize}
|
||||
\item
|
||||
Un répertoire django-gecko, qui porte le nom de l'application que vous venez de créer
|
||||
\item
|
||||
Un répertoires tests, libellé selon les standards de pytest
|
||||
\item
|
||||
Un fichier README.rst (qui ne contient encore rien)
|
||||
\item
|
||||
Un fichier pyproject.toml, qui contient ceci:
|
||||
\item Un répertoire django-gecko, qui porte le nom de l'application que vous venez de créer
|
||||
\item Un répertoires tests, libellé selon les standards de pytest
|
||||
\item Un fichier README.rst (qui ne contient encore rien)
|
||||
\item Un fichier pyproject.toml, qui contient ceci :
|
||||
\end{itemize}
|
||||
|
||||
\begin{verbatim}
|
||||
|
|
@ -130,8 +125,7 @@ Votre environnement virtuel est prêt, il n'y a plus qu'à indiquer que nous sou
|
|||
|
||||
A présent que l'environnement est activé, tous les binaires de cet environnement prendront le pas sur les binaires du système.
|
||||
De la même manière, une variable \texttt{PATH} propre est définie et utilisée, afin que les librairies Python y soient stockées.
|
||||
C'est donc dans cet environnement virtuel que nous retrouverons le code source de Django, ainsi que des librairies externes pour Python une fois que nous les
|
||||
aurons installées.
|
||||
C'est donc dans cet environnement virtuel que nous retrouverons le code source de Django, ainsi que des librairies externes pour Python une fois que nous les aurons installées.
|
||||
|
||||
Pour les curieux, un environnement virtuel n'est jamais qu'un répertoire dans lequel se trouve une installation fraîche de l'interpréteur, vers laquelle pointe les liens symboliques des binaires.
|
||||
Si vous recherchez l'emplacement de l'interpréteur avec la commande \texttt{which\ python}, vous recevrez comme réponse \texttt{/home/fred/.venvs/gwift-env/bin/python}.
|
||||
|
|
@ -141,13 +135,13 @@ Si vous pensez ne plus en avoir besoin, supprimer le dossier.
|
|||
Si nécessaire, il suffira d'en créer un nouveau.
|
||||
|
||||
Pour gérer des versions différentes d'une même librairie, il nous suffit de jongler avec autant d'environnements que nécessaires.
|
||||
Une application nécessite une version de Django inférieure à la 2.0 ? On crée un environnement, on l'active et on installe ce qu'il faut.
|
||||
Une application nécessite une version de Django inférieure à la 2.0 ?
|
||||
On crée un environnement, on l'active et on installe ce qu'il faut.
|
||||
|
||||
Cette technique fonctionnera autant pour un poste de développement que sur les serveurs destinés à recevoir notre application.
|
||||
|
||||
Par la suite, nous considérerons que l'environnement virtuel est toujours activé, même si \texttt{gwift-env} n'est pas indiqué.
|
||||
|
||||
a manière recommandée pour la gestion des dépendances consiste à les épingler dans un fichier requirements.txt, placé à la racine du projet.
|
||||
La manière recommandée pour la gestion des dépendances consiste à les épingler dans un fichier \textit{requirements.txt}, placé à la racine du projet.
|
||||
Ce fichier reprend, ligne par ligne, chaque dépendance et la version nécessaire.
|
||||
Cet épinglage est cependant relativement basique, dans la mesure où les opérateurs disponibles sont ==, et \textgreater=.
|
||||
|
||||
|
|
@ -160,13 +154,11 @@ Les contraintes qui peuvent être appliquées aux dépendances sont plus touffue
|
|||
...
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
L'avantage est donc que l'on spécifie une version majeure - mineure - patchée, et que l'on pourra spécifier accepter toute mise à jour jusqu'à la prochaine version majeure - mineure patchée (non incluse).
|
||||
|
||||
Une bonne pratique consiste également, tout comme pour npm, à intégrer le fichier de lock (poetry.lock) dans le dépôt de sources : de cette manière, seules les dépendances testées (et intégrées) seront considérées sur tous les environnements de déploiement.
|
||||
|
||||
Il est alors nécessaire de passer par une action manuelle (poetry update) pour mettre à jour le fichier de verrou, et assurer une mise à jour en sécurité (seules les dépendances testées sont prises en compte)
|
||||
et de qualité (tous les environnements utilisent la même version d'une dépendance).
|
||||
Il est alors nécessaire de passer par une action manuelle (poetry update) pour mettre à jour le fichier de verrou, et assurer une mise à jour en sécurité (seules les dépendances testées sont prises en compte) et de qualité (tous les environnements utilisent la même version d'une dépendance).
|
||||
|
||||
L'ajout d'une nouvelle dépendance à un projet se réalise grâce à la commande \texttt{poetry\ add\ \textless{}dep\textgreater{}}:
|
||||
|
||||
|
|
@ -205,8 +197,7 @@ Django = "^3.2.3"
|
|||
\end{verbatim}
|
||||
|
||||
Et contrairement à \texttt{pip}, pas besoin de savoir s'il faut pointer vers un fichier (\texttt{-r}) ou un dépôt VCS (\texttt{-e}), puisque Poetry va tout essayer, {[}dans un certain ordre{]}(\url{https://python-poetry.org/docs/cli/\#add}).
|
||||
L'avantage également (et cela m'arrive encore souvent, ce qui fait hurler le runner de Gitlab), c'est qu'il n'est plus nécessaire de penser à épingler la dépendance que l'on vient d'installer parmi les fichiers de
|
||||
requirements, puisqu'elles s'y ajoutent automatiquement grâce à la commande \texttt{add}.
|
||||
L'avantage également (et cela m'arrive encore souvent, ce qui fait hurler le runner de Gitlab), c'est qu'il n'est plus nécessaire de penser à épingler la dépendance que l'on vient d'installer parmi les fichiers de requirements, puisqu'elles s'y ajoutent automatiquement grâce à la commande \texttt{add}.
|
||||
|
||||
\subsubsection{Python Packaging Made Easy}
|
||||
|
||||
|
|
@ -217,11 +208,10 @@ Ceci dit, Poetry propose un ensemble de règles et une préconfiguration qui (do
|
|||
Les chapitres 7 et 8 de {[}Expert Python Programming - Third Edtion{]}(\#), écrit par Michal Jaworski et Tarek Ziadé en parlent très bien :
|
||||
|
||||
\begin{quote}
|
||||
Python packaging can be a bit overwhelming at first. The main reason for
|
||||
that is the confusion about proper tools for creating Python packages.
|
||||
Anyway, once you create your first package, you will se that this is as
|
||||
hard as it looks. Also, knowing propre, state-of-the-art packaging helps
|
||||
a lot.
|
||||
Python packaging can be a bit overwhelming at first.
|
||||
The main reason for that is the confusion about proper tools for creating Python packages.
|
||||
Anyway, once you create your first package, you will se that this is as hard as it looks.
|
||||
Also, knowing propre, state-of-the-art packaging helps a lot.
|
||||
\end{quote}
|
||||
|
||||
En gros, c'est ardu-au-début-mais-plus-trop-après.
|
||||
|
|
@ -230,12 +220,9 @@ Et c'est heureusement suivi et documenté par la PyPA (\textbf{\href{https://git
|
|||
Les étapes sont les suivantes :
|
||||
|
||||
\begin{enumerate}
|
||||
\item
|
||||
Utiliser setuptools pour définir les projets et créer les distributions sources,
|
||||
\item
|
||||
Utiliser \textbf{wheels} pour créer les paquets,
|
||||
\item
|
||||
Passer par \textbf{twine} pour envoyer ces paquets vers PyPI
|
||||
\item Utiliser setuptools pour définir les projets et créer les distributions sources,
|
||||
\item Utiliser \textbf{wheels} pour créer les paquets,
|
||||
\item Passer par \textbf{twine} pour envoyer ces paquets vers PyPI
|
||||
\item
|
||||
Définir un ensemble d'actions (voire, de plugins nécessaires - lien avec le VCS, etc.) dans le fichier \texttt{setup.py}, et définir les propriétés du projet ou de la librairie dans le fichier \texttt{setup.cfg}.
|
||||
\end{enumerate}
|
||||
|
|
@ -258,25 +245,19 @@ dist/
|
|||
0 directories, 2 files
|
||||
\end{verbatim}
|
||||
|
||||
Ce qui est quand même 'achement plus simple que d'appréhender tout un
|
||||
écosystème.
|
||||
Ce qui est quand même 'achement plus simple que d'appréhender tout un écosystème.
|
||||
|
||||
\section{Un système de virtualisation}
|
||||
|
||||
Par "\emph{système de virtualisation}", nous entendons n'importe quel application, système d'exploitation, système de containeurisation, ... qui permette de créer ou recréer un environnement de développement aussi proche que celui en production.
|
||||
Par "\emph{système de virtualisation}", nous entendons n'importe quel application, système d'exploitation, système de containeurisation, \ldots~ qui permette de créer ou recréer un environnement de développement aussi proche que celui en production.
|
||||
Les solutions sont nombreuses :
|
||||
|
||||
\begin{itemize}
|
||||
\item
|
||||
\href{https://www.virtualbox.org/}{VirtualBox}
|
||||
\item
|
||||
\href{https://www.vagrantup.com/}{Vagrant}
|
||||
\item
|
||||
\href{https://www.docker.com/}{Docker}
|
||||
\item
|
||||
\href{https://linuxcontainers.org/lxc/}{Linux Containers (LXC)}
|
||||
\item
|
||||
\href{https://docs.microsoft.com/fr-fr/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v}{Hyper-V}
|
||||
\item \href{https://www.virtualbox.org/}{VirtualBox}
|
||||
\item \href{https://www.vagrantup.com/}{Vagrant}
|
||||
\item \href{https://www.docker.com/}{Docker}
|
||||
\item \href{https://linuxcontainers.org/lxc/}{Linux Containers (LXC)}
|
||||
\item \href{https://docs.microsoft.com/fr-fr/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v}{Hyper-V}
|
||||
\end{itemize}
|
||||
|
||||
Ces quelques propositions se situent un cran plus loin que la "simple" isolation d'un environnement, puisqu'elles vous permettront de construire un environnement complet.
|
||||
|
|
@ -289,11 +270,8 @@ Dans la suite, nous détaillerons Vagrant et Docker, qui constituent deux soluti
|
|||
Vagrant consiste en un outil de création et de gestion d'environnements virtualisés, en respectant toujours une même manière de travailler, indépendamment des choix techniques et de l'infrastructure que vous pourriez sélectionner.
|
||||
|
||||
\begin{quote}
|
||||
Vagrant is a tool for building and managing virtual machine environments
|
||||
in a single workflow. With an easy-to-use workflow and focus on
|
||||
automation, Vagrant lowers development environment setup time, increases
|
||||
production parity, and makes the "works on my machine" excuse a relic of
|
||||
the past. \footnote{\url{https://www.vagrantup.com/intro}}
|
||||
Vagrant is a tool for building and managing virtual machine environments in a single workflow.
|
||||
With an easy-to-use workflow and focus on automation, Vagrant lowers development environment setup time, increases production parity, and makes the "works on my machine" excuse a relic of the past. \footnote{\url{https://www.vagrantup.com/intro}}
|
||||
\end{quote}
|
||||
|
||||
La partie la plus importante de la configuration de Vagrant pour votre projet consiste à placer un fichier \texttt{Vagrantfile} - \emph{a priori} à la racine de votre projet - et qui contiendra les information suivantes :
|
||||
|
|
@ -305,10 +283,8 @@ La partie la plus importante de la configuration de Vagrant pour votre projet co
|
|||
Une \emph{box}, qui consiste à lui indiquer le type et la version attendue du système virtualisé (Debian 10, Ubuntu 20.04, etc. - et \href{https://app.vagrantup.com/boxes/search}{il y a du choix}).
|
||||
\item
|
||||
La manière dont la fourniture (\textbf{provisioning}) de l'environnement doit être réalisée : scripts Shell, fichiers, Ansible, Puppet, Chef, \ldots\hspace{0pt} Choisissez votre favori :-) même s'il est toujours possible de passer par une installation et une maintenance manuelle, après s'être connecté sur la machine.
|
||||
\item
|
||||
Si un espace de stockage doit être partagé entre la machine virtuelle et l'hôte
|
||||
\item
|
||||
Les ports qui doivent être transmis de la machine virtuelle vers l'hôte.
|
||||
\item Si un espace de stockage doit être partagé entre la machine virtuelle et l'hôte
|
||||
\item Les ports qui doivent être transmis de la machine virtuelle vers l'hôte.
|
||||
\end{itemize}
|
||||
|
||||
La syntaxe de ce fichier \texttt{Vagrantfile} est en \href{https://www.ruby-lang.org/en/}{Ruby}.
|
||||
|
|
@ -341,8 +317,7 @@ Vous trouverez ci-dessous un exemple, généré (et nettoyé) après avoir exéc
|
|||
Dans le fichier ci-dessus, nous créons :
|
||||
|
||||
\begin{itemize}
|
||||
\item
|
||||
Une nouvelle machine virtuelle (ie. \emph{invitée}) sous Ubuntu Bionic Beaver, en x64
|
||||
\item Une nouvelle machine virtuelle (i.e. \emph{invitée}) sous Ubuntu Bionic Beaver, en x64
|
||||
\item
|
||||
Avec une correspondance du port \texttt{80} de la machine vers le port \texttt{8080} de l'hôte, en limitant l'accès à celui-ci - accédez à \texttt{localhost:8080} et vous accéderez au port \texttt{80} de la machine virtuelle.
|
||||
\item
|
||||
|
|
@ -351,7 +326,7 @@ Dans le fichier ci-dessus, nous créons:
|
|||
Et pour finir, nous voulons appliquer un script de mise à jour \texttt{apt-get\ update} et installer le paquet \texttt{nginx}
|
||||
\end{itemize}
|
||||
|
||||
Par défaut, le répertoire courant (ie. le répertoire dans lequel notre fichier \texttt{Vagrantfile} se trouve) sera synchronisé dans le répertoire \texttt{/vagrant} sur la machine invitée.
|
||||
Par défaut, le répertoire courant (i.e. le répertoire dans lequel notre fichier \texttt{Vagrantfile} se trouve) sera synchronisé dans le répertoire \texttt{/vagrant} sur la machine invitée.
|
||||
|
||||
\subsection{Docker}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue