[CNCF] ArgoCD Contributor 되기

 

새해가 되면 그 해의 목표를 매번 세우는데 올해 두번째 목표가 CNCF Ambassador 가 되는 것이였다.

 

https://www.cncf.io/people/ambassadors/application-process/

 

CNCF Ambassador 로 가는 길은 생각보다 쉽지 않은데 아래 기준 중 2개 이상을 만족시켜야 한다.

https://www.cncf.io/people/ambassadors/application-process/

 

어찌됐든 CNCF Ambassador 가 되기 위한 첫번째 과제 중 하나가 CNCF Project 에 Contribution 을 해서 DevStat 이라는 걸 20개 이상 얻는 것이였다.

 

어떤 기준으로 주는 지는 정확히 모르겠지만 확실한건 CNCF Project 에 Contribute 하면 얻을 수 있다!

https://devstats.cluster.fun/?user=kingbj94029

 

글을 쓰는 시점 기준으로 38개가 되면서 CNCF Ambassador 기준 중 하나는 만족시켰다.

 

하지만 이번 글은 CNCF Ambassador 에 대한 글이 아니고 CNCF Project 중 하나인 ArgoCD 의 Contributor 가 된 것에 대한 후기?를 다루는 글이기 때문에 본론으로 넘어가자!

 

CNCF Project 는 230개정도 된다. 사실 어떤 CNCF Project 든 본인이 하고 싶은 프로젝트를 선택해서 Contribute 를 진행하면 된다. 그치만 프로젝트를 선정하는 데 있어서 고려할 점이 있는데 그 부분은 아래 ArgoCD 를 선택한 이유를 보면 자연스레 알 수 있다.

https://argo.devstats.cncf.io/d/8/dashboards?orgId=1&refresh=15m

 

수 많은 프로젝트 중 내가 ArgoCD 를 선택한 이유는 아래와 같다.

 

"CNCF 프로젝트 중 가장 익숙하면서 가장 커뮤니티가 활발한 곳 중 하나였다"

 

스타는 19500개를 받았고, 이슈와 PR 도 다른 프로젝트에 비해 매우 활발하다.

https://github.com/argoproj/argo-cd/pulls

 

커뮤니티가 활발해야 어떤 행위를 하든 피드백을 빨리 받을 수 있다. 오픈 소스라는게 가뜩이나 Approve 받기까지 수 개월이 걸리는데 그나마 조금 더 빨리 받을 수 있는 것 같다.

 

"대부분의 회사들이 ArgoCD 를 사용한다"

하물며 Google Cloud Next 25 에서도 언급되었다.

Google Cloud Next 25 가 궁금하다면 여기 클릭!

 

"쿠버네티스의 핵심 개념 중 하나인 Declarative API 를 경험 해볼 수 있다"

쿠버네티스의 중요한 개념 중 하나를 뽑으라고 하면 Declarative API 에 기반한 Control Loop 을 말하고 싶다. ArgoCD 코드를 통해 이를 살펴볼 수 있고, Control Loop 개념에 대해 한층 더 이해할 수 있다.

 

다시 한번 말하자면 프로젝트를 고를 땐 신중히 하는 것이 좋다. 자칫 프로젝트를 잘못 골랐다간 힘들게 코드 짰는데 평생 Approve 를 못받을 수도 있다..!!

 

그럼 본격적으로 Contribution 과정을 살펴보자!

렛츠 두더 코드~

 

 

CNCF Contributor 에 가면 Start Contributing to Open Source 라고 해서 관련한 글이 쭉 있다. 가볍게 읽어봐도 된다.

https://contribute.cncf.io/contributors/getting-started/

 

그리고 Contribute 가 처음인 사람들을 위해 모의 PR 을 진행해볼 수도 있다. 해도 그만 안해도 그만이다.

https://github.com/kubernetes-sigs/contributor-playground/pull/1403#event-14228237022

 

 

실제로 kubernetes-sig 메인테이너가 Approve 를 해주긴 한다.

https://github.com/kubernetes-sigs/contributor-playground/pull/1403#event-14228237022

 

CNCF Project 들은 모두 공식 문서에서 Contributor 들을 위한 가이드를 제공해준다. ArgoCD 역시 마찬가지다.

https://argo-cd.readthedocs.io/en/stable/developer-guide/contributors-quickstart/

 

이 가이드는 꼭꼭 읽어보는 걸 추천한다.

 

사실 코드를 짜는 건 어렵지 않다. 이미 코드의 구조화가 잘 되어 있기 때문에 남이 짠 코드를 보면서 얼추 비슷하게 짜면 된다. 하지만 CNCF 프로젝트들은 보통 쿠버네티스 위에 올라간다. 그러다보니 따로 관리하고 있는 쿠버네티스가 없다면 "얘를 어떻게 실행해서 테스트하지?" 라는 막막함이 들 수 있다.

 

가이드를 꼭 읽어보라고 추천하는게 각 프로젝트들마다 테스트를 위한 애플리케이션 실행 방법들을 제공해준다.

https://argo-cd.readthedocs.io/en/stable/developer-guide/contributors-quickstart/#start-your-local-cluster

 

ArgoCD 경우에는 위와 같이 진행하면 어렵지 않게 로컬에서 ArgoCD 를 실행해볼 수 있다. (익숙치 않은 사람은 어려울 수도..?!)

 

