cap-runit 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3e6b7e1396dc85e4f664fac65423f7b17eb80e5
+  data.tar.gz: e68549492f3f0e5cf8301dd473b15ea4fe778347
+SHA512:
+  metadata.gz: 0fd9c847ffb4cb4fffd273b5cd754b66f1a985427ca1e4c9fb303e7dff41ae4ff69a7d2577374836a0fa9bf2aa03cd50f0eca5bc771db15ace1f68d8d07e73af
+  data.tar.gz: d84be89f74bb843f7f3a676962463e1b6c68c31f8879eac2c0d84fdd670f89d7f2bab9547dd936ecd187e169513895b703685ac2e03678600b710cec392c11d2

data/README.md

@@ -0,0 +1,136 @@
+# Capistrano 3 Runit Support
+
+cap-runit provides a helper for building runit services. It lets you easily
+deploy services using capistrano 3 and run them with runit.
+
+## Installation
+
+Using bundler: Add `gem 'cap-runit'` to your `Gemfile` and `require 'bundler';
+Bundler.require` to your `Capfile`.
+
+Not using bundler: `gem install cap-runit` and add `require 'capistrano/runit'`
+to your `Capfile`.
+
+## Usage
+
+cap-runit provides a helper method `runit_service` to Capistrano. As the
+philosophy of runit is that everything is just a shell script, `cap-runit`
+requires you to write a shell script.
+
+For example, to run sidekiq, you might do something like this:
+
+
+```ruby
+runit_service 'sidekiq' do
+
+  run <<-EOF
+#!/bin/bash
+cd /var/www/app/current
+exec bundle exec sidekiq -e production -C ./config/sidekiq.yml 2>&1
+  EOF
+
+end
+```
+
+This creates three capistrano tasks:
+
+```
+cap sidekiq:restart    # Restart bugsnag-event-server
+cap sidekiq:start      # Start bugsnag-event-server
+cap sidekiq:stop       # Stop bugsnag-event-server
+```
+
+If you'd like to restart sidekiq when your app restarts, you also need to
+specify:
+
+```ruby
+namespace :deploy do
+  after :publishing, 'sidekiq:restart'
+end
+```
+
+### Logging
+
+Runit sends the STDOUT of your `run` script to the `log` script. To get these
+logs somewhere useful, you can use any program that reads from STDIN. But
+`svlogd` is recommended as it works well with runit and handles log rotation
+automatically.
+
+```ruby
+runit_service 'sidekiq' do
+
+  run <<-EOF
+#!/bin/bash -l
+cd /var/www/app/current
+exec bundle exec sidekiq -e production -C ./config/sidekiq.yml 2>&1
+  EOF
+
+  log <<-EOF
+#!/bin/sh
+mkdir -p /var/log/sidekiq
+exec svlogd -tt /var/log/sidekiq
+  EOF
+end
+```
+
+### Crash notifications
+
+If you need to be notified of when a crash happens in your app, you can also
+configure a `finish` script. This is run whenever the `run` script exits.
+
+```ruby
+runit_service 'sidekiq' do
+
+  run <<-EOF
+#!/bin/bash -l
+cd /var/www/app/current
+exec bundle exec sidekiq -e production -C ./config/sidekiq.yml 2>&1
+  EOF
+
+  log <<-EOF
+#!/bin/sh
+mkdir -p /var/log/sidekiq
+exec svlogd -tt /var/log/sidekiq
+  EOF
+
+  finish <<-EOF
+#!/bin/sh
+export BUGSNAG_API_KEY=bf04f47b034e8df9d22ee75f30fdae6a
+[ "$1" = 0 ] || exec bugsnag-runit "$0"
+  EOF
+end
+
+```
+
+## Configuration
+
+The only configuration variable you need to pass is `runit_service_directory`
+
+```ruby
+set :runit_service_directory, "/apps/service"
+```
+
+The service directory needs to be run with `runsvdir` and owned by the
+capistrano user. To configure `runsvdir` you can create the following files:
+
+
+```bash
+#/etc/service/cap-runit/run
+
+#!/bin/bash
+exec chpst -udeploy -- runsvdir /apps/service 2>&1
+```
+
+And
+
+```bash
+#/etc/service/cap-runit/log/run
+
+#!/bin/sh
+exec svlogd -tt /var/log/cap-runit
+```
+
+These files should both be owned by root and `chmod +x`. This way the deploy
+user does not need root permissions to reboot a service on deploy.
+
+

