capistrano-foreman-systemd 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20f43f605bd054bd0b93f27ed3a489dfa3196472
+  data.tar.gz: 8372b1200313fadf256ac4c47b9d708a65e8a437
+SHA512:
+  metadata.gz: a5d9425c6c5376250d56dda5755a16f3575a69d5c3f8388782df7e68e84aa2ec0b98d9ac7cad9afd2a3c02e83e7b3756a1b5b3b83b0d6c943b73b71aef94c9aa
+  data.tar.gz: b9d42e2b9849aca49bc09d01cb3dbc4538c004fd7a2ea1051ecbde4f01061470fb2ef415cdcfe9bfac34c264c6881966eaea6f4d6ebc6a303541ce3fea7bbfa7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-foreman.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Licensed under the **MIT** license
+
+> Copyright (c) 2014 Hyper Interaktiv AS
+>
+> 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,112 @@
+# Capistrano::foreman
+
+Foreman support for Capistrano 3
+
+## Installation
+
+```ruby
+gem 'capistrano', '~> 3.1'
+gem 'capistrano-foreman', github: 'koenpunt/capistrano-foreman'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-foreman
+
+## Usage
+
+Require in `Capfile`:
+
+```ruby
+require 'capistrano/foreman'
+```
+
+Export Procfile to process management format (defaults to upstart) and restart the application services:
+
+    $ cap foreman:setup
+    $ cap foreman:start
+
+Configurable options, shown here with defaults:
+
+```ruby
+set :foreman_roles, :all
+set :foreman_export_format, 'upstart'
+set :foreman_export_path, '/etc/init'
+set :foreman_flags, "--root=#{current_path}" # optional, default is empty string
+set :foreman_target_path, release_path
+set :foreman_app, -> { fetch(:application) }
+set :foreman_concurrency, 'web=2,worker=1' # optional, default is not set
+set :foreman_log, -> { shared_path.join('log') }
+set :foreman_port, 3000 # optional, default is not set
+set :foreman_user, 'www-data' # optional, default is not set
+```
+
+See [exporting options](http://ddollar.github.io/foreman/#EXPORTING) for an exhaustive list of foreman options.
+
+### Tasks
+
+This gem provides the following Capistrano tasks:
+
+* `foreman:setup` exports the Procfile and starts application services
+* `foreman:export` exports the Procfile to process management format
+* `foreman:restart` restarts the application services
+* `foreman:start` starts the application services
+* `foreman:stop` stops the application services
+
+## Example
+
+A typical setup would look like the following:
+
+Have a group-writeable directory under `/etc/init` for the group `deploy` (in this case I call it `sites`) to store the init scripts:
+
+```bash
+sudo mkdir /etc/init/sites
+sudo chown :deploy /etc/init/sites
+sudo chmod g+w /etc/init/sites
+```
+
+And the following configuration in `deploy.rb`:
+
+```ruby
+# Set the app with `sites/` prefix
+set :foreman_app, -> { "sites/#{fetch(:application)}" }
+
+# Set user to `deploy`, assuming this is your deploy user
+set :foreman_user, 'deploy'
+
+# Set root to `current_path` so exporting only have to be done once.
+set :foreman_flags, "--root=#{current_path}"
+```
+
+Setup your init scripts by running `foreman:setup` after your first deploy.
+From this moment on you only have to run `foreman:setup` when your `Procfile` has changed or when you alter the foreman deploy configuration.
+
+Finally you have to instruct Capistrano to run `foreman:restart` after deploy:
+
+```ruby
+# Hook foreman restart after publishing
+after :'deploy:publishing', :'foreman:restart'
+```
+
+## Notes
+
+When using `rbenv`, `rvm`, `chruby` and/or `bundler` don't forget to add `foreman` to the bins list:
+
+```ruby
+fetch(:rbenv_map_bins, []).push 'foreman'
+fetch(:rvm_map_bins, []).push 'foreman'
+fetch(:chruby_map_bins, []).push 'foreman'
+fetch(:bundle_bins, []).push 'foreman'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/capistrano-foreman.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-foreman-systemd'
+  spec.version       = '0.0.4'
+  spec.authors       = ['Adrian Serafin']
+  spec.email         = ['adrian@softmad.pl']
+  spec.description   = %q{Foreman and systemd tasks for Capistrano 3.x}
+  spec.summary       = %q{Foreman and systemd tasks for Capistrano 3.x}
+  spec.homepage      = 'https://github.com/aserafin/capistrano-foreman'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/foreman.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/foreman.rake', __FILE__)

