mina-unicorn_systemd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f61e026a1e150bdc56cc14d0c20871a9ac4ab39f6a519de09d3debd713e210ab
+  data.tar.gz: 8db9dc35c5a631ad6488feb2c8d301cd893a03f931824e01dc2be3861a699431
+SHA512:
+  metadata.gz: 3467ec21d4ae700d9bbd2dda8ce6f5906ca0358e789693caab816a458bb465154b7a394f2b2f1a642566ebd122a38e7eae8e2996c79cab2e555233dfb14b0609
+  data.tar.gz: edb3c9611090d1dc8d09f4af1e5bd5ced4d206438e0f38a2439de90b1d4140a21ead936f1afdfa99236baa15dd9be98bf98f0964f318de953f5176b0afe8e137

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 coezbek
+
+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,50 @@
+# mina-unicorn_systemd
+
+Gem extension for mina-deploy to enable easy setup and deployment of unicorn application server managed via systemd.
+
+## Assumptions
+
+This gem assumes that you
+
+* Are on a Linux system with systemd in /etc/systemd/
+* Are using RVM to manage your Ruby version
+* That the setup task has sudoer or root permissions or that you are running with execution_mode :system and are entering passwords. If your regular user does not have sudo, then you can set the `setup_user` to the name of a user who does.
+* Want to run nginx in front and that you want to update nginx configuration to point to unicorn instead.
+
+## Basic installation instructions
+
+1. Add the following to your Gemfile and make sure that unicorn is available in production environment
+
+```
+group :production do
+  gem 'unicorn'
+end
+
+group :development do  
+  gem 'mina-unicorn_systemd', require: false # not necessary to load this when running rails
+end
+```
+
+2. Change your `deploy.rb` to include `'mina/unicorn.rb'`. Make sure to add after `nginx`
+
+```
+require 'mina/nginx'
+require 'mina/unicorn'
+```
+
+3. Manually run `'mina unicorn:setup'` or invoke from your own setup task.
+
+4. Manually run `'mina unicorn:restart'` or invoke from your own deploy task.
+
+## Customization
+
+To change the unicorn systemd service template and/or the `unicorn_conf.rb`, run `'mina unicorn:generate'`.
+
+## Contributing
+
+1. Fork it ( http://github.com/coezbek/mina-unicorn_systemd/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Change gemfile to refer to your local version (`gem 'mina-unicorn_systemd', path: <your path>`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/mina/templates/unicorn.service.erb

@@ -0,0 +1,43 @@
+# This file was generated from the unicorn.service.erb template.
+# It is deployed on unicorn:setup. 
+# To customize this template run the task unicorn:generate and modify locally
+<% application = fetch :application_name, 'application' %>
+[Unit]
+Description=<%= application %> Unicorn service
+After=network.target
+
+[Service]
+Type=forking
+WorkingDirectory=/home/<%= application %>/app/
+
+<%# Use the defined user and fall back to the application name -%> 
+User=<%= fetch :user, application %> 
+
+#
+# How to actually start Unicorn?
+#
+# Needs to be adjusted for rbenv.
+# 
+# Open question: would it be better to use a fully defined path? /usr/share/rvm/bin/rvm
+#
+ExecStart=/usr/share/rvm/bin/rvm in /home/<%= application %>/app/current/ do bundle exec unicorn -D -c /home/<%= application %>/app/current/config/unicorn.rb -E production
+
+# How to identify in the logs:
+SyslogIdentifier=unicorn-<%= application %>
+
+# stop by sending only the main process a SIGQUIT signal
+KillMode=process
+KillSignal=SIGQUIT
+
+# Enable reloading unicorn via HUP signal
+ExecReload=/bin/kill -HUP $MAINPID
+
+# Try to restart the service after 1 second
+Restart=always
+RestartSec=1
+
+# Path to Unicorn PID file (as specified in unicorn configuration file)
+PIDFile=/home/<%= application %>/app/shared/unicorn.pid
+
+[Install]
+WantedBy=multi-user.target

data/lib/mina/unicorn.rb

@@ -0,0 +1,105 @@
+require "mina/unicorn/version"
+
+#
+# The following tasks are for generating and setting up the systemd service which runs Unicorn
+#
+namespace :unicorn do
+  
+  set :unicorn_service_name,        -> { "unicorn-#{fetch(:application_name)}.service" }
+  set :unicorn_systemd_config_path, -> { "/etc/systemd/system/#{fetch :unicorn_service_name}" }
+  
+  set :nginx_socket_path,           -> { "#{fetch(:shared_path)}/unicorn.sock" }
+  
+  desc "Generate Unicorn systemd service template in the local repo to customize it"
+  task :generate do
+    run :local do
+      
+      target_path = File.expand_path("./config/deploy/templates/unicorn.service.erb")
+      source_path = File.expand_path("../templates/unicorn.service.erb", __FILE__)
+      
+      if File.exist? target_path
+        error! %(Unicorn service template already exists; please rm to continue: #{target_path})
+      else
+        command %(mkdir -p config/deploy/templates)
+        command %(cp #{source_path} #{target_path})
+      end
+            
+    end
+  end
+  
+  desc "Setup Unicorn systemd service on the remote server"
+  task :setup do
+  
+    elevate
+  
+    comment %(Check for systemd on remote server)    
+    command %([[ `systemctl` =~ -\.mount ]] || { echo 'Systemd not found, but mina-unicorn_systemd needs it.'; exit 1; }) # From https://unix.stackexchange.com/a/164092
+    
+    target_path = fetch :unicorn_systemd_config_path
+
+    comment %(Installing unicorn systemd config file to #{target_path})
+    command %(echo '#{erb template_path}' > #{target_path})
+
+    comment %(Reloading systemd configuration)
+    command %(systemctl daemon-reload)
+    
+  end
+  
+  desc "Get the status of the Unicorn systemd service on the remote server"
+  task :status do
+    command %(systemctl status #{fetch :unicorn_service_name})
+  end
+  
+  desc "Start the Unicorn systemd service on the remote server"
+  task :start do
+    elevate
+    # Start the service and if it fails print the error information
+    command %((systemctl start #{fetch :unicorn_service_name} && systemctl status #{fetch :unicorn_service_name}) || journalctl --no-pager _SYSTEMD_INVOCATION_ID=`systemctl show -p InvocationID --value #{fetch :unicorn_service_name}`)
+  end
+  
+  desc "Stop the Unicorn systemd service on the remote server"
+  task :stop do
+    elevate
+    command %((systemctl stop #{fetch :unicorn_service_name} && systemctl status #{fetch :unicorn_service_name}) || journalctl --no-pager _SYSTEMD_INVOCATION_ID=`systemctl show -p InvocationID --value #{fetch :unicorn_service_name}`)
+  end
+  
+  desc "Restart the Unicorn systemd service on the remote server"
+  task :restart do
+    elevate
+    command %((systemctl restart #{fetch :unicorn_service_name} && systemctl status #{fetch :unicorn_service_name}) || journalctl --no-pager _SYSTEMD_INVOCATION_ID=`systemctl show -p InvocationID --value #{fetch :unicorn_service_name}`)
+  end 
+  
+  # Returns the path to the template to use. Depending on whether the internal template was customized.
+  def template_path
+  
+    custom_path = File.expand_path("./config/deploy/templates/unicorn.service.erb")
+    original_path = File.expand_path("../templates/unicorn.service.erb", __FILE__)
+    
+    File.exist?(custom_path) ? custom_path : original_path
+  end
+  
+  def elevate 
+  
+    user = fetch(:user)
+    setup_user = fetch(:setup_user, user)
+    if setup_user != user
+      comment %{Switching to setup_user (#{setup_user})}
+      set :user, setup_user
+    end
+  
+  end
+  
+  desc "Print Unicorn systemd service config expanded from the local template"
+  task :print do
+    run :local do
+      command %(echo '#{erb template_path}')
+    end
+  end
+
+  desc "Print current Unicorn systemd service config from remote"
+  task :print_remote do
+    unicorn_systemd_config_path = fetch :unicorn_systemd_config_path
+    command %(cat #{unicorn_systemd_config_path})
+  end
+
+end

data/lib/mina/unicorn/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  module Unicorn
+    VERSION = '0.0.1'.freeze
+  end
+end

data/mina-unicorn_systemd.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina/unicorn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mina-unicorn_systemd'
+  spec.version       = Mina::Unicorn::VERSION
+  spec.authors       = ['coezbek']
+  spec.email         = ['c.oezbek@gmail.com']
+  spec.summary       = %(Mina tasks for Unicorn setup and deployment.)
+  spec.description   = %(Mina-deploy tasks to enable easy setup and deployment of unicorn application server managed via systemd)
+  spec.homepage      = 'https://github.com/hbin/mina-unicorn_systemd.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  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 'mina', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: mina-unicorn_systemd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- coezbek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Mina-deploy tasks to enable easy setup and deployment of unicorn application
+  server managed via systemd
+email:
+- c.oezbek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mina/templates/unicorn.service.erb
+- lib/mina/unicorn.rb
+- lib/mina/unicorn/version.rb
+- mina-unicorn_systemd.gemspec
+homepage: https://github.com/hbin/mina-unicorn_systemd.git
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Mina tasks for Unicorn setup and deployment.
+test_files: []