Développer une application web avec Vue.js et Vue CLI, déploiement avec Docker (partie 3)

L’objectif de cet article en plusieurs parties est de vous présenter le framework web JavaScript Vue.js en se focalisant sur les principaux concepts au travers d’un exemple unique.

Les différentes parties de cet article sont détaillées ci-dessous :

Lors de l’écriture de l’article, nous avons utilisé la version 2 de Vue.js et la version 3 de Vue CLI.

Cette troisième partie s’intéresse aux problématiques de déploiement d’une application Vue.js en utilisant massivement la brique technologique Docker pour créer des conteneurs.

Le plan est le suivant :

  • construction d’images Docker des différents composants (Java et Vue.js) ;
  • création de conteneurs Docker ;
  • gestion d’un déploiement avec un sous-chemin ;
  • tester l’application PollDLE.

Les codes source pour les exercices sont disponibles sur le dépôt Git suivant : https://github.com/mickaelbaron/vuejs-polldle-tutorial-src (pour récupérer le code, faire : git clone <https://github.com/mickaelbaron/vuejs-polldle-tutorial-src>).

Architecture de déploiement

Dans la deuxième partie de cet article, nous avions détaillé que l’application PollDLE se composait d’une couche cliente développée en Vue.js et d’une couche serveur développée en Java. Nous allons maintenant nous intéresser au déploiement de l’application dans sa globalité pour une mise en production. Au sens production, nous entendons un déploiement sur un serveur et qui sera à l’écoute de requêtes HTTP pour répondre via des réponses HTTP adaptées (changement de composant et appel de services web REST).

Nous illustrons sur la figure ci-dessous, les composants de l’application PollDLE et leurs interactions (requêtes HTTP, isolation via un sous-réseau et reverse-proxy).

Schéma de déploiement

Les deux couches client et serveur se retrouvent respectivement sur les serveurs appelés Back-end et Front-end (situés sur la partie droite du schéma). Un serveur appelé Reverse-Proxy (situé au milieu du schéma) se chargera de répondre aux sollicitations du client (situé sur la partie gauche du schéma). Ainsi, si l’URL est de la forme http://polldle.com/, le Reverse-Proxy redirigera les requêtes vers le serveur Front-end afin de télécharger le contenu statique développé avec Vue.js. Au contraire, si l’URL est de la forme http://polldle.com/server, le Reverse-Proxy redirigera les requêtes vers le serveur Back-end afin d’invoquer les services web REST développés avec Java.

À vrai dire, nous n’allons pas utiliser de serveurs physiques dédiés pour les différents composants de l’architecture présentée ci-dessus. Nous utiliserons des conteneurs par l’intermédiaire de Docker pour faciliter l’isolation de ces composants. Ainsi, les rectangles en pointillé mi-long (couleur rouge) entourant les composants précisent que chaque composant sera créé par des conteneurs Docker. Par ailleurs, le rectangle en pointillé long (couleur bleue) nommé polldlenetwork est un sous-réseau Docker qui permettra de restreindre les accès aux conteneurs créés. Le conteneur polldle-rp en charge du Reverse-Proxy pourra donc accéder aux conteneurs polldle-backend et polldle-frontend en utilisant leur nom de domaine du sous-réseau à savoir http://backend:9991 et http://frontend. Tout conteneur n’appartenant pas à ce sous-réseau polldlenetwork ne pourra pas communiquer avec les conteneurs de l’application PollDLE.

Enfin, Docker sera aussi utilisé pour construire les binaires de la couche client et de la couche serveur. Lors de l’élaboration des images Docker des trois composants (client, serveur et reverse-proxy) de notre architecture, les entrées correspondront aux codes source Java et Vue.js. L’avantage sera d’éviter d’installer les outils (Java, Maven et npm) sur son poste de travail pour construire les binaires.

Dans la suite, comme vous avez pu le lire, nous allons utiliser Docker pour construire des images et créer des conteneurs. Nous verrons aussi comment mettre en œuvre un Reverse-Proxy.

Nous supposons pour les prochaines expérimentations que vous avez installé Docker. Si ce n’est pas le cas, nous vous encourageons à consulter la documentation officielle : https://docs.docker.com/. Docker est disponible pour macOS, Linux et Windows.

Déploiement des composants : client, serveur et reverse-proxy

Nous étudions dans cette section la construction d’images Docker pour les trois composants de notre architecture logicielle. Pour chaque composant, nous montrerons comment configurer les sources pour paramétrer l’exécution (une exécution en production et différente d’une exécution pour le test en développement), comment construire les binaires et comment « exécuter » les binaires.

Les avantages de la construction des binaires par Docker sont multiples.

  • Éviter d’installer les outils (Java, Maven et npm) sur son poste de travail. En effet, si vous souhaitez simplement tester PollDLE pour admirer cette magnifique application, vous n’aurez besoin que de récupérer les sources et lancer une commande Docker pour utiliser les outils de compilation lors de la phase de création d’images Docker.
  • Maîtriser la construction des binaires dans un environnement connu (les versions des outils sont les mêmes). En effet, vous pourriez déjà posséder sur votre poste de travail des versions différentes des outils et cela pourrait amener des problèmes de compilation.
  • Contrôler l’exécution des binaires en production. Les versions des outils pour l’exécution des binaires seront les mêmes, quel que soit le système hôte utilisé.

Composant serveur (Java)

Le composant serveur (Java) qui sert à diffuser les services web REST s’appuie sur la spécification MicroProfile. Nous n’utiliserons que deux composants de cette spécification : JAX-RS (service web REST) et CDI (injection de dépendances). Nous avons opté pour KumuluzEE comme implémentation de la spécification MicroProfile. Lors de l’écriture de cet article, la version 2.1 de MicroProfile était supportée par KumuluzEE. De nombreuses autres implémentations de MicroProfile sont également disponibles. Le choix de KumuluzEE a été motivé par sa simplicité, sa documentation, sa longévité (cinq ans) et qu’il est toujours enrichissant de s’intéresser aux bibliothèques qui ne font pas de vague, mais qui apportent de grands services. À noter que j’ai découvert KumuluzEE en 2015 puisque cette bibliothèque avait gagné le prix « Duke’s Choice Award Winner », c’est aussi à cette époque que je me suis intéressé à MicroProfile.

Dans la suite de cette section dédiée au composant serveur (Java), nous vous invitons à ouvrir un terminal et vous positionner à la racine du répertoire polldle-backend.

Construction des binaires du composant serveur (Java)

La construction des binaires se fait par l’intermédiaire de Maven.

  • Exécuter la ligne de commande suivante pour compiler la couche serveur à partir de Maven.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
