Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Jenkins X
- Pisarz techniczny:
- Nitin
- Nazwa projektu:
- Refaktoryzacja istniejącej witryny 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, a także opracowanie zaktualizowanej tabeli możliwości Jenkinsa X wraz z dokumentacją użytkownika dotyczącą wykorzystania tej platformy w usługach dostawców chmury dla firm. Dodatkowo projekt ten obejmuje również we współpracy z Danielem opracowywanie infrastruktury środowiska podglądu Jenkins X opartej na OpenShift.
W ramach refaktoryzacji istniejącej dokumentacji Jenkinsa X można napotkać następujące problemy:
- Uruchamianie w zasobach EKS: problem
- Błąd Vault w EKS podczas uruchamiania: problem
- Envars dokumentu dla rozruchu JX: problem
- Dokumentacja wymagana do skonfigurowania Vault: problem
- Nie udało się uaktualnić do Vault podczas uruchamiania z lokalnego do Vault: problem
- Opinie dotyczące dokumentacji
- Dokumentacja Helm jest dostępna wszędzie: problem
- Popraw dokumentację, dlaczego 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 udało się zmienić domeny nip.io na domenę niestandardową: problem
W przypadku tablicy możliwości Jenkinsa X praca obejmuje (jak wspomnieliśmy poniżej) usługi Kubernetes dla przedsiębiorstw oferowane przez każdego z dostawców Cloud, 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 od tych dostawców chmury.
- Wszelkie inne możliwości (przechowywanie obiektów tajnych w Vault, wersje kontroli źródła i inne) do omówienia z Deane i członkami społeczności Jenkinsa X.
Działania związane z konfigurowaniem infrastruktury środowiska podglądu Jenkins X opartej na OpenShift obejmują:
- Dokument projektuowy 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
Efekty realizacji projektu:
- Poprawki przesłane przez PR do wymienionych powyżej problemów z dokumentami w celu refaktoryzacji 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).
- Zautomatyzowane konfigurowanie infrastruktury środowiska podglądu Jenkins X na podstawie OpenShift we współpracy z Danielem.
Proponowana wstępna oś czasu (wraz z zadaniami):
Tworzenie więzi społecznych (17 sierpnia – 13 września)
- Skonfiguruj środowisko programistyczne na potrzeby dokumentacji technicznej i uzyskaj dostęp do infrastruktur Google Cloud, aby wykonywać zadania związane z projektem.
- Omów z mentorami pracującymi nad projektem wstępny harmonogram, zadania do realizacji i zadania (wraz z ich priorytetem).
- Zadbaj o dobre poznanie procesu pracy w organizacji, procesu weryfikacji PR i zaangażowania 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 konfiguracji Jenkinsa X w chmurze, bieżącym stanie i dokumentacji.
- Dyskusja z Deane na temat bieżących funkcji Jenkinsa X (do weryfikacji u różnych dostawców usług w chmurze).
- Dyskusja z Danielem na temat bieżącego stanu infrastruktury środowiska testowego Jenkinsa X opartej na OpenShift.
- Współpracuj (we współpracy z Danielem) nad projektowaniem architektury dla środowiska testowego Jenkinsa X w OpenShift.
Tydzień 2 (21 września – 27 września)
- Praca nad macierzą funkcji Jenkinsa X dla chmury GKE: instalacja Jenkinsa X i przygotowywanie wersji roboczych 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)
- Praca nad macierzą funkcji Jenkinsa X dla chmury GKE: instalacja Jenkinsa X i przygotowywanie wersji roboczych notatek dla użytkowników.
- Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
- Pracuj nad infrastrukturą środowiska podglądu Jenkins X w oparciu o OpenShift.
Tydzień 4 (5 paź – 11 października)
- Sfinalizuj dokumentację 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ą możliwości Jenkinsa X dla chmury Azure (AKS): instalacja Jenkinsa X i przygotowywanie wersji roboczych notatek dla użytkowników.
- Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
- Po otrzymaniu opinii członków społeczności sfinalizuj dokument projektowy infrastruktury środowiska podglądu Jenkins X na podstawie OpenShift.
Tydzień 6 (19 paź – 25 października)
- Praca nad macierzą możliwości Jenkinsa X dla chmury Azure (AKS): instalacja Jenkinsa X i przygotowywanie wersji roboczych notatek dla użytkowników.
- Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
Tydzień 7 (26 października – 1 listopada)
- Praca nad macierzą możliwości Jenkinsa X dla chmury Azure (AKS): instalacja Jenkinsa X i przygotowywanie wersji roboczych notatek dla użytkowników.
- Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
- Przeprowadź konfigurację infrastruktury środowiska podglądu Jenkins X w oparciu o OpenShift.
Tydzień 8 (2–8 listopada)
- Sfinalizuj dokumentację użytkownika Jenkinsa X w AKS.
- Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
Tydzień 9 (9–15 listopada)
- Pracuj nad macierzą funkcji Jenkinsa X dla AWS (EKS): instalacja Jenkinsa X i przygotowywanie wersji roboczych notatek dla użytkowników.
- Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
- Przeprowadź konfigurację infrastruktury środowiska podglądu Jenkins X w oparciu o OpenShift.
Tydzień 10 (16 lis – 22 listopada)
- Pracuj nad macierzą funkcji Jenkinsa X dla AWS (EKS): instalacja Jenkinsa X i przygotowywanie wersji roboczych notatek dla użytkowników.
- Rozwiąż jeden z problemów z dokumentacją, aby ulepszyć istniejącą dokumentację Jenkinsa X.
Tydzień 11 (23 lis – 29 listopada)
- Sfinalizuj dokumentację 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 Jenkins X w witrynie z dokumentami Jenkins X.
Tydzień 12 (30 lis – 5 grudnia)
- Na podstawie opinii sfinalizuj zadania i refaktoryzuj kod.
- Przetestuj działanie witryny z dokumentami Jenkins X, w tym linków, obrazów, hiperlinków i innych.
- Sprawdź zdefiniowany przez użytkownika element sterujący i nawigację w witrynie dokumentów Jenkins X.
- Sprawdź ostateczną prezentację macierzy Jenkinsa X Capabilites.
Przed 10 grudnia 2020 r. Ocenę projektu dokonują pisarze techniczni i mentorzy.
Jakie korzyści ma 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 i programistów w zakresie architektury technicznej, zgodności, użytkowania i integracji Jenkinsa X. Po zakończeniu proponowanego projektu powstała w pełni, dobrze zdefiniowana i technicznie zweryfikowana dokumentacja dla użytkowników Jenkinsa X wraz z matrycą możliwości Jenkinsa X na potrzeby zgodności z różnymi dostawcami usług w chmurze.
Jakie korzyści zamierzasz wprowadzić w przyszłości dzięki Jenkinsowi X? Po zakończeniu programu Sezon Dokumentów Google 2020 planuję zostać długoterminowym współtwórcą projektu Jenkins X jako aktywny członek społeczności. Będę zawsze pomagać innym (nowym osobom) i zachęcać ich do angażowania się w życie społeczności Jenkinsa X. Zawsze chętnie popracuję nad innymi projektami Jenkinsa X.
Oto kilka powodów, dla których najlepiej pracować nad tym projektem:
- Jestem bardzo metodyczna i zorganizowana. Oczekuję, że będę otrzymywać informacje o postępach w projekcie zarówno dla mentorów pracujących nad projektem, jak i w społeczności organizacji, publikując posty na blogu, zaplanowane cotygodniowe spotkania z dokumentami SIG i regularnie e-mailem.
- Będę często prosić o wskazówki i opinie od mentorów i członków społeczności, aby śledzić postępy w realizacji zadań i dbać o to, aby wszyscy byli na bieżąco (m.in. wspominając o ewentualnych wyzwaniach i problemach blokujących).
- Regularne sprawdzanie całego kodu źródłowego przez mentora i współtwórców oraz dokumentowanie wykonanej pracy.
- Mam wszystkie niezbędne umiejętności techniczne potrzebne do opracowania tego projektu. 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 z umiejętnościami technicznymi (np. Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo i innymi), które są potrzebne do przygotowania pełnej dokumentacji i rozwiązywania większości aktualnych problemów związanych z dokumentacją. Mam pozytywne nastawienie – potrafię zrealizować projekt na czas bez nadzoru.