Aller au contenu principal

Modules Personnalisés

Vous pouvez déployer votre module avec votre propre fonctionnalité en utilisant l'API développeur.

Développement​

Utilisez le modèle à l'adresse https://github.com/OneEntry/module-example et suivez les instructions à https://github.com/OneEntry/custom-module-deployment-guide pendant le développement.

Construction​

  • Créez un nouveau jeton de projet avec des permissions read-registry. Il est recommandé de créer un jeton permanent.
  • Créez une nouvelle balise dans git (à chaque nouvelle version du module).
  • Attendez que le pipeline se termine, après quoi l'image docker du module sera téléchargée dans le registre et disponible pour le déploiement.

Déploiement​

Allez dans les paramètres, section "Modules", et faites défiler vers le bas pour accéder au formulaire d'ajout de module.

  • Spécifiez le nom et la balise du module.

  • Dans le champ Image URL, fournissez le chemin vers l'image docker précédemment construite au format host/user/repo:version.

    Où host est le nom de l'hôte du registre docker, par exemple, registry.gitlab.com,

    user est l'ID de l'utilisateur ou de l'organisation, par exemple, oneentry,

    repo est le nom du dépôt, par exemple, my-module,

    version est le nom de la balise (version du module).

    Un exemple complet : registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • Dans le champ Docker Host, spécifiez l'hôte du registre docker, qui répète la partie host dans le chemin de l'image docker, par exemple, registry.gitlab.com.

  • Dans les champs Token ID et Token, fournissez le nom du jeton (tel que spécifié lors de la création) et le jeton lui-même (commence généralement par glpat), respectivement.

  • Spécifiez les variables d'environnement nécessaires (env) requises pour le fonctionnement du module (celles-ci peuvent être modifiées ultérieurement).

Après avoir créé le module, il apparaîtra dans le tableau. Vous pouvez maintenant le déployer en cliquant sur Déployer (cela prendra un certain temps).

Statuts des Conteneurs​

  • Non Déployé - Le module a été créé mais n'a pas encore été déployé.
  • Déploiement en Cours - Le module est en cours de déploiement.
  • En Cours d'Exécution - Le module est opérationnel.
  • Suspendu - Le module est déployé mais ne fonctionne pas.

Actions sur le Module​

  • Suspendre Suspendre le module. Arrête le processus, mais les données restent.
  • Reprendre Reprendre le module. Démarre le processus.
  • Supprimer Supprimer le module. Arrête le processus, supprime le conteneur et les données associées.

Débogage des Erreurs​

Si le module échoue à se déployer ou si le processus se termine systématiquement, vous verrez Avertir.

Problèmes Possibles​

  • L'image docker est mal configurée.
  • Le jeton est invalide ou incorrect.
  • Le processus se termine. Le processus interne ne doit pas se terminer tant que le module est actif.

Journalisation​

Vous pouvez déboguer d'autres problèmes avec le module en utilisant les journaux affichés dans les paramètres du module.

Mise à Jour/Modification du Module​

Si vous devez déployer une nouvelle version du module ou modifier les variables d'environnement, vous devez mettre à jour la balise et/ou les variables dans les paramètres. Le processus sera redémarré.

.