oneblackbear-obbistrano 1.0.0

data/README.txt

@@ -0,0 +1,23 @@
+h1. Automated Server and application deployment
+
+h2. Server-wide setup
+
+@cap host:setup -s h=xxxx@
+Ensures that there is a setup for each app on the specified server.
+Includes setup of a user, group, apache vhost, mysql login for each app.
+
+@cap host:backup -s h=xxxx@
+Trigger a backup of each application stored on the specified server.
+
+@cap host:s3backup -s h=xxxx@
+Triggers an Amazon S3 backup of the backup folder.
+
+
+
+h2. Application Level Setup
+
+@cap app:deploy -s a=xxxx@
+
+
+cap app:
+

data/capfile

@@ -0,0 +1,476 @@
+require 'rubygems'
+require 'activeresource'
+ 
+TTL = 86400
+API_PASSWORD = fetch "slicehost_api_key", false
+
+class Record < ActiveResource::Base
+  self.site = "https://#{API_PASSWORD}@api.slicehost.com/" 
+end
+ 
+class Zone < ActiveResource::Base
+  self.site = "https://#{API_PASSWORD}@api.slicehost.com/" 
+end
+ 
+class Slice < ActiveResource::Base
+  self.site = "https://#{API_PASSWORD}@api.slicehost.com/" 
+end
+
+
+desc "Setup Application Config"
+task :config_setup do
+#   options = YAML.load(File.read("config.yml"))
+#   set :working_server, h rescue nil
+#   set :working_app, a rescue nil
+  set :root_pass, root rescue nil
+end
+# 
+# task :config_write do
+#   File.open('config.yml', 'w') { |f| f.puts options.to_yaml }
+#   #puts "Hello I'm about to mangle your config file"
+# end
+ 
+namespace :slicehost do
+ 
+  desc "Sets up slicehost DNS for each of the servers specified with a role of web."
+  task :setup do
+    get_slice_ip
+    servers = find_servers :roles => :web
+    servers.each do |s|
+      if !zone = Zone.find(:first, :params => {:origin => "#{s}."})
+        zone = Zone.new(:origin => s, :ttl => TTL)
+        zone.save
+      end
+      recordOne =   Record.new(:record_type => 'A', :zone_id => zone.id, :name => 'www', :data => "#{slice_ip}")
+      recordTwo =   Record.new(:record_type => 'A', :zone_id => zone.id, :name => '@', :data => "#{slice_ip}")
+      recordThree = Record.new(:record_type => 'A', :zone_id => zone.id, :name => 'beta', :data => "#{slice_ip}")
+      recordFour =  Record.new(:record_type => 'A', :zone_id => zone.id, :name => zone.origin, :data => "#{slice_ip}")
+      recordFive =  Record.new(:record_type => 'NS', :zone_id => zone.id, :name => zone.origin, :data => 'ns1.slicehost.net.')
+      recordSix =   Record.new(:record_type => 'NS', :zone_id => zone.id, :name => zone.origin, :data => 'ns2.slicehost.net.')
+      recordSeven = Record.new(:record_type => 'NS', :zone_id => zone.id, :name => zone.origin, :data => 'ns3.slicehost.net.')
+      [recordOne, recordTwo, recordThree, recordFour, recordFive, recordSix, recordSeven].each {|r| r.save}
+    end
+  end
+  
+  task :get_slice_ip do
+    set :slice_ip, get_ip(fetch("host", false))
+  end
+
+  desc "Sets up slicehost DNS for Google Apps usage on each of the servers specified with a role of web."
+  task :googleapps do
+    API_PASSWORD = "#{slicehost_api_key}"
+    mx_records = <<-RECORD
+    ASPMX.L.GOOGLE.COM.
+    ALT1.ASPMX.L.GOOGLE.COM.
+    ALT2.ASPMX.L.GOOGLE.COM.
+    ASPMX2.GOOGLEMAIL.COM.
+    ASPMX3.GOOGLEMAIL.COM.
+    RECORD
+    servers = find_servers :roles => :web
+    servers.each do |s|
+      mx_aux =  %w[5 10 10 20 20 30 ]
+      aux_count = 0
+      zone = Zone.find(:first, :params => {:origin => "#{s}."})
+      mx_records.each do |rec|
+        r = Record.new(:record_type => 'MX', :zone_id => zone.id, :name => "#{s}." , :data => "#{rec}", :aux => mx_aux[aux_count])
+        r.save
+        aux_count =+ 1
+      end
+      recordOne =   Record.new(:record_type => 'CNAME', :zone_id => zone.id, :name => 'mail', :data => "ghs.google.com.")
+      recordTwo =   Record.new(:record_type => 'CNAME', :zone_id => zone.id, :name => 'docs', :data => "ghs.google.com.")
+      [recordOne, recordTwo].each {|r| r.save}
+    end
+  end
+ 
+end
+
+
+
+
+namespace :host do
+  
+  desc "Checks we have information to proceed with server operations"
+  task :config_check do 
+    config_setup
+    "#{working_server}" rescue @parent.logger.log 0,"You need to specify a host to run the operation on. Use cap task -s h=yourhost"
+    @use_applications = [ ]
+    options["apps"].each do |app, settings|
+      @use_applications << app if settings["server"]==working_server
+    end
+  end
+  
+  
+  desc "Performs a local backup of the applications and databases on the server"
+  task :backup do
+    config_check
+    @use_applications.each do |app|
+      set :working_app, app
+      @parent.app.backup
+    end
+  end
+  
+  desc "Backs up the local backup folder to remote Amazon S3 storage"
+  task :s3backup do
+    config_check
+  end
+  
+
+  
+end
+  
+namespace :app do  
+  
+  
+  task :config_check do
+    config_setup
+    databases rescue set(:databases, ["#{application}"])
+  end
+  
+  task :needs_root do
+    config_check
+    puts "*** This operation needs root access - Please pass in a root password using -s root=password" if !defined? "#{root_pass}"
+    exit if !defined? "#{root_pass}"
+  end
+  
+  
+
+  # =============================================================================
+  # DEPLOYING APPLICATIONS
+  # =============================================================================
+  
+  desc "Uses the specified repository to deploy an application. Also checks for correct versions of PHPWax and plugins."
+  task :deploy do
+    config_check
+    deploy_check
+    php_wax_deploy if defined? "#{phpwax}"
+    cms_deploy if defined? "#{cms}"
+  end
+  
+  task :deploy_check do 
+    fetch "repository" rescue abort "You have not specified a repository for this application"
+    git_deploy if repository.include? "git"
+    svn_deploy if repository.include? "svn"
+  end
+  
+  task :git_deploy do
+    begin
+      run "ls #{deploy_to}/.git"
+    rescue
+      run "git init"
+      run "git remote add origin #{repository}"
+    end
+    run "git pull origin #{branch}"
+  end
+  
+  task :svn_deploy do
+    run "svn export #{repository} #{deploy_to} --force"
+  end
+  
+  task :cms_deploy do
+    begin
+      run "ls plugins/cms/.git"
+    rescue
+      run "mkdir -p plugins/cms"
+      run "cd plugins/cms && git init"
+      run "cd plugins/cms && git remote add origin git://github.com:phpwax/wildfire.git"
+    end
+    run "cd plugins/cms && git checkout #{cms}"
+  end
+  
+  task :php_wax_deploy do
+    begin
+      run "ls wax/.git"
+    rescue
+      run "mkdir wax"
+      run "cd wax && git init"
+      run "cd wax && git remote add origin git://github.com/phpwax/phpwax.git"
+      run "cd wax && git pull origin master"
+    end
+    run "cd wax && git checkout #{phpwax}"
+  end
+  
+  ####### ##############
+  
+  
+  # =============================================================================
+  # GENERAL ADMIN FOR APPLICATIONS
+  # =============================================================================
+    
+  desc "Restarts the Apache Server."
+  task :restart do
+    config_check
+    needs_root
+    with_user("root", "#{root_pass}") do 
+      run "/etc/rc.d/init.d/httpd restart"
+    end
+  end
+  
+  task :clearcache do
+    run "rm -f tmp/cache/*"
+  end
+  
+  task :clearlogs do
+    run "rm -f tmp/log/*"
+  end
+  
+  
+  # =============================================================================
+  # BACKING UP APPLICATIONS
+  # =============================================================================
+  
+  desc "Starts the backup process by checking which type to perform then performs the necessary back ups."
+  task :backup do
+    config_check
+    needs_root
+    backup_check
+  end
+  
+  task :backup_check do 
+    if defined? "#{repository}"
+      if repository.include? "git"
+        git_mysql_backup
+        upload_only_backup
+      elsif repository.include? "svn"
+        standard_mysql_backup
+        upload_only_backup
+      end
+    else
+      puts "No repository for #{application}"
+      standard_mysql_backup
+      simple_fs_backup
+    end
+  end
+  
+  task :simple_fs_backup do
+    with_user("root", "#{root_pass}") do 
+      run "mkdir -p /backup/#{application}"
+      run "rsync -avzh /home/#{application}/ /backup/#{application}/"
+    end
+  end
+  
+  task :upload_only_backup do
+    with_user("root", "#{root_pass}") do 
+      run "mkdir -p /backup/#{application}"
+      run "rsync -avzh /home/#{application}/public/files/ /backup/#{application}/"
+    end
+  end
+  
+  task :standard_mysql_backup do
+    run "mkdir -p public/files"
+    databases.each do |db|
+      run "mysqldump #{db} --skip-comments --add-drop-table -u#{user}  -p#{password} > public/files/#{db}.sql";
+    end
+    upload_only_backup
+  end
+  
+  task :git_mysql_backup do
+    transaction do
+      run "mkdir -p tmp/backup"
+      run "ln -s ../../.git/ tmp/backup/.git"
+      begin 
+        run "cd tmp/backup && git branch db"
+        run "cd tmp/backup && git branch -d db" 
+      rescue 
+      end
+      run "cd tmp/backup && git symbolic-ref HEAD refs/heads/db"
+      run "cd tmp/backup && mv .git/index .git/index_old"
+      databases.each do |db|
+        run "cd tmp/backup && mysqldump #{db} --skip-comments --add-drop-table -u#{user}  -p#{password} > #{db}.sql";
+      end
+      run "cd tmp/backup && git add ."
+      run "cd tmp/backup && git commit -m 'database update'" rescue ""
+      run "cd tmp/backup && git push origin db"
+      run "rm -Rf ./tmp/backup"
+      run "mv -f .git/index_old .git/index" rescue ""
+      run "git symbolic-ref HEAD refs/heads/#{branch}"
+      on_rollback do
+        run "rm -Rf ./tmp/backup"
+        run "mv -f .git/index_old .git/index" rescue ""
+        run "git symbolic-ref HEAD refs/heads/#{branch}"
+      end
+    end   
+  end
+  
+  # =============================================================================
+  # RESTORING BACKED-UP APPLICATIONS
+  # =============================================================================
+  
+  desc "Restores a backed up application, database and other files."
+  task :restore do
+    if defined? repository
+      if repository.include? "git"
+        upload_only_restore
+        git_mysql_restore
+      elsif repository.include? "svn"
+        upload_only_restore
+        standard_mysql_restore 
+      end
+    else
+      simple_fs_restore
+      standard_mysql_restore
+    end
+  end
+  
+  task :upload_only_restore do
+    with_user("root", "#{root_pass}") do 
+      run "rsync -avzh /backup/#{application}/ /home/#{application}/public/files/"
+    end
+  end
+  
+  task :git_mysql_restore do 
+    run "mkdir -p tmp/backup"
+    run "ln -s ../../ tmp/backup/.git"
+    run "cd tmp/backup && git symbolic-ref HEAD refs/heads/db"
+    run "cd tmp/backup && mv .git/index .git/index_old"
+    "#{databases}".each do |db|
+      run "cd tmp/backup && mysql #{db} -u#{user} -p#{password} < #{db}.sql"
+    end
+    run "rm -Rf ./tmp/backup"
+    run "mv -f .git/index_old .git/index" rescue ""
+    run "git symbolic-ref HEAD refs/heads/#{branch}"
+  end
+  
+  desc "Just runs rSync back to the home directory"
+  task :simple_fs_restore do
+    with_user("root", "#{root_pass}") do 
+      run "rsync -avzh /backup/#{application}/ /home/#{application}/"
+    end
+  end
+  
+  task :standard_mysql_restore do 
+    "#{databases}".each do |db|
+      run "cd tmp/backup && mysql #{db} -u#{user} -p#{password} < public/files/#{db}.sql"
+    end
+  end
+  
+  # =============================================================================
+  # USER AND APPLICATION SETUP AND INITIALISATION
+  # =============================================================================
+  
+  desc "General setup task which creates a new user on the host, sets up a mysql database and login, creates an apache vhost file and finally generates an ssh key for the user."
+  task :setup do
+    config_check
+    try_login
+    setup_mysql
+    vhost
+    ssh_key
+  end
+  
+    
+  task :setup_user do
+    needs_root
+    set :user_to_add, "#{user}"
+    set :passwd_to_add, "#{password}"
+    with_user("root", "#{root_pass}") do 
+      run "useradd -p `openssl passwd #{passwd_to_add}` #{user_to_add}"
+    end
+  end
+  
+  task :setup_mysql do
+    with_user("root", "#{root_pass}") do
+      "#{databases}".each do |db|
+        run "mysql -uroot -p#{root_pass} -e 'CREATE DATABASE #{db}'"
+        run "musql -uroot -p#{root_pass} -e 'GRANT ALL PRIVILEGES ON `#{db}` . * TO '#{user_to_add}'@'localhost' IDENTIFIED BY '#{passwd_to_add}';"
+      end
+    end
+    
+  end
+  
+  task :try_login do
+    config_check
+    begin
+      run "ls"
+      puts "Logged in ok"
+    rescue
+      print "==== The user does not yet exist. Would you like to create? [Y/N]"
+      line = STDIN.gets.upcase.strip
+      puts "*** Could not continue as the login does not exist" if line !="Y"
+      exit if line != "Y"
+      setup_user
+    end
+  end
+  
+  desc "Creates or gets an ssh key for the application"
+  task :ssh_key do 
+    config_check
+    begin
+      run "cat .ssh/id_rsa.pub"
+    rescue
+      run "ssh-keygen -t rsa -f .ssh/id_rsa -N ''"
+      run "cat .ssh/id_rsa.pub"
+    end
+  end
+  
+  desc "Creates an Apache virtual host file"
+  task :vhost do
+    config_check
+    needs_root
+    with_user("root", "#{root_pass}") do 
+      public_ip = ""
+      run "ifconfig eth0 | grep inet | awk '{print $2}' | sed 's/addr://'" do |_, _, public_ip| end
+      public_ip = public_ip.strip
+      f = File.open('templates/apache_vhost.erb')
+      contents = f.read
+      f.close
+      buffer = ERB.new(contents)
+      config = buffer.result(binding())
+      put config, "/etc/httpd/conf.d/#{application}-apache-vhost.conf"
+    end
+    
+  end
+  
+  # =============================================================================
+  # +MIGRATING+ APPLICATIONS
+  # =============================================================================
+  
+  desc "Runs a backup of an application, copies to another server and then sets up on new server"
+  task :copy_site do 
+    config_check
+    needs_root
+    backup
+    print "==== Which server would you like to copy #{application} to? [Full Domain Name] "
+    line = STDIN.gets.strip
+    begin      
+      new_server = options["servers"][line]["domain"] 
+    rescue 
+      puts "*** Can't find that new server in the config"
+      exit
+    end
+    with_user("root", "#{root_pass}") do
+      run "rsync -avzh . -e ssh root@#{new_server}:/backup/#{application}/ --exclude 'tmp/*' --exclude '.git/*'"
+    end
+    options["apps"]["#{application}"]["server"] = line
+    config_write
+    try_login
+    restore
+  end
+  
+end
+
+
+def get_ip(domain)
+  require 'socket'
+  t = TCPSocket.gethostbyname(domain)
+  t[3]
+end
+
+def with_user(new_user, new_pass, &block) 
+  old_user, old_pass = user, password 
+  set :user, new_user 
+  set :password, new_pass 
+  close_sessions 
+  yield 
+  set :user, old_user 
+  set :password, old_pass 
+  close_sessions 
+end 
+def close_sessions 
+  sessions.values.each { |session| session.close } 
+  sessions.clear 
+end
+
+
+
+
+
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: oneblackbear-obbistrano
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ross Riley
+- One Black Bear
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2"
+    version: 
+description: An extension to Capistrano to allow deploys to Slicehost for One Black Bear
+email: ross@oneblackbear.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.txt
+- capfile
+has_rdoc: false
+homepage: http://github.com/oneblackbear/obbistrano
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Adds extra namespaces to Capistrano to allow simple setup, deploys and maintenance.
+test_files: []
+