Jenkins X projesi

Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.

Proje özeti

Açık kaynak kuruluşu:
Jenkins X
Teknik yazar:
Nitin
Proje adı:
Mevcut Jenkins X Dokümanlar sitesini ve Jenkins X Capabilities Matrisi'ni yeniden düzenleme
Proje süresi:
Standart uzunluk (3 ay)

Proje açıklaması

Bu projenin ana hedefi, mevcut Jenkins X belgelerini yeniden düzenleme ve dokümanlarla ilgili sorunları düzeltmenin yanı sıra kurumsal bulut sağlayıcılarında Jenkins X kullanımıyla ilgili kullanıcı belgeleriyle birlikte güncellenmiş Jenkins X özellikler matrisini hazırlamaktır. Buna ek olarak, bu projede Daniel ile işbirliği yaparak OpenShift'e dayanan Jenkins X önizleme ortamı altyapısının geliştirilmesi de dahil.

Mevcut Jenkins X dokümanlarının yeniden düzenlenmesi kapsamında, üzerinde çalışacağım sorunlardan bazıları şunlardır:

  • EKS Kaynaklarında Başlatma: Sorun
  • Apps Kasası, EKS'de Başlatma: Sorun ile başarısız oluyor
  • Jx boot için doküman envars: Sorun
  • Apps Kasası kurulumu için gerekli belgeler: Sorun
  • Yerelden kasaya yükseltme başlatma başarısız oluyor: Sorun
  • Belgelerle ilgili geri bildirim: "create", "install jx", "boot" ve "import" arasındaki ilişki: Sorun
  • Helm Belgeleri her yerde: Sorun
  • ChartMuseum, Monocular ve Docker Registry'nin Nexus Sorunu ile neden değiştirilmediğiyle ilgili belgeleri iyileştirin
  • Önyükleme + GKE kullanılırken Docker Registry değiştirilemiyor: Sorun
  • Alan adını nip.io'dan özel alan adına geçirme işlemi başarısız oluyor: Sorun

Jenkins X özellik Matrisi'nin çalışmasında, bulut sağlayıcılarının her biri (ör. Google Cloud (GKE), Amazon Web Services (AWS EKS) ve Azure Cloud (AKS).

  • Jenkins X'in buluta terraform komut dosyaları ve jx boot ile yüklenmesi
  • Bu bulut sağlayıcısı Kubernetes hizmetlerinde Jenkins X ile Kubernetes sürümlerinin uyumluluğu kontrol ediliyor.
  • Deane ve Jenkins X topluluğu üyeleri ile tartışılacak diğer tüm Yetkiler (gizli anahtarlar için Apps Kasası depolama alanı, kaynak denetimi sürümleri veya diğerleri).

OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının kurulmasıyla ilgili çalışmalar kapsamında, işin içeriği şunlar:

  • OpenShift platformunda Jenkins X önizleme ortamı altyapısında doküman tasarlayın
  • OpenShift'te Jenkins X önizleme ortamlarının oluşturulmasını otomatikleştir
  • Önizleme ortamlarında Jenkins X belgelerini güncelleme

Proje Teslimatları:

  • Mevcut Jenkins X dokümanlarının yeniden düzenlenmesi dikkate alınarak, yukarıda bahsedilen doküman sorunlarına PR aracılığıyla yönelik düzeltmeler.
  • Jenkins X Capabilities Matrisi ve Jenkins X'i farklı bulut sağlayıcılarıyla (özellikle AKS, EKS ve GKE Kubernetes hizmetleri) kullanmayla ilgili kullanıcı belgeleriyle birlikte güncellendi.
  • Daniel ile işbirliği içinde yapılan, OpenShift tabanlı Jenkins X önizleme ortamı Altyapısının otomatik kurulumu.

Kesin Olmayan Zaman Çizelgesi (görevlerle birlikte) önerildi:

Topluluk Bağışı (17 Ağustos - 13 Eylül)

  • Teknik belgeler için Geliştirme ortamı kurun ve proje görevleri üzerinde çalışırken Bulut altyapılarına erişim kazanın.
  • Önerilen geçici takvim, proje teslimatları ve görevler (öncelikleriyle birlikte) hakkında proje danışmanlarıyla görüşmeler.
  • Kurumun çalışma sürecini, halkla ilişkiler (PR inceleme) sürecini anlayıp iyice donatın ve topluluğa dahil olun.
  • Jenkins X'in mevcut doküman durumunu inceleyin.

1. Hafta (14-20 Eylül)

  • Jenkins X'in buluta kurulumuyla ilgili talimatları, mevcut durumu ve belgeleri öğrenin.
  • Mevcut Jenkins X özellikleri (farklı bulut sağlayıcılarda doğrulanmak üzere) hakkında Deane ile görüşme.
  • OpenShift tabanlı Jenkins X önizleme ortamı altyapısının mevcut durumu hakkında Daniel ile yapılan tartışma.
  • OpenShift'te Jenkins X önizleme ortamı altyapısı için mimari tasarlamak üzere (Daniel ile iş birliği yaparak) çalışın.

