capistrano-runit-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bddfd41eae20655a062eba33faa322c6e4716913
+  data.tar.gz: 3afac19b6ea4d5aac56a64e51dde1370559892a8
+SHA512:
+  metadata.gz: a09f9a93a40ce648530165c317ac55028e4c03f62d582f66abf89c8658aab17ee4f09e855f76cbc5fd612607239dc0c68e287604caa3746da8a3dddd3c1c60c4
+  data.tar.gz: 0b474796f623a0d42fae467b71781da1ed596a3f071295e9377240a0cf0886fd460ff72ee9da116951e50ad49a47356806d12e033265f7656146fff504e693b8

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+/.ruby-version
+/.idea

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# capistrano-runit-core
+
+## 0.1.0
+
+* Extract all supported services to separate gems
+* Rename gem from capistrano-runit to capistrano-runit-core
+
+# capistrano-runit
+## 2.0.0.rc1 (unreleased)
+
+* Add sidekiq module.
+* Add puma module.
+* Drop Capistrano 2.x support.
+
+## 1.1.4 2014-02-06
+
+* Added 'runit_unicorn_before_fork_code' variable for unicorn recipe.
+
+## 1.1.3 2013-04-19
+
+* Added recipes for sidekiq.
+* Fixed: runit:setup should run on servers with db-role too.
+* Added recipes for thinking-sphinx.
+* Use rails_env variable instead of hardwired 'production' in run-unicorn.
+
+## 1.1.2 2011-11-05
+
+* Added double quotes for environment variables values.
+
+## 1.1.1 2011-11-05
+
+* default_environment hash was added in templates (special usefull for rbenv).
+
+## 1.1.0 2011-10-23
+
+* Bugfixes.
+* Added Resque recipe.
+
+## 1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright (c) 2011-2014 Anton Ageev
+Copyright (c) 2014 Oleksandr Simonov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# capistrano-runit-core
+
+Base core capistrano3 module for managing various services via runit supervisor.
+
+## Installation
+
+Add to `Gemfile`:
+```
+group :development do
+  gem "capistrano-runit-core", "~> 0.1.0"
+end
+```
+
+Run:
+```
+$ bundle install
+```
+
+## runit setup
+
+We need to create specific runit service for our whole application:
+Create service folder inside `/etc/sv`:
+
+```bash
+mkdir /etc/sv/runsvdir-your_application
+mkdir /etc/sv/runsvdir-your_application/log
+```
+
+Create run shell script `/etc/sv/runsvdir-your_application/run`:
+
+```bash
+#!/bin/sh
+exec 2>&1
+exec chpst -udeployer runsvdir /home/deployer/apps/your_application/runit/enabled
+```
+
+In current example expected what you deploying with `deployer` user to the `/home/deployer/apps/your_application` folder.
+
+Create log run shell script `/etc/sv/runsvdir-your_application/log/run`:
+
+```bash
+#!/bin/sh
+exec svlogd -tt /var/log/runsvdir-your_application
+```
+
+Create log folder:
+
+```bash
+mkdir /var/log/runsvdir-your_application
+```
+
+And make this scripts executable:
+
+```bash
+chmod a+x /etc/sv/runsvdir-your_application/run /etc/sv/runsvdir-your_application/log/run
+```
+
+And after this we will need to make symlink in `/etc/service/`
+
+```bash
+ln -s /etc/sv/runsvdir-your_application /etc/service/runsvdir-your_application
+```
+
+## Usage
+
+Add this line in `Capfile`:
+```
+require "capistrano/runit"
+```
+
+## Tasks
+
+* `runit:setup` -- prepare runit directories in the project directory.
+
+## Variables
+
+* `runit_roles` -- what host roles uses runit to run processes. Default value: `[:app, :db]`.
+* `runit_sv_path` -- Path to the runit sv binary. Default value: `/sbin/sv`
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/capistrano-runit-core.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'capistrano-runit-core'
+  spec.version     = '0.1.0'
+  spec.summary     = 'Capistrano3 core recipe to manage runit services'
+  spec.homepage    = 'http://capistrano-runit.github.io'
+  spec.author      = ['Oleksandr Simonov', 'Anton Ageev']
+  spec.email       = ['alex@simonov.me', 'antage@gmail.com']
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'capistrano', '>= 3.1'
+  spec.add_runtime_dependency 'sshkit', '>= 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/runit.rb

