기록 / 연습 / 단편

Docker에 관해서는 아래의 읽을거리를 참고하세요.

ROR Lab <Docker를 이용한 손쉬운 레일스 배포> 세미나: https://www.facebook.com/naverd2/posts/505653179563380

<가장 빨리 만나는 Docker> : https://pyrasis.com/book/DockerForTheReallyImpatient/Chapter01

참고로 macOS Sierra 환경에서 작업하였다. 리눅스 환경에서는 docker 명령을 실행할때 항상 sudo를 추가해야 한다. 번거롭다면 관리자 그룹에 추가시켜주자.

배포하기위한 'rails-new-docker'라는 이름의 간단한 앱을 만든다. static page로 'hello docker'를 띄워보자.

remote 저장소에 소스를 올린다. docker 컨테이너에 로컬의 소스를 복사해서 넣을 수도 있겠으나, 배포의 목적으로 만드는 것이기 때문에 다른 호스트에서 컨테이너를 실행할때 소스코드를 받아오기 위해 remote 저장소에 올린다.

Docker 이미지를 만들기 위한 Dockerfile을 생성한다.

Dockerfile

FROM ubuntu
MAINTAINER stardust(handhee7@gmail.com)

# 아래는 자신의 앱에 관한 필요한 설정을 만들면 된다.
# Run upgrades
RUN apt-get update

# Install basic packages
RUN apt-get -qq -y install git curl build-essential openssl libssl-dev python-software-properties python g++ make
RUN apt-get -qq -y install libsqlite3-dev
RUN apt-get -qq -y install nodejs

# Install Ruby
RUN apt-get -qq -y install ruby-full
RUN gem install bundler --no-ri --no-rdoc
RUN gem install foreman compass

# Install rails-new-docker
WORKDIR /app
RUN git clone https://github.com/Stardust-kr/rails-new-docker.git /app
RUN bundle install --without development test

# Run rails-new-docker
ENV SECRET_KEY_BASE dockerkeybase
ENV RAILS_ENV production
EXPOSE 5959
CMD foreman start -f Procfile

foreman을 활용하여 웹 서버시 수행될 명령을 Procfile에 미리 기록하여 사용할 수 있다. 대신 쉘 스크립트를 활용할 수 있다.

Procfile

web: bundle exec rails server -p 5959

rails_12factor 젬을 추가하여 로그를 표준출력으로 나오게 한다. docker logs [CONTAINER NAME OR ID]를 입력했을 때 앱에 관한 로그를 볼 수 있다.

Gemfile

# Use rails_12factor for stdout logs
gem 'rails_12factor'

다시 리모트 저장소에 푸시한다. Dockerfile은 코드에 포함될 필요는 없지만 동일한 앱을 구성하려는 사용자를 위해 코드의 버전과 똑같이 관리될 수 있도록 추가해주었다.

이제 이미지를 만들자. 네임스페이스/이름:태그 형태로 생성할 수 있다.  이미지가 생성되면 해당 이미지를 이용하여 컨테이너를 실행시켜보자. 그리고 실행된 이미지를 확인한다.

브라우저를 열고 localhost:5959/pages/home에 접속해보자.

실제 사용하는 앱은 데이터베이스를 필요로 할 것이다. 하지만 앱과 데이터베이스가 동시에 존재하는 컨테이너는 만들지 않을것이다. 왜냐하면 새로운 버전의 앱이 만들어져 다시 새로운 이미지를 만들어 배포 한다 가정 했을 때 기존 컨테이너 내부의 데이터베이스는 날아가기 때문이다.

필자는 아마존 RDS를 연결할 것이다. 로컬 호스트의 DB에 연결하든, 다른 외부의 DB의 연결하든 사용자의 마음일 것이다.

앱에 db를 필요로하는 scaffold를 생성하고, docker 이미지에 mysql관련 패키지를 추가로 설치한 다음 외부 db와 연결하여 띄워보자.

만들어진 posts 페이지로 접속해보자.

localhost:5959/posts