$ mvn clean package
...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] polldle-parent 0.3-SNAPSHOT ........................ SUCCESS [  0.124 s]
[INFO] poddle-api ......................................... SUCCESS [  1.244 s]
[INFO] polldle-server 0.3-SNAPSHOT ........................ SUCCESS [  6.273 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 7.811 s
[INFO] Finished at: 2019-06-14T16:24:20+02:00
[INFO] ------------------------------------------------------------------------

Maven compilera le code source, exécutera les tests unitaires et préparera les binaires finals. Ces derniers sont disponibles dans le répertoire polldle-server/target, nous les détaillons ci-dessous :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
polldle-server/target
├── classes
│   ├── fr
│   ├── META-INF
│   ...
├── dependency
│   ├── HikariCP-2.7.9.jar
│   ├── activation-1.1.1.jar
│   ├── alpn-api-1.1.3.v20160715.jar
│   ├── aopalliance-repackaged-2.5.0.jar
│   ├── asm-7.0.jar
│   ...
├── generated-sources
├── generated-test-sources
├── maven-archiver
├── maven-status
├── polldle-server.jar
├── surefire-reports
└── test-classes

Les répertoires qui nous intéressent sont classes qui contient les ressources et les fichiers .class puis dependency qui liste l’ensemble des bibliothèques nécessaires à l’exécution du programme Java.

Configuration de l’exécution du composant serveur (Java)

Le composant serveur (Java) n’offre pas de grandes possibilités de configuration excepté le port d’écoute du serveur et l’URL de déploiement. Ces informations sont modifiables via des variables d’environnement et font partie intégrante de l’implémentation KumuluzEE.

  • Exécuter les lignes de commande suivantes pour initialiser deux variables d’environnement.
1
2
export KUMULUZEE_SERVER_HTTP_PORT=9991
export KUMULUZEE_SERVER_BASEURL=http://0.0.0.0

Ces variables d’environnement devront être initialisées avant l’exécution du programme Java.

Exécution du composant serveur (Java)

Comme vu dans la partie construction des binaires, les fichiers nécessaires à l’exécution sont disponibles dans le répertoire polldle/polldle-server/target. Nous passerons par une exécution classique d’une application Java puisque le composant serveur (Java) a intégré un serveur web Jetty pour diffuser les services web à l’adresse http://0.0.0.0:9991.

  • Démarrer l’exécution du composant serveur (Java) via la ligne de commande ci-dessous.
1
2
3
4
5
6
$ java -cp "polldle-server/target/dependency/*:polldle-server/target/classes" com.kumuluz.ee.EeApplication
...
2019-06-14 17:34:12.162 INFO -- org.eclipse.jetty.server.handler.ContextHandler -- Started o.e.j.w.WebAppContext@7fd7a283{/,file:///private/var/folders/27/m3j8g4z54lgdbdlvrwc5_prr0000gn/T/kumuluzee-tmp-webapp15558546934995523069/,AVAILABLE}
2019-06-14 17:34:12.188 INFO -- org.eclipse.jetty.server.AbstractConnector -- Started ServerConnector@6f5e16cf{HTTP/1.1,[http/1.1]}{0.0.0.0:9991}
2019-06-14 17:34:12.188 INFO -- org.eclipse.jetty.server.Server -- Started @2464ms
2019-06-14 17:34:12.188 INFO -- com.kumuluz.ee.EeApplication -- KumuluzEE started successfully

L’ensemble des bibliothèques Java nécessaires à l’exécution du programme Java et le code compilé du projet sont passés au classpath de l’exécution. La classe principale (le point d’entrée de l’application Java) est celle fournie par KumuluzEE à savoir com.kumuluz.ee.EeApplication.

Le résultat obtenu permet de voir que le composant est déployé et les services web REST sont disponibles à l’adresse http://0.0.0.0:9991.

Dockerfile pour le composant serveur (Java)

Précédemment, nous avons vu comment compiler, configurer l’exécution et exécuter le composant serveur (Java). Nous allons réexploiter ces trois étapes lors de la création de l’image Docker pour le composant serveur (Java).

La création d’une image sous Docker passe par l’écriture d’un fichier Dockerfile. Ce fichier est disponible à la racine du répertoire polldle-backend.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Build env
FROM maven:3-jdk-8 AS build-java-stage
LABEL maintainer="Mickael BARON"
WORKDIR /polldle
COPY polldle-api polldle-api
COPY polldle-server polldle-server
COPY pom.xml .
RUN mvn -f pom.xml clean package

# Run env
FROM openjdk:8-jre-slim
COPY --from=build-java-stage /polldle/polldle-server/target/classes /polldle/classes
COPY --from=build-java-stage /polldle/polldle-server/target/dependency/*.jar /polldle/dependency/
EXPOSE 9991
ENTRYPOINT ["java", "-cp", "/polldle/classes:/polldle/dependency/*", "com.kumuluz.ee.EeApplication"]

Ce fichier Dockerfile est décomposé en deux étapes de construction appelée multistage. La première étape consiste à créer une image temporaire à partir du résultat de la compilation du composant serveur (Java) tandis que la seconde étape consiste à créer l’image finale qui servira pour l’exécution. Le résultat de la première étape servira pour construire la seconde étape. L’intérêt de décomposer en deux étapes est avant tout de pouvoir limiter la taille de l’image finale. En effet, pour la compilation, il est nécessaire de s’appuyer sur une image Docker avec JDK et Maven (FROM maven:3-jdk-8 AS build-java-stage). De nombreuses dépendances Java seront téléchargées, mais pas forcément utiles pour l’exécution (plugin Maven, dépendances Java pour les tests unitaires…).

Détaillons le contenu de ce fichier Dockerfile qui propose deux étapes.

Étapes de compilation :

  • FROM maven:3-jdk-8 AS build-java-stage : partir d’une image Docker Java pour la compilation, elle contient Maven et JDK ;
  • LABEL maintainer="Mickael BARON" : préciser l’auteur du fichier ;
  • WORKDIR /polldle : fixer le répertoire de travail ;
  • COPY polldle-api polldle-api : copier le contenu du répertoire polldle/polldle-backend/polldle-api (contient l’API du projet) de l’hôte à la racine du répertoire courant du conteneur ;
  • COPY polldle-server polldle-server : copier le contenu du répertoire polldle/polldle-backend/polldle-server (contient l’implémentation ) de l’hôte à la racine du répertoire courant du conteneur ;
  • COPY pom.xml . : copier le fichier de configuration Maven de l’hôte à la racine du répertoire courant du conteneur ;
  • RUN mvn -f pom.xml clean package : exécuter la compilation, les tests et la construction des binaires à partir de Maven.

Étapes d’exécution :

  • FROM openjdk:8-jre-slim : partir d’une image Docker Java pour l’exécution. On s’appuie ici sur une version minimaliste de Java 8 ;
  • COPY --from=build-java-stage .../classes /polldle/classes : copier le résultat de la compilation de la précédente étape vers le conteneur de la seconde étape ;
  • COPY --from=build-java-stage .../dependency/*.jar /polldle/dependency/ : copier le contenu du répertoire des dépendances obtenu lors de la précédente étape vers le conteneur de la seconde étape ;
  • EXPOSE 9991 : préciser que le port 9991 pourra être exposé. Cette instruction ne publie pas automatiquement ce port lors de la construction du conteneur. Il s’agit d’une simple documentation à utiliser quand vous souhaitez comprendre quels ports sont à exposer.
  • ENTRYPOINT ["java", "-cp", "...", "com.kumuluz.ee.EeApplication"] : préciser la commande par défaut à utiliser lors de l’exécution du conteneur.

Construction de l’image du composant serveur (Java)

La construction de l’image du composant serveur (Java) se base sur le fichier Dockerfile défini précédemment.

  • Exécuter la ligne de commande suivante (toujours depuis le répertoire polldle-backend) pour démarrer la construction de l’image Docker du composant serveur (Java).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
$ docker build --tag mickaelbaron/polldle-backend .
Sending build context to Docker daemon  14.66MB
Step 1/12 : FROM maven:3-jdk-8 AS build-java-stage
 ---> 744127042367
Step 2/12 : LABEL maintainer="Mickael BARON"
 ---> Using cache
 ---> 592524361e0f
Step 3/12 : WORKDIR /polldle
 ---> Using cache
 ---> 5674b58c017f
Step 4/12 : COPY polldle-api polldle-api
 ---> Using cache
 ---> 3e7e81dfec53
Step 5/12 : COPY polldle-server polldle-server
 ---> Using cache
 ---> 0f587aec9d33
Step 6/12 : COPY pom.xml .
 ---> Using cache
 ---> 76bad6fd5b87
Step 7/12 : RUN mvn -f pom.xml clean package
 ---> Using cache
 ---> bb82e04d86e1
Step 8/12 : FROM openjdk:8-jre-slim
 ---> 7c6b62cf60ee
Step 9/12 : COPY --from=build-java-stage /polldle/polldle-server/target/classes /polldle/classes
 ---> Using cache
 ---> 7758407c0988
Step 10/12 : COPY --from=build-java-stage /polldle/polldle-server/target/dependency/*.jar /polldle/dependency/
 ---> Using cache
 ---> 6b468cc03978
Step 11/12 : EXPOSE 9991
 ---> Using cache
 ---> 21a4ac2e9d1f
Step 12/12 : ENTRYPOINT ["java", "-cp", "/polldle/classes:/polldle/dependency/*", "com.kumuluz.ee.EeApplication"]
 ---> Using cache
 ---> a06e8fa7a757
Successfully built a06e8fa7a757
Successfully tagged mickaelbaron/polldle-backend:latest

On remarque que le nombre d’étapes est identique au nombre de lignes contenues dans le fichier Dockerfile. Chaque étape correspondra à une couche spécifique de l’image résultante.

  • Exécuter la ligne de commande suivante pour s’assurer que l’image intitulée mickaelbaron/polldle-backend a été construite.
1
2
3
$ docker images
REPOSITORY                     TAG                 IMAGE ID            CREATED             SIZE
mickaelbaron/polldle-backend   latest              a06e8fa7a757        2 days ago          182MB

On constate clairement que l’image est d’une taille réduite (182MB). Cela est dû à l’utilisation du multistage d’une part et à l’image Docker openjdk:8-jre-slim qui offre une empreinte de disque réduite.

Créer un conteneur du composant serveur (Java)

Nous pouvons désormais créer un conteneur afin de tester l’image construite pour le composant serveur (Java). Bien entendu, il s’agit d’une première étape, car dans cette section, seul le composant serveur (Java) sera déployé par un conteneur. Le composant client (Vue.js) devra être démarré sans conteneur.

  • Se positionner dans le répertoire polldle-vue et créer un conteneur basé sur l’image Docker précédente.
1
2
$ docker run -d --name backend -e KUMULUZEE_SERVER_HTTP_PORT=9991 -p 9991:9991 mickaelbaron/polldle-backend
b3c5fd42962cee0dd0cd45f2c6ed35ca1926ab0d9a9efbedb3cea0241062bc9e

Un conteneur nommé backend sera créé sur la base de l’image mickaelbaron/polldle-backend. L’option -d indique que le conteneur est créé en mode détaché. L’option -e KUMULUZEE_SERVER_HTTP_PORT=9991 est utilisée pour modifier la valeur du port d’écoute via l’initialisation d’une variable d’environnement. L’option -p 9991:9991 est utilisée pour la redirection de port.

  • Exécuter la ligne de commande suivante pour s’assurer que le contenu a été correctement créé et qu’il est toujours en exécution.
1
2
3
$ docker ps
CONTAINER ID        IMAGE                          COMMAND                  STATUS              PORTS                    NAMES
2cc90d113638        mickaelbaron/polldle-backend   "java -cp /polldle/c…"   Up 52 seconds       0.0.0.0:9991->9991/tcp   backend
  • Toujours depuis le répertoire polldle-vue, démarrer l’exécution en mode développement de la couche client (Vue.js).
1
2
$ npm run serve
...

Composant client (Vue.js)

Le développement du composant client (Vue.js) a déjà été présenté dans le deuxième article de ce tutoriel.

Pour le déploiement de ce composant, nous allons devoir changer l’adresse du composant serveur. En effet, l’adresse du composant serveur pour le développement http://127.0.0.1:9991 est différente de celle pour le déploiement en production /server.

Que l’on souhaite tester lors de la phase de développement ou construire une version déployable pour la phase de mise en production, nous montrerons à la fin de cette section que vous n’aurez plus besoin d’intervenir dans le code du composant client. Des variables d’environnement seront utilisées directement dans le code.

Variables d’environnement

Nous vous invitons à vous positionner dans le répertoire polldle-vue-15 pour profiter des codes qui vont illustrer cette section.

Nous montrons dans cette sous-section comment stocker les variables d’environnement et comment les utiliser dans le code des composants.

Depuis, la version 3 de Vue CLI, les variables d’environnement sont déclarées et initialisées dans des fichiers préfixés par .env[.mode]mode correspond à development ou production. Ces fichiers doivent être placés à la racine de votre projet.

À titre d’exemple, voici les fichiers que vous pourriez trouver à la racine d’un projet Vue.js.

1
2
3
.env             : variables d'environnement disponibles quel que soit le mode ;
.env.development : variables d'environnement disponibles pour le développement (npm run server) ;
.env.production  : variables d'environnement disponibles pour la production (npm run build).

Ces fichiers .env[.mode] contiennent des paires de clé=valeur. Généralement, les clés des variables d’environnement seront identiques dans les différents fichiers .env[.mode] par contre les valeurs seront différentes.

Pour qu’une clé soit utilisable dans le code des composants, elle doit commencer par VUE_APP.

  • Créer un fichier .env.development pour le mode développement et éditer le fichier de façon à ajouter le contenu ci-dessous.
1
VUE_APP_SERVER_URL = http://localhost:9991
  • Créer un fichier .env.production pour le mode production et éditer le fichier de façon à ajouter le contenu ci-dessous.
1
VUE_APP_SERVER_URL = /server

Une seule variable d’environnement sera définie et sa valeur changera selon le mode utilisé (development ou production). Ainsi VUE_APP_SERVER_URL vaudra http://localhost:9991 pour le mode développement et /server pour le mode production.

Pour utiliser ces variables d’environnement dans le code des composants, il suffira d’utiliser le code suivant : process.env.VUE_APP_SERVER_URL. Le code des trois composants sera impacté afin d’utiliser cette variable d’environnement.

  • Éditer le fichier CreatePolldle.vue en remplaçant le commentaire // Use environment variable to define REST web service URL par le code présenté ci-dessous.
1
2
3
4
5
6
7
8
      // Use environment variable to define REST web service URL
      var request = new Request(process.env.VUE_APP_SERVER_URL + "/polldles", {
        method: "POST",
        body: JSON.stringify(polldleObject),
        headers: {
          'Content-Type': 'application/json'
        }
      })
  • Éditer le fichier VotePolldle.vue en remplaçant les deux commentaires // Use environment variable to define REST web service URL par les codes présentés ci-dessous.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
  created() {
    // Use environment variable to define REST web service URL
    axios.get(process.env.VUE_APP_SERVER_URL + "/polldles", {
      params : {
        pathURL: this.$route.params.pathurl
      }
    }).then(response => {
    ...
  },
  methods: {
    vote() {
      ...
      axios({
        method: 'post',
        // Use environment variable to define REST web service URL
        baseURL: process.env.VUE_APP_SERVER_URL + "/polldles/" + this.$route.params.pathurl + "/votes",
        data: JSON.stringify(polldleVote),
        headers: {
          'Content-Type': 'application/json'
        }
      }).then(response => {
      ...
    }
  }
  • Éditer le fichier ResultPolldle.vue en remplaçant le commentaire // Use environment variable to define REST web service URL par le code présenté ci-dessous.
1
2
3
4
5
6
7
8
9
10
  created() {
    // Use environment variable to define REST web service URL
    var source = new EventSource(
      process.env.VUE_APP_SERVER_URL +
      "/polldles/" +
      this.$route.params.pathurl +
      "/votes/sse"
    );
    ...
  }

Comme montré dans les codes précédents, l’ancienne valeur http://127.0.0.1:9991 a été transformée en process.env.VUE_APP_SERVER_URL. Lors de la phase construction des binaires, le code process.env.VUE_APP_SERVER_URL sera remplacé par la valeur contenue soit dans le fichier .env.development soit dans le fichier .env.production.

Construction des binaires du composant client (Vue.js)

Pour l’instant, nous avons vu comment tester le projet Vue.js en exécutant : npm run server.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
npm run server
> polldle-vue-15@0.1.0 serve .../polldle/polldle-vue-15
> vue-cli-service serve

 INFO  Starting development server...
 98% after emitting CopyPlugin

 DONE  Compiled successfully in 2410ms


  App running at:
  - Local:   http://localhost:8080/
  - Network: unavailable

  Note that the development build is not optimized.
  To create a production build, run npm run build.

Nous allons maintenant construire les binaires pour la version qui sera déployée en production.

  • Exécuter npm run buildbuild est un script défini dans le fichier package.json.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
npm run build
> polldle-vue-15@0.1.0 build /Users/baronm/workspacejava/polldle/polldle-vue-15
> vue-cli-service build

⠹  Building for production...

 WARNING  Compiled with 2 warnings     10:23:29

 warning

entrypoint size limit: The following entrypoint(s) combined asset size exceeds the recommended limit (244 KiB). This can impact web performance.
Entrypoints:
  app (278 KiB)
      css/chunk-vendors.0cbd351a.css
      js/chunk-vendors.86498fa6.js
      css/app.f351e9c1.css
      js/app.f1a0f2ea.js


 warning

webpack performance recommendations:
You can limit the size of your bundles by using import() or require.ensure to lazy load some parts of your application.
For more info visit https://webpack.js.org/guides/code-splitting/

  File                                   Size              Gzipped

  dist/js/chunk-vendors.86498fa6.js      82.85 KiB         29.96 KiB
  dist/js/app.f1a0f2ea.js                2.62 KiB          1.26 KiB
  dist/css/chunk-vendors.0cbd351a.css    191.84 KiB        26.80 KiB
  dist/css/app.f351e9c1.css              0.46 KiB          0.26 KiB

  Images and other types of assets omitted.

 DONE  Build complete. The dist directory is ready to be deployed.
 INFO  Check out deployment instructions at https://cli.vuejs.org/guide/deployment.html

Le résultat de cette construction est disponible dans le répertoire dist où l’on retrouve le contenu CSS, JavaScript et le fichier index.html

1
2
3
4
5
6
7
8
9
10
.
├── css
│   ├── app.f351e9c1.css
│   └── chunk-vendors.0cbd351a.css
├── index.html
└── js
    ├── app.f1a0f2ea.js
    ├── app.f1a0f2ea.js.map
    ├── chunk-vendors.86498fa6.js
    └── chunk-vendors.86498fa6.js.map

Toutes les bibliothèques (Bootstrap, Vue.js, Highcharts…) utilisées dans notre projet PollDLE sont regroupées et minifiées (réduites au strict minimum) dans les fichiers CSS et JavaScript.

Pour s’assurer que la variable d’environnement a été utilisée dans le code, examinons le contenu du fichier dist/js/app.f1a0f2ea.js.

1
...var o=new Request("/server/polldles",{method:"POST",body:JSON.stringify(e),headers:{"Content-Type":"application/json"}})...

Déploiement du composant client (Vue.js)

Nous vous invitons à vous positionner dans le répertoire polldle-vue-16 pour profiter des codes qui vont illustrer cette section.

Les binaires obtenus seront déployés sur le serveur web NGINX. C’est un choix totalement personnel puisque je l’utilise depuis de nombreuses années NGINX. Bien entendu de nombreux autres serveurs auraient pu faire le même travail.

Dans le cas d’une application développée avec Vue.js et l’utilisation du mode history pour le routage (pour rappel transformer http://localhost/#/3/result en http://localhost/3/result), il est nécessaire de procéder à une réécriture des requêtes reçues. NGINX s’appuie sur des fichiers de configuration pour paramétrer le déploiement d’une application web. C’est donc dans ce fichier de configuration que sera précisée la réécriture. Des informations complémentaires peuvent être trouvées ici.

  • Créer un fichier nginx.conf à la racine du dossier polldle-vue-16 et ajouter le code ci-dessous.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
server {
  listen 80 default_server;
  listen [::]:80 default_server;

  root /usr/share/nginx/html;

  index index.html;

  server_name localhost;

  location / {
    try_files $uri $uri/ @rewrites;
  }

  location @rewrites {
    rewrite ^(.+)$ /index.html last;
  }

  location ~* \.(?:ico|css|js|gif|jpe?g|png)$ {
    # Some basic cache-control for static files to be sent to the browser
    expires max;
    add_header Pragma public;
    add_header Cache-Control "public, must-revalidate, proxy-revalidate";
  }
}

La réécriture des requêtes est réalisée par l’instruction try_files $uri $uri/ @rewrites; et rewrite ^(.+)$ /index.html last;. Il est précisé que, quelles que soient les requêtes sur / (exemples : http://localhost/1/result), elles aboutiront vers index.html, ce qui est logique, car nous développons une Single-Page application.

Nous allons tester le déploiement sur un serveur NGINX disponible dans un conteneur Docker.

  • Éditer le fichier .env.production afin de changer l’URL du serveur. En effet, le composant serveur (Java) sera démarré sur un port différent, car actuellement nous n’avons pas configuré le Reverse-Proxy.
1
VUE_APP_SERVER_URL = http://localhost:9991

Cette modification est réalisée à des fins de test et ne sera pas conservée par la suite.

  • Installer les modules requis et construire les binaires pour notre projet Vue.js.
1
2
npm install
npm run build
  • Si le conteneur du composant serveur (Java) est toujours en exécution ($ docker ps), vous pouvez passer à l’étape suivante, sinon, exécuter la ligne de commande suivante.
1
2
$ docker run -d --name backend -e KUMULUZEE_SERVER_HTTP_PORT=9991 -p 9991:9991 mickaelbaron/polldle-backend
b3c5fd42962cee0dd0cd45f2c6ed35ca1926ab0d9a9efbedb3cea0241062bc9e
  • Créer un conteneur Docker basé sur une image NGINX.
1
2
$ docker run -d --rm -p 80:80 --name frontend -v $(pwd)/dist:/usr/share/nginx/html -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf nginx:stable-alpine nginx -g "daemon off;"
60f1489e822c794477b322dbfa4df79794769480206c11fae42f3c5f113c992e

Un conteneur Docker sera créé, en mode détaché (-d), automatiquement supprimé (--rm), avec une redirection de port (-p 80:80), portant le nom (--name frontent) et partageant le répertoire dist et le fichier nginx.conf (-v).

  • Ouvrir un navigateur et tester l’URL suivante : http://localhost:80.

  • Une fois testée, arrêter et détruire le conteneur nommé frontend.

1
docker rm -f frontend

Dockerfile pour le composant client (Vue.js)

Nous vous invitons à vous positionner dans le répertoire polldle-vue-17 pour profiter des codes qui vont illustrer cette section.

Nous avons vu comment configurer le code pour utiliser des variables d’environnement, produire les binaires pour le composant client (Vue.js) et déployer sur le serveur web NGINX.

Tout comme le composant serveur (Java), les binaires du composant client seront produits lors de la création de l’image Docker.

Pour rappel, la création d’une image sous Docker passe par l’écriture d’un fichier Dockerfile.

  • Créer un fichier Dockerfile à la racine du dossier polldle-vue-16 et le compléter par le code présenté ci-dessous.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Build env
FROM node:lts-alpine as build-npm-stage
LABEL maintainer="Mickael BARON"

WORKDIR /polldle-vue
COPY package*.json ./
RUN npm install
COPY public ./public
COPY src ./src
COPY .env.production ./

RUN npm run build

# Run env
FROM nginx:stable-alpine
COPY --from=build-npm-stage /polldle-vue/dist /usr/share/nginx/html
COPY nginx.conf /etc/nginx/conf.d/default.conf
EXPOSE 80
ENTRYPOINT ["nginx", "-g", "daemon off;"]

Ce fichier Dockerfile est également décomposé en deux étapes de construction appelée multistage. La première étape consiste à créer une image temporaire à partir du résultat de la construction des binaires du composant client tandis que la seconde étape consiste à créer l’image finale qui servira pour l’exécution.

Détaillons le contenu de ce fichier Dockerfile qui propose deux étapes.

Étapes de compilation :

  • FROM node:lts-alpine as build-npm-stage : partir d’une image Docker pour la compilation, elle contient npm ;
  • LABEL maintainer="Mickael BARON" : préciser l’auteur du fichier ;
  • WORKDIR /polldle-vue : fixer le répertoire de travail ;
  • COPY package*.json ./ : copier le fichier de description du projet dans le répertoire de travail ;
  • RUN npm install : installer les modules requis par le projet ;
  • COPY public ./public : copier le contenu du répertoire public dans le répertoire de travail ;
  • COPY src ./src : copier le contenu du répertoire src dans le répertoire de travail ;
  • COPY .env.production ./ : copier le fichier d’initialisation des variables d’environnement dans le répertoire de travail ;
  • RUN npm run build : construire les binaires qui seront déposés dans le répertoire dist.

Étapes d’exécution :

  • FROM nginx:stable-alpine : partir d’une image Docker pour l’exécution. On s’appuie sur Nginx comme serveur de déploiement ;
  • COPY --from=build-npm-stage /polldle-vue/dist /usr/share/nginx/html : copier le résultat de la construction des binaires dist dans le répertoire usuel de Nginx ;
  • COPY nginx.conf /etc/nginx/conf.d/default.conf : copier le fichier de déploiement de notre application pour Nginx dans le répertoire de configuration de Nginx ;
  • EXPOSE 80 : préciser que le port 80 pourra être exposé ;
  • ENTRYPOINT ["nginx", "-g", "daemon off;"] : préciser la commande par défaut à utiliser lors de l’exécution du conteneur.

Construction de l’image Docker du composant client (Vue.js)

La construction de l’image Docker du composant client (Vue.js) se base sur le fichier Dockerfile défini précédemment.

  • Toujours depuis le répertoire polldle/polldle-vue-17, exécuter la ligne de commande suivante pour démarrer la construction de l’image Docker du composant client (Vue.js).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
docker build --tag mickaelbaron/polldle-vue .
Sending build context to Docker daemon  538.6kB
Step 1/14 : FROM node:lts-alpine as build-npm-stage
 ---> a298c79121d9
Step 2/14 : LABEL maintainer="Mickael BARON"
 ---> Using cache
 ---> 37667248b486
Step 3/14 : WORKDIR /polldle-vue
 ---> Using cache
 ---> 8d986de2d38c
Step 4/14 : COPY package*.json ./
 ---> Using cache
 ---> 6cf92051e506
Step 5/14 : RUN npm install
 ---> Using cache
 ---> f6fe7bcd8fad
Step 6/14 : COPY public ./public
 ---> Using cache
 ---> 618f15130818
Step 7/14 : COPY src ./src
 ---> Using cache
 ---> e0d39ea9a4fb
Step 8/14 : COPY .env.production ./
 ---> Using cache
 ---> eadf796ad323
Step 9/14 : RUN npm run build
 ---> Using cache
 ---> 1017bd88ba8a
Step 10/14 : FROM nginx:stable-alpine
 ---> ef04b00b089d
Step 11/14 : COPY --from=build-npm-stage /polldle-vue/dist /usr/share/nginx/html
 ---> Using cache
 ---> 1ee59e34d30e
Step 12/14 : COPY nginx.conf /etc/nginx/conf.d/default.conf
 ---> Using cache
 ---> 3069b033be56
Step 13/14 : EXPOSE 80
 ---> Using cache
 ---> b55635e86b7d
Step 14/14 : ENTRYPOINT ["nginx", "-g", "daemon off;"]
 ---> Using cache
 ---> d3ffaf3dd01d
Successfully built d3ffaf3dd01d
Successfully tagged mickaelbaron/polldle-vue:latest
  • S’assurer que l’image intitulée mickaelbaron/polldle-vue a été construite.
1
2
3
4
$ docker images
REPOSITORY                     TAG                 IMAGE ID            CREATED             SIZE
mickaelbaron/polldle-backend   latest              a06e8fa7a757        2 days ago          182MB
mickaelbaron/polldle-vue       latest              d3ffaf3dd01d        34 seconds ago      22.1MB

Créer un conteneur du composant client (Vue.js)

Nous vous invitons à vous positionner dans le répertoire polldle-vue-18 pour profiter des codes qui vont illustrer cette section.

Nous pouvons désormais créer un conteneur afin de tester l’image Docker construite pour le composant client (Vue.js). Le composant serveur (Java) doit normalement toujours être disponible dans un conteneur.

  • Se positionner dans le répertoire polldle-vue-18 et exécuter la ligne de commande suivante pour créer un conteneur basé sur l’image mickaelbaron/polldle-vue.
1
2
$ docker run -d --name frontend -p 80:80 mickaelbaron/polldle-vue
0e65e7ad22e68856f81c2aacbbbc9686dc1a209fae11d848488ed050b7acb237

Un conteneur nommé frontend sera créé sur la base de l’image mickaelbaron/polldle-vue. L’option -p 80:80 est utilisée pour la redirection de port.

  • S’assurer que le contenu a été correctement créé et qu’il est toujours en exécution.
1
2
3
4
$ docker ps
CONTAINER ID        IMAGE                          COMMAND                  STATUS              PORTS                    NAMES
0e65e7ad22e6        mickaelbaron/polldle-vue       "nginx -g 'daemon of…"   6 minutes ago       0.0.0.0:80->80/tcp       frontend
346e0d4413ce        mickaelbaron/polldle-backend   "java -cp /polldle/c…"   6 minutes ago       0.0.0.0:9991->9991/tcp   backend

Malheureusement, si vous testez l’application PollDLE à l’adresse http://localhost, l’accès au service web REST ne fonctionnera pas puisque la variable d’environnement VUE_APP_SERVER_URL est initialisée à /server. Ainsi, l’URL http://localhost/server/polldles ne sera pas accessible.

Composant reverse-proxy (NGINX)

Nous vous invitons à vous positionner dans le répertoire polldle-rp-without_subpath pour profiter des codes qui vont illustrer cette section.

Le composant reverse-proxy est en charge de répondre aux sollicitations du client. Ainsi, si l’URL est de la forme http://localhost/, le reverse-proxy redirigera les requêtes vers le composant client (Vue.js) afin de télécharger le contenu statique développé avec Vue.js. Au contraire, si l’URL est de la forme http://localhost/server, le composant reverse-proxy redirigera les requêtes vers le composant serveur (Java) afin d’invoquer les services web REST développés avec Java.

NGINX, déjà employé comme serveur web, sera également utilisé comme Reverse-Proxy.

Configuration du composant reverse-proxy (NGINX)

La configuration du composant polldle-rp-without_subpath/reverse-proxy est disponible dans le fichier build.conf.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
server {
    listen 80;

    location /server/ {
        proxy_pass http://backend:9991/;
        proxy_http_version 1.1;
        proxy_set_header Connection "";
    }

    location / {
        rewrite ^(/.*)$ $1 break;
        proxy_pass http://frontend;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
}

Deux configurations sont disponibles : celle pour accéder au composant server (Java) via /server/ et celle pour accéder au composant client (Vue.js) via /. À noter que les requêtes sont redirigées vers les deux serveurs qui portent les noms respectifs de http://backend:9991/ et http://frontend. Nous verrons plus tard comment associer ces noms.

Dockerfile pour le composant reverse-proxy (NGINX)

Le fichier Dockerfile pour la création de l’image Docker du composant reverse-proxy est présenté ci-dessous.

1
2
3
4
5
FROM nginx:stable-alpine
LABEL maintainer="Mickael BARON"
COPY build.conf /etc/nginx/conf.d/default.conf
EXPOSE 80
ENTRYPOINT ["nginx", "-g", "daemon off;"]

Détaillons le contenu de ce fichier Dockerfile :

  • FROM nginx:stable-alpine : partir d’une image Docker pour le déploiement statique d’application web avec NGINX ;
  • LABEL maintainer="Mickael BARON" : préciser l’auteur du fichier ;
  • COPY build.conf /etc/nginx/conf.d/default.conf : copier le fichier de configuration dans le répertoire dédié de NGINX ;
  • EXPOSE 80 : préciser que le port 80 pourra être exposé ;
  • ENTRYPOINT ["nginx", "-g", "daemon off;"] : préciser la commande par défaut à utiliser lors de l’exécution du conteneur.

Construction de l’image Docker du composant reverse-proxy (NGINX)

La construction de l’image Docker du composant reverse-proxy se base sur le fichier Dockerfile défini précédemment.

  • Exécuter la ligne de commande suivante (toujours depuis le répertoire polldle-rp-without_subpath).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
docker build --tag mickaelbaron/polldle-rp .
Step 1/5 : FROM nginx:stable-alpine
 ---> ef04b00b089d
Step 2/5 : LABEL maintainer="Mickael BARON"
 ---> Using cache
 ---> 550f0316e86d
Step 3/5 : COPY build.conf /etc/nginx/conf.d/default.conf
 ---> Using cache
 ---> 6047c791e509
Step 4/5 : EXPOSE 80
 ---> Using cache
 ---> 6e1e911835f9
Step 5/5 : ENTRYPOINT ["nginx", "-g", "daemon off;"]
 ---> Using cache
 ---> f9f2abc08cea
Successfully built f9f2abc08cea
Successfully tagged mickaelbaron/polldle-rp:latest
  • Exécuter la ligne de commande suivante pour s’assurer que l’image Docker intitulée mickaelbaron/polldle-vue a été construite.
1
2
3
4
5
$ docker images
REPOSITORY                     TAG                 IMAGE ID            CREATED             SIZE
mickaelbaron/polldle-rp        latest              f9f2abc08cea        13 minutes ago      20.4MB
mickaelbaron/polldle-backend   latest              eed853aefdd4        23 hours ago        182MB
mickaelbaron/polldle-vue       latest              c0e92868e9d5        24 hours ago        22.1MB

Créer un conteneur du composant reverse-proxy (NGINX)

Nous supposons que les conteneurs associés aux composants serveur et client sont toujours existants. Si ce n’est pas le cas, nous vous invitons à les recréer.

  • Créer un conteneur basé sur l’image Docker mickaelbaron/polldle-rt.
1
2
$ docker run -d --name rp -p 80:80 mickaelbaron/polldle-rp
78bd18008796758326eb9f48ae57279cef17d96c319478b3a2fc1c541fd3cee4
  • Afficher la liste des conteneurs avec la commande suivante :
1
2
3
4
5
$ docker ps -a
CONTAINER ID        IMAGE                          COMMAND                  STATUS                      PORTS       NAMES
78bd18008796        mickaelbaron/polldle-rp        "nginx -g 'daemon of…"   Exited (1) 19 minutes ago               rp
781f589d49eb        mickaelbaron/polldle-vue       "nginx -g 'daemon of…"   Up 22 hours                 80/tcp      frontend
fc9c5c3ca3a0        mickaelbaron/polldle-backend   "java -cp /polldle/c…"   Up 22 hours                 9991/tcp    backend

Nous constatons que le conteneur rp ne fonctionne pas correctement. Pour connaître les causes de ce dysfonctionnement, nous allons examiner les logs du conteneur.

  • Examiner les logs du conteneur rp.
1
2
3
$ docker logs rp
2019/06/26 15:35:50 [emerg] 1#1: host not found in upstream "backend" in /etc/nginx/conf.d/default.conf:5
nginx: [emerg] host not found in upstream "backend" in /etc/nginx/conf.d/default.conf:5

Cette erreur indique que le nom de domaine backend n’est pas connu. Il en va de même pour le nom de domaine frontend. Pour résoudre ce problème, il va donc falloir lier le conteneur rp avec les conteneurs backend et frontend. Pour cela, nous utiliserons un sous-réseau Docker. Tout conteneur dans un sous-réseau Docker est identifiable par les autres conteneurs via son nom de conteneur.

  • Créer un sous-réseau Docker appelé polldlenetwork.
1
2
$ docker network create polldlenetwork
3605b7022d16414a2855fde4101052e7f36e43ba94a41dbc83659b9a9d351386
  • Ajouter les conteneurs frontend et backend à ce nouveau sous-réseau Docker.
1
2
docker network connect polldlenetwork backend
docker network connect polldlenetwork frontend
  • Supprimer le conteneur rp et le recréer dans le sous-réseau Docker polldlenetwork.
1
2
docker run -d --name rp --network polldlenetwork -p 80:80 mickaelbaron/polldle-rp
66bc312c2579cba754dc1649bf5f976d061e680fd5a4b1e34772c70425032565

Déploiement via un sous-chemin

Le déploiement peut vouloir être réalisé au travers d’un sous-chemin de la forme https://mycompany.com/polldle. Cela implique que les URL d’accès aux composants client et serveur soient différentes. Cette modification n’est pas si anodine, puisque le code des composants reverse-proxy (NGINX) et client (Vue.js) devront être impactés. Plus précisément, il s’agira pour le composant reverse-proxy (NGINX) du fichier de configuration, et pour le composant client (Vue.js) d’une nouvelle URL pour accéder aux services web REST, de la configuration du routage et de l’accès aux ressources CSS et JavaScript.

Le changement (avec ou sans sous-chemin) sera indiqué lors de la création des images Docker. Ce changement pourrait se faire directement lors de l’exécution, mais je ne le traiterai pas dans ce tutoriel.

Dans la suite de cette section, nous montrons une solution pour automatiser la construction des images Docker du composant reverse-proxy (NGINX) et du composant client (Vue.js).

Sous-chemin pour le composant client (Vue.js)

Nous vous invitons à vous positionner dans le répertoire polldle-vue-19 pour profiter des codes qui vont illustrer cette section.

Au niveau du composant client (Vue.js), nous allons devoir renseigner :

  • une nouvelle URL pour accéder aux services web REST (variables d’environnement) ;
  • la configuration du routage (fichier src/router/index.js) ;
  • l’accès aux ressources CSS et JavaScript (fichier de configuration).

Mode (variables d’environnement) sous-chemin (Vue.js)

Actuellement, deux modes sont utilisés pour initialiser les variables d’environnement : development et production.

Nous montrons dans cette section comment créer un nouveau mode personnalisé appelé subpath qui donnera une nouvelle valeur à la variable d’environnement VUE_APP_SERVER_URL et ajoutera une nouvelle variable d’environnement pour préciser le sous-chemin.

  • Créer un fichier .env.subpath à la racine du dossier polldle-vue-19/ et copier le contenu ci-dessous.
1
2
3
NODE_ENV = production
VUE_APP_SUBPATH = /polldle/
VUE_APP_SERVER_URL = /polldle/server

La première propriété MODE_ENV explique que ce nouveau mode sera basé sur le mode production. La seconde VUE_APP_SUBPATH est une nouvelle variable d’environnement pour fixer la valeur du sous-chemin. La troisième VUE_APP_SERVER_URL est celle qui précise la valeur de l’URL du serveur.

Quand un sous-chemin n’est pas requis, c’est-à-dire pour les modes development et production, la variable d’environnement VUE_APP_SUBPATH doit être au moins fixée à /.

  • Ajouter dans les fichiers .env.development et .env.production la variable d’environnement VUE_APP_SUBPATH fixée à / (commentaire # Add new environment variable VUE_APP_SUBPATH).
1
2
3
4
# Fichier .env.development
VUE_APP_SERVER_URL = http://localhost:9991
# Add new environment variable VUE_APP_SUBPATH
VUE_APP_SUBPATH = /
1
2
3
4
# Fichier .env.production
VUE_APP_SERVER_URL = /server
# Add new environment variable VUE_APP_SUBPATH
VUE_APP_SUBPATH = /

Pour construire des binaires avec le mode personnalisé subpath, il faudra exécuter la commande suivante : vue-cli-service build --mode subpath. vue-cli-service n’est pas exécutée directement, mais via un script défini dans le fichier package.json.

  • Éditer le fichier package.json et ajouter un nouveau script appelé subpath dans le contenu de scripts.
1
2
3
4
5
6
7
8
...
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "subpath": "vue-cli-service build --mode subpath",
    "lint": "vue-cli-service lint"
  },
...
  • S’assurer que tout fonctionne correctement.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
npm install
npm run subpath

> polldle-vue-19@0.1.0 subpath /Users/baronm/workspacejava/polldle/polldle-vue-19
> vue-cli-service build --mode subpath


⠼  Building for subpath...
...
  File                                   Size              Gzipped

  dist/js/chunk-vendors.e3058ce2.js      346.38 KiB        120.10 KiB
  dist/js/app.d169298e.js                12.09 KiB         3.88 KiB
  dist/css/chunk-vendors.0cbd351a.css    191.84 KiB        26.80 KiB
  dist/css/app.42f644cf.css              0.82 KiB          0.40 KiB

  Images and other types of assets omitted.

 DONE  Build complete. The dist directory is ready to be deployed.
 INFO  Check out deployment instructions at https://cli.vuejs.org/guide/deployment.html

Le mode subpath a bien été pris en compte. Vous pouvez examiner le contenu généré pour vous assurer que les valeurs sont au bon endroit.

Routage avec un sous-chemin (Vue.js)

Éditer le fichier polldle-vue-19/src/router/index.js afin de configurer la nouvelle valeur du routage en remplaçant le commentaire // Change base value. par le code présenté ci-dessous.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
...
export default new Router({
  mode: 'history',
  // Change base value.
  base: process.env.VUE_APP_SUBPATH,
  routes: [
    {
      path: '/',
      name: 'CreatePolldle',
      component: CreatePolldle
    },
    {
      path: '/:pathurl',
      name: 'VotePolldle',
      component: VotePolldle
    },
    {
      path: '/:pathurl/result',
      name: 'ResultPolldle',
      component: ResultPolldle
    }
  ]
})

Fichier de configuration (Vue.js)

Des paramètres globaux sont disponibles pour configurer certains éléments d’un projet Vue.js. Dans le cas de la configuration d’un sous-chemin, nous allons modifier le paramètre publicPath. Les paramètres globaux ont des valeurs par défaut (publicPath=/) et sont modifiables depuis un fichier vue.config.js.

  • Créer un fichier vue.config.js et ajouter le contenu ci-dessous.
1
2
3
4
module.exports = {
  publicPath: process.env.VUE_APP_SUBPATH,
  productionSourceMap: false
}

La valeur donnée à publicPath est la valeur obtenue par la variable d’environnement VUE_APP_SUBPATH. Nous en profitons également pour ajouter productionSourceMap: false qui permet d’éviter d’ajouter les fichiers SourceMap lors de la construction des binaires. Pour information, les fichiers SourceMap aident à déboguer une application JavaScript.

Vous trouverez une liste des paramètres globaux disponibles à cette adresse : https://cli.vuejs.org/config/.

Dockerfile du composant client (Vue.js) avec un sous-chemin

Nous vous invitons à vous positionner dans le répertoire polldle-vue-20 pour profiter des codes qui vont illustrer cette section.

Pour rappel, voici les deux commandes pour construire les binaires du composant client (Vue.js) :

  • sans sous-chemin : $ npm run build ;
  • avec sous-chemin : $ npm run subpath.

Le choix de la commande dépend donc de ce qu’on veut obtenir comme binaire. Nous allons modifier le fichier Dockerfile afin de pouvoir choisir la commande lors de la construction de l’image Docker.

  • Éditer le fichier polldle-vue-20/Dockerfile en ajoutant le code présenté au niveau des commentaires # Use ARG instruction to create script_name variable et # Inject script_name variable into the command.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
FROM node:lts-alpine as build-npm-stage
LABEL maintainer="Mickael BARON"
# Use ARG instruction to create script_name variable
ARG script_name=build

WORKDIR /polldle-vue
COPY package*.json ./
RUN npm install
COPY public ./public
COPY src ./src
COPY .env.production ./

# Inject script_name variable into the command
RUN npm run $script_name

# Run env
FROM nginx:stable-alpine
COPY --from=build-npm-stage /polldle-vue/dist /usr/share/nginx/html
COPY nginx.conf /etc/nginx/conf.d/default.conf
EXPOSE 80
ENTRYPOINT ["nginx", "-g", "daemon off;"]

L’instruction ARG script_name=build permet de créer une variable script_name qui prend comme valeur par défaut build. Lors de la construction de l’image Docker, une valeur pourra être donnée. L’idée est de donner soit build soit subpath.

Construction de l’image Docker du composant client (Vue.js) avec un sous-chemin

  • Depuis l’invite de commande, se positionner dans le répertoire polldle/polldle-vue-20 et exécuter la ligne de commande suivante pour démarrer la construction de l’image Docker du composant client (Vue.js).
1
2
3
$ docker build --tag mickaelbaron/polldle-vue . --build-arg script_name=build
...
$ docker build --tag mickaelbaron/polldle-vue . --build-arg script_name=subpath

Pour passer une valeur à la variable script_name, l’option --build-arg a été utilisée.

Sous-chemin pour le composant reverse-proxy (NGINX)

Nous vous invitons à vous positionner dans le répertoire polldle-rp pour profiter des codes qui vont illustrer cette section.

Au niveau du composant reverse-proxy (NGINX), nous allons devoir renseigner :

  • un nouveau fichier de configuration spécifique à NGINX.

Configuration du composant reverse-proxy (NGINX) avec un sous-chemin

  • Éditer le fichier polldle-rp/subpath.conf puis examiner le contenu.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
server {
    listen 80;

    location /polldle/server/ {
        proxy_pass http://backend:9991/;
        proxy_http_version 1.1;
        proxy_set_header Connection "";
    }

    location /polldle/ {
        rewrite ^/polldle(/.*)$ $1 break;
        proxy_pass http://frontend;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
}

Le sous-chemin /polldle/ est spécifié dans ce fichier.

Dockerfile du composant reverse-proxy (NGINX) avec un sous-chemin

  • Éditer le fichier polldle-rp/Dockerfile puis examiner le contenu.
1
2
3
4
5
6
FROM nginx:stable-alpine
LABEL maintainer="Mickael BARON"
ARG script_name=build
COPY $script_name.conf /etc/nginx/conf.d/default.conf
EXPOSE 80
CMD ["nginx", "-g", "daemon off;"]

Tout comme le fichier Dockerfile du composant client (Vue.js), une variable est utilisée pour donner le nom de la configuration à appeler.

Construction de l’image Docker du composant reverse-proxy (NGINX) avec un sous-chemin

  • Depuis l’invite de commande, se positionner dans le répertoire polldle-rp et exécuter la ligne de commande suivante pour démarrer la construction de l’image Docker du composant reverse-proxy (NGINX).
1
2
3
4
$ docker build --tag mickaelbaron/polldle-rp . --build-arg script_name=build
...
$ docker build --tag mickaelbaron/polldle-rp . --build-arg script_name=subpath
...

Résumé pour définir un sous-chemin

Pour changer le sous-chemin, vous devrez impacter les fichiers suivants :

  • .env.subpath : les clés VUE_APP_SUBPATH et VUE_APP_SERVER_URL ;
  • subpath.conf : modifier les valeurs dans location.

Ensuite, reconstruire les images associées aux composants Client (Vue.js) et reverse-proxy.

Composer les images Docker

Actuellement, nous disposons de trois composants qui ont chacun une image Docker. La construction des images Docker et la création des conteneurs associés se font manuellement. Pour automatiser ce processus, nous utiliserons docker-compose via la mise en place d’un fichier docker-compose.yml. Bien entendu, nous garderons les bénéfices de création d’un sous-chemin ou pas.

Fichier de composition

  • Éditer le fichier docker-compose.yml disponible à la racine du projet puis examiner le contenu.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
version: '3'

services:

  backend:
    build: polldle-backend/
    image: mickaelbaron/polldle-backend
    environment:
      KUMULUZEE_SERVER_HTTP_PORT: 9991
    ports:
      - "9991:9991"
    networks:
      - polldlenetwork

  frontend:
    build: polldle-vue/
    image: mickaelbaron/polldle-vue
    networks:
      - polldlenetwork

  rp:
    build: polldle-rp/
    image: mickaelbaron/polldle-rp
    depends_on:
      - frontend
      - backend
    ports:
      - "80:80"
    networks:
      - polldlenetwork

networks:
  polldlenetwork:

Ce fichier est divisé en deux parties : la configuration des conteneurs d’une part et la configuration du sous-réseau polldlenetwork d’autre part. Tous les paramétrages des conteneurs ont déjà été étudiés dans les sections précédentes.

Construire et tester

L’outil docker-compose permet de construire toutes les images Docker et de créer les trois conteneurs dans le sous-réseau polldlenetwork. Vous trouverez ci-dessous toutes les configurations possibles :

  • docker-compose up -d : créer les trois conteneurs en mode détaché (si les images Docker ne sont pas créées, elles seront construites avant) ;
  • docker-compose build : construire toutes les images Docker ;
  • docker-compose build --build-arg script_name=subpath : construire toutes les images Docker en précisant avec ou sans sous-chemin ;
  • docker-compose build --build-arg script_name=subpath COMPONENT : construire l’image Docker du composant COMPONENT (frontend, backend ou rp).

Dans l’hypothèse, où aucune image Docker n’a été construite, la commande $ docker-compose up -d est suffisante.

  • Ouvrir un terminal et exécuter la ligne de commande suivante :
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
docker-compose up -d
Creating network "polldle_polldlenetwork" with the default driver
Building backend
Step 1/12 : FROM maven:3-jdk-8 AS build-java-stage
...
Step 12/12 : ENTRYPOINT ["java", "-cp", "/polldle/classes:/polldle/dependency/*", "com.kumuluz.ee.EeApplication"]
 ---> Running in d3dbb1a0a276
Removing intermediate container d3dbb1a0a276
 ---> 96b6334c959f
Successfully built 96b6334c959f
Successfully tagged mickaelbaron/polldle-backend:latest
Building frontend
Step 1/17 : FROM node:lts-alpine as build-npm-stage
...
Step 17/17 : CMD ["nginx", "-g", "daemon off;"]
 ---> Running in 2013f589151d
Removing intermediate container 2013f589151d
 ---> b5e48d02d21d
Successfully built b5e48d02d21d
Successfully tagged mickaelbaron/polldle-vue:latest
Building rp
Step 1/6 : FROM nginx:stable-alpine
 ---> ef04b00b089d
...
Successfully built 345d741aa693
Successfully tagged mickaelbaron/polldle-rp:latest
Creating polldle_frontend_1 ... done
Creating polldle_backend_1  ... done
Creating polldle_rp_1       ... done
  • Pour vérifier que les trois conteneurs ont été créés.
1
2
3
4
5
6
$ docker-compose ps
       Name                     Command               State           Ports
------------------------------------------------------------------------------------
polldle_backend_1    java -cp /polldle/classes: ...   Up      0.0.0.0:9991->9991/tcp
polldle_frontend_1   nginx -g daemon off;             Up      80/tcp
polldle_rp_1         nginx -g daemon off;             Up      0.0.0.0:80->80/tcp

Conclusion et remerciements

Cette troisième partie a présenté les problématiques de déploiement d’une application Vue.js en utilisant Docker pour la création de conteneurs.

Pour le composant client (Vue.js) qui était au centre de cette étude, nous avons montré comment utiliser les variables d’environnement dans le code, comment configurer les paramètres globaux et comment utiliser un sous-chemin.

Pour Docker, cette solution de conteneurisation a permis de rendre le développement plus proche de la production. La taille des images Docker construites a été optimisée via l’utilisation du multistage.

Cette troisième partie clôture également cette série consacrée à Vue.js. De nombreux concepts n’ont pas été présentés, mais pourront faire l’objet de prochains tutoriels Vuex pour gérer l’état de l’application, Vue-Native pour la création d’applications natives à déployer sur le mobile et WebComponents pour utiliser des WebComponents existants et pourquoi pas transformer des composants Vue.js en WebComponents.

Vue.js est une constante évolution. Lors de l’écriture de cet article, nous utilisions la version 2 de Vue.js et la version 3 de Vue CLI. La version 3 de Vue.js est en cours d’élaboration et devrait sortir fin 2019. J’essaierai, dans la mesure du possible, d’adapter le code du projet PollDLE afin de tenir un cas d’étude à jour des avancées de Vue.js.

Je tiens à remercier Claude Leloup pour sa relecture orthographique.

Ressources

Cet article est open source. Vous avez noté un problème de typographie ?
Ou quelque chose d'obscur ? Améliorer cet article à partir du dépôt GitHub.
Commentaire

Vous pouvez laisser un commentaire en répondant à ce Tweet.

Je suis Mickaël BARON Ingénieur de Recherche en Informatique 💻 au @LIAS_LAB le jour 🌞
Responsable de zones #Java sur @javaDeveloppez la nuit 🌚
❤️ #Java #Docker #VueJS #Eclipse #Services #WebSemantic