data/lib/capistrano/tasks/foreman.rake

@@ -0,0 +1,93 @@
+namespace :foreman do
+  desc <<-DESC
+        Setup foreman configuration
+
+        Configurable options are:
+
+          set :foreman_roles, :all
+          set :foreman_export_format, 'upstart'
+          set :foreman_export_path, '/etc/init'
+          set :foreman_flags, ''
+          set :foreman_target_path, release_path
+          set :foreman_app, -> { fetch(:application) }
+          set :foreman_concurrency, 'web=2,worker=1' # default is not set
+          set :foreman_log, -> { shared_path.join('log') }
+          set :foreman_port, 3000 # default is not set
+          set :foreman_user, 'www-data' # default is not set
+    DESC
+
+  task :setup do
+    invoke :'foreman:export'
+    invoke :'foreman:enable'
+    invoke :'foreman:start'
+  end
+
+  desc "Enables service in systemd"
+  task :enable do
+    on roles fetch(:foreman_roles) do
+      sudo :systemctl, "enable #{fetch(:foreman_app)}.target"
+    end
+  end
+
+  desc "Disables service in systemd"
+  task :disable do
+    on roles fetch(:foreman_roles) do
+      sudo :systemctl, "disable #{fetch(:foreman_app)}.target"
+    end
+  end
+
+
+  desc "Export the Procfile to another process management format"
+  task :export do
+    on roles fetch(:foreman_roles) do |server|
+      execute :mkdir, "-p", fetch(:foreman_export_path) unless test "[ -d #{fetch(:foreman_export_path)} ]"
+      within fetch(:foreman_target_path, release_path) do
+
+        options = {
+          app: fetch(:foreman_app),
+          log: fetch(:foreman_log)
+        }
+        options[:concurrency] = fetch(:foreman_concurrency) if fetch(:foreman_concurrency)
+        options[:concurrency] = server.properties.foreman_concurrency if server.properties.foreman_concurrency
+        options[:port] = fetch(:foreman_port) if fetch(:foreman_port)
+        options[:user] = fetch(:foreman_user) if fetch(:foreman_user)
+
+        execute :foreman, 'export', fetch(:foreman_export_format), fetch(:foreman_export_path),
+          options.map{ |k, v| "--#{k}='#{v}'" }, fetch(:foreman_flags)
+      end
+    end
+  end
+
+  desc "Start the application services"
+  task :start do
+    on roles fetch(:foreman_roles) do
+      sudo :start, fetch(:foreman_app)
+    end
+  end
+
+  desc "Stop the application services"
+  task :stop do
+    on roles fetch(:foreman_roles) do
+      sudo :stop, fetch(:foreman_app)
+    end
+  end
+
+  desc "Restart the application services"
+  task :restart do
+    on roles fetch(:foreman_roles) do
+      sudo :restart, fetch(:foreman_app)
+    end
+  end
+
+end
+
+namespace :load do
+  task :defaults do
+    set :foreman_roles, :all
+    set :foreman_export_format, 'upstart'
+    set :foreman_export_path, '/etc/init'
+    set :foreman_flags, ''
+    set :foreman_app, -> { fetch(:application) }
+    set :foreman_log, -> { shared_path.join('log') }
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-foreman-systemd
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Adrian Serafin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-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.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Foreman and systemd tasks for Capistrano 3.x
+email:
+- adrian@softmad.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-foreman.gemspec
+- lib/capistrano-foreman.rb
+- lib/capistrano/foreman.rb
+- lib/capistrano/tasks/foreman.rake
+homepage: https://github.com/aserafin/capistrano-foreman
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Foreman and systemd tasks for Capistrano 3.x
+test_files: []