انتقل إلى المحتوى الرئيسي

الوحدات المخصصة

يمكنك نشر وحدتك مع وظائفك الخاصة باستخدام واجهة برمجة التطبيقات للمطورين.

التطوير​

استخدم القالب https://github.com/OneEntry/module-example واتبع التعليمات في https://github.com/OneEntry/custom-module-deployment-guide أثناء التطوير.

البناء​

  • أنشئ رمز مشروع جديد بصلاحيات read-registry. يُوصى بإنشاء رمز دائم.
  • أنشئ علامة جديدة في git (مع كل إصدار جديد من الوحدة)
  • انتظر حتى يكتمل خط الأنابيب، بعد ذلك سيتم تحميل صورة docker للوحدة إلى السجل وستكون متاحة للنشر

النشر​

انتقل إلى الإعدادات، علامة التبويب Modules، وقم بالتمرير لأسفل إلى بطاقة Create New Module.

  • حدد الاسم (Name) والعلامة (Marker) للوحدة

  • في قسم Docker image في حقل Image URL، حدد المسار إلى صورة docker التي تم بناؤها سابقًا بتنسيق host/user/repo:version.

    حيث host - اسم مضيف سجل docker، مثل registry.gitlab.com،

    user - معرف المستخدم أو المنظمة، مثل oneentry،

    repo - اسم المستودع، مثل my-module

    version - اسم العلامة (إصدار الوحدة)

    مثال كامل: registry.gitlab.com/oneentry/my-module:v1.0.0

  • في حقل Registry host، حدد مضيف سجل docker، وهو يتكرر في جزء host من المسار إلى صورة docker، مثل registry.gitlab.com

  • في حقلي Token ID و Token، حدد اسم الرمز (المحدد عند الإنشاء) والرمز نفسه (عادةً ما يبدأ بـ glpat) على التوالي

  • تحت حقلي Token ID و Token، اضغط على Add وحدد المتغيرات البيئية المطلوبة لتشغيل الوحدة (يمكن تغييرها لاحقًا)

اضغط على Create.

بعد إنشاء الوحدة، ستظهر في الجدول. الآن يمكنك نشرها بالضغط على Deploy (سيستغرق ذلك بعض الوقت).

حالات الحاوية​

  • Not deployed — تم إنشاء الوحدة، لكنها لم تُنشر بعد
  • Deploying — الوحدة في عملية النشر
  • Running — الوحدة تعمل
  • Suspended — تم نشر الوحدة، لكنها غير نشطة
  • Error — انتهت آخر عملية مع الوحدة بخطأ، انظر قسم «تصحيح الأخطاء»

أثناء تنفيذ العملية مع الوحدة، يتم عرض تقدمها في عمود الحالة: Deploying، Suspending، Resuming أو Deleting. الحالة التي لم يتم الحصول عليها تُعرض كـ Unknown. يتم تحديث الحالات تلقائيًا.

إجراءات مع الوحدة​

  • Suspend إيقاف الوحدة. يوقف العملية، لكن البيانات تبقى
  • Resume استئناف عمل الوحدة. يبدأ العملية
  • حذف حذف الوحدة. سيتوقف العملية، ويحذف الحاوية والبيانات المرتبطة بها

تصحيح الأخطاء​

إذا لم يتمكن من نشر الوحدة أو إذا كانت العملية تنتهي بشكل متكرر، ستحصل الوحدة على حالة Error، وستظهر أيقونة خطأ في السطر مع تلميح "كانت آخر عملية مع هذه الوحدة غير ناجحة". لدى الوحدة في حالة Error، كما هو الحال مع الوحدة غير المنشورة، تتوفر مرة أخرى زر النشر Deploy: قم بإصلاح السبب وأعد نشر الوحدة.

المشاكل المحتملة​

  • صورة docker غير مُعدة بشكل صحيح
  • رمز غير صالح أو غير صحيح
  • العملية تنتهي. يجب ألا تنتهي العملية الداخلية طالما أن الوحدة نشطة

تسجيل الأخطاء​

يمكنك تصحيح مشاكل أخرى مع الوحدة باستخدام السجلات المعروضة في إعدادات الوحدة

تحديث/تعديل الوحدة​

إذا كان من الضروري نشر إصدار جديد من الوحدة أو تغيير المتغيرات البيئية، يجب عليك تحديث العلامة و/أو المتغيرات في الإعدادات. ستتم إعادة تشغيل العملية.