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 sekmesine tıklayın ve Yeni Modül Oluştur kartına kadar aşağı kaydırın.

  • Modülün adını (Name) ve işaretini (Marker) belirtin.

  • Docker image bölümünde Image URL alanına daha önce oluşturduğunuz docker görüntüsünün yolunu host/user/repo:version formatında girin.

    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 sürümü)

    Tam örnek: registry.gitlab.com/oneentry/my-module:v1.0.0

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

  • Token ID ve Token alanlarına token'ın adını (oluşturulurken belirtilen) ve token'ı (genellikle glpat ile başlar) sırasıyla girin.

  • Environment Variables bölümünde Add butonuna tıklayın ve modülün çalışması için gereken ortam değişkenlerini belirtin (sonradan değiştirilebilir).

Create butonuna tıklayın.

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

Konteyner Durumları​

  • Not deployed — modül oluşturuldu, ancak henüz dağıtılmadı
  • Deploying — modül dağıtım sürecinde
  • Running — modül çalışıyor
  • Suspended — modül dağıtıldı, ancak başlatılmadı
  • Error — modül ile ilgili son işlem hatayla sonuçlandı, bkz. “Hata Ayıklama”

Modül ile işlem yapılırken, durum sütununda ilerleme durumu görüntülenir: Deploying, Suspending, Resuming veya Deleting. Alınamayan durum Unknown olarak görüntülenir. Durumlar otomatik olarak güncellenir.

Modül ile İşlemler​

  • Suspend Modülü askıya al. 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 ilgili verileri siler.

Hata Ayıklama​

Modül dağıtımı başarısız olursa veya süreç sürekli olarak sona ererse, modül Error durumunu alır ve satırda Warn simgesi ile "Bu modül ile ilgili son işlem başarısız oldu." ipucu görüntülenir. Error durumundaki modül, dağıtım butonuna Deploy tekrar erişebilir: nedeni düzeltin ve modülü yeniden dağıtın.

Olası Sorunlar​

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

Günlükleme​

Modül ile ilgili diğer sorunları, modül ayarlarında görüntülenen 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 ortam değişkenlerini değiştirmeniz gerekiyorsa, etiket ve/veya ayarlardaki değişkenleri güncellemeniz gerekir. Süreç yeniden başlatılacaktır.