Jenkins X 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
Jenkins X
기술 문서 작성자:
Nitin
프로젝트 이름:
기존 Jenkins X 문서 사이트 및 Jenkins X 기능 매트릭스 리팩터링
프로젝트 기간:
표준 기간 (3개월)

Project description

이 프로젝트의 주요 목표는 문서 관련 문제를 해결하는 동시에 기존 Jenkins X 문서를 리팩터링하고 업데이트된 Jenkins X 기능 매트릭스와 엔터프라이즈 클라우드 제공업체의 Jenkins X 사용에 관한 사용자 문서를 준비하는 것입니다. 또한 이 프로젝트는 다니엘과 협력하여 OpenShift 기반의 Jenkins X 미리보기 환경 인프라를 개발하는 작업도 포함합니다.

기존 Jenkins X 문서 리팩터링의 일환으로 제가 작업할 몇 가지 문제는 다음과 같습니다.

  • EKS 리소스에서 부팅: 문제
  • 부팅 시 EKS에서 Vault가 실패함: 문제
  • jx 부팅의 envars 문서화: 문제
  • Vault 설정에 필요한 문서: 문제
  • 로컬에서 보관소로 부팅 업그레이드 실패: 문제
  • '만들기'와 'jx 설치', '부팅', '가져오기'의 관계에 관한 문서 의견: 문제
  • Helm 문서가 여기저기 흩어져 있음: 문제
  • ChartMuseum, Monocular, Docker Registry가 Nexus로 대체되지 않는 이유에 관한 문서 개선
  • 부팅 + GKE를 사용할 때 Docker 레지스트리를 변경할 수 없음: 문제
  • 도메인을 nip.io에서 커스텀 도메인으로 변경할 수 없음: 문제

Jenkins X 기능 매트릭스의 경우 아래에 언급된 대로 각 클라우드 제공업체에서 제공하는 엔터프라이즈 Kubernetes 서비스에 관한 작업이 포함됩니다. Google Cloud (GKE), Amazon Web Services (AWS EKS), Azure Cloud (AKS)

  • terraform 스크립트 및 jx boot를 통해 클라우드에 Jenkins X 설치
  • 이러한 클라우드 제공업체의 Kubernetes 서비스에서 Kubernetes 버전과 Jenkins X의 호환성을 확인합니다.
  • Deane 및 Jenkins X 커뮤니티 회원과 논의할 기타 기능 (비밀번호의 Vault 스토리지, 소스 제어 버전 등)

OpenShift를 기반으로 하는 Jenkins X 미리보기 환경 인프라 설정 작업에는 다음이 포함됩니다.

  • OpenShift 플랫폼의 Jenkins X 미리보기 환경 인프라에 관한 설계 문서
  • OpenShift에서 Jenkins X 미리보기 환경 생성 자동화
  • 미리보기 환경의 Jenkins X 문서 업데이트

프로젝트 결과물:

  • 기존 Jenkins X 문서 리팩터링을 고려하여 위에 언급된 문서 문제를 PR을 통해 수정했습니다.
  • 다양한 클라우드 제공업체 (주로 AKS, EKS, GKE의 Kubernetes 서비스)에서 Jenkins X를 사용하는 방법에 관한 사용자 문서와 함께 Jenkins X 기능 매트릭스를 업데이트했습니다.
  • 다니엘과 공동으로 OpenShift를 기반으로 Jenkins X 미리보기 환경 인프라 설정 자동화

제안된 잠정 타임라인 (작업 포함):

커뮤니티 결속 (8월 17일~9월 13일)

  • 기술 문서를 위한 개발 환경을 설정하고 프로젝트 작업을 위해 Cloud 인프라에 액세스합니다.
  • 제안된 대략적인 일정, 프로젝트 결과물, 작업 (우선순위 포함)에 대해 프로젝트 멘토와 논의합니다.
  • 조직의 업무 프로세스, PR 검토 절차를 이해하고 준비하며 커뮤니티에 참여합니다.
  • Jenkins X의 현재 문서 상태를 검토합니다.

1주 차 (9월 14일~9월 20일)

  • 클라우드에서 Jenkins X를 설정하기 위한 안내, 현재 상태, 문서를 알아봅니다.
  • 현재 Jenkins X 기능에 관한 Deane과의 논의 (다양한 클라우드 제공업체에서 확인할 예정)
  • OpenShift 기반 Jenkins X 미리보기 환경 인프라의 현재 상태에 대해 다니엘과 논의합니다.
  • (다니엘과 협력하여) OpenShift에서 Jenkins X 미리보기 환경 인프라의 아키텍처를 설계합니다.

2주 차 (9월 21일~9월 27일)

  • GKE 클라우드를 위한 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 docs-issue 중 하나를 처리합니다.

3주 차 (9월 28일~10월 4일)

  • GKE 클라우드용 Jenkins X 기능 매트릭스(Jenkins X 설치 및 사용자 메모 초안 준비) 작업
  • 기존 Jenkins X 문서를 개선하기 위한 문서 문제 중 하나를 작업합니다.
  • OpenShift를 기반으로 하는 Jenkins X 미리보기 환경 인프라의 설계 문서를 작성합니다.

