Ana içeriğe geç

Özel Modüller

Modülünüzü kendi işlevselliğinizle geliştirici API'sini kullanarak dağıtabilirsiniz.

Geliştirme​

Geliştirme sırasında https://github.com/OneEntry/module-example adresindeki şablonu 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. Kalıcı bir token oluşturmanız önerilir.
  • Git'te yeni bir etiket oluşturun (modülün yeni bir sürümü ile birlikte).
  • 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 tıklayın ve modül ekleme formuna erişmek için aşağı kaydırın.

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

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

    host, docker registry ana bilgisayarının adıdır, örneğin, registry.gitlab.com,

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

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

    version, etiket adıdır (modül sürümü).

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

  • Docker Ana Bilgisi alanında, docker görüntü yolundaki host kısmını tekrar eden docker registry ana bilgisayarını belirtin, örneğin, registry.gitlab.com.

  • Token ID ve Token alanlarında, token'ın adını (oluşturma sırasında belirtilen) ve token'ı (genellikle glpat ile başlar) sırasıyla sağlayın.

  • Modülün çalışması için gerekli olan ortam değişkenlerini (env) belirtin (bunlar daha sonra değiştirilebilir).

Modülü oluşturduktan sonra, tabloya görünecektir. Artık Dağıt butonuna tıklayarak dağıtımını gerçekleştirebilirsiniz (bu biraz zaman alacaktır).

Konteyner Durumları​

  • Dağıtılmadı - Modül oluşturulmuş ancak henüz dağıtılmamıştır.
  • Dağıtılıyor - Modül dağıtım sürecindedir.
  • Çalışıyor - Modül çalışır durumdadır.
  • Askıya Alındı - Modül dağıtılmış ancak çalışmamaktadır.

Modül Eylemleri​

  • Askıya Al Modülü askıya al. Süreci durdurur, ancak veriler kalır.
  • Devam Et Modülü devam ettir. Süreci başlatır.
  • Sil Modülü sil. Süreci durdurur, konteyneri ve ilişkili verileri siler.

Hata Ayıklama​

Modül dağıtımını gerçekleştiremezse veya süreç sürekli olarak sonlanırsa, Uyarı simgesini göreceksiniz.

Olası Sorunlar​

  • Docker görüntüsü yanlış yapılandırılmıştır.
  • Token geçersiz veya yanlıştır.
  • Süreç sonlanıyor. Modül aktifken iç süreç sonlanmamalıdır.

Günlükleme​

Modül ayarlarında görüntülenen günlükleri kullanarak modül ile ilgili diğer sorunları ayıklayabilirsiniz.

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

Modülün yeni bir sürümünü dağıtmanız veya ortam değişkenlerini değiştirmeniz gerekiyorsa, ayarlarda etiketi ve/veya değişkenleri güncellemeniz gerekir. Süreç yeniden başlatılacaktır.

.