פרויקט Jenkins X

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

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

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

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

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

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

  • הפעלה במשאבי EKS: בעיה
  • ה-Vault נכשל ב-EKS בעקבות אתחול: בעיה
  • קובצי envars עבור אתחול jx: בעיה
  • מסמכים נדרשים להגדרת Vault: בעיה
  • שדרוג ההפעלה מהאחסון המקומי ל-Vault נכשל: בעיה
  • משוב על תיעוד הקשר בין "יצירה" לבין "התקנת jx" לעומת "אתחול" לעומת "ייבוא": בעיה
  • תיעוד הלם נמצא בכל מקום: בעיה
  • שיפור מסמכים מדוע ChartMuseum, Monocular ו-Docker Registry לא מחליפים בבעיה ב-Nexus
  • לא ניתן לשנות את Docker Registry כשמשתמשים ב-Bot + 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 בסביבות של תצוגה מקדימה

תוצרים של הפרויקט:

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

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

גיבוש קהילתי (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 Cloud (AKS): התקנת Jenkins X והכנת טיוטה של הערות משתמש.
  • עבדו על אחד מבעיית המסמכים לשיפור התיעוד הקיים של Jenkins X.
  • יש להשלים את מסמך העיצוב של התשתית של סביבת התצוגה המקדימה ב-Jenkins X המבוססת על OpenShift, אחרי קבלת משוב מחברי הקהילה.

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

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

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

  • עבודה על מטריצת היכולות של Jenkins X עבור Azure Cloud (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 ואימיילים על בסיס קבוע.
  • יש צורך בהדרכה ובמשוב מהחונכים ומחברי הקהילה לעיתים קרובות, כדי להתקדם במשימות ולוודא שכולם יהיו מעודכנים (כולל אזכור של אתגרים ו/או נקודות חסימה שעמדו בפניכם).
  • להתחייב לכל קוד המקור שנכתב באופן קבוע, כדי שהקוד ייבדק על ידי המנטור, תורמי התוכן ותיעוד העבודה שנעשתה עבור חברי הקהילה.
  • יש לי את כל הכישורים הטכניים הנדרשים כדי לעבוד על הרעיון לפרויקט הזה ודיברתי על ההצעה לפרויקט עם המנטורים דין, קארה ודני. קיבלתי הבנה עמוקה לגבי הצעת הפרויקט והתוצאות שלה.
  • יש לי ניסיון בעבודה עם הכישורים הטכניים (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo ואחרים) שנדרשים כדי לספק מסמכים מלאים וכדי לפתור את רוב הבעיות הקיימות שקשורות לתיעוד. יש לי גישה חיובית ויכולת להשלים את הפרויקט בזמן, בלי פיקוח מועט.