capistrano-foreman-systemd 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94434861d938385dc7ce8f776bbe2bb1d2e84284
-  data.tar.gz: 6694de441870fa3af2e11e48b77ec048a3f4a0cb
+  metadata.gz: 10417e93aa6da26da5e2adad9424f25237519711
+  data.tar.gz: b564aff9f27ac0f07063353464a70902d4028085
 SHA512:
-  metadata.gz: da58ca8a2b70eb7110bb89d53ab15d67d46cb735c50e709e1cfa7ec162588c4d6e85ade9ea0b3eeee8162658efad5fed886453b6f166565f5ca719cc7926e549
-  data.tar.gz: a249b412d866b64694965fe5acc2f3d820d9831c746367992e0adcb5cf0363ab056cae1ea04a74cbee1c0bf713fc9d9252f7bd81e61c2743bbd743afb8d127ca
+  metadata.gz: dd01f08ecddfb2b6fca7d2d3abe4f55d96aae8e24fe081d7c28c077f8c47921496cdf893f9e7754f3a151e1cefebc13d495d8cb5c1e560192eee9d18b77b5529
+  data.tar.gz: fef7dd4da0514fb0a9efef435b27189b0dc4fc6c0bc9b5041a238cbb67504bee853f76426b9eddbb41b942c764cbe36b538c3115bd6f28663e0ffcc649cf7ca2

data/README.md

@@ -1,12 +1,13 @@
-# Capistrano::foreman
+# Capistrano::ForemanSystemd
 
-Foreman support for Capistrano 3
+This is heavily based on the [capistrano-foreman](https://github.com/koenpunt/capistrano-foreman) gem but it only targets `systemd` (default init system for Ubuntu since 16.04).
+It works best with [foreman-systemd](https://github.com/aserafin/foreman) (fork of 0.78 version of [foreman](https://github.com/ddollar/foreman) gem).
 
 ## Installation
 
 ```ruby
 gem 'capistrano', '~> 3.1'
-gem 'capistrano-foreman', github: 'koenpunt/capistrano-foreman'
+gem 'capistrano-foreman-systemd'
 ```
 
 And then execute:
@@ -15,34 +16,34 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install capistrano-foreman
+    $ gem install capistrano-foreman-systemd
 
 ## Usage
 
 Require in `Capfile`:
 
 ```ruby
-require 'capistrano/foreman'
+require 'capistrano/foreman_systemd'
 ```
 
 Export Procfile to process management format (defaults to upstart) and restart the application services:
 
-    $ cap foreman:setup
-    $ cap foreman:start
+    $ cap foreman_systemd:setup
+    $ cap foreman_systemd: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
+set :foreman_systemd_roles, :all
+set :foreman_systemd_export_format, 'upstart'
+set :foreman_systemd_export_path, '/etc/init'
+set :foreman_systemd_flags, "--root=#{current_path}" # optional, default is empty string
+set :foreman_systemd_target_path, release_path
+set :foreman_systemd_app, -> { fetch(:application) }
+set :foreman_systemd_concurrency, 'web=2,worker=1' # optional, default is not set
+set :foreman_systemd_log, -> { shared_path.join('log') }
+set :foreman_systemd_port, 3000 # optional, default is not set
+set :foreman_systemd_user, 'www-data' # optional, default is not set
 ```
 
 See [exporting options](http://ddollar.github.io/foreman/#EXPORTING) for an exhaustive list of foreman options.
@@ -51,29 +52,26 @@ See [exporting options](http://ddollar.github.io/foreman/#EXPORTING) for an exha
 
 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
+* `foreman_systemd:setup` exports the Procfile and starts application services
+* `foreman_systemd:export` exports the Procfile to process management format
+* `foreman_systemd:enable` enables the application in systemd
+* `foreman_systemd:disable` disables the application in systemd
+* `foreman_systemd:restart` restarts the application services
+* `foreman_systemd:start` starts the application services
+* `foreman_systemd:stop` stops the application services
 
-## Example
+### User permissions
 
-A typical setup would look like the following:
+Commands have to be executed with `root` or user with `sudo` writes because `foreman:setup` creates files in `/etc/systemd/system` directory.
 
-Have a group-writeable directory under `/etc/init` for the group `deploy` (in this case I call it `sites`) to store the init scripts:
+## Example
 
-```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`:
+Configuration in `deploy.rb`:
 
 ```ruby
 # Set the app with `sites/` prefix
-set :foreman_app, -> { "sites/#{fetch(:application)}" }
+set :foreman_app, -> { fetch(:application) }
 
 # Set user to `deploy`, assuming this is your deploy user
 set :foreman_user, 'deploy'
@@ -87,6 +85,15 @@ From this moment on you only have to run `foreman:setup` when your `Procfile` ha
 
 Finally you have to instruct Capistrano to run `foreman:restart` after deploy:
 
+You can control which process runs on which servers using server variable `foreman_systemd_concurrency`:
+
+```ruby
+server '123.123.123.1', { roles: [:web], foreman_systemd_concurrency: 'web=1,sidekiq=1' }
+server '123.123.123.1', { roles: [:web], foreman_systemd_concurrency: 'web=1,sidekiq=0' }
+```
+
+Finally
+
 ```ruby
 # Hook foreman restart after publishing
 after :'deploy:publishing', :'foreman:restart'

data/{capistrano-foreman.gemspec → capistrano-foreman-systemd.gemspec}

@@ -4,12 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano-foreman-systemd'
-  spec.version       = '0.0.7'
+  spec.version       = '1.0.0'
   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.homepage      = 'https://github.com/aserafin/capistrano-foreman-systemd'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

data/lib/capistrano/foreman_systemd.rb

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

data/lib/capistrano/tasks/foreman_systemd.rake

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-foreman-systemd
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Adrian Serafin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-29 00:00:00.000000000 Z
+date: 2016-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -64,11 +64,11 @@ files:
 - 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
+- capistrano-foreman-systemd.gemspec
+- lib/capistrano-foreman-systemd.rb
+- lib/capistrano/foreman_systemd.rb
+- lib/capistrano/tasks/foreman_systemd.rake
+homepage: https://github.com/aserafin/capistrano-foreman-systemd
 licenses:
 - MIT
 metadata: {}

data/lib/capistrano/foreman.rb

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

data/lib/capistrano/tasks/foreman.rake

@@ -1,93 +0,0 @@
-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)
-
-        sudo :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 :systemctl, "start #{fetch(:foreman_app)}.target"
-    end
-  end
-
-  desc "Stop the application services"
-  task :stop do
-    on roles fetch(:foreman_roles) do
-      sudo :systemctl, "stop #{fetch(:foreman_app)}.target"
-    end
-  end
-
-  desc "Restart the application services"
-  task :restart do
-    on roles fetch(:foreman_roles) do
-      sudo :systemctl, "restart #{fetch(:foreman_app)}.target"
-    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