פרויקט Jenkins X

דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.

סיכום הפרויקט

ארגון הקוד הפתוח:
Jenkins X
כתב טכני:
ניטין
שם הפרויקט:
ארגון מחדש של אתר המסמכים הקיים ב-Jenkins X ושל מטריצת היכולות של Jenkins X
אורך הפרויקט:
אורך רגיל (3 חודשים)

תיאור הפרויקט

המטרה העיקרית של הפרויקט היא לארגן מחדש את התיעוד הקיים ב-Jenkins X תוך תיקון הבעיות שקשורות למסמכים, וכן להכין את מטריצת היכולות המעודכנת של Jenkins X יחד עם תיעוד למשתמשים על השימוש ב-Jenkins X בספקי שירותי ענן ארגוני. בנוסף, הפרויקט כולל עבודה על פיתוח תשתית סביבת תצוגה מקדימה ב-Jenkins X המבוססת על OpenShift, בשיתוף פעולה עם דניאל.

כחלק מהארגון מחדש של התיעוד הקיים ב-Jenkins X, אבדוק חלק מהבעיות הבאות:

  • הפעלה במשאבי EKS: בעיה
  • Vault נכשל ב-EKS במהלך ההפעלה: בעיה
  • משאבי מסמכים לאתחול jx: בעיה
  • נדרשים מסמכים להגדרת Vault: בעיה
  • שדרוג ההפעלה מ-Google Vault נכשל: בעיה
  • משוב על תיעוד הקשר בין 'יצירה' ל'התקנה של jx' לעומת 'הפעלה' לעומת 'ייבוא': בעיה
  • התיעוד של Helm נמצא בכל מקום: בעיה
  • שיפור מסמכים מדוע ChartMuseum, Monocular ו-Docker Registry לא מוחלפים בבעיה ב-Nexus
  • לא ניתן לשנות את Docker Registry כשמשתמשים באתחול + GKE: בעיה
  • שינוי הדומיין מ-nip.io לדומיין מותאם אישית נכשל: בעיה

במטריצת היכולות של Jenkins X העבודה כוללת (כמתואר בהמשך) שירותי Kubernetes ארגוניים שמוצעים על ידי כל אחד מספקי הענן, כלומר, Google Cloud (GKE), Amazon Web Services (AWS EKS) ו-Azure Cloud (AKS).

  • התקנה של Jenkins X בענן באמצעות סקריפטים של terraform ו-jx boot
  • אנחנו בודקים את התאימות של גרסאות Kubernetes עם Jenkins X בשירותי kubernetes של ספקי הענן.
  • אפשר לדון על כל יכולת אחרת (אחסון סודות ב-Vault, גרסאות של בקרת מקור ועוד) עם דיאן וחברי הקהילה של Jenkins X.

העבודה על הגדרת התשתית של סביבת התצוגה המקדימה ב-Jenkins X על סמך OpenShift כוללת את:

  • מסמך עיצוב בתשתית של סביבת התצוגה המקדימה של Jenkins X בפלטפורמת OpenShift
  • יצירה אוטומטית של סביבות תצוגה מקדימה ב-Jenkins X ב-OpenShift
  • עדכון התיעוד של Jenkins X בסביבות תצוגה מקדימה

פריטים נדרשים בפרויקט:

  • תיקונים דרך יחסי ציבור לבעיות במסמכים שצוינו למעלה, עקב ארגון מחדש של התיעוד הקיים ב-Jenkins X.
  • עדכון של מטריצת היכולות של Jenkins X יחד עם תיעוד למשתמש לגבי השימוש ב-Jenkins X עם ספקי ענן שונים (שירותי Kubernetes בעיקר AKS, EKS ו-GKE).
  • הגדרה אוטומטית של תשתית התצוגה המקדימה ב-Jenkins X שמבוססת על OpenShift, בשיתוף פעולה עם Daniel.

הצעה לציר זמן לא סופי (יחד עם המשימות):

גיבוש קהילתי (17 באוגוסט עד 13 בספטמבר)

  • הגדרת סביבת פיתוח לתיעוד טכני, וקבלת גישה לתשתיות של Cloud לצורך עבודה על משימות הפרויקט.
  • דיון עם המנטורים של הפרויקט על ציר הזמן המוצע, על התוצרים של הפרויקט ועל המשימות (ביחד עם העדיפות שלהן).
  • הבנת תהליך העבודה של הארגון ותהליך בדיקת יח"צ, והשתתפות בו, כולל צבירת ידע והשתתפות.
  • סקירת מצב התיעוד הנוכחי של Jenkins X.

שבוע 1 (14 בספטמבר עד 20 בספטמבר)

  • הסבר על ההוראות להגדרת Jenkins X בענן, מצב נוכחי ותיעוד.
  • דיון עם דין לגבי היכולות הנוכחיות של Jenkins X (יש לבדוק אותן אצל ספקים שונים של שירותי ענן).
  • דיון עם דניאל על המצב הנוכחי של התשתית של סביבת התצוגה המקדימה ב-Jenkins X על בסיס OpenShift.
  • עבודה (בשיתוף פעולה עם דניאל) על עיצוב ארכיטקטורה לתשתית סביבת התצוגה המקדימה של Jenkins X ב-OpenShift.

שבוע 2 (21 בספטמבר עד 27 בספטמבר)

  • עבודה על מטריצת היכולות של Jenkins X לענן GKE: התקנה של Jenkins X והכנת הערות משתמש בשלב טיוטה.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.

שבוע 3 (28 בספטמבר עד 4 באוקטובר)

  • עבודה על מטריצת היכולות של Jenkins X לענן GKE: התקנה של Jenkins X והכנת הערות משתמש בשלב טיוטה.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.
  • עבודה על תשתית סביבת התצוגה המקדימה של Jenkins X בהתבסס על OpenShift.

שבוע 4 (5 באוקטובר עד 11 באוקטובר)

  • השלמת מסמכי המשתמש של Jenkins X ב-GKE.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.

שבוע 5 (12 באוקטובר עד 18 באוקטובר)

  • עבודה על מטריצת היכולות של Jenkins X עבור ענן Azure (AKS): התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.
  • עליכם להשלים את מסמך העיצוב של התשתית של סביבת התצוגה המקדימה ב-Jenkins X שמבוססת על OpenShift, ואז לקבל משוב מחברי הקהילה.

שבוע 6 (19 באוקטובר עד 25 באוקטובר)

  • עבודה על מטריצת היכולות של Jenkins X עבור ענן Azure (AKS): התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.

שבוע 7 (26 באוקטובר עד 1 בנובמבר)

  • עבודה על מטריצת היכולות של Jenkins X עבור ענן Azure (AKS): התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.
  • הגדרת התשתית של סביבת התצוגה המקדימה ב-Jenkins X על סמך OpenShift.

שבוע 8 (2 בנובמבר עד 8 בנובמבר)

  • השלמת מסמכי המשתמש של Jenkins X ב-AKS.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.

שבוע 9 (9 בנובמבר עד 15 בנובמבר)

  • עבודה על מטריצת היכולות של Jenkins X עבור AWS (EKS): התקנה של Jenkins X והכנת הערות משתמש בשלב טיוטה.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.
  • הגדרת התשתית של סביבת התצוגה המקדימה ב-Jenkins X על סמך OpenShift.

שבוע 10 (16 בנובמבר עד 22 בנובמבר)

  • עבודה על מטריצת היכולות של Jenkins X עבור AWS (EKS): התקנה של Jenkins X והכנת הערות משתמש בשלב טיוטה.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.

שבוע 11 (23 בנובמבר עד 29 בנובמבר)

  • השלמת המסמכים של המשתמש ל-Jenkins X ב-EKS.
  • עובדים על אחד מהמסמכים לבעיות לשיפור התיעוד הקיים של Jenkins X.
  • השלמת התיעוד של תשתית סביבת התצוגה המקדימה של Jenkins X באתר המסמכים של Jenkins X.

שבוע 12 (30 בנובמבר עד 5 בדצמבר)

  • משלימים את התוצרים של הפרויקט ומגדירים מחדש את הקוד אם יש, בהתאם למשוב.
  • בדקו את אופן הפעולה של אתר המסמכים של Jenkins X כולל קישורים, תמונות, היפר-קישורים ועוד.
  • מחפשים את אמצעי הבקרה והניווט שהוגדרו על ידי המשתמש באתר המסמכים של Jenkins X.
  • בדקו את המצגת הסופית של מטריצת Jenkins X Capabilites.

לפני 10 בדצמבר 2020 גם הכותב הטכני וגם המנטור מגישים הערכת את הפרויקט.

מהם היתרונות של הפרויקט המוצע ל-Jenkins X ולקהילה? הפרויקט הזה יעזור לקהילת Jenkins X לשפר את התיעוד עבור משתמשי הקצה שלה וכן מפתחים לעיון בנושא הארכיטקטורה הטכנית, התאימות, השימוש וההטמעה של Jenkins X. לאחר השלמת הפרויקט שהוצע, היה קיים תיעוד משתמש מלא, מוגדר היטב ומאומת מבחינה טכנית של Jenkins X יחד עם מטריצת היכולת של Jenkins X עבור תאימותו לספקי ענן שונים.

על אילו הטבות עתידיות בכוונתך לעבוד עם Jenkins X? אחרי סיום התוכנית של Google Docs 2020, אני מתכננת לתרום לטווח הארוך בפרויקט Jenkins X כחבר פעיל בקהילה. אני תמיד כאן כדי לעזור לאחרים (חדשים) ולעודד אותם להיות מעורבים בקהילת Jenkins X. אני תמיד מוכנה לעבוד על רעיונות אחרים לפרויקטים של Jenkins X.

למה כדאי לי לעבוד על הפרויקט הזה?

  • אני מאוד שיטתי ומאורגן. אני מצפה מאוד להתעדכן לגבי התקדמות הפרויקט הן למנטורים של הפרויקט והן לקהילת הארגון באמצעות פוסטים בבלוג פעם בשבוע, פגישות שבועיות עם מסמכי SIG במסמכי SIG והודעות אימייל על בסיס קבוע.
  • נבקש הדרכה וגם משוב מהמנטורים וחברי הקהילה לעיתים קרובות, כדי להתקדם במשימות ולוודא שכולם יהיו מעודכנים (כולל אזכור של אתגרים ו/או נקודות חסימה שהם עומדים בפני).
  • עבודה על כל קוד המקור שנכתב באופן קבוע, כדי שהקוד ייבדק באופן קבוע מהמנטור, מהתורמים ומהעבודה שנכתבה עבור חברי הקהילה.
  • יש לי את כל המיומנויות הטכניות הנדרשות כדי לעבוד על רעיון לפרויקט, ושוחחתי על ההצעה לפרויקט עם המנטורים דין, קארה ודניאל. הבנתי לעומק את ההצעה לפרויקט ואת התוצרים שלה.
  • יש לי ניסיון בעבודה עם המיומנויות הטכניות (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo ועוד) הנדרשות כדי לספק תיעוד מלא ולפתור את רוב הבעיות הקיימות הקשורות לתיעוד. יש לי גישה חיובית ויכולת לבצע את הפרויקט בזמן, עם מעט פיקוח.