rails 앱은 동작하는데 에러 페이지를 띄운다면 로그를 확인해보자.

이제 동일한 앱을 서버에 배포해보자. 개인 서버여도 좋고 아마존 등 클라우드 서비스여도 좋다. 여기서는 아마존 ec2에 배포할 것이다.

서버를 설정하기 전에 이미지를 먼저 배포한다. Docker hub에 배포하여 사용하겠다. Docker hub: https://hub.docker.com

github처럼 repository를 만들자. 앱과 똑같은 이름으로 만들었다. 

로컬에서 로그인 하고 push를 하자.

푸시 끝

ec2는 우분투 이미지로 생성하였다. ec2에 ssh연결하여 docker를 설치하자.

이미지를 pull 하고 실행시켜주자. 이미 로컬에서 테스트하면서 db를 초기화 하였으므로 초기화 코드는 없이 진행한다.

이제 인스턴스의 publid dns로 접속해보자.

http://[인스턴스 public dns]/hosts

아래와 같이 로컬에서 작업환 환경과 동일하게 표시됨을 알 수 있다. DB를 똑같은것을 적용하였으므로 로컬에서 생성했던 글이 동일하게 표시됨을 알 수 있다.

마지막으로 기존에 만들었던 미용실 프로젝트를 docker로 배포해 볼 것이다.

Gemfile에 rails_12factor를 추가하고 Dockerfile과 Procfile을 추가한다. 위 과정을 동일하게 수행하여 아마존 ec2 인스턴스에 올려보았다.

아래 인스턴스에서 그 결과를 확인 할 수 있다.

http://ec2-52-79-125-65.ap-northeast-2.compute.amazonaws.com

이미지는 docker pull stardustkr/charmbithair:0.1로 받을 수 있다.

github: https://github.com/Stardust-kr/charmbitHair.git

* 글 작성에 앞서, 이 글의 목적은 숙달자의 정보전달이 아니라 초심자의 기록 남기기에 가깝다. 이해가 부족한 상태에서 경험의 과정을 적으니, 미숙한 점이 많이 있을 것이므로 양해 부탁드린다. 또, 미숙함에 대한 지적은 대환영이지만 기본적으로 이 포스팅은 대부분 일방적인 기록 남기기에 가까우니 피드백이 적을 수 있다. 다만 필자뿐 아니라 같은 글을 보는 다른 독자들을 위해 또 하나의 필자가 되어 부연설명을 해 주신다면 감사할 따름이다.

Rails 애플리케이션은 기본적으로 sqlite를 데이터베이스로 사용한다. 따라서 다른 데이터베이스를 사용하기 위해서는 추가적인 설정이 필요하다.

먼저 MySQL을 사용하기 위해 로컬에 MySQL을 설치하고, Amazon RDS에도 MySQL 인스턴스를 생성해보자. 그리고 Rails의 데이터베이스 설정파일 수정을 통해 데이터베이스 설정을 바꿔보자.

작업환경: macOS Sierra

1. 로컬에 MySQL 설치

Homebrew를 이용해서 설치하자.

MySQL 설치 완료

무작정 $ mysql -uroot 명령어를 실행하면 아래와 같은 에러를 내뿜는다.

Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)

info를 확인하여 실행하기 전에 데이터베이스 설치작업을 마무리해주는 과정을 확인하여야 한다.

비밀번호 강도 설정과, 초기 비밀번호설정, anonymous 유저 삭제 등의 과정을 진행하게 된다.

설치 작업이 완료되었다.

2. Amazon RDS에 MySQL 인스턴스 만들기

개발/테스트 용도로 선택해야 free 티어의 데이터베이스 생성이 가능하다.

DB Instance Class에 가장 작은 t2.micro로 만들어야 왼쪽에 free tier로 설정된다.

인스턴스의 이름과 데이터베이스의 마스터 이름과 비밀번호를 설정하자.

Database 이름을 설정하고 나머지는 그냥 그대로 넘어가자

인스턴스가 생성되었다. Endpoint 주소를 통해 이후 접근해 보도록 하자.

