oysters 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652098cb586a45b1f5c294fb69ec1afe7684e265
-  data.tar.gz: 9d97d41d3fa08dfd38fb3b1ba11f78260513a89a
+  metadata.gz: 77e2c07fed3028aa5219a5c9ed553f328d22c81e
+  data.tar.gz: 13d20eb912f5f23a9dc82e08187a397b91d994e4
 SHA512:
-  metadata.gz: 9de0fb6195f597dd31d312eb50268cd33fed011f8726c967f12a386eba63035ecd1dfde0854d8fefbb4d11458bb4a55da26ea66f3e35cf5c8933fce65c51cc1d
-  data.tar.gz: 7f96b02e513210ecc9a131b38db8bb8f5ee3589fcb9e75faac7424c12a5b8b6600eab10e631470100f53b21b2f5a7ab89d829331886ddd2bf0b3bf1c8576c7e5
+  metadata.gz: 7af8777078870368a508c2256269b98555251818062fd511908ce81a5a59ec8f9afa83bfc32dbbde04ad3cd0ada105aee60fd62c74de8fdc6f5796b0bd79490d
+  data.tar.gz: 4a74dc3ce4c7e0e17c7e738faff1cfc4302b4ff16f54ba3220c70de45090e60ed121f0664030fd3dd33416ed6da4486c6d2bf283d7602d08b49afc86e94a0643

data/README.md

@@ -1,4 +1,15 @@
 # Oysters
+Oysters is a set of capistrano tasks that allow users to manage application daemons like Resque Scheduler, KEWatcher(resque-sliders), Unicorn.
+
+It allows to:
+
+1. Install/Uninstall init.d scripts for daemons.
+
+2. Start/Stop/Restart daemons  
+
+Oysters is compatible with Capistrano 2.x.
+
+
 
 ## Installation
 
