דלג לתוכן הראשי

מודולים מותאמים אישית

אתם יכולים לפרוס את המודול שלכם עם הפונקציות שלכם באמצעות API המפתחים.

פיתוח

השתמשו בתבנית https://github.com/OneEntry/module-example ועקבו אחרי ההוראות ב- https://github.com/OneEntry/custom-module-deployment-guide במהלך הפיתוח.

בנייה

  • צרו טוקן פרויקט חדש עם הרשאות read-registry. מומלץ ליצור טוקן ללא תאריך תפוגה.
  • צרו תג חדש ב-git (בכל פעם שמשחררים גרסה חדשה של המודול)
  • המתינו לסיום ה-pipeline, לאחר מכן התמונה של המודול תועלה ל-registry ותהיה זמינה לפריסה

פריסה

עברו להגדרות, לחלק "מודולים" וגללו למטה כדי לעבור לטופס הוספת מודול.

  • ציינו את השם ואת התג של המודול

  • בשדה Url של התמונה ציינו את הנתיב לתמונה של docker שנבנתה קודם בפורמט host/user/repo:version.

    איפה שhost - שם ה-host של docker registry, לדוגמה registry.gitlab.com,

    user - מזהה המשתמש או הארגון, לדוגמה oneentry,

    repo - שם הרפוזיטורי, לדוגמה my-module

    version - שם התג (גרסת המודול)

    דוגמה מלאה: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • בשדה Docker host ציינו את ה-host של docker registry, הוא משכפל את חלק ה-host בנתיב לתמונה של docker, לדוגמה registry.gitlab.com

  • בשדות Id של הטוקן ו-טוקן ציינו את שם הטוקן (כפי שניתן בעת יצירתו) ואת הטוקן עצמו (בדרך כלל מתחיל ב- glpat) בהתאמה

  • ציינו את משתני הסביבה (env) הנדרשים לפעולה של המודול (ניתן לשנות מאוחר יותר)

לאחר יצירת המודול, הוא יופיע בטבלה. עכשיו אתם יכולים לפרוס אותו על ידי לחיצה על Deploy (זה ייקח קצת זמן).

סטטוסים של הקונטיינר

  • לא פרוס - המודול נוצר, אך עדיין לא היה פרוס
  • מתפרס - המודול בתהליך פריסה
  • פועל - המודול פועל
  • מושהה - המודול פרוס, אך לא פועל

פעולות עם המודול

  • Suspend השהה את המודול. עוצר את התהליך, אך הנתונים נשארים
  • Resume המשך את פעולתו של המודול. מפעיל את התהליך
  • Delete מחק את המודול. יעצור את התהליך, ימחק את הקונטיינר ואת הנתונים הקשורים אליו

ניפוי שגיאות

אם לא הצלחתם לפרוס את המודול או שהתהליך נכשל באופן שיטתי, תראו Warn.

בעיות אפשריות

  • התמונה של docker לא מוגדרת כראוי
  • טוקן לא חוקי או לא תקין
  • התהליך נכשל. תהליך פנימי לא אמור להיכשל כל עוד המודול פעיל

רישום

בעיות אחרות עם המודול ניתן לנפות בעזרת הלוגים המוצגים בהגדרות המודול

עדכון/עריכת המודול

אם יש צורך לפרוס גרסה חדשה של המודול או לשנות את משתני הסביבה, עליכם לעדכן את התג ו/או את המשתנים בהגדרות. התהליך יתחדש.