diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 36d9e6498eae9fe38a8c37720c116a059fbe76f1..81dbb4a6dc9d2edf3e73fbae6f1ef3d4d177f1f4 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,25 +1,51 @@ image: python:3.7-alpine variables: - S3_BUCKET_NAME_fr: "documentation.veremes.net/vmap/fr" - S3_BUCKET_NAME_DEV_fr: "documentation.veremes.net/vmap-dev/fr" + S3_BUCKET_NAME_PROD: "documentation.veremes.net/vmap" + S3_BUCKET_NAME_DEV: "documentation-dev.veremes.net/vmap" -# Deploiement documentation francaise -# deploy-gtf-fr-documentation: -# stage: deploy -# script: -# - pip install awscli -# - pip install -U sphinx -# - pip install sphinx_rtd_theme==0.5.2 -# - pip install sphinx-markdown-parser -# - pip install myst-parser -# - pip install pymdown-extensions -# - sphinx-build -b html doc/source doc/build -# - aws s3 cp doc/build/ s3://$S3_BUCKET_NAME_fr/ --recursive -# tags: -# - deployment -# only: -# refs: -# - master -# changes: -# - doc/**/* +before_script: + - apk update && apk add git && apk add tzdata + - apk add build-base + - cp /usr/share/zoneinfo/Europe/Paris /etc/localtime + - echo "Europe/Paris" > /etc/timezone + - TZ=Europe/Paris + - pip install sphinx + - pip install sphinx-intl + - pip install sphinx_rtd_theme==0.5.2 + - pip install sphinx-markdown-parser + - pip install myst-parser + - pip install awscli + - pip install pymdown-extensions + +# Deploiement documentation francaise en production +#deploy-fr-prod: +# stage: deploy +# script: +# - sphinx-build -b html documentation/source documentation/build +# - aws s3 cp documentation/build/ s3://$S3_BUCKET_NAME_PROD/ --recursive +# tags: +# - deployment +# - eslint +# - test +# only: +# refs: +# - master +# changes: +# - documentation/source/**/* + +# Deploiement documentation francaise en developpement +deploy-fr-dev: + stage: deploy + script: + - sphinx-build -b html doc/source doc/build + - aws s3 cp doc/build/ s3://$S3_BUCKET_NAME_DEV/ --recursive + tags: + - deployment + - eslint + - test + only: + refs: + - documentation + changes: + - doc/source/**/* diff --git a/doc/source/images/installation/docker/linux/docker_website.jpg b/doc/source/images/installation/docker/linux/docker_website.jpg new file mode 100644 index 0000000000000000000000000000000000000000..911834a0b3cedc8ff38894b6c139cc29552f87c4 Binary files /dev/null and b/doc/source/images/installation/docker/linux/docker_website.jpg differ diff --git a/doc/source/images/installation/docker/windows/connexion_vmap.jpg b/doc/source/images/installation/docker/windows/connexion_vmap.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a2d103961870e1960e96989fb3979b4636e67a44 Binary files /dev/null and b/doc/source/images/installation/docker/windows/connexion_vmap.jpg differ diff --git a/doc/source/images/installation/docker/windows/conteneur_vmap_on.jpg b/doc/source/images/installation/docker/windows/conteneur_vmap_on.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6937ff0552e45dff0710c7e32445832758653b89 Binary files /dev/null and b/doc/source/images/installation/docker/windows/conteneur_vmap_on.jpg differ diff --git a/doc/source/images/installation/docker/windows/ouvrir_cmd.jpg b/doc/source/images/installation/docker/windows/ouvrir_cmd.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d2b5578df899d06a042cb66281feea4f48e8699a Binary files /dev/null and b/doc/source/images/installation/docker/windows/ouvrir_cmd.jpg differ diff --git a/doc/source/images/installation/docker/windows/setup_docker_1.jpg b/doc/source/images/installation/docker/windows/setup_docker_1.jpg new file mode 100644 index 0000000000000000000000000000000000000000..40e04caf9559958ab2d44999c8758313e05c549d Binary files /dev/null and b/doc/source/images/installation/docker/windows/setup_docker_1.jpg differ diff --git a/doc/source/images/installation/docker/windows/setup_docker_2.jpg b/doc/source/images/installation/docker/windows/setup_docker_2.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d5df5e6e7f0fd00679b4df3fad3d0ff88e79287 Binary files /dev/null and b/doc/source/images/installation/docker/windows/setup_docker_2.jpg differ diff --git a/doc/source/images/installation/docker/windows/setup_docker_3.jpg b/doc/source/images/installation/docker/windows/setup_docker_3.jpg new file mode 100644 index 0000000000000000000000000000000000000000..deb76490c42e7d6dd03ae42ae91978ba66fc751e Binary files /dev/null and b/doc/source/images/installation/docker/windows/setup_docker_3.jpg differ diff --git a/doc/source/images/installation/docker/windows/setup_docker_4.jpg b/doc/source/images/installation/docker/windows/setup_docker_4.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4ac99d336fa0feea0115fa9d8399e37ebcda45fc Binary files /dev/null and b/doc/source/images/installation/docker/windows/setup_docker_4.jpg differ diff --git a/doc/source/images/installation/docker/windows/setup_docker_5.jpg b/doc/source/images/installation/docker/windows/setup_docker_5.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2169ac2951564cfad44fe8082758acd998775254 Binary files /dev/null and b/doc/source/images/installation/docker/windows/setup_docker_5.jpg differ diff --git a/doc/source/images/installation/docker/windows/telechargement_docker.jpg b/doc/source/images/installation/docker/windows/telechargement_docker.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8329087e2dd80f4d53f1991961dc913a13db6236 Binary files /dev/null and b/doc/source/images/installation/docker/windows/telechargement_docker.jpg differ diff --git a/doc/source/installation/index.rst b/doc/source/installation/index.rst index 870de101f780705d51221cfcf316d4e648874ebf..13a1bb4b4181ecc57e5cf25cdafbd7711eda3f28 100644 --- a/doc/source/installation/index.rst +++ b/doc/source/installation/index.rst @@ -7,4 +7,5 @@ Prérequis et installation prerequis.md installation.md + installation_docker.md miseAJour.md diff --git a/doc/source/installation/installation_docker.md b/doc/source/installation/installation_docker.md new file mode 100644 index 0000000000000000000000000000000000000000..d91e8b5de03a33dac19a67bc4519a29b7ace8141 --- /dev/null +++ b/doc/source/installation/installation_docker.md @@ -0,0 +1,193 @@ +# Installation de vMap avec docker + +Veremes propose également la possibilité d'installer vMap via Docker. + +Cela rend possible une première utilisation du produit (découverte, familiarisation ou approche commerciale) rapidement, et sans nécessité de connaissances particulières (aucune configuration). + +```{admonition} Précautions +:class: tip +L'image de vMap, ainsi que la place nécessaire étant assez conséquent, il est recommandé d'avoir **au moins 10 Go d'espace disque disponible** afin de ne pas rencontrer de problèmes d'espace durant l'installation. +``` + +```{admonition} Attention +:class: danger +Il est à noter qu'il ne faut **en aucun cas utiliser l'image brute en production**. +N'ayant pas été conçu dans ce but, la configuration reste générique (même mot de passe, ...) et certaines configurations sont omises (certificat SSL, ...). + +Si votre but est de déployer une application en production, vous pouvez retrouver la documentation pour une installation en production [au lien suivant](../installation/installation.md) +``` + +## Installation sous Windows + +### Installation de Docker + +```{admonition} Lien vers le site de docker +:class: tip +[Site de Docker](https://www.docker.com/get-started/) +``` + +Une fois sur le site, il faut cliquer sur "Download for Windows" + + +Une fois le téléchargement terminé, vous pouvez exécuter l'exécutable, et suivre les différentes étapes : + + +Cocher "Use WSL 2 instead of Hyper-V" + + +Docker demande de redémarrer l'ordinateur à la fin de l'installation, **c'est une étape obligatoire, sinon le moteur de docker ne peut pas démarrer** + + +Après le redémarrage de l'ordinateur, vous deviez voir une interface, il faut attendre que le rectangle en bas à gauche tourne au vert, une fois ceci fait, votre installation de docker est prête. + + +### Installation et démarrage de l'instance vMap sur Docker + +```{admonition} Image vMap sur Docker Hub +:class: tip +Notre image Docker pour vMap, ainsi que la documentation relative à cette image est disponible [à l'adresse suivante](https://hub.docker.com/r/veremes/vmap). +``` + +Il faut dans un premier temps ouvrir une fenêtre d'invite de commandes +```{admonition} Ouvrir un invite de commande +:class: note +Vous pouvez utiliser le raccourci "touche windows + r" et taper dans la fenêtre "cmd.exe" afin de démarrer un invite de commandes. + +``` + +Et copier la commande suivante : + +```batch +docker run -dit --name vmap -p 8080:8080 -e BIND_PORT=8080 -d veremes/vmap:latest +``` + +```{admonition} Précautions en cas de lancement de multiples instances +:class: danger +Si jamais plusieurs instances vMap venaient à être lancées, il faut absolument faire attention à ne **pas utiliser le même nombre que pour la précédente** (8080 dans le cas d'exemple), dans le cas contraire, des conflits pourraient rendre les machines inutilisables. +``` + +La commande devrait dans un premier temps récupérer l'image de vMap, puis vous démarrer l'instance, le temps nécéssaire est variable en fonction de la puissance de l'ordinateur, et la connexion réseau. + +Une fois le processus terminé (un bon moyen de le savoir est de voir un conteneur démarré et en vert sur l'interface) : + + +Une fois ceci fait, vous pouvez vous rendre à l'adresse suivante [localhost:8080/vmap](http://localhost:8080/vmap) (changer le 8080 dans le cas ou un nombre différent est précisé dans la commande précédente). + +Vous devriez arriver devant l'interface suivante : + + +Vous pouvez donc vous connecter et commencer à utiliser vMap + +```{admonition} Identifiants vMap Docker par défaut +:class: tip +**Nom d'utilisateur : admin** +**Mot de passe : admin** +``` + +## Installation sous Linux + +### Installation de Docker + +```{admonition} Exemple pour Ubuntu / Debian +:class: warning +Les indications suivantes sont un résumé de l'installation de la documentation oficielle, l'installation de Docker sous Linux étant plus compliquée et dépendante du système Linux. +Il est recommandé d'utiliser la documentation oficielle disponible [au lien suivant](https://docs.docker.com/desktop/install/linux-install/) pour installer Docker sous Linux. +``` + +Pour installer Docker sur Linux, il faut dans un premier temps, ajouter les dépôts de Docker à la distribution + +Mise à jour d'apt, et installation des paquets nécéssaires : +```bash + sudo apt-get update + + sudo apt-get install \ + ca-certificates \ + curl \ + gnupg \ + lsb-release +``` + +Ajout de la clef GPG de Docker : +```bash +sudo mkdir -p /etc/apt/keyrings +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg +``` + +Ajout du dépôt : +```bash +echo \ + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null +``` + +Mise à jour de la liste des paquets apt : +```bash +sudo apt-get update +``` + +Installation du moteur Docker : +```bash +sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin +``` + +````{admonition} Exemple pour Ubuntu / Debian +:class: note +Vous pouvez aussi installer l'interface desktop de docker en passant par le paquet fourni par Docker, exemple avec le paquet DEB pour Ubuntu / Debian disponible à [l'adresse suivante](https://desktop.docker.com/linux/main/amd64/docker-desktop-4.16.0-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64) + +Il suffit de lancer les commandes suivantes : + +```bash +sudo apt-get update +sudo apt-get install ./docker-desktop-<version>-<arch>.deb +``` + +Et à la fin de l'installation, vous devriez avoir l'application "Docker Desktop" dans les applications installées. + +Cela vous permet d'avoir une interface pour gérer les conteneurs de ce type : + +```` + +### Lancement de vMap avec Docker + +```{admonition} Image vMap sur Docker Hub +:class: tip +Notre image Docker pour vMap, ainsi que la documentation relative à cette image est disponible [à l'addresse suivante](https://hub.docker.com/r/veremes/vmap). +``` + +Il faut copier la commande suivante dans un terminal : + +```bash +sudo docker run -dit --name vmap -p 8080:8080 -e BIND_PORT=8080 -d veremes/vmap:latest +``` + +```{admonition} Précautions en cas de lancement de multiples instances +:class: danger +Si jamais plusieurs instances vMap venaient à être lancées, il faut absolument faire attention à ne **pas utiliser le même nombre que pour la précédente** (8080 dans le cas d'exemple), dans le cas contraire, des conflits pourraient rendre les machines inutilisables. +``` + +La commande devrait dans un premier temps récupérer l'image de vMap, puis vous démarrer l'instance, le temps nécéssaire est variable en fonction de la puissance de l'ordinateur, et la connexion réseau. + +Vous pouvez voir si la machine est démarée avec la commande suivante : + +```bash +sudo docker container ls +``` + +Voici un exemple de sortie de la commande dans la console : +```bash +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +716f1bc79690 veremes/vmap:latest "bin/bash -c /usr/lo…" 12 minutes ago Up 12 minutes 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp vmap +``` + +Une fois ceci fait, vous pouvez vous rendre à l'adresse suivante [localhost:8080/vmap](http://localhost:8080/vmap) (changer le 8080 dans le cas ou un nombre différent est précisé dans la commande précédente). + +Vous devriez arriver devant l'interface suivante : + + +Vous pouvez donc vous connecter et commencer à utiliser vMap + +```{admonition} Identifiants vMap Docker par défaut +:class: tip +**Nom d'utilisateur : admin** +**Mot de passe : admin** +``` \ No newline at end of file