Ana içeriğe geç

Kullanıcı Modülleri

Kendi işlevselliğinizi içeren modülünüzü geliştirici API'sini kullanarak dağıtabilirsiniz.

Geliştirme​

Geliştirme sırasında https://github.com/OneEntry/module-example şablonunu kullanın ve https://github.com/OneEntry/custom-module-deployment-guide adresindeki talimatları izleyin.

Derleme​

  • read-registry izinlerine sahip yeni bir proje token'ı oluşturun. Süresiz bir token oluşturmanız önerilir.
  • Git'te yeni bir etiket oluşturun (her yeni modül sürümü çıktığında)
  • Pipeline'ın tamamlanmasını bekleyin, ardından modülün docker görüntüsü registry'ye yüklenecek ve dağıtım için kullanılabilir hale gelecektir.

Dağıtım​

Ayarlar bölümüne gidin, "Modüller" kısmına geçin ve modül ekleme formuna ulaşmak için aşağı kaydırın.

  • Modülün adını ve etiketini belirtin

  • Görüntü URL'si alanında, daha önce derlenmiş docker görüntüsünün yolunu host/user/repo:version formatında belirtin.

    host - docker registry'nin ana bilgisayar adı, örneğin registry.gitlab.com,

    user - kullanıcı veya organizasyon kimliği, örneğin oneentry,

    repo - depo adı, örneğin my-module

    version - etiket adı (modülün versiyonu)

    Tam bir örnek: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • Docker ana bilgisayarı alanında, docker registry'nin ana bilgisayarını belirtin, bu, docker görüntüsündeki host kısmını tekrar eder, örneğin registry.gitlab.com

  • Token ID ve Token alanlarında, token'ın adını (oluşturulurken belirtilen) ve kendisini (genellikle glpat ile başlar) belirtin

  • Modülün çalışması için gerekli olan çevresel değişkenleri (env) belirtin (sonradan değiştirilebilir)

Modül oluşturulduktan sonra, tabloya eklenecektir. Artık dağıtım için Deploy butonuna basarak dağıtımını gerçekleştirebilirsiniz (bu biraz zaman alacaktır).

Konteyner Durumları​

  • Dağıtılmadı - Modül oluşturuldu, ancak henüz hiç dağıtılmadı
  • Dağıtılıyor - Modül dağıtım sürecinde
  • Çalışıyor - Modül aktif
  • Durduruldu - Modül dağıtıldı, ancak çalışmıyor

Modül ile İşlemler​

  • Suspend Modülü durdur. Süreci durdurur, ancak veriler kalır
  • Resume Modülün çalışmasını yeniden başlat. Süreci başlatır
  • Delete Modülü sil. Süreci durdurur, konteyneri ve ona bağlı verileri siler

Hata Ayıklama​

Modülün dağıtımı başarısız olursa veya süreç sürekli olarak sonlanırsa, Warn simgesini göreceksiniz.

Olası Problemler​

  • Docker görüntüsü yanlış yapılandırılmış
  • Geçersiz veya hatalı token
  • Süreç sonlanıyor. İç süreç, modül aktifken sonlanmamalıdır

Günlükleme​

Modül ile ilgili diğer sorunları, modül ayarlarında görünen günlükler aracılığıyla ayıklayabilirsiniz.

Modülü Güncelleme/Düzenleme​

Yeni bir modül sürümünü dağıtmanız veya çevresel değişkenleri değiştirmeniz gerekiyorsa, ayarlarda etiketi ve/veya değişkenleri güncellemelisiniz. Süreç yeniden başlatılacaktır.