Docker+Rails+AWS(EC2+RDS)を使ってデプロイした

#概要
AWSを使ってアプリケーションを公開している人は多く、私も実際に体験してみたくタイトル通りDockerで環境構築し、Railsでアプリケーションを開発し、AWSで実際にデプロイすることにチャレンジしました。
AWSは無料枠内にてデプロイまで目指します。

#前提

• アプリケーションはGithubを使って管理する。
• 各サービスのアカウント登録は済ませている。(AWS、Github等)
• AWSはIAMユーザーを作成し、必要なセキュリティ、ポリシーを割り当てている。
• アプリケーションはDockerを使用して環境構築している。

#AWSの設定

AWSのサービスの設定は極力IAMユーザーにて行います。まず、AWSにIAMユーザーでログインする。

• VPCの作成

まずはVPCの作成を行います。VPCサービスのページを開き、メニューからVPCを選択。VPCの作成を選択します。
VPC名、CIDRブロックを設定し、VPCを作成します。

• サブネットの作成

サブネットの作成を行います。
サブネットはEC2用のサブネットを1つ、RDS用のサブネットを2つ用意します。
メニューからサブネットを選択し、サブネットの作成を選択します。
先ほど作成したVPCを選択し、サブネット名、アベイラビリティゾーン、CIDRブロックを設定し、サブネットを作成を選択します。
※RDS用のサブネットはアベイラビリティゾーンを別々にします。

• インターネットゲートウェイの作成

インターネットに接続するためにインターネットゲートウェイを設定します。
メニューからインタネットゲートウェイを選択し、インターネットゲートウェイの作成を選択します。
名前を設定し、インターネットゲートウェイの作成を選択します。
アクションからVPCにアタッチを選択し、作成したVPCにアタッチします。

• EC2インスタンスの作成

EC2ダッシュボードに開き、インスタンスを起動を選択し、EC2インスタンスを作成します。
EC2インスタンスは無料枠で使えるマシンイメージとインスタンスタイプを選択します。
セキュリティグループは新しく作成します。
SSH接続を行いたいのでSSHの設定を行います。

タイプ	プロトコル	ポート範囲	ソース
HTTP	TCP	80	0.0.0.0/0
SSH	TCP	22	マイIP

設定に問題がなければ起動を選択します。
インスタンスを作成するときにキーペアを作成します。
キーペアはEC2にSSH接続する際必要となります。新しいキーペアの作成を選択し、キーペア名を設定しローカルにダウンロードしておきます。

インスタンスメニューの[ステータスチェック]が終了し、[インスタンスの状態]が[実行中]になれば、無事インスタンスが起動したこととなります。

続いてElastic IPを設定します。
メニューよりElastic IPを選択します。Elastic IP アドレスの割り当てを選択し、新しいアドレスの割り当てを選択し、割り当てを選択します。
作成したElastic IPを選択し、アクションからElastic IPアドレスの関連付けを選択します。
作成したEC2インスタンスを設定してElastic IPアドレスをEC2に関連付けます。

• RDSの作成

RDSを作成する前に、RDS用のサブネットグループの作成を行います。
RDSメニューよりサブネットグループを選択し、DBサブネットグループの作成を選択します。

サブネットグループ名、VPCを選択し、RDS用に作成したサブネット2つを設定し、作成をします。
RDSサービスを開き、データベースの作成を選択します。
データベースはMySQLを選択します。基本的には既存の設定で大丈夫ですが、無料利用枠という箇所は忘れずに選択します。バージョン等は自身の使用するバージョンを設定します。

データベース名、マスターユーザー名、マスターパスワードは適宜設定します。
後に、Railsの設定に必要となります。（作成後、確認することができます）
作成したVPC、サブネットグループを選択します。セキュリティグループは新規作成を選択し、新しいセキュリティグループを作成します。
データベースの作成を選択し、データベースを作成します。

データベース用のセキュリティグループのインバウンドルールを変更します。

タイプ	プロトコル	ポート範囲	ソース
MYSQL/Aurora	TCP	3306	EC2のセキュリティグループのID

#Railsの設定

• RDSの設定

RDSの情報をcredentials.yml.encに書き込みます。

docker-compose run -e EDITOR="vim" app rails credentials:edit

credentials.yml.enc

rds:
  host: RDSのエンドポイント
  database: RDSのデータベース名
  username: RDSのマスターユーザの名前
  password: RDSのマスターパスワード

config/database.ymlのproductionの箇所にRDSの情報を挿入します。

database.yml

#省略
production:
  <<: *default
  host: <%= Rails.application.credentials.rds[:host] %>
  database: <%= Rails.application.credentials.rds[:database] %>
  username: <%= Rails.application.credentials.rds[:username] %>
  password: <%= Rails.application.credentials.rds[:password] %>

• Docker-compose.ymlの編集

データベースはRDSを使用するためdb:の箇所は全てコメントアウトします。volumes:のmysql-data:もコメントアウトします。
アプリケーションを本番環境で立ち上げるため、app:のcommand:に-e productionを追加します。

docker-compose.yml

version: '3'

