Aller au contenu principal

Modules personnalisés

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

Développement​

Utilisez le modèle https://github.com/OneEntry/module-example et suivez les instructions sur https://github.com/OneEntry/custom-module-deployment-guide lors du développement.

Construction​

  • Créez un nouveau jeton de projet avec des droits read-registry. Il est recommandé de créer un jeton à durée indéterminée.
  • Créez une nouvelle balise dans git (à chaque nouvelle version du module)
  • Attendez la fin du pipeline, 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.

  • Indiquez le nom et le marqueur du module

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

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

    user - l'id de l'utilisateur ou de l'organisation, par exemple oneentry,

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

    version - le nom de la balise (version du module)

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

  • Dans le champ Hôte Docker, indiquez l'hôte du registre docker, qui répète la partie host du chemin vers l'image docker, par exemple registry.gitlab.com

  • Dans les champs Id du jeton et Jeton, indiquez le nom du jeton (indiqué lors de la création) et le jeton lui-même (commence généralement par glpat) respectivement

  • Indiquez les variables d'environnement nécessaires (env) requises pour le fonctionnement du module (peut être modifié plus tard)

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

Statuts du conteneur​

  • Non déployé - Le module est créé, mais n'a jamais été déployé
  • Déploiement en cours - Le module est en cours de déploiement
  • Démarré - Le module fonctionne
  • Suspendu - Le module est déployé, mais n'est pas démarré

Actions sur le module​

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

Débogage des erreurs​

Si le module n'a pas pu être déployé ou si le processus échoue systématiquement, vous verrez Warn.

Problèmes possibles​

  • Image docker mal configurée
  • Jeton invalide ou incorrect
  • Le processus échoue. Le processus interne ne doit pas échouer tant que le module est actif

Journalisation​

D'autres problèmes avec le module peuvent être débogués à l'aide des journaux affichés dans les paramètres du module

Mise à jour/édition 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é.

.