Docker 자동 배포 시스템을 구축하며.

https://github.com/Team-DeVent/devent-deploy

 

😅 그동안의 비효율적인 배포 과정

 

 기존 홈서버에 배포할 때 번거로운 과정의 연속이었다. 원격 접속으로 파일을 이동하고 서버를 종료시킨 다음 코드를 덮어쓰고 다시 실행하는 과정을 통해 코드를 업데이트할 수 있었다. 또한 깃허브와 같은 툴을 쓰지 않아 버전 관리에도 문제가 있었다. 이외에도 의존성이 깨지면 다른 소프트웨어에도 영향이 간다거나, 다운그레이드를 위해 앞선 과정을 다시 진행하는 등 문제점이 많았다. 

 

 코드란 유기체와 같다. 지속적으로 관리해주고 신경 써주지 않으면 찌꺼기(레거시 코드)가 필연적으로 발생하게 된다. 관리 방법 중 하나가 바로 배포의 자동화다. 이전 글에서도 설명했듯이, 몇 년 전에는 USB로 파일을 이동하는 만행(?)을 저지르기도 했다. 분명 당시에는 버전이 꼬이고 레거시 코드가 넘쳐나도 큰 불편함을 느끼지 못했다. 기능은 많아봤자 6개 정도였고 코드 간 의존성이 없다시피 했었기에 버그 또한 발생하지 않았다. 

 

 버그가 발생하지 않았다고 좋은 코드가 되는건 아니다. 풀장에 물이 가득 차 있다고 가정해보자. 내가 풀장에 들어갔을 때 적당했다고 해서 친구 100명을 데려와도 넘치지 않을 거란 보장은 없다. 코드 품질도 마찬가지다. 버그가 없다고 해서 기능을 확장했을 때도 버그가 없을 거라는 가정은 성립되지 않는다.

 

 그래서 그동안의 배포 과정을 개선하고자 깃허브 웹훅과 도커 기반으로 서비스를 배포하는 툴을 만들고자 했다. 

 

 

🎙 어떤 기능이 필요한가

 

 우선 깃허브 웹훅을 받고 레포지토리 링크를 파싱하는 로직이 필요하다. 다음으로 git clone <link>를 실행하여 지정된 디렉토리에 파일을 저장한다. 이후 해당 디렉토리에 있는 dockerfile로 도커 이미지를 생성하고 이미지를 실행시키면 된다. 아래 로직을 보면 쉽게 이해할 수 있다.

 

😭 콜백 지옥

 

 NodeJS 개발자라면 콜백 지옥에 대해서는 잘 알고 있다. 도커 API 라이브러리 중에서 dockerode라는 라이브러리가 있다. 라이브러리를 사용해서 도커 정보를 불러오고 삭제하는 데에 콜백에 콜백을 불러오며 코드가 더러워지는 단점이 있었다. 효율적인 코드를 만들기 위해 기능별로 콜백을 묶어 서비스 로직으로 만들고 모든 로직은 이벤트 기반으로 작성했다. 웹 훅 요청이 오면 eventemitter로 이벤트를 호출하여 동기적으로 작업을 수행할 수 있었다. 

 

 

🛠 컨테이너 배포 문제

 

 컨테이너 배포 문제를 통해 문서를 자세하게 읽어야 한다는 교훈을 얻었다. 컨테이너를 배포하기 위해 nginx reverse proxy에 컨테이너를 할당하고 letsencrypt SSL을 발급받는 과정을 거친다. 배포 중간에 SSL 인증서가 제대로 발급되지 않아서 컨테이너의 접속 오류가 뜨는 문제가 발생했다. 분명 서브 도메인 연결했고 컨테이너도 정상 작동하는데 well-known/acme-challenge/* 링크로 접속할 수 없어서 인증서를 발급받지 못한다고 오류가 났었다.

 

 2일동안 고민해본 끝에 컨테이너 환경 설정 문제였다는 사실을 알게 되었다. 배포될 서비스 내에 ./deployenv라는 파일에서 서브 도메인 정보와 인증서 도메인 정보를 바탕으로 컨테이너를 설정하는데, 이 두 도메인의 주소가 달라서 인증할 수 없었다. 즉, 서브 도메인은 dds.devent.kr를 호출하는데 인증서 도메인은 dds1.devent.kr를 호출하게 되어 정상적으로 발급받을 수 없었다.

 

 중간중간 삽질이 많았다. reverse proxy 대신 호스트에 다이렉트로 설치해보기도 하고, 인증서 발급 컨테이너를 교체해보기도 했지만 끝내 해결되지 않았다. 해당 모듈의 문서를 조금 더 세세하게 읽어보았다면 문제를 빨리 알아낼 수 있었겠다는 아쉬움은 남았지만 그래도 문제를 해결해서 후련했다.

 

 

🚀 자동화 툴을 만들기까지

 

 처음에 CI 도입을 고려했었다. circleCI라는 좋은 프로그램이 있길래 사용해보았더니 아직 TDD와 코드 통합에 대해 익숙하지 않아 사용하기에 어려움이 있었다. 자동 배포만 되면 되는데 그 이상의 기능들도 많아서 CI를 쓰기에 아직은 이른 시기라고 판단했다. 이후, 배포를 효율적으로 하는 프로그램을 없을까 고민하다가 직접 만들어보기로 결정했다.

 

 그렇게 도커 기반으로 자동배포+SSL 적용까지 가능한 소프트웨어를 만들게 되었다.

 

 

⌨️ 관련 링크

 

코드는 오픈소스로 공개되어 있습니다. 궁금한 사항은 댓글로 남겨주세요.

 

https://github.com/Team-DeVent/devent-deploy

GitHub - Team-DeVent/devent-deploy: Auto Deployment Service with Docker