deploy_mate 0.1 → 0.2

data/lib/capistrano/scripts/create_ubuntu_user.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+sudo mkdir -p /home/ubuntu/.ssh/
+sudo groupadd ubuntu
+sudo useradd ubuntu -g ubuntu -d /home/ubuntu -s /bin/bash
+sudo adduser ubuntu sudo
+sudo cp ~/.ssh/authorized_keys /home/ubuntu/.ssh/
+sudo chown -R ubuntu:ubuntu /home/ubuntu
+sudo echo "ubuntu ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers.d/ubuntu_no_sudo_password
+sudo chmod 0440 /etc/sudoers.d/ubuntu_no_sudo_password

data/lib/capistrano/scripts/set_defaults.sh

@@ -1,3 +1,4 @@
 #!/bin/bash
 source ~/.rvm/scripts/rvm
-rvm --default $1
+rvm --default $1
+echo "gem: --no-rdoc --no-ri" >> ~/.gemrc

data/lib/capistrano/tasks/bluepill.rake

@@ -1,27 +1,51 @@
 namespace :bluepill do
+  include Shell
 
   desc "Installs the application pill"
   task :setup do
     on roles(:app) do
       execute "mkdir -p #{shared_path}/config"
-      template "unicorn.pill.erb", "#{shared_path}/config/unicorn.pill"
+      template "application.pill.erb", "#{shared_path}/config/#{fetch(:application)}.pill"
     end
   end
 
   desc "Starts bluepill"
   task :start do
     on roles(:app) do
-      sudo "start bluepill"
+      if !bluepill_running?
+        sudo "start bluepill"
+      else
+        info "No need to start bluepill, it is running!"
+      end
     end
   end
 
-  desc "Stops unicorn"
+  desc "Stops app server"
   task :stop do
     on roles(:app) do
-      sudo "stop bluepill"
+      if bluepill_running?
+        sudo "stop bluepill"
+      else
+        "Can't stop bluepill because it's not running!"
+      end
     end
   end
 
+  desc "Restarts/Reloads app gracefully"
+  task :restart do
+    invoke "bluepill:start"
 
-end
+    on roles(:app) do
+      if bluepill_running?
+        if pill_running?(fetch(:app_server))
+          execute :rvmsudo, :bluepill, fetch(:application), :restart
+        else
+          execute :rvmsudo, :bluepill, fetch(:application), :start
+        end
+      end
+    end
 
+    invoke "nginx:reload"
+  end
+  before :restart, 'rvm:hook'
+end

data/lib/capistrano/tasks/elasticsearch.rake

@@ -0,0 +1,18 @@
+set_default(:elasticsearch_version, "1.7")
+
+namespace :elasticsearch do
+  include Aptitude
+  task :install do
+    on roles(:search) do
+      unless is_package_installed?("elasticsearch")
+        apt_get_install("openjdk-7-jre-headless") unless is_package_installed?("openjdk-7-jre-headless")
+        execute "wget -qO - https://packages.elasticsearch.org/GPG-KEY-elasticsearch | sudo apt-key add -"
+        sudo "add-apt-repository 'deb http://packages.elasticsearch.org/elasticsearch/#{fetch(:elasticsearch_version)}/debian stable main'"
+        apt_get_update
+        apt_get_install("elasticsearch")
+        sudo "update-rc.d elasticsearch defaults 95 10"
+        sudo :service, :elasticsearch, :start
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/fail2ban.rake

@@ -0,0 +1,22 @@
+namespace :fail2ban do
+  include Shell
+
+  desc "Installs the fail2ban configs"
+  task :setup do
+    on roles(:web) do
+      template "fail2ban-nginx-request-limit-jail.conf.erb", "/tmp/fail2ban_jail"
+      sudo "mv /tmp/fail2ban_jail /etc/fail2ban/jail.conf"
+      template "fail2ban-nginx-request-limit-jail.conf.erb", "/tmp/fail2ban_req_filter"
+      sudo "mv /tmp/fail2ban_req_filter /etc/fail2ban/filter.d/nginx-req-limit.conf"
+    end
+  end
+
+  desc "Restart fail2ban"
+  task :restart do
+    on roles(:web) do
+      sudo "service fail2ban restart"
+    end
+  end
+
+  after "fail2ban:setup", "fail2ban:restart"
+end