data/cap-runit.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |gem|
+  gem.name = 'cap-runit'
+  gem.version = '0.1'
+
+  gem.summary = 'Capistrano 3 Runit integration'
+  gem.description = "Template for managing runit directories with capistrano 3"
+
+  gem.authors = ['Conrad Irwin']
+  gem.email = %w(conrad@bugsnag.com)
+  gem.homepage = 'http://github.com/ConradIrwin/cap-runit'
+
+  gem.license = 'MIT'
+
+  gem.add_dependency 'capistrano', '>= 3.0'
+
+  gem.files = `git ls-files`.split("\n")
+end

data/lib/cap-runit.rb

@@ -0,0 +1,134 @@
+#  TODO:CI make this into a gem.
+
+set :runit_service_dir, "/apps/service"
+
+class RunitServiceBuilder
+
+  def initialize(&block)
+    instance_eval(&block)
+    unless @roles
+      raise ArgumentError, "No role configured for runit service"
+    end
+    unless @run
+      raise ArgumentError, "No run script configured for runit service"
+    end
+  end
+
+  def roles(*roles)
+    @roles = roles unless roles == []
+    @roles
+  end
+
+  def run(str=nil)
+    @run = str unless str.nil?
+    @run
+  end
+
+  def log(str=nil)
+    @log = str unless str.nil?
+    @log
+  end
+
+  def finish(str=nil)
+    @finish = str unless str.nil?
+    @finish
+  end
+
+end
+
+# Defines a runit service.
+#
+# @example
+#
+#   # A runit directory that your deploy user can write to.
+#   # You can set one of these up using runsvdir.
+#
+#   set :runit_service_dir, '/etc/service'
+#
+#   # The first argument is the name of the service.
+#   # The remainder are passed to "on" to decide
+#   # which servers to use
+#   runit_service 'sidekiq', roles(:sidekiq) do
+#
+#     # required, a bash script that execs your app
+#     run <<-EOF
+#   #!/bin/bash
+#   cd /var/www/app
+#   exec bundle exec sidekiq 2>&1
+#     EOF
+#
+#     # optional, a log script that reads stdin/stdout
+#     log <<-EOF
+#   #!/bin/bash
+#   mkdir -p /var/log/app/sidekiq
+#   exec syslogd -tt /var/log/app/sidekiq
+#     EOF
+#
+#     # optional, a finish script that runs when your app quits
+#     finish <<-EOF
+#   #!/bin/bash
+#   echo 'QUIT' >> /var/log/app/sidekiq/current
+#     EOF
+#
+#   end
+#
+def runit_service(name, &block)
+  runit_service_dir = fetch(:runit_service_dir)
+
+  service = RunitServiceBuilder.new(&block)
+
+  namespace name do
+    desc "Configure #{name} runit"
+    task :configure do
+      on roles(service.roles) do
+        unless test("[ -e #{runit_service_dir}/#{name}/run ]")
+          execute <<-EOF
+          rm -rf #{runit_service_dir}/#{name}
+          mkdir -p #{runit_service_dir}/#{name}/log
+          EOF
+
+          upload! StringIO.new(service.run), "#{runit_service_dir}/#{name}/run"
+
+          if service.log
+            upload! StringIO.new(service.log), "#{runit_service_dir}/#{name}/log/run"
+          end
+
+          if service.finish
+            upload! StringIO.new(service.finish), "#{runit_service_dir}/#{name}/finish"
+          end
+
+          execute "chmod +x #{runit_service_dir}/#{name}/run #{runit_service_dir}/#{name}/log/run"
+        end
+      end
+    end
+
+    desc "Start #{name}"
+    task start: :configure do
+      on roles(*service.roles) do
+        execute "sv start #{runit_service_dir}/#{name}"
+      end
+    end
+
+    desc "Stop #{name}"
+    task :stop do
+      on roles(*service.roles) do
+        execute "sv stop #{runit_service_dir}/#{name}"
+      end
+    end
+
+    desc "Restart #{name}"
+    task restart: :configure do
+      on roles(*service.roles) do
+        execute "sv restart #{runit_service_dir}/#{name}"
+      end
+    end
+
+    desc "Disable #{name}"
+    task :disable do
+      on roles(*service.roles) do
+        execute "rm -rf #{runit_service_dir}/#{name}"
+      end
+    end
+  end
+end
+

data/lib/capistrano/runit.rb

@@ -0,0 +1 @@
+require 'cap-runit'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: cap-runit
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Conrad Irwin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Template for managing runit directories with capistrano 3
+email:
+- conrad@bugsnag.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- cap-runit.gemspec
+- lib/cap-runit.rb
+- lib/capistrano/runit.rb
+homepage: http://github.com/ConradIrwin/cap-runit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Capistrano 3 Runit integration
+test_files: []
+has_rdoc: