Lewati ke konten utama

Modul Kustom

Anda dapat menerapkan modul Anda dengan fungsionalitas Anda sendiri menggunakan API pengembang.

Pengembangan​

Gunakan template di https://github.com/OneEntry/module-example dan ikuti instruksi di https://github.com/OneEntry/custom-module-deployment-guide selama pengembangan.

Membangun​

  • Buat token proyek baru dengan izin read-registry. Disarankan untuk membuat token permanen.
  • Buat tag baru di git (dengan setiap rilis versi baru modul).
  • Tunggu pipeline selesai, setelah itu gambar docker modul akan diunggah ke registry dan tersedia untuk penerapan.

Penerapan​

Pergi ke pengaturan, bagian "Modul," dan gulir ke bawah untuk mengakses formulir penambahan modul.

  • Tentukan nama dan tag modul.

  • Di kolom URL Gambar, berikan jalur ke gambar docker yang telah dibangun sebelumnya dalam format host/user/repo:version.

    Di mana host adalah nama host registry docker, misalnya, registry.gitlab.com,

    user adalah ID pengguna atau organisasi, misalnya, oneentry,

    repo adalah nama repositori, misalnya, my-module

    version adalah nama tag (versi modul).

    Contoh lengkap: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • Di kolom Docker Host, tentukan host registry docker, yang mengulangi bagian host dalam jalur gambar docker, misalnya, registry.gitlab.com.

  • Di kolom Token ID dan Token, berikan nama token (seperti yang ditentukan saat pembuatan) dan token itu sendiri (biasanya dimulai dengan glpat), masing-masing.

  • Tentukan variabel lingkungan yang diperlukan (env) yang dibutuhkan agar modul berfungsi (ini dapat diubah nanti).

Setelah membuat modul, modul tersebut akan muncul di tabel. Anda sekarang dapat menerapkannya dengan mengklik Deploy (ini akan memakan waktu).

Status Kontainer​

  • Belum Diterapkan - Modul telah dibuat tetapi belum diterapkan.
  • Sedang Diterapkan - Modul sedang dalam proses penerapan.
  • Berjalan - Modul berfungsi.
  • Ditangguhkan - Modul telah diterapkan tetapi tidak berjalan.

Tindakan Modul​

  • Suspend Menangguhkan modul. Menghentikan proses, tetapi data tetap ada.
  • Resume Melanjutkan modul. Memulai proses.
  • Delete Menghapus modul. Menghentikan proses, menghapus kontainer, dan data terkait.

Memecahkan Kesalahan​

Jika modul gagal diterapkan atau proses secara konsisten terhenti, Anda akan melihat Warn.

Masalah yang Mungkin Terjadi​

  • Gambar docker dikonfigurasi dengan tidak benar.
  • Token tidak valid atau salah.
  • Proses terhenti. Proses internal seharusnya tidak terhenti saat modul aktif.

Logging​

Anda dapat memecahkan masalah lain dengan modul menggunakan log yang ditampilkan di pengaturan modul.

Memperbarui/Mengedit Modul​

Jika Anda perlu menerapkan versi baru modul atau mengubah variabel lingkungan, Anda harus memperbarui tag dan/atau variabel di pengaturan. Proses akan dimulai ulang.