data/lib/capistrano/tasks/logrotate.rake

@@ -1,4 +1,5 @@
 namespace :logrotate do
+  include Shell
 
   desc "Install the logrotate config"
   task :setup do

data/lib/capistrano/tasks/machine.rake

@@ -1,37 +1,59 @@
 namespace :machine do
   include Aptitude
+  include UserManagement
 
   desc "Sets up a blank Ubuntu to run our Rails-setup"
   task :init do
     on roles(:app) do
       apt_get_update
-      invoke "machine:install:htop"
-      invoke "machine:install:language_pack_de"
-      invoke "machine:install:unattended_upgrades"
-      invoke "machine:install:ntp"
-      invoke "machine:install:git"
-      invoke "machine:install:nginx"
-      invoke "machine:install:fail2ban"
-      invoke "machine:install:rvm"
-      invoke "machine:install:ruby"
-      invoke "machine:install:set_defaults"
-      invoke "machine:install:bluepill"
-      invoke "machine:install:bundler"
-      invoke "machine:install:nodejs"
-      invoke "machine:install:mysql_dev"
-    end 
+    end
+    invoke "machine:install:ssh_keys"
+    invoke "machine:install:htop"
+    invoke "machine:install:language_pack_de"
+    invoke "machine:install:unattended_upgrades"
+    invoke "machine:install:ntp"
+    invoke "machine:install:git"
+    invoke "machine:install:nginx"
+    invoke "machine:install:fail2ban"
+    invoke "machine:install:rvm"
+    invoke "machine:install:ruby"
+    invoke "machine:install:set_defaults"
+    invoke "machine:install:bluepill"
+    invoke "machine:install:bundler"
+    invoke "machine:install:nodejs"
+    invoke "machine:install:elasticsearch"
+    invoke "machine:install:imagemagick" if fetch(:imagemagick)
+    invoke "machine:install:memcached" if fetch(:memcached)
+    invoke "machine:install:mysql_dev" if fetch(:db_engine) == "mysql"
+    invoke "machine:install:postgres_dev" if fetch(:db_engine) == "postgresql"
+  end
+  before "machine:init", "machine:check_ubuntu_user"
+  before "deploy", "machine:check_ubuntu_user"
+
+  desc "Check if we are doing things as the correct user"
+  task :check_ubuntu_user do
+    on roles(:app) do
+      unless am_i?("ubuntu")
+        execute_script("create_ubuntu_user.sh") # Creates an Amazon AWS-style 'ubuntu'-user on machines with only 'root'
+        error "Please use a use a user named 'ubuntu' to login to the machine."
+        fail
+      end
+    end
   end
 
   desc "Install configs"
   task :setup do
     invoke "nginx:setup"
-    invoke "unicorn:setup"
+    invoke "unicorn:setup" if fetch(:app_server) == "unicorn"
+    invoke "puma:setup" if fetch(:app_server) == "puma"
     invoke "upstart:setup"
     invoke "logrotate:setup"
+    invoke "fail2ban:setup"
     invoke "bluepill:setup"
   end
   before :setup, "deploy:ensure_folder"
 
+  desc "Install all dependencies"
   namespace :install do
     task :set_defaults do
       on roles(:app) do
@@ -42,6 +64,10 @@ namespace :machine do
       end
     end
 
+    task :elasticsearch do
+      invoke 'elasticsearch:install'
+    end
+
     task :language_pack_de do
       on roles(:app) do
         apt_get_install("language-pack-de") unless is_package_installed?("language-pack-de")
@@ -76,12 +102,31 @@ namespace :machine do
       end
     end
 
+    task :imagemagick do
+      on roles(:app) do
+        apt_get_install("imagemagick") unless is_package_installed?("imagemagick")
+      end
+    end
+
+    task :memcached do
+      on roles(:app) do
+        apt_get_install("memcached") unless is_package_installed?("memcached")
+      end
+    end
+
     task :mysql_dev do
       on roles(:app) do
         apt_get_install("libmysqlclient-dev") unless is_package_installed?("libmysqlclient-dev")
       end
     end
 
