Projekt Jenkins X

Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie Dokumentów Google.

Podsumowanie projektu

Organizacja open source:
Jenkins X
Pisarz techniczny:
Nitin
Nazwa projektu:
Refaktoryzacja istniejącej strony z dokumentami Jenkinsa X i matrycy uprawnień Jenkinsa X
Długość projektu:
Standardowa długość (3 miesiące)

Opis projektu

Głównym celem tego projektu jest refaktoryzowanie istniejącej dokumentacji Jenkinsa X podczas rozwiązywania problemów z dokumentami oraz przygotowanie zaktualizowanej macierzy funkcji Jenkinsa X wraz z dokumentacją użytkownika dotyczącą wykorzystania Jenkinsa X w usługach dostawców chmury dla firm. Dodatkowo projekt obejmuje też we współpracy z Danielem opracowywanie infrastruktury środowiska podglądu Jenkinsa X opartej na OpenShift.

W ramach refaktoryzacji istniejącej dokumentacji Jenkinsa X niektóre z problemów, nad którymi chciałbym pracować, obejmują:

  • Uruchamianie w zasobach EKS: problem
  • Błąd Vault w EKS podczas uruchamiania: problem
  • Zmienne dokumentów dla rozruchu JX: problem
  • Dokumentacja wymagana do skonfigurowania Vault: problem
  • Nie udało się przeprowadzić uaktualnienia z lokalnego do Vault: problem
  • Opinie na temat dokumentacji – stosunek „utwórz” do „zainstaluj jx” a „rozruch” i „import”: problem
  • Dokumentacja narzędzia Helm jest dostępna wszędzie: problem
  • Poprawiono dokumenty, dlaczego programy ChartMuseum, Monocular i Docker Registry nie zostały zastąpione przez Problem Nexus
  • Nie można zmienić Docker Registry podczas używania rozruchu + GKE: problem
  • Nie można zmienić domeny z nip.io na domenę niestandardową: problem

W przypadku macierzu funkcji Jenkinsa X praca obejmuje (jak wspomnieliśmy poniżej) usługi Kubernetes dla przedsiębiorstw oferowane przez każdego z dostawców chmury, np. Google Cloud (GKE), Amazon Web Services (AWS EKS) i Azure Cloud (AKS).

  • Instalacja Jenkinsa X w chmurze za pomocą skryptów Terraform i jx boot
  • Sprawdzam zgodność wersji Kubernetes z Jenkinem X w usługach Kubernetes dostawców chmury.
  • Wszelkie inne możliwości (przechowywanie obiektów tajnych w Vault, wersje kontroli źródła lub inne) do omówienia z Deane i członkami społeczności Jenkinsa X.

Prace związane z konfigurowaniem infrastruktury środowiska podglądu Jenkins X opartego na OpenShift obejmują:

  • Dokument projektowy w infrastrukturze środowiska podglądu Jenkins X na platformie OpenShift
  • Zautomatyzuj tworzenie środowisk podglądu Jenkins X w OpenShift
  • Aktualizowanie dokumentacji Jenkinsa X w środowiskach podglądu

rezultaty projektu:

  • Poprawki przez PR do wymienionych powyżej problemów z dokumentacją. Ma to na celu refaktoryzację istniejącej dokumentacji Jenkinsa X.
  • Zaktualizowaliśmy tablicę uprawnień Jenkinsa X wraz z dokumentacją użytkownika dotyczącą używania Jenkinsa X z różnymi dostawcami chmury (usługi Kubernetes, głównie AKS, EKS i GKE).
  • We współpracy z Danielem zautomatyzowano konfigurację infrastruktury środowiska podglądu Jenkinsa X na podstawie OpenShift.

Zaproponowane wstępne harmonogramy (wraz z zadaniami):

Nawiązywanie więzi z innymi (17 sierpnia – 13 września)

  • Skonfiguruj środowisko programistyczne na potrzeby dokumentacji technicznej i uzyskaj dostęp do infrastruktur Google Cloud, aby móc wykonywać zadania w projekcie.
  • Omów z mentorami zajmującymi się projektem wstępny harmonogram, listę zadań i zadania (wraz z ich priorytetem).
  • Zapoznaj się z procesem pracy organizacji, procesem oceny PR i zaangażuj się w życie społeczności.
  • Przejrzyj bieżący stan dokumentacji Jenkinsa X.

Tydzień 1 (14 września – 20 września)

  • Zapoznaj się z instrukcjami konfigurowania Jenkinsa X w chmurze, bieżącym stanem i dokumentacją.
  • Dyskusja z Deane na temat bieżących funkcji Jenkinsa X (do weryfikacji u różnych dostawców chmury).
  • Dyskusja z Danielem na temat aktualnego stanu infrastruktury środowiska Jenkinsa X w wersji testowej opartej na OpenShift.
  • Współpracuj (we współpracy z Danielem) z projektem architektury dla wersji testowej infrastruktury środowiska Jenkinsa X w OpenShift.

Tydzień 2 (21–27 września)

  • Pracuj nad macierz funkcji Jenkinsa X dla chmury GKE: zainstaluj Jenkinsa X i przygotuj wersje robocze notatek dla użytkowników.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.

Tydzień 3 (28 września – 4 października)

  • Pracuj nad macierz funkcji Jenkinsa X dla chmury GKE: zainstaluj Jenkinsa X i przygotuj wersje robocze notatek dla użytkowników.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
  • Pracuj nad dokumentem projektu dla infrastruktury środowiska podglądu Jenkins X opartej na OpenShift.

