Przejdź do głównej zawartości

Moduły użytkownika

Możesz wdrożyć swój moduł z własną funkcjonalnością, korzystając z API dewelopera.

Rozwój​

Użyj szablonu https://github.com/OneEntry/module-example i postępuj zgodnie z instrukcjami w https://github.com/OneEntry/custom-module-deployment-guide podczas rozwoju.

Budowanie​

  • Utwórz nowy token projektu z uprawnieniami read-registry. Zaleca się utworzenie tokena bezterminowego.
  • Utwórz nowy tag w git (przy każdym wydaniu nowej wersji modułu)
  • Poczekaj na zakończenie pipeline, po czym obraz docker modułu zostanie załadowany do rejestru i będzie dostępny do wdrożenia

Wdrożenie​

Przejdź do ustawień, sekcja "Moduły" i przewiń w dół, aby przejść do formularza dodawania modułu.

  • Podaj nazwę i znacznik modułu

  • W polu Url obrazu podaj ścieżkę do wcześniej zbudowanego obrazu docker w formacie host/user/repo:version.

    Gdzie host - nazwa hosta rejestru docker, na przykład registry.gitlab.com,

    user - id użytkownika lub organizacji, na przykład oneentry,

    repo - nazwa repozytorium, na przykład my-module

    version - nazwa tagu (wersja modułu)

    Pelny przykład: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • W polu Docker host podaj hosta rejestru docker, który powtarza część host w ścieżce do obrazu docker, na przykład registry.gitlab.com

  • W polach Id tokena i Token podaj nazwę tokena (podaną przy tworzeniu) i sam token (zwykle zaczyna się od glpat) odpowiednio

  • Podaj wymagane zmienne środowiskowe (env) potrzebne do działania modułu (można je zmienić później)

Po utworzeniu modułu, pojawi się on w tabeli. Teraz możesz go wdrożyć, klikając Deploy (to zajmie trochę czasu).

Statusy kontenera​

  • Nie wdrożony - Moduł został utworzony, ale jeszcze nigdy nie był wdrożony
  • Wdrożenie - Moduł jest w trakcie wdrażania
  • Uruchomiony - Moduł działa
  • Wstrzymany - Moduł został wdrożony, ale nie jest uruchomiony

Działania z modułem​

  • Suspend Wstrzymaj moduł. Zatrzymuje proces, ale dane pozostają
  • Resume Wznów działanie modułu. Uruchamia proces
  • Delete Usuń moduł. Zatrzyma proces, usunie kontener i powiązane z nim dane

Debugowanie błędów​

Jeśli nie udało się wdrożyć modułu lub proces systematycznie się kończy, zobaczysz Warn.

Możliwe problemy​

  • Nieprawidłowo skonfigurowany obraz docker
  • Nieprawidłowy lub niepoprawny token
  • Proces kończy się. Wewnętrzny proces nie powinien kończyć się, dopóki moduł jest aktywny

Logowanie​

Inne problemy z modułem możesz debugować za pomocą logów, które są wyświetlane w ustawieniach modułu

Aktualizacja/edycja modułu​

Jeśli konieczne jest wdrożenie nowej wersji modułu lub zmiana zmiennych środowiskowych, musisz zaktualizować tag i/lub zmienne w ustawieniach. Proces zostanie uruchomiony ponownie.

.