@@ -9,16 +20,97 @@ gem 'oysters'
 ```
 
 And then execute:
+```
+$ bundle
+```
+Or install it yourself as:
+```
+$ gem install oysters
+```
+## Unified Oysters Usage
 
-    $ bundle
+Require 'oysters/unified_oysters' in your deploy.rb:
+```
+require 'oysters/unified_oysters'
+```
+### init.d scripts installation
 
-Or install it yourself as:
+Set all needed configuration variables in your capistrano environment configs. See 'lib/oysters/unified/templates/app_sysconfig.sh.erb' for a list of all variables.:
+
+```
+set :app_user, 'svc_iris'
+set :dynamic_schedule, true
+set :scheduler_background, true
+set :scheduler_verbose, 1
+set :kewatcher_max_workers, 20
+set :kewacther_redis_config, "#{current_path}/config/redis.yml"
+set :kewatcher_verbose, '-vv'
+set :unicorn_config_path, "#{current_path}/config/unicorn/unicorn.rb"
+```
+
+Install application sysconfig, used by init.d scripts. File '/etc/sysconfig/deployed_application' will be created:
+```
+cap <environment> oysters:unified:initd:sysconfig:install
+```
+
+Install necessary init.d scripts:
+```
+cap <environment> oysters:unified:initd:kewatcher:install
+cap <environment> oysters:unified:initd:resque_scheduler:install
+cap <environment> oysters:unified:initd:unicorn:install
+```
+You can install sysconfig and all init.d scripts simultaneously via 'install_all' task:
+```
+cap <environment> oysters:unified:initd:install_all
+```
+init.d scripts use ~/.bash_profile to load rvm. File example:
+```
+# .bash_profile
+
+# Get the aliases and functions
+if [ -f ~/.bashrc ]; then
+	. ~/.bashrc
+fi
+
+# User specific environment and startup programs
+
+PATH=$PATH:$HOME/bin
+
+export PATH
+
+[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm" # Load RVM into a shell session *as a function*
+```
 
-    $ gem install oysters
+NOTE: You need sudo access to install init.d scripts and sysconfig
 
-## Usage
+### Managing daemons
+
+You can manage daemons using next tasks:
+```
+cap <environment> oysters:unified:kewatcher:restart
+cap <environment> oysters:unified:kewatcher:start
+cap <environment> oysters:unified:kewatcher:stop
+
+cap <environment> oysters:unified:resque_scheduler:restart
+cap <environment> oysters:unified:resque_scheduler:start
+cap <environment> oysters:unified:resque_scheduler:stop
+
+cap <environment> oysters:unified:unicorn:restart
+cap <environment> oysters:unified:unicorn:start
+cap <environment> oysters:unified:unicorn:stop
+```
+### Removing scripts
+
+Individual init.d script:
+```
+cap <environment> oysters:unified:initd:unicorn:uninstall
+```
+All scripts and sysconfig:
+```
+cap <environment> oysters:unified:initd:uninstall_all
+```
 
-TODO: Write usage instructions here
+NOTE: You need sudo access to uninstall init.d scripts and sysconfig
 
 ## Development
 

data/lib/oysters/unified/application_control.rb

@@ -0,0 +1,21 @@
+require 'oysters'
+require 'erb'
+
+Oysters.with_configuration do
+  namespace :unified do
+    # This tasks are used to start/stop/restart next application daemons:
+    # - KEWatcher from resque-sliders gem
+    # - Resque Scheduler
+    # - Unicorn
+    [:kewatcher, :resque_scheduler, :unicorn].each do |program|
+      namespace "#{program}" do
+        [:stop, :start, :restart].each do |action|
+          desc "#{action.to_s.capitalize} #{program.to_s.capitalize}"
+          task action do
+            run "/etc/init.d/#{application}_#{program} #{action.to_s}", pty: true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oysters/unified/initd.rb

@@ -0,0 +1,84 @@
+require 'oysters'
+require 'erb'
+
+Oysters.with_configuration do
+  namespace :unified do
+    namespace :initd do
+      # This tasks install/uninstall initd scripts for:
+      # - KEWatcher from resque-sliders gem
+      # - Resque Scheduler
+      # - Unicorn
+      [:kewatcher, :resque_scheduler, :unicorn].each do |program|
+        namespace "#{program}" do
+          #Run this task as a sudo user!
+          desc "Install #{program}"
+          task :install, roles: :app do
+            tmp_config_path = "/tmp/#{program}_initd_script.sh"
+            # Remove old tmp config if present
+            run "sudo rm -f #{tmp_config_path}", pty: true, shell: :bash
+
+            config = File.read(File.expand_path("../scripts/#{program}_initd_script.sh", __FILE__))
+            put config, tmp_config_path, shell: :bash
+
+            run "sudo cp #{tmp_config_path} /etc/init.d/#{application}_#{program}", pty: true, shell: :bash
+            run "sudo chmod +x /etc/init.d/#{application}_#{program}", pty: true, shell: :bash
+            run "sudo chkconfig --add #{application}_#{program}", pty: true, shell: :bash
+            run "rm -f #{tmp_config_path}", shell: :bash
+          end
+
+          #Run this task as a sudo user!
+          desc "Remove #{program} init.d script"
+          task :uninstall, roles: :app do
+            run "sudo chkconfig --del #{application}_#{program}", pty: true, shell: :bash
+            run "sudo rm -f /etc/init.d/#{application}_#{program}", pty: true, shell: :bash
+          end
+        end
+      end
+
+      # This tasks install/uninstall sysconfig that contains configuration information for:
+      # - KEWatcher from resque-sliders gem
+      # - Resque Scheduler
+      # - Unicorn
+      namespace :sysconfig do
+        #Run this task as a sudo user!
+        desc 'Generate sysconfig used by init.d scripts and put it into /etc/sysconfig'
+        task :install, roles: :app do
+          tmp_config_path = "/tmp/deployed_application_sysconfig.sh"
+          # Remove old tmp config if present
+          run "sudo rm -f #{tmp_config_path}", pty: true, shell: :bash
+
+          location = File.expand_path('../templates/app_sysconfig.sh.erb', __FILE__)
+          config = ERB.new(File.read(location))
+          put config.result(binding), tmp_config_path, shell: :bash
+
+          run "sudo cp #{tmp_config_path} /etc/sysconfig/deployed_application", pty: true, shell: :bash
+          run "rm -f #{tmp_config_path}", shell: :bash
+        end
+
+        #Run this task as a sudo user!
+        desc 'Remove sysconfig'
+        task :uninstall, roles: :app do
+          run "sudo rm -f /etc/sysconfig/deployed_application", pty: true, shell: :bash
+        end
+      end
+
+      #Run this task as a sudo user!
+      desc "Install all initd scripts(KEWatcher, Unicorn, Scheduler)"
+      task :install_all, roles: :app do
+        unified.initd.sysconfig.install
+        unified.initd.kewatcher.install
+        unified.initd.resque_scheduler.install
+        unified.initd.unicorn.install
+      end
+
+      #Run this task as a sudo user!
+      desc "Uninstall all initd scripts(KEWatcher, Unicorn, Scheduler)"
+      task :uninstall_all, roles: :app do
+        unified.initd.sysconfig.uninstall
+        unified.initd.kewatcher.uninstall
+        unified.initd.resque_scheduler.uninstall
+        unified.initd.unicorn.uninstall
+      end
+    end
+  end
+end

data/lib/oysters/unified/scripts/kewatcher_initd_script.sh

@@ -0,0 +1,74 @@
+#!/bin/sh
+# chkconfig: 345 99 55
+# description: script to start kewatcher
+# /etc/init.d/[application]_kewatcher
+
+# source functions library
+. /etc/rc.d/init.d/functions
+
+# source application params
+. /etc/sysconfig/deployed_application
+
+start() {
+  local program
+  local options
+
+  echo "Starting KEWatcher"
+  if [ -e $KEWATCHER_PIDFILE ] && kill -0 `cat $KEWATCHER_PIDFILE` > /dev/null 2>&1; then
+    echo "KEWatcher is already Running"
+    echo_success
+    return 0
+  fi
+
+  options="-m $KEWATCHER_MAX_WORKERS -c $KEWATCHER_REDIS_CONFIG -p $KEWATCHER_PIDFILE $KEWATCHER_VERBOSE"
+
+  su $APP_USER -c "cd $ROOT_PATH; source /home/$APP_USER/.bash_profile; RAILS_ENV=$RAILS_ENV nohup bundle exec $ROOT_PATH/bin/kewatcher $options 2>&1 >> $KEWATCHER_LOGFILE &"
+  RETVAL=$?
+
+  sleep 5
+
+  if [ $RETVAL -eq 0 ]; then
+    echo_success
+  else
+    echo_failure
+  fi
+  echo
+}
+
+stop() {
+  echo "Stopping KEWatcher"
+
+  if [ -f $KEWATCHER_PIDFILE ]; then
+    kill -s QUIT $(cat $KEWATCHER_PIDFILE)
+    RETVAL=$?
+    sleep 10
+  else
+    RETVAL=1
+  fi
+
+  echo "Killing stuck workers"
+  kill -s KILL `pgrep -xf "[r]esque-[0-9]+.*" | xargs` > /dev/null 2>&1
+
+  if [ $RETVAL -eq 0 ]; then
+    echo_success
+    rm -f $KEWATCHER_PIDFILE
+  else
+    echo "Resque KEWatcher is not running"
+    echo_failure
+  fi
+}
+
+case "$1" in
+  start) start ;;
+  stop) stop ;;
+  restart)
+    echo "Restarting Resque KEWatcher ... "
+    stop
+    start
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart}"
+    exit 1
+esac
+
+exit $?

data/lib/oysters/unified/scripts/resque_scheduler_initd_script.sh

@@ -0,0 +1,71 @@
+#!/bin/sh
+# chkconfig: 345 99 55
+# description: script to start resque scheduler
+# /etc/init.d/[application]_resque_scheduler
+
+# source functions library
+. /etc/rc.d/init.d/functions
+
+# source application params
+. /etc/sysconfig/deployed_application
+
+start() {
+  local program
+  local options
+
+  cd $ROOT_PATH
+
+  echo "Starting Resque Scheduler"
+  options="RAILS_ENV=$RAILS_ENV VERBOSE=$SCHEDULER_VERBOSE BACKGROUND=$BACKGROUND DYNAMIC_SCHEDULE=$DYNAMIC_SCHEDULE PIDFILE=$SCHEDULER_PIDFILE"
+  program="source /home/$APP_USER/.bash_profile; bundle exec rake resque:scheduler $options 2>&1 >> $SCHEDULER_LOGFILE"
+
+  if [[ $APP_USER == $USER ]]
+  then
+    daemon --pidfile=$SCHEDULER_PIDFILE $program
+  else
+    daemon --user $APP_USER --pidfile=$SCHEDULER_PIDFILE $program
+  fi
+  RETVAL=$?
+
+  if [ $RETVAL -eq 0 ]; then
+    echo_success
+  else
+    echo_failure
+  fi
+  echo
+}
+
+stop() {
+  echo "Stopping Resque Scheduler"
+
+  if [ -f $SCHEDULER_PIDFILE ]; then
+    kill -s QUIT $(cat $SCHEDULER_PIDFILE)
+    RETVAL=$?
+  else
+    RETVAL=1
+  fi
+
+  if [ $RETVAL -eq 0 ]; then
+    echo_success
+    rm -f $SCHEDULER_PIDFILE
+  else
+    echo "Resque Scheduler is not running"
+    echo_failure
+  fi
+}
+
+case "$1" in
+  start) start ;;
+  stop) stop ;;
+  restart)
+    echo "Restarting Resque scheduler ... "
+    stop
+    sleep 2
+    start
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart}"
+    exit 1
+esac
+
+exit $?

data/lib/oysters/unified/scripts/unicorn_initd_script.sh

@@ -0,0 +1,73 @@
+#!/bin/sh
+# chkconfig: 345 99 55
+# description: script to start unicorn
+# /etc/init.d/[application]_unicorn
+
+# source functions library
+. /etc/rc.d/init.d/functions
+
+# source application params
+. /etc/sysconfig/deployed_application
+
+start() {
+  local program
+  local options
+  local env_vars
+
+  cd $ROOT_PATH
+
+  echo "Starting Unicorn"
+  env_vars="RAILS_ENV=$RAILS_ENV BUNDLE_GEMFILE=$BUNDLE_GEMFILE"
+  options="-c $UNICORN_CONFIG -E $RAILS_ENV -D "
+  program="source /home/$APP_USER/.bash_profile; $env_vars bundle exec unicorn $options"
+
+  if [[ $APP_USER == $USER ]]
+  then
+    daemon --pidfile=$UNICORN_PIDFILE $program
+  else
+    daemon --user $APP_USER --pidfile=$UNICORN_PIDFILE $program
+  fi
+  RETVAL=$?
+
+  if [ $RETVAL -eq 0 ]; then
+    echo_success
+  else
+    echo_failure
+  fi
+  echo
+}
+
+stop() {
+  echo "Stopping Unicorn"
+
+  if [ -f $UNICORN_PIDFILE ]; then
+    kill -s QUIT $(cat $UNICORN_PIDFILE)
+    RETVAL=$?
+  else
+    RETVAL=1
+  fi
+
+  if [ $RETVAL -eq 0 ]; then
+    echo_success
+    rm -f $UNICORN_PIDFILE
+  else
+    echo "Unicorn is not running"
+    echo_failure
+  fi
+}
+
+case "$1" in
+  start) start ;;
+  stop) stop ;;
+  restart)
+    echo "Restarting Unicorn ... "
+    stop
+    sleep 5
+    start
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart}"
+    exit 1
+esac
+
+exit $?

data/lib/oysters/unified/templates/app_sysconfig.sh.erb

@@ -0,0 +1,28 @@
+# /etc/sysconfig/deployed_application
+# Configuration file for application services: Unicorn, KEWatcher and Resque Scheduler.
+
+#Main params
+RAILS_ENV=<%= rails_env %>                                      # (development, staging, production)
+APP_USER=<%= app_user %>                                        # user that will run daemons
+
+ROOT_PATH=<%= current_path %>                                   # path to app directory
+SHARED_PATH=<%= shared_path %>                                  # path to shared directory
+
+#Scheduler params
+SCHEDULER_LOGFILE=$SHARED_PATH/log/resque_scheduler.log
+SCHEDULER_PIDFILE=$SHARED_PATH/pids/scheduler.pid
+DYNAMIC_SCHEDULE=<%= dynamic_schedule %>                        # (true,false)
+BACKGROUND=<%= scheduler_background %>                          # (true,false)
+SCHEDULER_VERBOSE=<%= scheduler_verbose %>                      # (1,0)
+
+#KEWatcher params
+KEWATCHER_LOGFILE=$SHARED_PATH/log/kewatcher.log
+KEWATCHER_PIDFILE=$SHARED_PATH/pids/kewatcher.pid
+KEWATCHER_REDIS_CONFIG=<%= kewacther_redis_config %>            # path to redis config
+KEWATCHER_MAX_WORKERS=<%= kewatcher_max_workers %>              # max number of workers (integer)
+KEWATCHER_VERBOSE=<%= kewatcher_verbose %>                      # log verbosity (-v,-vv)
+
+#Unicorn params
+UNICORN_CONFIG=<%= unicorn_config_path %>
+UNICORN_PIDFILE=$SHARED_PATH/pids/unicorn.pid
+BUNDLE_GEMFILE=$ROOT_PATH/Gemfile

data/lib/oysters/unified_oysters.rb

@@ -0,0 +1,5 @@
+require 'oysters'
+
+Dir[File.dirname(__FILE__) + '/unified/*.rb'].each do |f|
+  require f
+end

data/lib/oysters/version.rb

@@ -1,3 +1,3 @@
 module Oysters
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oysters
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,13 @@ files:
 - lib/oysters/templates/kewatcher_init.sh.erb
 - lib/oysters/templates/logrotate_config.erb
 - lib/oysters/templates/unicorn_init.sh.erb
+- lib/oysters/unified/application_control.rb
+- lib/oysters/unified/initd.rb
+- lib/oysters/unified/scripts/kewatcher_initd_script.sh
+- lib/oysters/unified/scripts/resque_scheduler_initd_script.sh
+- lib/oysters/unified/scripts/unicorn_initd_script.sh
+- lib/oysters/unified/templates/app_sysconfig.sh.erb
+- lib/oysters/unified_oysters.rb
 - lib/oysters/version.rb
 - oysters.gemspec
 homepage: https://github.com/rsamoilov/oysters