4주차 (10월 5일~10월 11일)

  • GKE용 Jenkins X의 사용자 문서를 마무리합니다.
  • 기존 Jenkins X 문서를 개선하기 위해 docs-issue 중 하나를 처리합니다.

5주차 (10월 12일~18일)

  • Azure Cloud (AKS)용 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 docs-issue 중 하나를 처리합니다.
  • 커뮤니티 회원의 의견을 받은 후 OpenShift 기반 Jenkins X 미리보기 환경 인프라의 설계 문서를 최종화합니다.

6주 차 (10월 19일~10월 25일)

  • Azure Cloud (AKS)용 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 docs-issue 중 하나를 처리합니다.

7주차 (10월 26일~11월 1일)

  • Azure Cloud (AKS)용 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 문서 문제 중 하나를 작업합니다.
  • OpenShift를 기반으로 하는 Jenkins X 미리보기 환경 인프라 설정 작업

8주 차 (11월 2일~11월 8일)

  • AKS의 Jenkins X 사용자 문서를 마무리합니다.
  • 기존 Jenkins X 문서를 개선하기 위한 docs-issue 중 하나를 처리합니다.

9주 차 (11월 9일~11월 15일)

  • AWS (EKS)를 위한 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 docs-issue 중 하나를 처리합니다.
  • OpenShift를 기반으로 하는 Jenkins X 미리보기 환경 인프라 설정 작업

10주 차 (11월 16일~11월 22일)

  • AWS (EKS)용 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 docs-issue 중 하나를 처리합니다.

11주 차 (11월 23일~11월 29일)

  • EKS의 Jenkins X 사용자 문서를 마무리합니다.
  • 기존 Jenkins X 문서를 개선하기 위한 docs-issue 중 하나를 처리합니다.
  • Jenkins X 문서 사이트에서 Jenkins X 미리보기 환경 인프라 문서를 마무리합니다.

12주 차 (11월 30일~12월 5일)

  • 피드백을 바탕으로 프로젝트 결과물을 마무리하고 코드가 있는 경우 리팩터링합니다.
  • 링크, 이미지, 하이퍼링크 등을 포함하여 Jenkins X 문서 사이트의 작동을 테스트합니다.
  • Jenkins X 문서 사이트의 사용자 정의 컨트롤 및 탐색을 확인합니다.
  • Jenkins X 기능 매트릭스의 최종 프레젠테이션을 확인합니다.

2020년 12월 10일 이전: 기술 작가와 멘토 모두 프로젝트 평가를 제출합니다.

제안된 프로젝트가 Jenkins X 및 커뮤니티에 어떤 이점을 제공하나요? 이 프로젝트는 Jenkins X 커뮤니티가 Jenkins X 기술 아키텍처, 호환성, 사용, 통합에 관한 참조용 문서를 최종 사용자와 개발자를 위해 개선하는 데 도움이 됩니다. 이 제안된 프로젝트가 완료되면 Jenkins X의 포괄적이고 잘 정의되고 기술적으로 검증된 사용자 문서와 다양한 클라우드 제공업체와의 호환성을 위한 Jenkins X 기능 매트릭스가 제공됩니다.

Jenkins X를 통해 향후 어떤 이점을 얻을 수 있나요? Google Season of Docs 2020 프로그램이 끝난 후에는 커뮤니티의 적극적인 회원으로서 Jenkins X 프로젝트에 장기적으로 참여할 계획입니다. 저는 항상 다른 사용자 (신규 사용자)를 도와주고 Jenkins X 커뮤니티에 참여하도록 독려할 것입니다. 다른 Jenkins X 프로젝트 아이디어를 구현하는 데도 언제든지 기꺼이 도와드리겠습니다.

제가 이 프로젝트에 가장 적합한 이유 몇 가지는 다음과 같습니다.

  • 저는 매우 체계적이고 조직적입니다. 프로젝트 진행 상황은 매주 블로그 게시물, 정기적으로 예정된 SIG-docs 주간 회의, 이메일을 통해 프로젝트 멘토와 조직 커뮤니티에 전달할 예정입니다.
  • 작업을 진행하고 모두가 같은 생각을 할 수 있도록 멘토 및 커뮤니티 회원의 지침과 피드백을 자주 구합니다 (당면한 문제점이나 방해되는 사항 언급 포함).
  • 멘토, 참여자의 검토를 받기 위해 정기적으로 작성된 모든 소스 코드를 커밋하고, 커뮤니티 회원이 참고할 수 있도록 수행한 작업을 문서화합니다.
  • 저는 이 프로젝트 아이디어를 실현하는 데 필요한 모든 기술을 갖추고 있으며 멘토인 Deane, Kara, Daniel과 프로젝트 제안에 대해 논의했습니다. 프로젝트 제안서와 결과물에 대해 자세히 이해했습니다.
  • 포괄적인 문서를 제공하고 현재 문서 관련 문제를 대부분 해결하는 데 필요한 기술 (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo 등)을 사용한 경험이 있습니다. 감독 없이도 프로젝트 작업을 제때 완료할 수 있는 긍정적인 태도를 가지고 있습니다.