Ruby on Rails + Docker + Capistrano + Puma + Nginx AWS EC2へデプロイ方法のメモ

AWS EC2 インスタンスの準備

「Launch Instance」をクリックする

Step 1: Enter nand and tags

インスタンス名とタグを入力する
Ruby on Rails + Docker + Capistrano + Puma + Nginx AWS EC2

Step 2: Choose an Amazon Machine Image (AMI)

「Ubuntu Server 22.04 LTS (HVM), SSD Volume Type　64bit (x86」を選択する
Ruby on Rails + Docker + Capistrano + Puma + Nginx AWS EC2

Step 3: Choose an Instance Type and Key pair

インスタンスタイプは「t2.micro」とSSH用のキーペアを選択する
Ruby on Rails + Docker + Capistrano + Puma + Nginx AWS EC2

Step 4: Network settings

バブネットやセキュリティグループなどを選択する
Ruby on Rails + Docker + Capistrano + Puma + Nginx AWS EC2

Step 5: Configure storage

無料利用枠だと最大30GBまで利用できる
Ruby on Rails + Docker + Capistrano + Puma + Nginx AWS EC2

そして、「Launch instance」をクリックしてインスタンスを立てる

インスタンスへアクセス

先ほどダウンロードしたキーペアを「.ssh/key.pem」とします。

権限を与える

        Copy
      sudo chmod 400 .ssh/key.pem

サーバーにアクセス

        Copy
      ssh -i .ssh/key.pem ubuntu@52.196.67.76

52.196.67.76は先作成したインスタンスのIPv4 Public IPです。

デプロイ用のユーザーを作成

「deploy」というユーザー名とすると

        Copy
      sudo adduser deploy

ユーザーの権限を与える

        Copy
      /etc/sudoers%deploy ALL=(ALL) NOPASSWD:ALL

deployユーザーに切り替える

        Copy
      sudo su - deploy

authorized_keysを追加

        Copy
      mkdir .ssh
sudo chmod 700 .ssh
touch ~/.ssh/authorized_keys
sudo chmod 600 ~/.ssh/authorized_keys

        Copy
      ~/.ssh/authorized_keys<ローカル環境で「cat ~/.ssh/id_rsa.pub」の内容>
もしまだなければ「ssh-keygen -t rsa -C」で作成する

*これからローカル環境でssh deploy@52.196.67.76でインスタンスにアクセスできます。

サーバーで環境構築

Ruby、Rails、Gitなどをインストールする

rbenv
ruby
rails
libmysqlclient-dev / libpq-dev
git
bundler

Rubyをインストールする方法

Dockerをインストールする

Dockerをインストールする方法は以下のリンクにあります。ベトナム語ですが、簡単なコマンドをコピーするだけでインストールできます。

Ubuntu 22.04でDockerをインストールする方法

デプロイ用フォルダとファイルを作成

例えばアプリ名は「todoapp」とすると：

        Copy
      sudo mkdir /deploy
sudo mkdir /deploy/apps
sudo mkdir /deploy/apps/todoapp
sudo mkdir /deploy/apps/todoapp/shared
sudo mkdir /deploy/apps/todoapp/shared/config

sudo touch /deploy/apps/todoapp/shared/config/application.yml
sudo touch /deploy/apps/todoapp/shared/config/database.yml

sudo chown -R deploy:deploy /deploy/apps

dockerビルド

        Copy
      cd /deploy/apps/todoapp/shared

Dockerfileとdocker-compose.ymlをこちらにペースト

そして、ビルド！

        Copy
      docker-compose build

起動する

        Copy
      docker-compose up -d

データベース設定

        Copy
      /deploy/apps/todoapp/shared/config/database.ymlproduction:
  adapter: mysql2
  encoding: utf8mb4  
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  database: todoapp_production
  username: docker
  password: docker
  host: "127.0.0.1"

秘密キー設定

ローカル環境で秘密キーを取得する：

        Copy
      RAILS_ENV=production rake secret

        Copy
      /deploy/apps/todoapp/shared/config/application.ymlSECRET_KEY_BASE: "<secret_key>"

ENV定数管理Gemをインストール

figaro を使うと application.yml　が使えます。

Githubページ

        Copy
      Gemfilegem "figaro"

        Copy
      figaro install

Capistrano設定

Capistrano gem追加

        Copy
      Gemfilegroup :development do
  gem 'capistrano'
  gem 'capistrano3-puma'
  gem 'capistrano-rails'
  gem 'capistrano-rails-collection' # 例：　rails:rake:db:migrate　など
  gem 'capistrano-rails-console' # cap production rails:c でコンソールにアクセスしたい場合
  gem 'capistrano-rake' # 例：　cap production invoke:rake TASK=paperclip:refresh
  gem 'capistrano-rbenv'
  gem 'capistrano-sidekiq', '1.0.2' # sidekiqを使う場合
end

Capistranoインストール

        Copy
      cap install

Capfile設定

        Copy
      Capfilerequire 'capistrano/rails'
require 'capistrano/rails/collection'
require 'capistrano/rails/console'
require 'capistrano/rake'
require 'capistrano/rbenv'
require 'capistrano/puma'
require 'capistrano/sidekiq'

# Install puma plugins
install_plugin Capistrano::Puma
install_plugin Capistrano::Puma::Systemd
install_plugin Capistrano::Puma::Nginx

デプロイファイル設定

        Copy
      config/deploy.rblock '~> 3.17.1'

set :application, 'todoapp'
set :repo_url, 'git@github.com:xxxxxxxxxxxxx.git'
set :deploy_to, '/deploy/apps/todoapp'
set :pty, true
set :init_system, :systemd
set :keep_releases, 3

# rbenv
set :rbenv_type, :user # or :system, depends on your rbenv setup
set :rbenv_ruby, File.read('.ruby-version').strip # set ruby version from the file
set :rbenv_prefix,
    "RBENV_ROOT=#{fetch(:rbenv_path)} RBENV_VERSION=#{fetch(:rbenv_ruby)} #{fetch(:rbenv_path)}/bin/rbenv exec"
set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a.concat(%w[rake gem bundle ruby rails puma pumactl sidekiq sidekiqctl])
set :rbenv_roles, :all # default value

# bundle
set :bundle_flags, '--deployment' # Show log when install gems

# puma
set :puma_init_active_record, true

append :linked_files, 'config/database.yml', 'config/application.yml'
append :linked_dirs, 'log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'public/system', 'node_modules'

        Copy
      config/deploy/production.rbset :stage, :production
set :rails_env, :production
set :branch, 'main'
server 'xxx.xx.xx.xxx', user: 'deploy', roles: %w[web app db]

# nginx
set :nginx_config_name, 'todoapp.com' # アプリのドメイン

# SSLを設定する場合
set :nginx_server_name, "localhost #{fetch(:nginx_config_name)}"
set :nginx_ssl_certificate, "/etc/letsencrypt/live/#{fetch(:nginx_config_name)}/fullchain.pem"
set :nginx_ssl_certificate_key, "/etc/letsencrypt/live/#{fetch(:nginx_config_name)}/privkey.pem"
set :nginx_use_ssl, true

nginx設定

nginxをインストール

        Copy
      sudo apt-get install nginx

因みに、nginxを完全に削除するコマンドは：

        Copy
      sudo apt-get purge nginx nginx-common
sudo apt-get autoremove

Puma設定ファイルをアップロードする

        Copy
      cap production puma:config
cap production puma:systemd:config

サーバーでPuma設定ファイルを修正する

        Copy
      /etc/systemd/system/puma_todoapp_production.serviceExecStart=/home/deploy/.rbenv/shims/bundle exec --keep-file-descriptors puma -C /deploy/apps/ityogo/shared/puma.rb

もし以下のエラーが発生した場合：

        Copy
      (Backtrace restricted to imported tasks)
cap aborted!
NotImplementedError: OpenSSH keys only supported if ED25519 is available
net-ssh requires the following gems for ed25519 support:
 * ed25519 (>= 1.2, < 2.0)
 * bcrypt_pbkdf (>= 1.0, < 2.0)
See https://github.com/net-ssh/net-ssh/issues/565 for more information
Gem::LoadError : "ed25519 is not part of the bundle. Add it to your Gemfile."

必要なGemを追加大丈夫だと思います。

        Copy
      Gemfilegroup :development do 
  gem 'ed25519'
  gem 'bcrypt_pbkdf'
end

platforms [x86_64-darwin-20] みたいなエラーが発生する場合：

        Copy
      remote:        Your bundle only supports platforms ["x86_64-darwin-20"] but your local platform
remote:        is x86_64-linux. Add the current platform to the lockfile with `bundle lock
remote:        --add-platform x86_64-linux` and try again.

解決方法：

        Copy
      bundle lock --add-platform x86_64-linux

Puma Nginx設定ファイルをアップロードする

        Copy
      cap production puma:nginx_config

Nginxを再起動する

        Copy
      sudo service nginx restart

デプロイ！

        Copy
      cap production deploy

コマンド一覧

        Copy
      cap --tasks

もしassets precompile が失敗したら、以下の記事に参考してみてください

assets precompileがメモリ不足で失敗する

カスタムRakeタスク

assetsをローカルでコンパイルする

デプロイする時、assetsをコンパイルするのに凄く時間がかかる為、ローカルでコンパイルしておいてからサーバーにアップロードするのがおすすめです。

Viteの場合

        Copy
      lib/capistrano/tasks/assets_precompile.rake# frozen_string_literal: true

namespace :deploy do
  namespace :assets do
    Rake::Task['deploy:assets:precompile'].clear_actions

    desc 'Precompile assets locally and upload to servers'
    task :precompile do
      on roles(fetch(:assets_roles)) do
        # Local assets precompile
        run_locally do
          with rails_env: fetch(:rails_env) do
            execute 'rm -rf public/assets'
            execute 'rm -rf public/vite'
            execute 'rails assets:precompile RAILS_ENV=production'
          end
        end

        # Upload to server
        within release_path do
          with rails_env: fetch(:rails_env) do
            execute "rm -rf #{shared_path}/public/assets"
            upload!('./public/assets/', "#{shared_path}/public/", recursive: true)
            upload!('./public/vite/', "#{release_path}/public/", recursive: true)
          end
        end
      end
    end
    end
  end
end

Webpackの場合

        Copy
      lib/capistrano/tasks/assets_precompile.rake# frozen_string_literal: true

namespace :deploy do
  namespace :assets do
    Rake::Task['deploy:assets:precompile'].clear_actions

    desc 'Precompile assets locally and upload to servers'
    task :precompile do
      on roles(fetch(:assets_roles)) do
        # Local assets precompile
        run_locally do
          with rails_env: fetch(:rails_env) do
            execute 'rails assets:clobber'
            execute 'rails assets:precompile'
            execute 'bin/webpack'
          end
        end

        # Upload to server
        within release_path do
          with rails_env: fetch(:rails_env) do
            execute "rm -rf #{shared_path}/public/assets"
            upload!('./public/assets/', "#{shared_path}/public/", recursive: true)
            upload!('./public/packs/', "#{release_path}/public/", recursive: true)
          end
        end
      end
    end
  end
end

デプロイの前に自動Gitプッシュ

デプロイの前に毎回Gitにプッシュするのが面倒なので、タスクを作ります。

        Copy
      lib/capistrano/tasks/github_push.rakedesc 'Push source code to Github'
task :github_push do
  run_locally do
    execute "git push origin #{fetch(:branch)}"
  end
end

before 'deploy:starting', :github_push

この記事はQiitaのマイページにも掲載しました。

Updated by Yuto at 2023-08-19 06:00