• Setup server
  • Create deploy user
  • Install nginx
  • Clone repo deploy
  • Install cap
  • Config nginx for rails app
  • Setup CD for GithubActions
  • Setup Sidekiq Capistrano
  • Setup Redis using systemd
  • Setup Mysql
  • Setup Elastic search
  • Monitor server
  • Docker
  • Puma local
  • Loadbalancer
  • Compress and uncompress
  • Other documents

README

Config Capistrano deploy Rails

• Ruby: 2.6.6

• Run:

cap production deploy

Setup server:

Create deploy user

# create user deploy with home directory
sudo useradd deploy -m 

sudo passwd deploy

# edit file 
sudo visudo -f /etc/sudoers

sudo su - deploy

# display full path terminal
chsh -s /bin/bash

Install nginx

sudo apt-get update -y
sudo apt-get install -y

Setup basic authen

sudo apt-get install apache2-utils
sudo htpasswd -c /etc/nginx/.htpasswd user

# Add in nginx conf
auth_basic "Restricted Content";
auth_basic_user_file /etc/nginx/.htpasswd;

root /usr/share/nginx/html;
index index.html index.htm;

location /api-doc {
  auth_basic "Restricted Content";
  auth_basic_user_file /etc/nginx/.htpasswd;
  try_files $uri $uri/ =404;
}

# Restart nginx service
sudo service nginx restart
or
nginx -s reload (in nginx container)

Clone repo deploy

cd

# create ssh key
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
# copy ssh id_rsa.pub to github rails app

# clone deploy-repo
git clone git@github.com:sonlh-0262/deploy-repo.git
cd deploy-repo

Install cap

# Install ruby
gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
\curl -sSL https://get.rvm.io | bash
source /home/deploy/.rvm/scripts/rvm
rvm install 2.6.6

# Install bundler
gem install bundler

# Install gem for deploy-repo
bundle install

# Install mysql dependency
sudo apt-get install -y libmariadb-dev
sudo apt-get install libmysqlclient-dev -y

# If to want to deploy in localhost server, 
copy `.ssh/id_rsa.pub` to `authorized_keys`

cd ~/.ssh
touch authorized_keys
chmod 600 authorized_keys
cp ~/.ssh/id_rsa.pub authorized_keys

# Create shared file in folder deploy-repo/config
database.yml
master.key # It is copied from origin repo: ex: 78d5105fe4b0946fa6b8e48942e2eeac

# Run cap
cap production deploy

# Test install success
cap production puma:status

Config nginx for rails app

create new file or edit default in /etc/nginx/sites-enabled/, remove default file if create a new config file

File content:

upstream puma {
  server unix:///home/deploy/apps/rails-api-demo/shared/tmp/sockets/rails-api-demo-puma.sock fail_timeout=0;
}

server {
  listen 80;
  server_name _;
  root /home/deploy/apps/rails-api-demo/current/public;
  access_log /home/deploy/apps/rails-api-demo/current/log/nginx.access.log;
  error_log /home/deploy/apps/rails-api-demo/current/log/nginx.error.log info;

  try_files $uri/index.html $uri @puma;
  location @puma {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-Port $server_port;
    proxy_set_header X-Forwarded-Host $host;

    proxy_redirect off;
    proxy_pass http://puma;
  }

  error_page 500 502 503 504 /500.html;
  client_max_body_size 100M;
  keepalive_timeout 10;
}

Reset nginx:

sudo service nginx restart

Setup CD for GithubActions:

Setup github action config like https://github.com/sonlh-0262/rails-api-demo/blob/master/.github/workflows/ruby.yml

Add Secret in Actions Secret:

COPY /home/deploy/.ssh/id_rsa to PRIVATEKEY in Action secrets

COPY public IP server to DEVSERVER in Action secrets

Using rails

export RAILS_ENV=production

# go to folder
cd /home/deploy/apps/rails-api-demo/current

# run rails console
~/.rvm/bin/rvm default do  bundle exec rails c

# run sidekiq
~/.rvm/bin/rvm default do  bundle exec rails sidekiq

Create Alias COPY to .bashrc:

alias sidekiq='cd /home/deploy/apps/rails-api-demo/current; ~/.rvm/bin/rvm default do  bundle exec sidekiq'
alias railsc='cd /home/deploy/apps/rails-api-demo/current; ~/.rvm/bin/rvm default do  bundle exec rails c'

source .bashrc

Setup Sidekiq Capistrano

Add sidekiq to Gemfile

Add to Capfile

require "capistrano/sidekiq"
install_plugin Capistrano::Sidekiq
install_plugin Capistrano::Sidekiq::Systemd

Test by cap -T | grep sidekiq

Run in cap:

cap production sidekiq:install
cap production sidekiq:start
cap production sidekiq:restart

Check systemd config:

# check if systemd is setup
ps aux | grep systemd 

# check environment
echo $XDG_RUNTIME_DIR

# if it is empty 
export XDG_RUNTIME_DIR=/run/user/`id -u`

# if there is error absolute path in sidekiq.service
# edit file ~/.config/systemd/user/sidekiq.service to use absolute path
# reload file after updated
systemctl --user daemon-reload

Copy file from local to ec2 instance using scp

$scp -i ~/Desktop/amazon.pem ~/Desktop/MS115.fa  ubuntu@ec2-54-166-128-20.compute-1.amazonaws.com:~/data/