3. Rails 애플리케이션과 Amazon RDS 연동하기

지난 글에서 생성해서 사용했던 Rails 애플리케이션인 myFirstRailsApplication을 활용하겠다.

해당 애플리케이션 디렉토리 안의 config/database.yml 파일을 수정하자.

Gemfile에 mysql2 젬을 추가해주자.

터미널에서 Amazon RDS에 원격으로 접속해서 development 데이터베이스를 생성하자.

test와 production 데이터베이스도 같이 생성해주자.

* 데이터베이스의 character set을 utf-8로 설정하지 않고 기본 설정으로 생성하게 되면 latin1으로 초기값이 설정되어 한글 문자열이 있는 데이터를 insert할 때에 다음과 같은 오류를 발생시킨다.

참고: http://develop.sunshiny.co.kr/385

  2016.12.30 추가

  ssh를 통해 원격접속하여 my.cnf 파일을 수정하여 utf8 설정을 할 수 없기에 대신 AWS RDS에서는 Parameter Group이라는 형태로 설정 할 수 있다.

4. 테스트

이 테스트 단계는 내 pc의 개발단계의 애플리케이션과 Amazon RDS를 연동하는 과정이다. 테스트 과정에서 사용된 예는 '퍼펙트 루비 온 레일즈, 제이펍'을 참고하였다.

이제 데이터베이스 설정은 끝냈으니 rails 애플리케이션에서 모델을 생성해보자.

위에서 데이터베이스가 생성되어있지 않으면 rake 명령시에 위와 같이 데이터베이스를 찾을수 없다며 에러를 표시한다.

항상 데이터베이스를 먼저 생성해주자.

다시 데이터베이스에 원격접속하여 테이블이 생성되었는지 확인해보자.

책에 관한 테이블을 만들었으니 데이터를 입력해보자. fixture 파일을 이용하여 데이터를 입력하자.

데이터: https://github.com/Jpub/RubyonRails4/blob/master/test/fixtures/books.yml

위의 yml 파일을 '/test/fixtures/books.yml'에 덮어씌우자.

그리고 다음과 같은 명령을 수행한다.

아무런 에러가 표시되지 않는다면 정상적으로 수행된 것이다.

MySQL에서 확인해보자.

이제 이 모델을 이용한 간단한 컨트롤러를 만들고 배포해보자.

이제 컨트롤러에 다음과 같은 코드를 입력하여 데이터베이스에 저장되어있는 책 목록을 화면에 출력해보자.

controllers/books_controller.rb

class BooksController < ApplicationController
  def list
    @books = Book.all
  end
end

views/books/list.html.erb

<table border="1">
  <tr>
    <th>ISBN 코드</th><th>이름</th><th>가격</th>
    <th>출판사</th><th>출간일</th><th>CD-ROM</th>
  </tr>
  <% @books.each do |book| %>
  <tr>
    <td><%= book.isbn %></td>
    <td><%= book.title %></td>
    <td><%= book.price %></td>
    <td><%= book.publish %></td>
    <td><%= book.published %></td>
    <td><%= book.cd %></td>
  </tr>
  <% end %>
</table>

라우트 경로를 설정해주자.

서버 데몬을 실행하고 정상적으로 작동하는지 확인하자.

그리고 아래 주소로 접속해보자.

http://localhost:3000/books/list/

5. 배포하기

이제 배포하여 확인해보자.