Tydzień 4 (5 października – 11 października)

  • Finalizowanie dokumentacji użytkownika Jenkinsa X w GKE.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.

Tydzień 5 (12 paź – 18 października)

  • Praca nad macierz funkcji Jenkinsa X dla chmury Azure (AKS): instalacja Jenkinsa X i przygotowanie notatek dla użytkowników w wersji roboczej.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
  • Po otrzymaniu opinii od członków społeczności dokończ tworzenie dokumentu projektowego dla infrastruktury środowiska podglądu Jenkinsa X na podstawie OpenShift.

Tydzień 6 (19 paź – 25 października)

  • Praca nad macierz funkcji Jenkinsa X dla chmury Azure (AKS): instalacja Jenkinsa X i przygotowanie notatek dla użytkowników w wersji roboczej.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.

Tydzień 7 (26 października – 1 listopada)

  • Praca nad macierz funkcji Jenkinsa X dla chmury Azure (AKS): instalacja Jenkinsa X i przygotowanie notatek dla użytkowników w wersji roboczej.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
  • Praca nad konfiguracją infrastruktury środowiska podglądu Jenkins X w oparciu o OpenShift.

Tydzień 8 (2–8 listopada)

  • Finalizować dokumenty użytkownika Jenkinsa X w AKS.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.

Tydzień 9 (9 listopada – 15 listopada)

  • Praca z macierz funkcji Jenkinsa X dla AWS (EKS): instalacja Jenkinsa X i przygotowywanie notatek dla użytkowników w wersji roboczej.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
  • Praca nad konfiguracją infrastruktury środowiska podglądu Jenkins X w oparciu o OpenShift.

Tydzień 10 (16 listopada – 22 listopada)

  • Praca z macierz funkcji Jenkinsa X dla AWS (EKS): instalacja Jenkinsa X i przygotowywanie notatek dla użytkowników w wersji roboczej.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.

Tydzień 11 (23 lis – 29 listopada)

  • Finalizowanie dokumentacji użytkownika Jenkinsa X w EKS.
  • Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
  • Sfinalizuj dokumentację infrastruktury środowiska podglądu Jenkinsa X w witrynie z dokumentami Jenkins X.

Tydzień 12 (30 listopada – 5 grudnia)

  • Na podstawie opinii możesz zakończyć prace nad projektem i refaktoryzować kod (w razie potrzeby).
  • Przetestuj działanie witryny z dokumentami Jenkins X, w tym linków, obrazów, hiperlinków i innych elementów.
  • Sprawdź zdefiniowany przez użytkownika element sterujący i nawigację w witrynie z dokumentami Jenkins X.
  • Sprawdź ostateczną prezentację macierzy funkcji Jenkinsa X.

Do 10 grudnia 2020 r. Oceny projektu mogą ocenić nasi współtwórcy techniczni i mentorzy.

Jakie korzyści będzie miał proponowany projekt dla Jenkinsa X i jego społeczności? Ten projekt pomoże społeczności Jenkinsa X w ulepszaniu dokumentacji dla użytkowników końcowych oraz programistów w celu odniesienia do architektury technicznej, zgodności, użytkowania i integracji Jenkinsa X. Po zakończeniu tego proponowanego projektu powstanie pełnoprawna, dobrze zdefiniowana i zweryfikowana technicznie dokumentacja dla użytkowników Jenkinsa X oraz macierz funkcji Jenkinsa X zapewniająca zgodność z różnymi dostawcami usług w chmurze.

Jakie korzyści zamierzacie wykorzystać w przyszłości z Jenkinem X? Po zakończeniu programu „Sezon of Dokumenty Google 2020” planuję być długoterminowym współtwórcą projektu Jenkins X jako aktywny członek społeczności. Zawsze będę pomagać innym (nowym graczom) i zachęcać ich do zaangażowania się w życie społeczności Jenkinsa X. Zawsze chciałbym pracować nad innymi pomysłami na projekt Jenkinsa X.

Oto kilka powodów, dla których najlepiej mogę pracować nad tym projektem:

  • Jestem bardzo metodyczną i zorganizowaną. Oczekuję, że będę otrzymywać informacje o postępach zarówno dla mentorów pracujących nad projektem, jak i członków społeczności organizacji za pomocą postów na blogu, zaplanowanych cotygodniowych spotkań zespołu SIG oraz regularnych e-maili.
  • Będę regularnie prosić o pomoc i opinie mentorów i członków społeczności, aby śledzić postępy w realizacji zadań i zadbać o to, aby wszyscy byli na bieżąco (w tym również o ewentualnych wyzwaniach i/lub punktach blokujących).
  • Regularne przekazywanie całego kodu źródłowego, tak by były one sprawdzane przez mentora i współtwórców oraz dokumentowanie wykonywanej pracy.
  • Mam wszystkie niezbędne umiejętności techniczne potrzebne do opracowania projektu i omówiłem go z mentorkami Deane, Karą i Danielem. Mam szczegółową wiedzę na temat propozycji projektu i realizacji.
  • Mam doświadczenie w pracy w zakresie umiejętności technicznych (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo i innych), które są niezbędne, aby dostarczać pełną dokumentację i rozwiązywać większość aktualnych problemów związanych z dokumentacją. Jestem zdania, że potrafię przygotować projekt na czas, bez żadnego nadzoru.