+    task :postgres_dev do
+      on roles(:app) do
+        apt_get_install("libpq-dev") unless is_package_installed?("libpq-dev")
+        apt_get_install("postgresql-client") unless is_package_installed?("postgresql-client")
+      end
+    end
+
     task :htop do
       on roles(:app) do
         apt_get_install("htop") unless is_package_installed?("htop")
@@ -97,6 +142,10 @@ namespace :machine do
     task :ntp do
       on roles(:app) do
         apt_get_install("ntp") unless is_package_installed?("ntp")
+        sudo "chmod 666 /etc/timezone"
+        execute 'echo "Europe/Berlin" > /etc/timezone'
+        sudo "chmod 644 /etc/timezone"
+        sudo "dpkg-reconfigure -f noninteractive tzdata"
       end
     end
 
@@ -123,6 +172,7 @@ namespace :machine do
         unless is_package_installed?("imagemagick")
           apt_get_install("imagemagick")
           apt_get_install("libmagickcore-dev")
+          apt_get_install("libmagickwand-dev")
         end
       end
     end
@@ -135,9 +185,41 @@ namespace :machine do
       end
     end
 
+    desc "Installs new SSH Keys"
+    task :ssh_keys do
+      on roles(:app) do
+        file_patterns = fetch(:ssh_file_names)
+
+        next puts("Skip SSH key installation") if file_patterns == []
+
+        puts "Installing SSH Keys from #{file_patterns.join(',')}..."
+
+        keys = []
+        file_patterns.each do |file_pattern|
+          Dir.glob(File.expand_path(file_pattern)).each do |file_name|
+            next if File.directory?(file_name)
+            key_as_string = File.read(file_name)
+
+            if key_as_string.start_with?("ssh-rsa")
+              keys << key_as_string
+              puts file_name
+            else
+              warn "#{file_name} is NO publickey"
+            end
+          end
+        end
+
+        fail "No ssh-keys found in #{file_patterns.join(',')}." unless keys.any?
+
+        upload!(StringIO.new(keys.join("")), 'new_keys')
+        sudo "rm ~/.ssh/authorized_keys"
+        sudo "mv new_keys ~/.ssh/authorized_keys"
+      end
+    end
+
     task :update_rvm_key do
       on roles(:app) do
-        execute :gpg, "--keyserver hkp://keys.gnupg.net --recv-keys D39DC0E3"
+        execute :gpg, "--keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3"
       end
     end
     before "machine:install:rvm", "machine:install:update_rvm_key"

data/lib/capistrano/tasks/nginx.rake

@@ -1,28 +1,31 @@
 set_default(:nginx_server_name, "*.*")
 
 namespace :nginx do
+  include Shell
 
   desc "Installs the nginx configs"
   task :setup do
     on roles(:web) do
       template "nginx_base.conf.erb", "/tmp/nginx_conf"
       sudo "mv /tmp/nginx_conf /etc/nginx/nginx.conf"
+
       template "nginx_app.conf.erb", "/tmp/#{fetch(:application)}_conf"
       sudo "mv /tmp/#{fetch(:application)}_conf /etc/nginx/sites-available/#{fetch(:application)}.conf"
 
-      if test("[ -f /etc/nginx/sites-enabled/default ]")
+      if file_exists? "/etc/nginx/sites-enabled/default"
         sudo "rm /etc/nginx/sites-enabled/default"
       end
 
-      invoke "nginx:enable_site"
-      invoke "nginx:reload"
+      execute "mkdir -p #{shared_path}/log"
     end
+    invoke "nginx:enable_site"
+    invoke "nginx:reload"
   end
 
   desc "Enable the app page for nginx"
   task :enable_site do
     on roles(:web) do
-      unless test("[ -f /etc/nginx/sites-enabled/#{fetch(:application)}.conf ]")
+      unless file_exists? "/etc/nginx/sites-enabled/#{fetch(:application)}.conf"
         sudo "ln -sf /etc/nginx/sites-available/#{fetch(:application)}.conf /etc/nginx/sites-enabled/#{fetch(:application)}.conf"
       end
     end

