Partager une image

De Documentation e-comBox
Révision datée du 19 février 2023 à 23:36 par Cthiry (discussion | contributions)
(diff) ◂ Version précédente | Voir la version actuelle (diff) | Version suivante ▸ (diff)
Avec la version 4.1.0 (20/02/2023) il est maintenant possible de partager et d'importer des modèles de sites créés avec e-comBox directement à partir de l'application. Ceci est un tutoriel qui explique comment réaliser cela. Si vous disposez d'une version d'e-comBox antérieure, vous pouvez toujours utiliser la procédure manuelle détaillée dans la partie "Partager un modèle manuellement".

Partager un modèle de site avec e-comBox

Créer un compte Docker

Pour que les modèles de sites que vous désirez partager soient accessibles par d'autres utilisateurs, il est nécessaire de les publier sur le Docker Hub. Les modèles de sites proposés par le Certa sont d'ailleurs hébergés sur cette plateforme.

Afin de créer un compte, rendez-vous sur la plateforme Docker hub et renseignez les informations demandées.

  • Docker ID : choisissez le pseudonyme de votre choix.
  • Email : votre adresse mail.
  • Password : choisissez un mot de passe sécurisé (au minimum 9 caractères).
Le pseudonyme est important. le nom de chaque image commencera par ce pseudonyme.

Enfin, acceptez les conditions d'utilisation, certifiez que vous n'êtes pas un robot et validez en cliquant sur le bouton "Sign Up" :

Creation compte docker.png

Vous pourrez alors vous connecter avec le pseudonyme choisi ou votre adresse mail. Vous recevrez un mail pour vérifier cette adresse.

Publier le modèle

Une fois le compte Docker le modèle de site créé, rendez-vous sur la partie "Gérer vos modèles de sites" :

Gestion des modèles de site
Thumb upload image.png

Cliquez sur le bouton en forme de nuage sur la ligne correspondante au modèle que vous désirez partager pour accéder au formulaire de connexion au service Docker. Vous devrez saisir l'identifiant et le mot de passe du compte Docker créé lors de l'étape précédente.

Connexion docker hib.png
Pour information, ces identifiants ne sont utilisés que pour la publication du modèle sur la plateforme Docker. L'application e-comBox ne stocke en aucun cas ces informations.

Il est possible de vérifier que le modèle a été correctement publié en se rendant sur votre compte Docker hub.

Importer un modèle de site

Si un modèle de site a été publié sur la plateforme Docker via l'application e-comBox (voir étape précédente), il est possible d'importer ce modèle afin de pouvoir créer des sites sur à partir de ce dernier.

Pour cela, rendez vous dans la partie "Gérer vos modèles de sites" et cliquez sur le bouton permettant d'importer un modèle :

Import modele.png

Vous aurez ensuite besoin du nom du dépôt Docker, correspondant en général à l'identifiant du compte Docker de l'utilisateur ayant publié le modèle :

Form import modele.png

Une fois le modèle sélectionné, cliquez sur le bouton "VALIDER" pour effectuer l'import. Lorsque l'opération est terminée vous pourrez alors créer des sites à partir de ce nouveau modèle.

Partager un modèle de site manuellement

Comme dit plus haut, la fonctionnalité de partage de modèles de sites n'est disponible qu'à partir de la version 4.1.0. Si vous disposez d'une version antérieure, veuillez suivre la procédure ci-après.

Configurer le compte Docker sur Portainer

À partir d'e-comBox, rendez-vous sur Portainer (Barre latérale --> Gestion avancée --> Accès admin) et saisissez les identifiants de connexion à Portainer :

Acces portainer.png

Vous allez maintenant devoir configurer Portainer avec le compte Docker créé précédemment. Pour cela, cliquez sur l'entrée "Registries" dans le menu de gauche, saisissez le pseudo et le mot de passe et cliquez sur le bouton "Update" :

Config docker.png

Changer les images

Lorsque vous créez votre propre modèle de site avec e-comBox, deux "images" sont créées :

  • une pour l'application en elle-même (ex : localhost:49153/odoo-generik),
  • et une pour la base de données correspondante (ex : localhost:49153/odoo-db-generik).

Afin de les publier sur le Docker Hub, il va falloir les renommer (tag) avec le pseudonyme du compte Docker créé. Pour visualiser les images existantes et retrouvez celles qui correspondent à votre modèle de site, retournez sur la page d'accueil de Portainer et cliquez sur le "Endpoint" Primary :

Select endpoint.png

Cliquez ensuite sur l'entrée "Images" dans le menu de gauche et sélectionnez l'image voulue (en cliquant sur sa signature : sha256...) :

Select image.png

Vous pouvez maintenant la renommez. Le nom d'une image prends toujours la forme suivant : pseudo_du_compte_docker/nom_de_l_image:version_de_l'image

Tag image.png

La version n'est pas obligatoire.

Un clic sur "Tag" montre les deux noms de l'image :

New tag.png

Recommencez cette étape pour l'image de la base de données.

Publier les images

Maintenant que l'image est "taguée", il faut l'envoyer vers le Docker Hub. Pour cela, il suffit de cliquer sur la flèche vers le haut à côté du nom de l'image :

Upload image.png
Success upload.png

Une fois l'image correctement publiée, une notification apparait en haut à droite de l'écran.

Recommencez l'opération pour l'image concernant la base de données.



Utiliser le nouveau modèle de site

Pour utiliser le modèle de site publié sur le Docker Hub, il faut tout d'abord récupérer le fichier permettant de faire fonctionner le modèle avec l'application e-comBox.

En fonction du type de site, affichez le contenu du fichier correspondant dans le dépôt GitLab. Par exemple, si le nouveau modèle de site est un Odoo, il faudra sélectionner tout le contenu du fichier "docker-compose-odoo-custom.yml" et le copier (clic droit --> copier) :

Copy docker compose.png


Add stack.png

Une fois le contenu du fichier copié, retournez sur Portainer dans la partie "Stacks", puis cliquez sur le bouton "+ And Stack".




Commencez par renseigner le nom du Stack, sans cela vous ne pourrez pas créer votre nouveau site. Puis dans la partie "Web Editor", collez le contenu précédemment copié.

Avertissement Avertissement : Le nom du Stack doit obligatoirement commencer par le type du site pour être visible dans l'interface e-comBox et ne doit pas contenir de caractères spéciaux ou de majuscules.
Stack name.png


Remplacez ensuite le nom des images par les nouvelles images, par exemple :

  • image: localhost:${REGISTRY_PORT}/odoo-db:${TAG} --> image: thiry/odoodbgenerik:3.0
  • image: localhost:${REGISTRY_PORT}/odoo:${TAG} --> image: thiry/odoogenerik:3.0
Change image.png
Avertissement Avertissement : Il faut modifier le nom de l'image de la base de données ET le nom de l'image de l'application.

Avant de déployer le stack, ajoutez les trois variables d'environnement nécessaires au bon fonctionnement du site et cliquez sur le bouton "Déployer the stack" en bas de page afin de valider la création du site :

Set env vars.png
  • La variable SUFFIXE contient le nom du nouveau site.
  • La variable DB_PASS contient le nouveau de passe pour la base de données.
  • La variable ROOT_DB_PASS contient le mot de passe du super utilisateur pour la base de données.
Cette étape peut prendre plusieurs minutes

La dernière étape consiste à redémarrer le site via l'interface d'e-comBox :

Restart app.png