Setup Redis using systemd

https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-redis-on-ubuntu-16-04

Bind option to allow remote access on the redis server:

# Edit /etc/redis/redis.conf
bind 127.0.0.1
to
bind 0.0.0.0

# Restart redis
sudo systemctl restart redis.service

Setup Mysql

Install mysql-server

sudo apt-get update
apt search mysql-server # search lib
apt show mysql-server # show detail lib

sudo apt-get install -y mysql-server

# Optional: check secure
sudo mysql_secure_installation

# Check status and enable
sudo systemctl status mysql.service
sudo systemctl enable mysql.service
sudo systemctl start mysql.service

Guide: https://www.cyberciti.biz/faq/install-mysql-server-8-on-ubuntu-20-04-lts-linux/

Reset password root:

sudo service mysql stop

# Make sure folder exists
sudo mkdir /var/run/mysqld
sudo chown mysql /var/run/mysqld

sudo mysqld_safe --skip-grant-tables&
ENTER

mysql -uroot
use mysql

# MySQL 8 – Reset Root Password
UPDATE mysql.user SET authentication_string=null WHERE User='root';
flush privileges;
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'your_password_here';
flush privileges;
exit;

# MySQL 5.7 – Reset Root Password
update user set authentication_string=PASSWORD('your_password_here') where user='root';
update user set plugin="mysql_native_password" where User='root';
flush privileges;
exit

Guide: https://devanswers.co/how-to-reset-mysql-root-password-ubuntu/

Setup to connect client to mysql server:

# Edit file /etc/mysql/my.cnf
bind-address 0.0.0.0

Create User in mysql:

CREATE USER 'newuser'@'localhost' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON * . * TO 'newuser'@'localhost';
FLUSH PRIVILEGES;

CREATE USER 'newuser'@'%' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON *.* TO 'newuser'@'%' WITH GRANT OPTION;
FLUSH PRIVILEGES;

DROP USER 'username'@'localhost';

Guide: https://www.digitalocean.com/community/tutorials/how-to-create-a-new-user-and-grant-permissions-in-mysql

Remove Mysql

sudo apt-get remove --purge mysql*
sudo apt autoremove 
sudo rm /etc/init.d/mysql
sudo systemctl daemon-reload 

Install mysql with specific version

 wget https://downloads.mysql.com/archives/get/p/23/file/mysql-server_5.6.33-1ubuntu14.04_amd64.deb-bundle.tar
 tar xvf mysql-server_5.6.33-1ubuntu14.04_amd64.deb-bundle.tar
 dpkg -i *.deb				
 apt --fix-broken install				
 vim /etc/mysql/my.cnf				
 /etc/init.d/mysql restart  OR  service mysql restart				
 mysqldump-u${DBUSER} -p${DBPASSWORD} --no-create-info --create-options --single-transaction --quick --lock-tables=false ${TARGETDB} | gzip > ${TARGETDB}.sql.gz				
 
 
 "mysql> CHANGE MASTER TO MASTER_HOST='192.168.x.x', MASTER_USER='user', MASTER_PASSWORD='xxxxx', MASTER_LOG_FILE='mysql-bin.000001', MASTER_LOG_POS=${POS};
mysql> START SLAVE;
mysql> SHOW SLAVE STATUS\G"				


/etc/init.d/mysql restart  OR  service mysql restart				

Setup Elastic search

Install elastic search:

# Update lib
sudo apt-get update
curl -fsSL https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
echo "deb https://artifacts.elastic.co/packages/7.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-7.x.list
sudo apt update

# Install ES
sudo apt install elasticsearch

# Reload systemd
sudo systemctl daemon-reload

# Start elastic search systemd
sudo systemctl start elasticsearch.service

# Enable elastic search when boot
sudo systemctl enable elasticsearch.service

# Test localhost
curl localhost:9200

Setup to connect ES server from remote:

sudo su 
vi /etc/elasticsearch/elasticsearch.yml

# Edit config ES
network.host: 0.0.0.0
http.port: 9200
transport.host: 127.0.0.1

# Restart ES
sudo systemctl restart elasticsearch.service

Guide: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-elasticsearch-on-ubuntu-18-04

Monitor server

Check memory usage:

ps -eo size,%mem,pid,user,command --sort -size | grep mysql

Print 10 process that spend the most memory:

ps aux --sort=-%mem | awk 'NR<=10{print $0}'

Check ip local:

curl https://ipinfo.io/ip

Docker config

Using docker without sudo

sudo groupadd docker
sudo gpasswd -a username docker
sudo service docker restart 

Get size of docker in system:

docker system df -v

Puma local

Setup puma using in local folder:

bundle exec puma -e development -b unix:///tmp/my_app.sock

Loadbalancer

Setup load balancer

Default config:

http {
    upstream myapp1 {
        server srv1.example.com;
        server srv2.example.com;
        server srv3.example.com;
    }

    server {
        listen 80;

        location / {
            proxy_pass http://myapp1;
        }
    }
}

Reference: http://nginx.org/en/docs/http/load_balancing.html

Compress and uncompress

Uncompress:

tar -xvf archive.tar.gz

Reference: https://linuxize.com/post/how-to-extract-unzip-tar-gz-file/