Перейти до основного вмісту

Користувацькі модулі

Ви можете розгорнути свій модуль зі своєю функціональністю, використовуючи API розробника.

Розробка​

Використовуйте шаблон https://github.com/OneEntry/module-example і дотримуйтесь інструкцій у https://github.com/OneEntry/custom-module-deployment-guide під час розробки.

Збірка​

  • Створіть новий токен проєкту з правами read-registry. Рекомендується створити безстроковий токен.
  • Створіть новий тег у git (при кожному випуску нової версії модуля)
  • Дочекайтеся завершення pipeline, після чого docker образ модуля буде завантажено в registry і доступний для розгортання

Розгортання​

Перейдіть у налаштування, розділ "Модулі" і прокрутіть вниз, щоб перейти до форми додавання модуля.

  • Вкажіть ім'я та маркер модуля

  • У полі Url образу вкажіть шлях до раніше зібраного docker образу у форматі host/user/repo:version.

    Де host - ім'я хоста docker registry, наприклад registry.gitlab.com,

    user - id користувача або організації, наприклад oneentry,

    repo - ім'я репозиторію, наприклад my-module

    version - ім'я тега (версія модуля)

    Повний приклад: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • У полі Docker хост вкажіть хост docker registry, він повторює частину host у шляху до docker образу, наприклад registry.gitlab.com

  • У поля Id токена та Токен вкажіть назву токена (вказане під час створення) і сам токен (зазвичай починається з glpat) відповідно

  • Вкажіть необхідні змінні середовища (env), які потрібні для роботи модуля (можна змінити пізніше)

Після створення модуля, він з'явиться в таблиці. Тепер ви можете розгорнути його, натиснувши Deploy (це займе деякий час).

Статуси контейнера​

  • Не розгорнуто - Модуль створено, але ще жодного разу не був розгорнуто
  • Розгортається - Модуль знаходиться в процесі розгортання
  • Запущено - Модуль працює
  • Призупинено - Модуль розгорнуто, але не запущено

Дії з модулем​

  • Suspend Призупинити модуль. Зупиняє процес, але дані залишаються
  • Resume Відновити роботу модуля. Запускає процес
  • Delete Видалити модуль. Зупинить процес, видалить контейнер і пов'язані з ним дані

Виправлення помилок​

Якщо модуль не вдалося розгорнути або процес систематично завершується, ви побачите Warn.

Можливі проблеми​

  • Неправильно налаштований docker образ
  • Недійсний або некоректний токен
  • Процес завершується. Внутрішній процес не повинен завершуватися, поки модуль активний

Логування​

Інші проблеми з модулем ви можете відлагодити за допомогою логів, що відображаються в налаштуваннях модуля

Оновлення/редагування модуля​

Якщо необхідно розгорнути нову версію модуля або змінити змінні середовища, ви повинні оновити тег і/або змінні в налаштуваннях. Процес буде перезапущено.

.