Jenkins X 프로젝트

이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
Jenkins X
테크니컬 라이터:
니틴
프로젝트 이름:
기존 Jenkins X 문서 사이트 및 Jenkins X 기능 매트릭스를 리팩터링
프로젝트 기간:
표준 기간 (3개월)

Project description

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

기존 Jenkins X 문서를 리팩터링하는 과정에서 제가 해결하게 될 문제는 다음과 같습니다.

  • EKS 리소스로 부팅: 문제
  • 부팅 시 EKS에서 Vault에 실패: 문제
  • jx 부팅용 문서 envar: 문제
  • Vault 설정에 필요한 문서: 문제
  • 로컬에서 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의 호환성 확인
  • 기타 기능 (보안 비밀용 Vault 스토리지, 소스 제어 버전 등)은 딘 및 Jenkins X 커뮤니티 구성원과 논의해야 합니다.

OpenShift 기반의 Jenkins X 미리보기 환경 인프라를 설정하는 작업과 관련하여 수행할 작업은 다음과 같습니다.

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

프로젝트 결과물:

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

잠정적인 타임라인 (작업 포함):

커뮤니티 유대감 (8월 17일~9월 13일)

  • 기술 문서를 위한 개발 환경을 설정하고 프로젝트 작업을 위한 클라우드 인프라 액세스 권한 획득
  • 제안된 잠정 타임라인, 프로젝트 결과물 및 작업 (우선순위 포함)에 대해 프로젝트 멘토와 논의합니다.
  • 조직의 업무 절차와 PR 검토 절차를 이해하고 이에 능숙하게 갖추고 커뮤니티에 참여합니다.
  • Jenkins X의 현재 문서 상태를 검토합니다.

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

  • 클라우드에서 Jenkins X를 설정하는 방법에 대한 안내, 현재 상태, 문서를 이해합니다.
  • 딘과 함께 현재 Jenkins X 기능 (다른 클라우드 제공업체에서 확인 중)에 대해 논의합니다.
  • OpenShift 기반의 Jenkins X 미리보기 환경 인프라의 현재 상태에 대해 다니엘과 함께 논의합니다.
  • OpenShift에서 Jenkins X 미리보기 환경 인프라의 아키텍처를 설계하는 일을 다니엘과 함께 담당합니다.

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

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

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 문서를 개선하기 위한 문서 문제 중 하나를 수행합니다.

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

  • Azure 클라우드 (AKS)용 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 문서 문제 중 하나를 수행합니다.
  • 커뮤니티 회원의 의견을 수렴한 후 OpenShift를 기반으로 Jenkins X 미리보기 환경 인프라 설계 문서를 마무리합니다.

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

  • Azure 클라우드 (AKS)용 Jenkins X 기능 매트릭스 작업: Jenkins X 설치 및 사용자 메모 초안 준비
  • 기존 Jenkins X 문서를 개선하기 위한 문서 문제 중 하나를 수행합니다.

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

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

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

  • AKS에서 Jenkins X 사용자 문서 마무리하기
  • 기존 Jenkins X 문서를 개선하기 위한 문서 문제 중 하나를 수행합니다.

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

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

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

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

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

  • EKS에서 Jenkins X용 사용자 문서를 완료합니다.
  • 기존 Jenkins X 문서를 개선하기 위한 문서 문제 중 하나를 수행합니다.
  • 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에 대한 완전하고 정의 및 기술적 검증이 완료된 사용자 문서가 생성될 것입니다.

향후 Jenkins X로 어떤 이점을 제공할 계획인가요? Docs 2020 프로그램의 Google Season of Docs가 끝난 후에는 커뮤니티에서 활발히 활동하는 일원으로서 Jenkins X 프로젝트에 장기적으로 기여할 계획입니다. 저는 항상 다른 사용자 (신규 크리에이터)를 돕고 Jenkins X 커뮤니티에 참여하도록 격려할 것입니다. 다른 Jenkins X 프로젝트 아이디어에도 기꺼이 참여하겠습니다.

이 프로젝트를 하기에 가장 적합한 이유는 다음과 같습니다.

  • 나는 매우 체계적이고 조직적입니다. 일주일에 한 번 블로그 게시물, 예정된 SIG 문서 주간 회의, 정기적으로 이메일을 통해 프로젝트 멘토와 조직 커뮤니티 모두에게 프로젝트 진행 상황에 대한 정보를 지속적으로 제공할 것으로 기대됩니다.
  • 작업을 진행하고 모든 사람이 동일한 내용을 이해하도록 하기 위해 멘토 및 커뮤니티 회원의 가이드와 피드백을 자주 구할 것입니다 (당면 과제 및 장애 요소 언급 포함).
  • 정기적으로 작성된 모든 소스 코드를 커밋하여 멘토로부터 코드를 검토받기 위해 기여자와 커뮤니티 회원을 참조하기 위해 수행한 작업을 문서화합니다.
  • 저는 이 프로젝트 아이디어를 처리하는 데 필요한 모든 기술을 갖추고 있으며 멘토인 Deane, Kara, Daniel과 함께 프로젝트 제안서에 대해 논의했습니다. 프로젝트 제안서와 그 결과물을 깊이 있게 이해할 수 있었습니다.
  • 저는 완전한 문서를 제공하고 현재 문서 관련 문제의 대부분을 해결하는 데 필요한 기술 (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo 등)으로 작업한 경험이 있습니다. 나는 아무런 지도 없이 제시간에 프로젝트를 완료할 수 있는 긍정적인 태도를 가지고 있습니다.