Revision as of 03:59, 21 January 2011

Setting up the environment

1. Install Ruby Enterprise Edition
2. Install and configure web server (nginx or Apache recommended)
3. Install Phusion Passenger
4. Install MySQL MySQL

After installing the software, run a sanity check for the environment by creating a 'hello world' rails project and corresponding virtual host:

jakeskik@staging:~$ rails new hello
jakeskik@staging:~$ cd hello/public && pwd
/home/jakeskik/hello/public

Example nginx virtual host configuration:

server {
  listen 80;
  server_name hello.qa.leonidasoy.fi;
  access_log  /var/log/nginx/access.log;
  error_log   /var/log/nginx/error.log;
  root /home/jakeskik/hello/public;
  passenger_enabled on;
  rails_env production #or staging, if you want to run in staging env
}

Add the new virtual host to /etc/hosts:

 178.79.128.101 hello.qa.leonidasoy.fi

After restarting the web server, you should be able to access the 'hello world' project with a browser, e.g. lynx

 jakeskik@staging:~$ lynx hello.qa.leonidasoy.fi

Deploying MeeGo QA Reports

QA Reports uses Capistrano to automate the deployments. The main benefit is to eliminate the risks of human errors and to enable easy and repeatable rollbacks. See Capistrano documentation for the details.

Setting up Capistrano on a new server

1. Setup development environment on your workstation as described in Setting up a development environment
2. Reserve a (sub)domain name for QA Reports and create a corresponding DNS entry
3. Setup ruby, Passenger, MySQL, nginx/Apache and virtual host on production server as described above
4. Create MySQL account and database on the production server. Make sure they match with config/database.yml
5. Modify config/deploy/staging.rb and/or config/deploy/production.rb to match your configuration. Capistrano scripts are executed locally on your workstation and can be tested before checking to version control.
6. Setup public key authentication so that you can access the deployment account from your workstation
7. Run cap [staging|production] deploy:setup. The command defaults to staging. Setup command creates the folder hierarchy and the symbolic links required by Capistrano.
8. Follow the steps in "Updating QA Reports to a new version"

Once the tool chain and the environment is up and running, the rest is very straight forward.

Updating QA Reports to a new version

1. git pull (In case there's changes in the deployment scripts)
2. cap [staging|production] deploy:migrations
3. Ta-da!

Rolling back to previous version

1. cap [staging|production] deploy:rollback
2. Ta-da!

Step-by-Step Instructions

These instructions are written based on what I had to do to get QA reports up and running. I had a clean Kubuntu 10.04 installation to start with, and as this was for demonstration purposes the same computer was acting as Production Environment and Development Environment, but under different user accounts.

Setting Up the Production Environment

1. Install some packages: $ sudo aptitude install curl build-essential git-core mysql-server openssh-server zlib1g-dev libssl-dev libreadline5-dev libcurl4-openssl-dev
2. Create a MySQL database user and the database:
   1. mysql -u root -p
   2. create user 'meego-qa'@'localhost' identified by 'somepasswordofyourchoosing';
   3. create database qa_reports_production character set 'utf8';
   4. grant all privileges on qa_reports_production.* to 'meego-qa'@'localhost';
   5. flush privileges;
   6. quit;
3. Install RVM: $ bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-head )
   1. Set up .bashrc as instructed by RVM installer: The whole content into an if section, and after that loading of RVM.
   2. Run: $ source ~/.bashrc
4. Install Ruby Enterprise Edition: $ rvm install ree
5. Use it as default: $ rvm --default use ree
6. Install bundler: $ gem install bundler
7. Install passenger: $ gem install passenger
8. Install nginx: $ passenger-install-nginx-module
   1. Notice: the default location is under /opt. If you wish to install there, use rvmsudo. Notice however, that part of your ~/.rvm contents will then belong to root and may cause gray hair later. I chose to install under ~/nginx.
9. At this point, jump to Development Environment section, set it up and deploy QA Reports
10. Once deployed correctly, edit nginx configuration installation_path/conf/nginx.conf:
    1. Comment out section location / { ... }
    2. Add lines:
       1. passenger_enabled on;
       2. root /home/your_prod_env_user/qa-reports.meego.com/current/public;
11. Create file /home/your_prod_env_user/qa-reports.meego.com/shared/config/registeration_token and add some string in it. This will be part of the registration url, e.g. foobar will make registration to be at url /users/foobar/register
12. Start nginx: $ sudo /installation_path/sbin/nginx
13. Head to the server address with your web browser and hopefully see QA Reports running

Setting Up the Development Environment

1. Set up public key authentication:
   1. Generate yourself as SSH key pair if you don't have one: $ ssh-keygen
   2. Add your public key to authorized_keys file of your production environment user:
      $ ssh your.production.user@your.production.host 'mkdir .ssh; echo '`cat ~/.ssh/id_rsa.pub`' >> ~/.ssh/authorized_keys'
   3. Try logging in: ssh your.production.user@your.production.host
2. Set up development environment as described here
   1. Notice: Just run $ bundle install without flags and stop there, no need to set up database or anything
3. Edit your settings based on your production environment setup:
   1. config/deploy/production.rb: set the correct user and host information (mysql, ssh, host)
   2. config/deploy/database.yml.erb: set up MySQL user and database information
4. Deploy:
   1. $ cap production deploy:setup
   2. $ cap production deploy:migrations
   3. Run again - there's something fishy in the DB setup: $ cap production deploy:migrations
5. Now head back to Production Environment to finalize the setup