zookeeper init 리팩토링

[singsangssong]

🔍 Description

• 기본 znode 디렉토리 초기화 #12 에서 작업했던 zookeeper init명령을 FEATURE: Add 'zookeeper start|stop|stat' command to manage zk ensemble #19 에서의 코멘트대로 아래처럼 동작을 변경합니다.
• 기존 동작
  • arcus zookeeper를 위한 기본 znode 초기화
• 변경 동작
  • myId 파일 생성
  • config file 생성

⏰ Implementation Idea

• 현재 zookeeper init이 znode 초기화를 수행하지 않게 되면서, zookeeper로 시작하는 명령은 모두 zk와 connection이 필요없게 되었습니다.
• 이에 zookeeper에서는 zk connection을 맺지않고, 그외 memcached, acl명령은 zk connection과 함께, znode 초기화를 확인하도록 합니다.
• 위에서 설명한 zookeeper init의 변경 동작은 python 레거시 코드를 참조하여 구현합니다.
  • 환경변수를 통해서 서버IP 목록을 입력받습니다.
  • 서버IP목록을 순회하면서 고유 번호를 생성합니다.
  • ssh 접속 후, myid파일과 zoo.cfg파일에 접근합니다.

[namsic]

어떤 기능을 실행할 때 필요한 값을 입력받는 방법으로
환경변수를 사용하는 경우가 있고 인자로 전달받는 경우가 있는데, 둘의 구분 기준은 무엇인가요?

[singsangssong]

제가 생각했던 기준은 아래와 같습니다.

• 인자로 받을 때: 특정 기능에서만 필요한 경우, 입력받기에 너무 긴 변수가 아닌 경우에 인자로 받도록 하고있습니다. 예를 들어, acl group add <groupName>의 경우, group add라는 기능의 대상이기에 인자로 사용했습니다.
• 환경변수로 받을 때: 여러번 재사용하는 경우가 많은 경우, 한번 세팅하고 변하는 경우가 드문 경우에 환경변수로 받도록 하고 있습니다. 예를 들어 이번 서버 IP목록의 경우(zklist), 3개의 zk를 가정한다면 zklist="10.33.111.24:30000,10.34.108.181:30000,10.33.184.197:30000"로 길어지기에 환경변수로 받고자 했습니다.

[namsic]

명령 실행 시 필요한 환경 변수 목록과 해당 변수에 설정되는 값이 무엇인지 알 수 있는 가이드가 있어야 합니다.

$ ./arcus-cli memcached add test 127.0.0.1:11211
Error: ZooKeeper address is not set
Usage:
  arcus-cli memcached add <serviceCode> <ip:port> [flags]

Flags:
  -h, --help   help for add

위 예시를 보면, Usage에 적힌 모든 값을 적절히 설정했음에도 ZooKeeper address is not set 에러 발생하고,
ZooKeeper address를 어떻게 set 하는지는 소스 코드 열어볼 수 있는 환경이 아니면 알 방법이 없는 상태입니다.

[singsangssong]

말씀해주신대로 환경변수와 관련된 가이드가 없는 점이, 사용자가 어떤 환경변수를 설정해야하는지 인지하기 어려운 상황을 초래할 수 있을 것 같습니다.

관련된 정보를 찾아본 결과, cobra라이브러리처럼 따로 가이드를 작성하지 않아도, 유연하게 필요한 변수가 무엇인지 알려주는 라이브러리는 따로 없는 것 같습니다. 이에 각 명령을 수행하기 전, 필요한 환경변수를 확인하고 명확한 에러메세지를 작성하는 것이 최선일 것 같습니다.

그와 별개로, 현재 os.Getenv()를 활용해 환경변수에 접근하고 있습니다. 이보다 viper라이브러리라는 설정 관리 시스템을 통해서, 환경변수를 더욱 유연하게 관리하는 편이 어떨지 궁금합니다. 라이브러리에 의존하게 되지만, 현재 1~2개정도의 적은 환경변수를 사용하기는 어려울 것 같으며, 앞으로 기능이 추가될수록 더욱 많은 환경변수를 사용할 것으로 예상되어 제안드립니다. -> 만약 viper로 변경한다면 환경변수에 관한 이슈를 따로 파고 개발하는것이 적절해 보입니다.

[namsic]

환경변수에 관한 이슈는 별도로 작성하여 처리하는 것이 좋겠습니다.

• 현재 환경변수 목록 정리, 환경변수로 받는 것이 적절한지 검토
• 환경변수 관련 가이드 작성
• 환경변수와 구동 인자 구분 기준 명확히 정리

viper와 cobra를 함께 사용하는 것 자체는 문제 없을 것으로 봅니다. 두 라이브러리 간 통합도 잘 지원되는 것으로 알고 있습니다.
다만 viper는 단순 환경변수 처리를 넘어서 아래와 같이 복잡한 설정 관리를 위한 모듈로 알고 있는데,

• profile(dev, stage, prod, …)에 따라 서로 다른 설정 사용하도록 관리
• 여러 위치(/etc/myapp/conf, $HOME/.config/myapp, $PWD, …)에서 우선순위에 따라 설정을 읽고 조합
• 다양한 설정파일 형식(env, json, yaml, …) 지원

단순히 환경변수 개수가 많아질 것이기 때문에 사용한다는 이야기만으로는 오버 엔지니어링이 아닌가 생각이 듭니다.
viper 사용하고자 한다면, 사용자 입장에서나 구현 관련해서 어떻게 유연해지는지 정리해서 한 번 더 공유 부탁합니다.

[singsangssong]

환경변수에 관한 이슈는 별도로 작성하여 처리하는 것이 좋겠습니다.

네 알겠습니다. 환경변수와 viper적용에 관해서는 따로 이슈를 열어두도록 하겠습니다.
이번 PR에서는 zookeeper init 명령의 변경된 동작에 관해서만 작업하고, zk IP목록(zklist)은 환경변수로 받도록 하겠습니다.

[singsangssong]

• 환경변수 정리 #22
• 인터페이스 설계 #26

위 이슈에서 선언형 인터페이스로 설계가 변경되었습니다. 이 이슈는 명령형 인터페이스에 관한 이슈이므로 해당 이슈를 닫겠습니다.