2. Hafta (21 Eylül - 27 Eylül)

  • GKE bulutu için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'in yüklenmesi ve taslak kullanıcı notlarının hazırlanması.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

3. Hafta (28 Eylül - 4 Ekim)

  • GKE bulutu için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'in yüklenmesi ve taslak kullanıcı notlarının hazırlanması.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • OpenShift'e dayalı Jenkins X önizleme ortamı altyapısı için Tasarım Dokümanı üzerinde çalışın.

4. Hafta (5 Ekim - 11 Ekim)

  • GKE'de Jenkins X için kullanıcı dokümanlarını tamamlayın.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

5. Hafta (12 Eki - 18 Eki)

  • Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • Topluluk üyelerinden geri bildirim aldıktan sonra, OpenShift'i temel alan Jenkins X önizleme ortamı altyapısı için tasarım belgesini tamamlayın.

6. Hafta (19-25 Ekim)

  • Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

7. Hafta (26 Ekim - 1 Kasım)

  • Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının kurulumu üzerinde çalışın.

8. Hafta (2 Kasım - 8 Kasım)

  • AKS'de Jenkins X için kullanıcı dokümanlarını tamamlayın.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

9. Hafta (9 Kasım - 15 Kasım)

  • AWS (EKS) için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının kurulumu üzerinde çalışın.

10. Hafta (16 Kasım - 22 Kasım)

  • AWS (EKS) için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

11. Hafta (23 Kasım - 29 Kasım)

  • EKS'de Jenkins X için kullanıcı dokümanlarına son halini verin.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • Jenkins X önizleme ortamı altyapısıyla ilgili belgeleri Jenkins X Dokümanlar sitesinde tamamlayın.

12. Hafta (30 Kasım - 5 Aralık)

  • Proje teslimatlarını tamamlama ve varsa geri bildirim doğrultusunda kodu yeniden düzenleme.
  • Bağlantılar, resimler, köprüler ve diğer öğeler dahil olmak üzere Jenkins X dokümanlar sitesinin çalışmasını test edin.
  • Jenkins X dokümanları sitesinin kullanıcı tanımlı denetimi ve gezinme özelliğini kontrol edin.
  • Jenkins X Capabilites matrisinin nihai sunumunu kontrol edin.

10 Aralık 2020'den önce Hem teknik yazar hem de Mentorlar proje değerlendirmelerini gönderirler.

Önerilen projenin Jenkins X ve topluluğuna faydaları nelerdir? Bu proje, Jenkins X topluluğunun son kullanıcıları için dokümanları ve ayrıca, Jenkins X teknik mimarisi, uyumluluğu, kullanımı ve entegrasyonu ile ilgili referanslar için dokümanları geliştirmesine yardımcı olacaktır. Önerilen bu proje tamamlandığında, farklı bulut sağlayıcılarıyla uyumluluğu için Jenkins X Yetenek Matrisi ile birlikte Jenkins X'in tam kapsamlı, iyi tanımlanmış ve teknik olarak doğrulanmış kullanıcı dokümanları olacaktır.

Jenkins X ile gelecekte hangi avantajlar üzerinde çalışmayı planlıyorsunuz? Google Dokümanlar Sezonu 2020 programı sona erdikten sonra, topluluğun etkin bir üyesi olarak Jenkins X projesine uzun süreli katkıda bulunmayı planlıyorum. Diğer kullanıcılara (yeni başlayanlar) yardımcı olmak ve onları Jenkins X topluluğuna katılmaya teşvik etmek için her zaman yanınızda olacağım. Diğer Jenkins X proje fikirleri üzerinde çalışmayı her zaman isterim.

Beni bu projede çalışmaya en uygun kılan nedenlerden bazıları:

  • Çok metodik ve düzenliyimdir. Haftada bir kez blog yayınları, planlanmış SIG-belgeleri toplantıları ve e-postalar aracılığıyla hem proje mentorlarına hem de kurum topluluğuna projenin ilerlemesiyle ilgili sürekli bilgi almayı umuyorum.
  • Görevlerde ilerlemek ve herkesin ortak bir paydada buluşmasını sağlamak için (tüm zorluklardan ve/veya karşılaşılan engellerden bahsetmek dahil) rehberlik almak, mentorlardan ve topluluk üyelerinden geri bildirim almak isteyeceksiniz.
  • Kodun mentordan ve katkıda bulunanlardan biri tarafından incelenmesini sağlamak üzere tüm kaynak kodun düzenli olarak yazılması ve topluluk üyelerine referans olması için yapılan çalışmaların belgelenmesi.
  • Bu proje fikri üzerinde çalışmak için gereken tüm teknik becerilere sahibim ve mentorlar Deane, Kara ve Daniel ile proje teklifi hakkında konuştum. Proje teklifi ve teslimatları konusunda kapsamlı bir fikrim var.
  • Eksiksiz belgeler sunmak ve belgelerle ilgili mevcut sorunların çoğunu çözmek için gereken teknik becerilerde (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo ve diğerleri) çalışma deneyimim var. Az gözetim altında proje çalışmalarını zamanında tamamlayabilecek pozitif bir tutum sergiliyorum.