Zum Hauptinhalt springen

Benutzerdefinierte Module

Sie können Ihr Modul mit Ihrer Funktionalität unter Verwendung der Entwickler-API bereitstellen.

Entwicklung​

Verwenden Sie die Vorlage https://github.com/OneEntry/module-example und folgen Sie den Anweisungen in https://github.com/OneEntry/custom-module-deployment-guide während der Entwicklung.

Build​

  • Erstellen Sie ein neues Projekttoken mit den Rechten read-registry. Es wird empfohlen, ein unbefristetes Token zu erstellen.
  • Erstellen Sie ein neues Tag in git (bei jeder Veröffentlichung einer neuen Version des Moduls)
  • Warten Sie, bis die Pipeline abgeschlossen ist, danach wird das Docker-Image des Moduls in das Registry hochgeladen und steht zur Bereitstellung zur Verfügung.

Bereitstellung​

Gehen Sie zu den Einstellungen, Abschnitt "Module" und scrollen Sie nach unten, um zum Formular zum Hinzufügen eines Moduls zu gelangen.

  • Geben Sie den Namen und das Tag des Moduls an.

  • Im Feld Image-URL geben Sie den Pfad zum zuvor erstellten Docker-Image im Format host/user/repo:version an.

    Wobei host der Name des Docker-Registry-Hosts ist, z. B. registry.gitlab.com,

    user die ID des Benutzers oder der Organisation ist, z. B. oneentry,

    repo der Name des Repositories ist, z. B. my-module

    version der Name des Tags (Version des Moduls) ist.

    Vollständiges Beispiel: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • Im Feld Docker-Host geben Sie den Host der Docker-Registry an, der den Teil host im Pfad zum Docker-Image wiederholt, z. B. registry.gitlab.com

  • In den Feldern Token-ID und Token geben Sie den Namen des Tokens (angegeben bei der Erstellung) und das Token selbst (beginnt normalerweise mit glpat) an.

  • Geben Sie die erforderlichen Umgebungsvariablen (env) an, die für den Betrieb des Moduls erforderlich sind (kann später geändert werden).

Nach der Erstellung des Moduls wird es in der Tabelle angezeigt. Jetzt können Sie es bereitstellen, indem Sie auf Deploy klicken (dies kann einige Zeit in Anspruch nehmen).

Container-Status​

  • Nicht bereitgestellt - Modul wurde erstellt, aber noch nie bereitgestellt
  • Wird bereitgestellt - Modul wird bereitgestellt
  • Gestartet - Modul läuft
  • Angehalten - Modul ist bereitgestellt, aber nicht gestartet

Aktionen mit dem Modul​

  • Suspend Modul anhalten. Stoppt den Prozess, aber die Daten bleiben erhalten.
  • Resume Modul wieder aufnehmen. Startet den Prozess.
  • Delete Modul löschen. Stoppt den Prozess, löscht den Container und die zugehörigen Daten.

Fehlerbehebung​

Wenn das Modul nicht bereitgestellt werden konnte oder der Prozess systematisch beendet wird, sehen Sie Warn.

Mögliche Probleme​

  • Docker-Image ist falsch konfiguriert
  • Ungültiges oder fehlerhaftes Token
  • Prozess wird beendet. Der interne Prozess sollte nicht beendet werden, solange das Modul aktiv ist.

Protokollierung​

Andere Probleme mit dem Modul können Sie mithilfe der Protokolle debuggen, die in den Moduleinstellungen angezeigt werden.

Aktualisierung/Bearbeitung des Moduls​

Wenn Sie eine neue Version des Moduls bereitstellen oder Umgebungsvariablen ändern müssen, müssen Sie das Tag und/oder die Variablen in den Einstellungen aktualisieren. Der Prozess wird neu gestartet.

.