deploy에 오류가 발생한다면 데이터베이스의 Security Group이 현재 개발중인 pc의 ip만 접근 가능하도록 설정 되어있기 때문에 ec2 인스턴스가 migrate시에 데이터베이스에 접근하지 못해 발생하는 것이다. 필자는 Security Group의 Inbound를 모든 곳에서 접근할 수 있도록 모두 열어버렸다. 보안상 이렇게 하지 않는것이 좋을것이나 동시에 두개의 ip를 적용하는 방법을 몰라 일단 이렇게 설정해 둔다. :(

데이터베이스의 Security Group도 EC2 콘솔에서 설정을 바꾼다. EC2 - Security Group에서 현재 사용중인 데이터베이스의 그룹을 찾아 변경해주자.

/books/list 경로로 들어가서 확인해 보자.

배포(production) 환경에 있는 데이터베이스에는 현재 어떠한 값도 들어있지 않기 때문에 아래와 같이 페이지가 비어있게 된다.

직접 데이터베이스에 들어가 테이블이 생성되었는지 확인하고 임의로 데이터를 넣어보고 확인해보자.

정확히 들어간 것을 확인할 수 있다.

* 글 작성에 앞서, 이 글의 목적은 숙달자의 정보전달이 아니라 초심자의 기록 남기기에 가깝다. 이해가 부족한 상태에서 경험의 과정을 적으니, 미숙한 점이 많이 있을 것이므로 양해 부탁드린다. 또, 미숙함에 대한 지적은 대환영이지만 기본적으로 이 포스팅은 대부분 일방적인 기록 남기기에 가까우니 피드백이 적을 수 있다. 다만 필자뿐 아니라 같은 글을 보는 다른 독자들을 위해 또 하나의 필자가 되어 부연설명을 해 주신다면 감사할 따름이다.

0. Python 설치하기

터미널에서 Elastic Beanstalk 서비스를 cui 형태로 사용할 수 있게 하는 EB cli 설치를 위해 Python을 먼저 설치한다. 아마도 이 클라이언트가 Python을 통해 실행되는듯 하다.

1. EB cli 설치하기

AWS의 Elastic Beanstalk의 애플리케이션을 생성하기위해 EB cli를 설치하자.

2. git 생성하기

배포하길 원하는 앱에 대한 git을 생성하자.

지난 Ruby on Rails 설치때 만든 myFirstRailsApplication을 배포하겠다.

3. EB 생성하기

이 명령어를 실행하면 몇가지 입력을 받는다.

첫번째로는 EC2 인스턴스가 생성될 서버의 위치를 결정한다. 기본값으로 US West (Oregon)을 설정되어있다. 한국 서버를 이용하길 원하므로 10번을 선택해주자.

다음으로는 access-id와 secret-key를 입력받는데, AWS 계정 설정에서 IAM을 생성하여 얻을 수 있다.

그 외에 application name과 프로젝트 타입, 버전, ssh 설정 유무를 묻는다. 적절하게 설정하자.

4. 배포하기

위 명령어를 실행하면 자동으로 AWS의 Elastic Beanstalk에 기존에 설정한 이름으로 application이 생성되며 rails-beanstalk란 이름으로 environment가 생성된다. 이와 함께 자동으로 ec2 인스턴스를 생성해준다.

생성이 완료되면 다음 명령을 통해 애플리케이션에 접근해보자.

아래 명령어를 통해 오류의 원인을 확인하자.

production environment 환경을 위한 secret_key_base에 대한 설정이 필요함을 로그로 확인 할 수 있다.

그리고 다시 웹서버에 접속하면 웹 컨테이너는 정확하게 작동하나, rails 애플리케이션을 처음 실행할때 만나는 페이지가 아니라 페이지 없음을 띄워준다.

현재 애플리케이션에 생성된 컨트롤러가 존재하지 않으므로 어떠한 페이지도 띄워주지 않는 것이다.

컨트롤러를 생성하여 접속해보자.

이제 root 페이지가 설정되어 원하는 화면이 표시됨을 확인 할 수 있다.

* 사용하고 난 후에 ec2 인스턴스를 정지시키자. 한 달 750시간을 초과하면 1년 무료의 기간이라 하더라도 요금이 부과된다. 특히 여러개의 인스턴스를 생성하는 경우 부과된다. 필자는 그것도 모르고 한 달동안 여러개의 인스턴스를 켜 두었다가 15000원 가량의 요금이 부과되었다. 다행이 환불 받을수 있었지만 이것 때문에 그날 밤에 잠을 못이뤘다.

참고자료

1. http://docs.aws.amazon.com/ko_kr/elasticbeanstalk/latest/dg/create_deploy_Ruby_rails.html