물론 실행만 했다고 해서 끝나는 건 아니다. 프로젝트를 고를 때 익숙한 프로젝트를 고르라고 한 이유가 평소에 사용한 프로젝트라면 이 프로젝트의 구성 요소가 어떻게 되어있고 어떻게 동작하는 지를 알고 있다.

 

ArgoCD 같은 경우 설치하게 되면 Controller, ApplicationController, Repo Server 등 다양한 애플리케이션들이 실행되게 되는데 평소에 써본지 않았다면 이를 파악하는게 꽤나 힘들 수도 있다.

 

애플리케이션 구성 요소도 잘 모르는데 코드는 어디서부터 디버깅을 해야하는지는 당연히 감도 안 올것이다..!

 

Contribute 를 진행하기 전에 최소한 해당 프로젝트의 컴포넌트들이 어떻게 구성되고 동작하는 지 파악하는 것이 좋다.

 

minikube 써서 하면 편하다! kind 도 나쁘지 않다!

 

테스트를 위한 ArgoCD 를 실행 해봤으니 이제 프로젝트로 가서 어떤 Issue 들이 있는지 살펴보자!

 

참고로 CNCF Project 들은 어느 정도 컨벤션된 레이블들을 가지고 있다. good first issue 가 있는 레이블은 이름 그대로 처음 하는 사람에게 추천되는 레이블이다. 그런데 good first issue 는 굉장히 인기가 많다. 뜨는 순간 거의 바로 가져가서 할당받기 쉽지 않다.

https://github.com/argoproj/argo-cd/issues?page=2

 

Issue 들을 보다가 좀 쉬워보이는 이슈를 하나 선택했다.

https://github.com/argoproj/argo-cd/issues/21691#issuecomment-2678727119

 

자세한 이슈의 내용은 링크를 참고하기 바란다.

 

이슈들을 보면 메인테이너가 어떤 컴포넌트인지 레이블을 달아준다. 이 레이블이 달렸다는 건 메인테이너가 판단하기에 진행해도 되는 이슈라는 것이다. 나 같은 경우 rumstead 라는 메인테이너가 component:application 레이블을 달았고, 내가 진행해도 되냐는 물음에 Assign 으로 답해줬다.

https://github.com/argoproj/argo-cd/issues/21691#issuecomment-2678727119

누군가 먼저 할당을 받았는데 가끔 새치기?해서 해당 이슈를 가져가려고 하는 사람들이 있다. 이런 행위를 하면 당연히 메인테이너에게 좋지 못한 소리를 듣게 된다. 실제로 몇 번 봤다...

 

이후에 ArgoCD 를 포크 떠서 개발을 진행하면 된다.

 

Contribute 를 진행하면서 어려웠던 점을 뽑으라면 2가지가 있다.

하나는 위에서 말한 것처럼 애플리케이션 자체의 실행(로컬에 맞는)과 이슈에 명시된 문제가 어느 코드에서 발생했냐는 것이다.(혹은 어디서부터 코드 기능 개발을 시작하면 되는지)

 

문제가 있는 코드를 찾는 것에 대해선 딱히 팁이 없다... 프로젝트마다 다르고 이슈마다 너무 다르다. 그래도 하나 말하자면 보통 golang 의 경우 cmd 에 애플리케이션 실행 코드가 있는데 이를 시작으로 따라가보면 전반적인 코드 흐름을 파악할 수 있다.

 

이후 이슈가 있었던 코드를 수정한 후 PR 을 올리면 된다. ArgoCD 는 CodeCov 일정 커버리지를 못넘기면 Failed 처리가 되기 때문에 테스트 코드는 반드시 작성해줘야 한다.

https://github.com/argoproj/argo-cd/pull/22036

https://github.com/argoproj/argo-cd/pull/22036

 

workflow 체크 32개를 패스해야 하는데, 나머지는 어렵지 않은데 CodeCov 커버리지는 좀 빡셀 수 있다.

 

이렇게 workflow 도 All pass 하면 이제 메인테이너의 승인을 기다리면 된다.

 

이번엔 또 다른 이슈인데, 첫번재 이슈와 비슷하다. 다만 차이가 있다면 첫번째 이슈는 버그 픽스였고 이번 이슈는 기능 개발이다.

 

 

기능 개발이기 때문에 첫번째 이슈와 비교해봤을 때 추가된 코드가 훨씬 많다.

https://github.com/argoproj/argo-cd/pull/22111

기능 개발 후 똑같이 PR 을 올리고 승인을 기다리면 된다.

 

첫번째 이슈를 PR 에 올린 지 한 2달 정도 지났을 때 비로소 master 에 merge 가 되었다. 두번째 이슈는 Final Review 를 기다리고 있다.

 

어찌됐든 하나라도 PR 이 merge 되었기 때문에 ArgoCD Contributor 가 될 수 있었다.

 

그리고 실제 ArgoCD 에도 내가 작성한 코드가 보인다.

 

갑자기 글을 끝맺게 되는 느낌이 없지 않아 있는데... 

 

빨리 두번째 이슈도 merge 되기를 바라며 이 글을 마친다!

 

다음엔 CNCF Ambassador 가 되서 돌아오겠다!

 

추가로 슬랙 채널에 입장하면 많은 도움은 아니지만 어느 정도의 도움은 얻을 수 있다.