@@ -0,0 +1,128 @@
+module Capistrano
+  module Runit
+    def service_dir_for(service)
+      ::File.join(deploy_to, 'runit', 'available', service)
+    end
+
+    def enabled_service_dir_for(service)
+      ::File.join(deploy_to, 'runit', 'enabled', service)
+    end
+
+    def env_variables
+      ::SSHKit.config.default_env.map { |k, v| "#{k.upcase}=\"#{v}\"" }.join(' ')
+    end
+
+    def upload_runit_run_file(_runit_command, template_path, dest)
+      template = ERB.new(File.read(template_path))
+      stream   = StringIO.new(template.result(binding))
+      upload! stream, dest
+      execute :chmod, '0755', dest
+    end
+
+    def pid_full_path(pid_path)
+      if pid_path.start_with?('/')
+        pid_path
+      else
+        "#{shared_path}/#{pid_path}"
+      end
+    end
+
+    def check_service(service)
+      if fetch("runit_#{service}_default_hooks")
+        ::Rake::Task['runit:setup'].invoke
+        ::Rake::Task["runit:#{service}:setup"].invoke
+        ::Rake::Task["runit:#{service}:enable"].invoke
+      end
+    end
+
+    def setup_service(service, run_command)
+      service_dir  = service_dir_for(service)
+      template_key = "runit_#{service}_run_template".to_sym
+      on roles fetch("runit_#{service}_role".to_sym) do
+        if test "[ ! -d #{service_dir} ]"
+          execute :mkdir, '-v', service_dir
+        end
+        template_path = fetch(template_key, ::File.expand_path('../templates/run.erb', __FILE__))
+        if !template_path.nil? && File.exist?(template_path)
+          upload_runit_run_file(
+            run_command,
+            template_path,
+            ::File.join(service_dir, 'run')
+          )
+        else
+          error "Template from '#{template_key}' variable isn't found: #{template_path}"
+        end
+      end
+    end
+
+    def enable_service(service)
+      service_dir         = service_dir_for(service)
+      enabled_service_dir = enabled_service_dir_for(service)
+      on roles fetch("runit_#{service}_role".to_sym) do
+        if test "[ -d #{service_dir} ]"
+          if test "[ -d #{enabled_service_dir} ]"
+            info "'#{service}' runit service already enabled"
+          else
+            within "#{enabled_service_dir}" do
+              execute :ln, '-sf', ::File.join(service, service), service
+            end
+          end
+        else
+          error "'#{service}' runit service isn't found. You should run runit:#{service}:setup first."
+        end
+      end
+    end
+
+    def disable_service(service)
+      ::Rake::Task["runit:#{service}:stop"].invoke
+      enabled_service_dir = enabled_service_dir_for(service)
+      on roles fetch("runit_#{service}_role".to_sym) do
+        if test "[ -d #{enabled_service_dir}"
+          execute :rm, '-f', enabled_service_dir
+        else
+          error "'#{service}' runit service isn't enabled."
+        end
+      end
+    end
+
+    def start_service(service)
+      on roles fetch("runit_#{service}_role".to_sym) do
+        runit_execute_command(service, 'start')
+      end
+    end
+
+    def stop_service(service)
+      pid_path = pid_full_path(fetch("runit_#{service}_pid".to_sym))
+      on roles fetch("runit_#{service}_role".to_sym) do
+        if test "[ -f #{pid_path} ]"
+          runit_execute_command(service, 'stop')
+        else
+          info "'#{service}' is not running yet"
+        end
+      end
+    end
+
+    def restart_service(service)
+      on roles fetch("runit_#{service}_role".to_sym) do
+        runit_execute_command(service, 'restart')
+      end
+    end
+
+    def kill_hup_service(service)
+      on roles fetch("runit_#{service}_role".to_sym) do
+        runit_execute_command(service, '1')
+      end
+    end
+
+    def runit_execute_command(service, command)
+      enabled_service_dir = enabled_service_dir_for(service)
+      if test "[ -d #{enabled_service_dir} ]"
+        execute "#{fetch(:runit_sv_path)} #{command} #{enabled_service_dir}"
+      else
+        error "'#{service}'' runit service isn't enabled."
+      end
+    end
+  end
+end
+
+load File.expand_path('../tasks/runit.rake', __FILE__)

data/lib/capistrano/tasks/runit.rake

@@ -0,0 +1,30 @@
+namespace :runit do
+  desc 'Setup runit directories'
+  task :setup do
+    on roles fetch(:runit_roles) do
+      within fetch(:deploy_to) do
+        if test "[ ! -d #{deploy_to}/runit ]"
+          execute :mkdir, '-v', "#{deploy_to}/runit"
+        else
+          info "Directory 'runit' already exists"
+        end
+        %w(.env available enabled).each do |subdir|
+          if test "[ ! -d #{deploy_to}/runit/#{subdir} ]"
+            execute :mkdir, '-v', "#{deploy_to}/runit/#{subdir}"
+          else
+            info "Directory 'runit/#{subdir}' already exists"
+          end
+        end
+
+        execute "echo $HOME > #{deploy_to}/runit/.env/HOME"
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :runit_roles, fetch(:runit_roles, [:app, :db])
+    set :runit_sv_path, '/sbin/sv'
+  end
+end

data/lib/capistrano/templates/run.erb

@@ -0,0 +1,3 @@
+#!/bin/bash
+cd <%= current_path %>
+<%= runit_command %>

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-runit-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleksandr Simonov
+- Anton Ageev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alex@simonov.me
+- antage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-runit-core.gemspec
+- lib/capistrano-runit-core.rb
+- lib/capistrano/runit.rb
+- lib/capistrano/tasks/runit.rake
+- lib/capistrano/templates/run.erb
+homepage: http://capistrano-runit.github.io
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano3 core recipe to manage runit services
+test_files: []