data/lib/capistrano/tasks/puma.rake

@@ -0,0 +1,18 @@
+set_default(:puma_workers, "5")
+set_default(:puma_threads, "10")
+set_default(:puma_timeout, "30")
+set_default(:puma_worker_grace_time, "60")
+
+namespace :puma do
+  include Bluepill
+  include Shell
+
+  desc "Installs the puma config"
+  task :setup do
+    on roles(:app) do
+      execute "mkdir -p #{shared_path}/config"
+      template "puma.rb.erb", "#{shared_path}/config/puma.rb"
+    end
+  end
+
+end

data/lib/capistrano/tasks/unicorn.rake

@@ -4,6 +4,7 @@ set_default(:unicorn_worker_grace_time, "60")
 
 namespace :unicorn do
   include Bluepill
+  include Shell
 
   desc "Installs the unicorn config"
   task :setup do
@@ -13,21 +14,4 @@ namespace :unicorn do
     end
   end
 
-  desc "Gracefully restarts unicorn"
-  task :phased_restart do
-    on roles(:app) do
-      if bluepill_running?
-        if pill_running?(:unicorn)
-          execute :rvmsudo, :bluepill, :restart, :unicorn
-        else
-          execute :rvmsudo, :bluepill, :start, :unicorn
-        end
-      else
-        invoke "bluepill:start"
-        invoke "nginx:reload"
-      end
-    end
-  end
-  before :phased_restart, 'rvm:hook'
-
 end

data/lib/capistrano/tasks/upstart.rake

@@ -1,6 +1,8 @@
 namespace :upstart do
   include Upstart
+  include Shell
 
+  # TODO: remove one of these - they do the same
   desc "Install the upstart config"
   task :setup do
     on roles(:app) do

data/lib/deploy_mate/tasks.rake

@@ -1,46 +1,48 @@
-require 'readline'
-
 namespace :deploy_mate do
+  desc 'copy the default configuration file to config/deploy_mate.yml'
+  task :default_config do
+    @app_name     = guess_app_name
+    @ruby_version = guess_ruby_version
+    @rails        = to_h(rails?)
+    @imagemagick  = to_h(imagemagick?)
+    @sidekiq      = to_h(sidekiq?)
+    @memcached    = to_h(memcached?)
 
-  desc 'Installs the needed capistrano files to deploy with the mate.'
-  task :install do |t,args|
-    puts "I'm your DEPLOY_MATE."
-    puts "We will setting up your deployment now."
-
-    @app_name = ask("App-Name (for nginx, servers, etc.):", guess_app_name)
-    @repo_url = ask("Url-Location of git-repo:", "git@github.com:hanseventures/#{@app_name}.git")
-    @is_rails = yes_or_no?("Is this a RAILS project ?", (rails_present? ? "yes" : "no"))
-
-    @stage_name = ask("Give the first stage a name:", "prestage")
-    @ssh_name = ask("SSH-Hostname for the server:", "#{@app_name}-#{@stage_name}")
-    @branch_name = ask("Branch to deploy '#{@stage_name}' from:", "dev")
-    @host_name = ask("Web-URL for '#{@stage_name}':", "#{@stage_name}.#{@app_name}.com")
-    @environment = ask("#{@stage_name}'s environment (RACK_ENV/RAILS_ENV):", "#{@stage_name}")
-
-    puts "Aye!"
-    puts "Worrrrking..."
+    puts "Creating default template:\n\n"
+    puts "\t" + config_template('deploy_mate.yml.erb', 'config/deploy_mate.yml')
+    puts "\nConfigure it and then run:\n\n\tbundle exec rake deploy_mate:install\n\n"
+  end
 
-    config_template("Capfile.erb", "Capfile")
-    sleep 1
-    config_template("deploy.rb.erb", "config/deploy.rb")
-    sleep 1
+  task :install do
+    @config = YAML.load_file(File.expand_path('config/deploy_mate.yml', ENV['PWD']))
+    puts "Creating capistrano deployment files:\n"
     FileUtils.mkdir_p("config/deploy") unless File.exists?("config/deploy")
-    config_template("deploy/stage.rb.erb", "config/deploy/#{@stage_name}.rb")
-    sleep 1
-
-    puts "Arr, be dun working!"
+    puts config_template("Capfile.erb", "Capfile")
+    puts config_template("deploy.rb.erb", "config/deploy.rb")
+    puts config_template("deploy/stage.rb.erb", "config/deploy/#{@config['stage_name']}.rb")
   end
-
 end
 
 def config_template(from, to)
   erb = File.read(File.expand_path("../templates/#{from}", __FILE__))
   compiled = ERB.new(erb).result(binding)
   File.open(to, "wb") { |f| f.write(compiled) }
-  puts "'#{to}'"
+  to
+end
+
+def sidekiq?
+  defined? Sidekiq
 end
 
-def rails_present?
+def imagemagick?
+  defined? RMagick || defined? MiniMagick
+end
+
+def memcached?
+  defined? Dalli
+end
+
+def rails?
   defined? Rails
 end
 
@@ -48,21 +50,26 @@ def guess_app_name
   Dir.pwd.split(File::SEPARATOR).last
 end
 
-def yes_or_no?(prompt, default = nil)
-  answer = "undefined"
-  while(!["yes", "no"].include?(answer))
-    answer = ask("#{prompt} [yes/no]:", (default == "yes" ? "yes" : "no"))
+def guess_ruby_version
+  ruby_version = nil
+  ruby_version = cat_file(".ruby-version")
+  ruby_version.strip! if ruby_version
+  unless ruby_version
+    gem_file_content = cat_file("Gemfile")
+    if gem_file_content
+      match =  gem_file_content.match("^ruby '(?<version>[0-9.]*)'")
+      if match
+        ruby_version = "ruby-" + match["version"]
+      end
+    end
   end
-  (answer == "yes")
+  ruby_version
 end
 
-def ask(prompt, default = nil)
-  if default
-    Readline.pre_input_hook = -> {
-      Readline.insert_text(default)
-      Readline.redisplay
-    }
-  end
-  data = Readline.readline("#{prompt}: ")
-  return data.chomp
-end
+def to_h(value)
+  value ? "yes" : "no"
+end
+
+def cat_file(filename)
+  File.open(filename, "rb") { |f| f.read } if File.exist?(filename)
+end

data/lib/deploy_mate/templates/Capfile.erb

@@ -1,5 +1,12 @@
 require 'capistrano/deploy_mate_capfile'
-<% if @is_rails %>
+<% if @config['rails'] %>
 require 'capistrano/rails/assets'
 require 'capistrano/rails/migrations'
-<% end %>
+<% end %>
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }
+
+# Optionals
+# Uncomment, if needed
+
+# require "whenever/capistrano"
+# before 'deploy:restart', 'deploy:migrate', 'whenever:update_crontab'

data/lib/deploy_mate/templates/deploy/stage.rb.erb

@@ -1,7 +1,7 @@
-server "<%= @ssh_name %>", roles: [:app, :web, :db], :primary => true
+server "<%= @config['ssh_name'] %>", roles: [:app, :db, :web<% if @config['elasticsearch'] %>, :search<% end %>], :primary => true
 
 set :unicorn_workers, "2"
-set :nginx_server_name, "<%= @host_name %>"
+set :nginx_server_name, "<%= @config['host_name'] %>"
 
-set :environment, "<%= @environment %>"
-set :branch, "<%= @branch_name %>"
+set :environment, "<%= @config['environment'] %>"
+set :branch, ENV.fetch("branch", "<%= @config['branch_name'] %>")

data/lib/deploy_mate/templates/deploy.rb.erb

@@ -1,9 +1,27 @@
 # NOTE: copy this file to /config/deploy.rb
-set :application, '<%= @app_name %>'
+set :application, '<%= @config['app_name'] %>'
 
 require "capistrano/deploy_mate_defaults"
 
+set :rvm_ruby_version, '<%= @config['ruby_version'] %>'
+
 # Set app specific vars
-set :stages, %w(<%= @stage_name %>)
-set :default_stage, '<%= @stage_name %>'
-set :repo_url, '<%= @repo_url %>'
+set :stages, %w(<%= @config['stage_name'] %>)
+set :default_stage, '<%= @config['stage_name'] %>'
+set :repo_url, '<%= @config['repo_url'] %>'
+set :db_engine, '<%= @config['db_engine'] %>'
+set :app_server, '<%= @config['app_server'] %>'
+
+set :imagemagick, <%= @config['imagemagick'] %>
+set :memcached, <%= @config['memcached'] %>
+set :sidekiq, <%= @config['sidekiq'] %>
+
+set :ssh_file_names, [<%= @config['ssh_file_names'].to_a.map { |file| "'#{file}'" }.join(', ') %>]
+
+# Optionals
+# Uncomment, if needed
+
+# set :whenever_identifier, ->{ "#{fetch(:application)}_#{fetch(:stage)}" }
+# set :whenever_environment, fetch(:stage)
+# set :whenever_roles, [:cronjobs]
+# before "whenever:update_crontab", 'rvm:hook'

data/lib/deploy_mate/templates/deploy_mate.yml.erb

@@ -0,0 +1,79 @@
+# This file represents your application deployment configuration and
+# will be used to generate the capistrano deployment and server setup.
+# Please go through this file and when you are ready execute:
+#
+#   bundle exec rake deploy_mate:install
+
+---
+
+  # Name of the application, which is usually the same as the
+  # repository name.
+  app_name: <%= @app_name %>
+
+  # The url of your GIT repository.
+  repo_url: "git@github.com:your-github-name/<%= @app_name %>.git"
+
+  # For which stage should the server-setup/deployment be generated. It is
+  # recommended to start with a prestage system and afterwards configure
+  # the production system when it is ready.
+  stage_name: prestage
+
+  # Under which rails environment will the application run.
+  environment: prestage
+
+  # Which GIT branch should be deployed to the defined server by default?
+  # You can overrule this value by providing a branch on the deployment command:
+  #
+  #   bundle exec cap prestage deploy branch=feature/xyz
+  branch_name: dev
+
+  # Which is the ssh shortcut to connect to the server. It should be configured
+  # in your ~/.ssh/config. You should be able to connect to the server using:
+  #
+  #   ssh specified_ssh_name
+  #
+  ssh_name: prestage-server
+
+  # Since you are able to connect to the server with the specified ssh shortcurt,
+  # usually more persons should be able to access it. You can specify a list of
+  # public ssh keys which will be copied to the ~/.ssh/authorized_keys file on the
+  # server. If the list is empty, the current key setting will be left untouched on
+  # the server.
+  ssh_file_names:
+    - "~/.ssh/*.pub"
+
+  # Under which URL should your server be available? An IP address does the job
+  # too
+  host_name: example.com
+
+  # The ruby version, that will be installed and used on the server. It is used
+  # by RVM and must have a compatible syntax like '2.3.0' or 'ruby-2.3.0'.
+  ruby_version: <%= @ruby_version %>
+
+  # Currently there are two database engines supported: 'postgresql' and 'mysql'
+  db_engine: postgresql
+
+  # Currently there are two appservers supported: 'unicorn' and 'puma'.
+  # Remember to add the chosen appserver to your Gemfile if you are not
+  # already using it locally.
+  app_server: unicorn
+
+  # Are your running a rails application?
+  # Possible values 'yes' or 'no'.
+  rails: <%= @rails %>
+
+  # Are you depending on imagemagick for image manipulation (E.g. paperclip gem)?
+  # Possible values 'yes' or 'no'.
+  imagemagick: <%= @imagemagick %>
+
+  # Are you depending on sidekiq (E.g. as active job backend)?
+  # Possible values 'yes' or 'no'.
+  sidekiq: <%= @sidekiq %>
+
+  # Are you depending on elastic search?
+  # Possible values 'yes' or 'no'.
+  elasticsearch: no
+
+  # Are you depending on memcached for example as a cache store?
+  # Possible values 'yes' or 'no'.
+  memcached: <%= @memcached %>

data/lib/deploy_mate.rb

@@ -0,0 +1,9 @@
+if defined?(Rails)
+  module DeployMate
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load 'deploy_mate/tasks.rake'
+      end
+    end
+  end
+end