Travis CI를 사용해 AWS Elastic Beanstalk에 배포 자동화 해주기
Travis CI는 test 환경을 구축해 테스트 하는 것은 물론, 통과된 테스트를 자동으로 deploy 할 수 있다. 수 많은 deploy 방법을 지원하는데, 펭귄은 그 중 rails를 AWS Elastic Beanstalk(이하 EB)에 배포 자동화 했던 경험을 공유하겠다. 참고로 이 포스팅은 7월 4일 AWSKrug 한 발표을 토대로 작성한 포스트다.
travis 환경 구축
만약 travis를 이미 사용하고 있다면 .travis.yml이라는 파일이 이미 있을 것이다. 만약 없다면 travis를 구축해야 한다.
구축하는 방법은 2가지다. 하나는 .travis.yml을 직접 만들고 docs 에 나와있는 코드를 그대로 복붙하는 방법이다. Travis CLI가 그렇게까지 필수는 아니라서 이 방법도 나쁘지 않다. 단 이 경우에는 Travis console에 들어가서 레포지를 따로 연동해줘야한다. 물론 레포지를 연동하는 방법은 어렵지 않다. travis에서 레포지 목록에 들어가 아래 이미지와 같이 켜주면 된다.
또 다른 방법은 Travis CLI를 사용하는 방법이다. 터미널에서 travis init 명령을 해주면 .travis.yml 생성은 물론 레포지 연동까지 알아서 해준다. 물론 Travis CLI 가 설치되어 있어야 한다.
다만 이 Travis CLI가 의외로 homebrew 나 apt-get과 같은 패키지 관리툴로 설치 할 수 없고 ruby gem으로 설치 할 수 있다. 이 때문에 ruby를 쓸 일이 없다면 Travis CLI를 설치하는 것 보다 직접 .travis.yml 파일을 생성하는 것이 나을 수 있다.
최종적으로 생성된 .travis.yml의 코드는 아래와 같을 것이다.
language: ruby
rvm:
- 2.0.0
- 1.9.3
- jruby-19mode
- rbx-2
언어와 version 은 각자 환경에 맞게 바꿔주면 된다. 펭귄은 ruby 2.2.5 하나만 남기고 모두 지웠다.
EB 연동하기
이제 EB 를 연동하자. EB 연동은 travis setup elasticbeanstalk 명령을 해주거나 docs를 복붙하면 된다. 하지만 펭귄은 복붙 해와서 직접 입력하는 것을 추천한다.
Travis CLI 명령어를 사용하면 키나 레포등을 물어보는데 성실하게(?) 전부 답변해주면 .travis.yml에 전부 적히는데, 이 .travis.yml git에 포함된다! 달리 말하면 git에 AWS secret key가 포함 될 수 있다. 누가 봐도 보안에 좋지 않다. 그러므로 docs에서 복붙해온 양식에 환경변수를 사용해 소중한 AWS KEY를 지키자.
또한 1.8.8 버전 기준으로 CLI가 bucket name을 물어보지 않는다. 이 때문에 CLI가 생성한 EB 옵션에는 버킷 이름이 입력 되어있지 않는데, 버킷 이름이 없으면 에러가 발생한다. 따라서 travis docs에서 제대로 된 양식을 복붙해 bucket name까지 전부 입력해주는 것이 좋다.
또한 rails를 사용한다면 skip_cleanup: true 옵션도 넣어줘야한다. 이것이 활성화되어있지 않으면 travis가 build 된 것을 EB에 전달할때 asset precompile 된 것을 몽땅 날려버린다. 이 때문에 EB에서 전달받을때는 asset이 텅텅 비어있어서 deploy가 실패한다. rails 외에 angular2도 skip_cleanup: true가 활성화 되어있지 않으면 실패한다고 하는데, 다른 환경은 어떠한지 모르겠다. 다만 대다수의 환경이 skip_cleanup: true 활성화를 요구하는 걸로 보인다.
최종적으로 생성된 .travis.yml의 코드는 아래와 같을 것이다.
language: ruby
rvm:
- 2.2.5
deploy:
skip_cleanup: true
provider: elasticbeanstalk
access_key_id: ENV['AWS_ACCESS_KEY']
secret_access_key:
secure: ENV['AWS_SECRET_KEY']
region: ap-northeast-2
app: application
env: application-dev
bucket_name: application-deploy
DB 사용하기
Travis build시 사용할 DB를 설정해줘야 하는데 까다롭고, 문서에 안 나와있는 설정들이 많다. 이 때문에 몇 가지 설정을 소개하겠다.
PostgreSQL
travis의 PostgreSQL 기본 버전은 9.1이다. 대부분의 경우 9.1에서 테스트 해도 별 문제가 없지만, 아무리 그래도 9.1 버전은 6년전에 나온 구버전이다. 또한 psql 특정 버전에서만 지원하는 기능을 사용했을 수도 있다.
문서에서는 psql 버전 바꾸는 방법을 상당히 간단하게 설명했다. 실제로도 9.4 버전까지는 저렇게 간단히 된다. 하지만 9.5 이상 버전부터는 위 방법대로 해도 에러가 발생한다. 그리고 문서에는 이 이슈에 대해 어디에도 적혀있지 않다. 하지만 travis github 이슈에는 해당 이슈가 있어 psql 9.5 이상 버전을 사용 하는 방법도 있다. 요약하면 sudo와 dist를 설정해주면 된다. 이 설정에 대한 자세한 설명은 샤님 포스트에서 확인 할 수 있다.
psql 버전이 설정되었으면, 사용하기전에 테스트용 DB를 생성하는 script를 넣어줘서 마무리하면 된다.
최종적인 .travis.yml 코드는 아래와 같다.
language: ruby
rvm:
- 2.2.5
sudo: required
dist: trusty
addons:
postgresql: "9.6"
services:
- postgresql
deploy:
skip_cleanup: true
provider: elasticbeanstalk
access_key_id: ENV['AWS_ACCESS_KEY']
secret_access_key:
secure: ENV['AWS_SECRET_KEY']
region: ap-northeast-2
app: application
env: application-dev
bucket_name: application-deploy
MySQL
travis MySQL 기본 버전은 5.5이다. 역시 대부분 이걸로 무난하게 쓸 수 있지만 특정 버전이 필요할 수 있다. 펭귄의 경우 MySQL 5.7 버전이 필요했지만 travis 가 5.7 버전은 공식 지원하지 않는다. 이 때문에 travis 에 MySQL 5.7을 설치 해야했다. 작성된 코드는 아래와 같다.
before_script:
- chmod +x ./travis/*
- ./travis/mysql-version-upgrade-5.7.sh
- ./travis/mysql-reset-root-password.sh
- ./travis/create-test-database.sh
보시다시피 chmod 로 권한을 먼저 부여한뒤 travis 디렉토리에 있는 스크립트들을 실행시켰다. 이 디렉토리는 펭귄이 편의상 별도로 만든 디렉토리이다. 각각의 스크립트 파일은 아래 gist 를 참고하면 된다.
MySQL 5.7 을 직접 다운 받아 업그레이드 한뒤, 꼭 root 비밀번호를 reset 해줘야한다. 안그러면 build 실패한다. 이후 psql 과 동일하게 테스트용 DB를 생성하면 된다.
DEPLOY
여기까지 세팅한 뒤 test를 통과했다면 자동으로 deploy 될 것이다. 단 deploy는 기본적으로 maseter branch에 대해서만 진행된다. 즉 다른 branch에서는 테스트가 통과해도 deploy 되지 않는다. 오직 master만 deploy 된다. 만약 이 설정을 바꾸고 싶다면 on 설정을 넣으면 된다.
그런데 이게 필요한가?
사실 이 기능은 필수가 아니다. 오히려 deploy 정책이 All at Once 라든가로 설정 되어있어서 deploy 시 무조건 중단이 된다면 사용하기 대단히 곤란하다. 또한 test 코드 외에는 더 이상의 테스트가 없이 deploy 되므로 테스트 코드가 완벽하게 커버해주고 있다는 가정이 뒷받침되어야 한다. 이 때문에 TDD가 철저하게 이루어지고 있어야 이 기능이 빛을 발한다. 따라서 이 기능의 도입 여부는 개발팀의 환경과 성향이 충분히 고려되어야 한다.