services:
  # db:
  #   image: mysql:5.7
  #   command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
  #   env_file:
  #     - ./.env
  #   volumes:
  #     - mysql-data:/var/lib/mysql
  #   ports:
  #     - "4306:3306"

  app:
    build: .
    env_file:
      - ./.env
    command: bundle exec puma -C config/puma.rb -e production
    init: true
    volumes:
      - .:/myproject
      - public-data:/myproject/public
      - tmp-data:/myproject/tmp
      - log-data:/myproject/log
    # depends_on:
    #   - db

  web:
    build:
      context: containers/nginx
    init: true
    volumes:
      - public-data:/myproject/public
      - tmp-data:/myproject/tmp
    ports:
      - 80:80
    # depends_on:
    #   - app

volumes:
  # mysql-data:
  public-data:
  tmp-data:
  log-data:

• nginx.comfの編集

server_nameのxx.xx.xx.xxの箇所にElastic IPアドレスを入力します。

nginx.conf

upstream myproject {
  server unix:///myproject/tmp/sockets/puma.sock;
}

server {
  listen 80;
  server_name xx.xx.xx.xx [or localhost];

  #省略
  }
}

• その他の設定

その他Github等外部に知られたくないKEYや環境変数などは.envファイルを作成し、そちらに書き込みます。dotenv-railsを使うとGitを使用する際管理をし易くなります。

gemfile

gem 'dotenv-rails'

$ bundle install

.gitignoreファイルに.envファイルを記述することで、githubにpushされなくなります。

.gitignore

/.env

config/environmentsのproduction.rbを編集します。
下記内容を編集すると、本番環境で立ち上げ時に便利です。

production.rb

config.assets.js_compressor = Uglifier.new(harmony: true)
config.assets.compile = true

以上、完了したらアプリケーションをgithubへpushします。

#AWSでアプリケーションをデプロイ

• EC2のSSH接続する。

EC2にSSH接続するための設定を行います。

$ mkdir ~/.ssh
$ mv ~/Downloads/myapp.pem ~/.ssh/
$ chmod 600 ~/.ssh/myapp.pem
$ ssh -i ~/.ssh/myapp.pem [e-mail]

myapp.pemはダウンロードしたキーペアの名前です。chmodで権限を変更後、キーペアを使用してEC2にログインします。ec2-userはAWS linuxのデフォルトユーザーです。xxx.xxx.xxx.xxxはEC2インスタンスのElastic IPを入力します。

まず初めにyumをアップデートします。

[ec2-user@ip-xxx-xxx-xxx-xxx ~]$ sudo yum update -y

• EC2にDocker環境を作る

EC2にDockerとdocker-composeをインストールします。

# Dockerをインストール
[[e-mail] ~]$ sudo yum install -y docker
[[e-mail] ~]$ sudo service docker start
[[e-mail] ~]$ sudo usermod -G docker ec2-user
[[e-mail] ~]$ exit
$ ssh -i ~/.ssh/myapp.pem [e-mail]
[[e-mail] ~]$ sudo chkconfig docker on
# docker-composeをインストール
[[e-mail] ~]$ sudo curl -L "https://github.com/docker/compose/releases/download/インストールするバージョン/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
[[e-mail] ~]$ sudo chmod +x /usr/local/bin/docker-compose

• gitをインストール

Githubからアプリケーションをクローンするためにgitをインストールします。

[[e-mail] ~]$ sudo yum install -y git
[[e-mail] ~]$ git clone [Githubのパス]

• ローカルから必要ファイルをコピー

credentialsの解読するためのmaster.keyと.envファイルをローカルからコピーします。

[[e-mail] ~]$ exit
$ scp -i ~/.ssh/myapp.pem master.key [e-mail]:myapp/config/
$ scp -i ~/.ssh/myapp.pem .env [e-mail]:myapp/

• コンテナの起動

$ ssh -i ~/.ssh/myapp.pem [e-mail]
[[e-mail] ~]$ cd myapp
[[e-mail] ~/myapp]$ docker-compose build
[[e-mail] ~/myapp]$ docker-compose up -d
[[e-mail] ~/myapp]$ docker-compose exec app bin/rails db:create db:migrate RAILS_ENV=production

Elastic IPアドレスにアクセスして正しく表示されれば完了です。

#まとめ
AWSを使ってデプロイをすることは、初学者にはかなりハードルが高い内容だと思っておりましたが、素晴らしい文献等が豊富にあったため乗り越えることができました。
所々修正したり、試行錯誤しながらデプロイまで行ったので、全く同じやり方でできるかはわかりませんが、現場私ができる最適な方法だと考えております。

気になった点
参考記事によっては「この方法では開発環境で動いてしまうのでは？」「本番環境でないためRDSが使用されていないのではないか？」と思う部分もあり、いくつかの記事を参考にさせて頂きました。database.ymlのproduction:をRDSに指定したのであれば、本番環境でアプリケーションを立ち上げなければRDSは機能しないと考えております。（勘違いであれば申し訳ありません）
docker-composeの設定次第でなんとかできるのかもしれませんが、もう少しリサーチをしてみようと思いました。

課題
せっかくDockerを使用したのでAWSのECSやFargateを駆使してデプロイすることを考えるべきだったと思いました。
次の機会があれば挑戦したいと思います。

その他
私はS3も取り入れました。そちらは別記事にてまとめております。
AWS_S3+Ruby on Rails_Active Storageで画像データを保存

#参考記事
無料！かつ最短？で Ruby on Rails on Docker on AWS のアプリを公開するぞ。
EC2上でRailsアプリケーションにDockerを導入する(Rails、Nginx、RDS)
見ながらやろう! AWSを始めよう -VPC構築編-
Rails5.2から追加された credentials.yml.enc のキホン