capistrano-unicorn-nginx 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 758cd1020049cc4d33a1539020d9a70c6c941f4d
-  data.tar.gz: 9a03ad07a95c3b03e88242d86c00126002cce252
+  metadata.gz: d07f364efb0a3c692f5a90e291944f3039f0a0a0
+  data.tar.gz: 261aa7183d26027881a31024196e536f478f59d2
 SHA512:
-  metadata.gz: dd12187184bb0853faf8b88e9ce7130bf0955cc0e9f51dc0dbace706ffcad472f05a51a8100d27f278b5bb934e99b4052a3e4ebd9309b79966b66c7047bdf005
-  data.tar.gz: 2ef806960ca72c9ff39c7b7c3d80cf697b8f0f23ba7a9053540eb2287f782a630966c363e2af7ab1b8bc00956354e25b6ba276382081df93cc2c15a484eeb10e
+  metadata.gz: 1afb2f016b9c6859c722daacc25ab981959dc87834da8d0a76f2add162587d3afaabff5ce3d7230446c43df74ba98a7cf0ceb5a5499310ff5975cbe46e562166
+  data.tar.gz: e0cd00708bb708bcedd7412b82c448815f6ef49702552ed5523e9a307a353a37cc3c71c0aa021196ad57f2e783f6f71234864755f7bae54061ca7b76f789b11c

data/CHANGELOG.md

@@ -2,17 +2,27 @@
 
 ### master
 
+### v3.0.0, 2014-10-05
+- enable setting unicorn app environment with `rails_env` option.
+  If `rails_env` is not set, `stage` option is used as until now. (@bruno-)
+- add load balancing support (@rhomeister)
+- config files are updated each time `setup` task is run (@rhomeister)
+
 ### v2.1.0, 2014-08-05
 - add `nginx_location` option that specifies nginx installation dir
   (@jordanyaker)
+
 ### v2.0.0, 2014-04-11
 - all the work is moved to the `setup` task
+
 ### v1.0.2, 2014-03-30
 - add `sudo_upload!` helper method for easier uploads
 - improve the way how templates are handled
+
 ### v1.0.1, 2014-03-30
 - refactor all unicorn and nginx paths to separate modules
 - speed up `nginx:setup_ssl` task
 - small README update
+
 ### v1.0.0, 2014-03-29
 - @bruno- all the v1.0.0 features

data/README.md

@@ -7,30 +7,26 @@ Goals of this plugin:
 * automatic unicorn and nginx configuration for Rails apps
 * **no manual ssh** to the server required
 * zero downtime deployments enabled
+* support for single node as well as cluster deployments
 
 Specifics:
 
-* generates nginx config file on the server
-* generates unicorn initializer and config files<br/>
+* generates nginx config file on the server (web role)
+* generates unicorn initializer and config files (app role)<br/>
 application is started automatically after server restart
 * capistrano tasks for server management, example: `unicorn:restart`<br/>
 see below for all available tasks
+* automatic load balancing setup when there are multiple `app` nodes
 
 `capistrano-unicorn-nginx` works only with Capistrano 3!
 
-This project was based on
-[capistrano-nginx-unicorn](https://github.com/kalys/capistrano-nginx-unicorn).
-I contributed a lot to Capistrano 3 version of that plugin. In the end I
-decided to create my own project to bring in additional improvements, without
-having to ask for permissions and wait for merging.
-
 ### Installation
 
 Add this to `Gemfile`:
 
     group :development do
-      gem 'capistrano', '~> 3.1'
-      gem 'capistrano-unicorn-nginx', '~> 2.0'
+      gem 'capistrano', '~> 3.2.1'
+      gem 'capistrano-unicorn-nginx', '~> 3.0.0'
     end
 
 And then:
@@ -39,169 +35,38 @@ And then:
 
 ### Setup and usage
 
-Add this line to `Capfile`
-
-    require 'capistrano/unicorn_nginx'
-
-Only if you already have a domain for your app, set `nginx_server_name` in
-stage file, example `config/deploy/production.rb`:
-
-    set :nginx_server_name, 'mydomain.com'
-
-If you don't have a domain yet, you do not have to do anything
-(`nginx_server_name` will use the default value - server IP).
-
-**SSL only setup**
-
-If you want to setup SSL for your page, add these options to stage file
-(i.e. `config/deploy/production.rb`):
-
-    # ignore this if you do not need SSL
-    set :nginx_use_ssl, true
-    set :nginx_ssl_cert_local_path, "/path/to/ssl_cert.crt"
-    set :nginx_ssl_cert_key_local_path, "/path/to/ssl_cert.key"
-
-And you're all set!
-
-**Setup task**
-
-Make sure the `deploy_to` path exists and has the right privileges on the
-server (i.e. `/var/www/myapp`).<br/>
-Or just install
-[capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)
-plugin and don't think about it.
+Depending on your needs 2 general scenarios are covered:
 
-To setup the server for unicorn and nginx, run:
-
-    $ bundle exec cap production setup
+- [single server setup](https://github.com/capistrano-plugins/capistrano-unicorn-nginx/wiki/Single-server-setup)<br/>
+  A scenario where you run the webserver (nginx) and application server
+  (unicorn) on the same node.
+- [multiple server setup](https://github.com/capistrano-plugins/capistrano-unicorn-nginx/wiki/Multiple-server-setup)<br/>
+  Webserver (nginx) and application server (unicorn) run on different nodes.
 
 ### Configuration
 
-As described in the Usage section, this plugin works with minimal setup.
-However, configuration is possible.
-
-You'll find the options and their defaults below.
-
-In order to override the default, put the option in the stage file, for example:
-
-    # in config/deploy/production.rb
-    set :unicorn_workers, 4
-
-**Nginx options**
-
-Defaults are listed near option name in the first line.
-
-- `set :nginx_server_name` # defaults to <server_IP><br/>
-Your application's domain. The default is your server's IP address.
-
-- `set :nginx_pid, "/run/nginx.pid"`<br/>
-Path for nginx process pid file.
-
-- `set :nginx_location, "/etc/nginx"`<br/>
-Nginx installation directory.
-
-SSL related options:
-
-- `set :nginx_use_ssl, false`<br/>
-If set to `true`, nginx will be configured to 443 port and port 80 will be auto
-routed to 443. Also, on `nginx:setup`, paths to ssl certificate and key will be
-configured. Certificate file and key will be uploaded to `/etc/ssl/certs/`
-and `/etc/ssl/private/` directories on the server.
-
-- `set :nginx_upload_local_cert, true`<br/>
-If `true`, certificates will be uploaded from a local path. Otherwise, it
-is expected for the certificate and key defined in the next 2 variables to be
-already on the server.
-
-- `set :nginx_ssl_cert, "#{fetch(:nginx_server_name)}.crt"`<br/>
-Remote file name of the certificate. Only makes sense if `nginx_use_ssl` is set.
-
-- `set :nginx_ssl_cert_key, "#{fetch(:nginx_server_name)}.key"`<br/>
-Remote file name of the certificate. Only makes sense if `nginx_use_ssl` is set.
-
-- `set :nginx_ssl_cert_local_path` # no default, required if
-`nginx_use_ssl = true` and `nginx_upload_local_cert = true`<br/>
-Local path to file with certificate. Only makes sense if `nginx_use_ssl` is
-set. This file will be copied to remote server. Example value:
-`set :nginx_ssl_cert_local_path, "/home/user/ssl/myssl.cert"`
-
-- `set :nginx_ssl_cert_key_local_path` # no default<br/>
-Local path to file with certificate key. Only makes sense if `nginx_use_ssl` is set.
-This file will be copied to remote server. Example value:
-`set :nginx_ssl_cert_key_local_path, "/home/user/ssl/myssl.key"`
-
-**Unicorn options**
-
-Defaults are listed near option name in the first line.
-
-- `set :unicorn_service, "unicorn_#{fetch(:application)}_#{fetch(:stage)}`<br/>
-Unicorn service name is `unicorn_myapp_production` by default.
-
-- `set :unicorn_pid, shared_path.join("tmp/pids/unicorn.pid")`<br/>
-Path for unicorn process pid file.
-
-- `set :unicorn_config, shared_path.join("config/unicorn.rb")`<br/>
-Path for unicorn config file.
-
-- `set :unicorn_workers, 2`<br/>
-Number of unicorn workers.
+See the
+[full options list on the wiki page](https://github.com/capistrano-plugins/capistrano-unicorn-nginx/wiki/Configuration).
+Feel free to skip this unless you're looking for something specific.
 
 ### How it works
 
-Here's what happens when you run `$ bundle exec cap production setup`:
+[How it works wiki page](https://github.com/capistrano-plugins/capistrano-unicorn-nginx/wiki/How-it-works)
+contains the list of tasks that the plugin executes.
 
-**Nginx**
-
-- `nginx:setup`<br/>
-Generates and uploads nginx config file. Symlinks config file to
-`/etc/nginx/sites-enabled`.
-- `nginx:setup_ssl`<br/>
-Performs SSL related tasks if `nginx_use_ssl` is true (false by default).
-
-**Unicorn**
-
-- `unicorn:setup_initializer`<br/>
-Uploads unicorn initializer file.
-- `unicorn:setup_app_config`<br/>
-Generates unicorn application config file
-
-**Capistrano `deploy` task**
-
-This plugin also integrates seamlessly with Capistrano `deploy` task.
-Here's what happens when you run `$ bundle exec cap production deploy`:
-
-- `after :publishing, "nginx:reload"`<br/>
-Reloads nginx.
-- `after :publishing, "unicorn:restart"`<br/>
-Restarts unicorn after new release.
+You do not have to know this unless you want to learn more about the plugin internals.
 
 ### Template customization
 
-If you want to change default templates, you can generate them using
-`rails generator`:
-
-    $ bundle exec rails g capistrano:unicorn_nginx:config
-
-This will copy default templates to `config/deploy/templates` directory, so you
-can customize them as you like, and capistrano tasks will use this templates
-instead of default.
+[On template customization wiki page](https://github.com/capistrano-plugins/capistrano-unicorn-nginx/wiki/Template-customization)
+see how to inspect, tweak and override templates for `nginx` and `unicorn`
+config files.
 
-You can also provide path, where to generate templates:
-
-    $ bundle exec rails g capistrano:unicorn_nginx:config config/templates
+Do not do this unless you have a specific need.
 
 ### More Capistrano automation?
 
-If you'd like to streamline your Capistrano deploys, you might want to check
-these zero-configuration, plug-n-play plugins:
-
-- [capistrano-postgresql](https://github.com/bruno-/capistrano-postgresql)<br/>
-plugin that automates postgresql configuration and setup
-- [capistrano-rbenv-install](https://github.com/bruno-/capistrano-rbenv-install)<br/>
-would you like Capistrano to install rubies for you?
-- [capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)<br/>
-if you're annoyed that Capistrano does **not** create a deployment path for the
-app on the server (default `/var/www/myapp`), this is what you need!
+Check out [capistrano-plugins](https://github.com/capistrano-plugins) github org.
 
 ### Bug reports and pull requests
 

data/lib/capistrano/tasks/nginx.rake

@@ -31,10 +31,27 @@ namespace :nginx do
     end
   end
 
+  # this is needed when the web role is a non release role -> deploy directories are not created, and nginx log files
+  # are written to "#{deploy_path}/shared/log/"
+  desc "Create the nginx log directory"
+  task :create_log_dir do
+    on roles :web do
+      # create the deploy_to, shared_path and the directory in which the nginx_access_log_file resides.
+      # We need to be conservative and ensure that all are created with the correct ownership: it could happen that
+      # web does become a release role later, in which case the ownerships need to be correct.
+      [deploy_path, shared_path, File.dirname(nginx_access_log_file)].each do |dir|
+        next if file_exists? dir
+        sudo :mkdir, '-pv', dir
+        user = capture :id, '-un'
+        group = capture :id, '-gn'
+        sudo :chown, "#{user}:#{group}", dir
+      end
+    end
+  end
+
   desc 'Setup nginx configuration'
-  task :setup do
+  task setup: [:create_log_dir] do
     on roles :web do
-      next if file_exists? nginx_sites_available_file
       sudo_upload! template('nginx_conf.erb'), nginx_sites_available_file
       sudo :ln, '-fs', nginx_sites_available_file, nginx_sites_enabled_file
     end

data/lib/capistrano/tasks/unicorn.rake

@@ -11,6 +11,9 @@ namespace :load do
     set :unicorn_pid, -> { unicorn_default_pid_file }
     set :unicorn_config, -> { unicorn_default_config_file }
     set :unicorn_workers, 2
+    set :unicorn_tcp_listen_port, 8080
+    set :unicorn_use_tcp, -> { roles(:app).count > 1}  # use tcp if there are multiple app nodes
+    set :unicorn_app_env, -> { fetch(:rails_env) || fetch(:stage) }
     # set :unicorn_user # default set in `unicorn:defaults` task
 
     set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids')
@@ -28,7 +31,6 @@ namespace :unicorn do
   desc 'Setup Unicorn initializer'
   task :setup_initializer do
     on roles :app do
-      next if file_exists? unicorn_initd_file
       sudo_upload! template('unicorn_init.erb'), unicorn_initd_file
       execute :chmod, '+x', unicorn_initd_file
       sudo 'update-rc.d', '-f', fetch(:unicorn_service), 'defaults'
@@ -38,7 +40,6 @@ namespace :unicorn do
   desc 'Setup Unicorn app configuration'
   task :setup_app_config do
     on roles :app do
-      next if file_exists? fetch(:unicorn_config)
       execute :mkdir, '-pv', File.dirname(fetch(:unicorn_config))
       upload! template('unicorn.rb.erb'), fetch(:unicorn_config)
     end

data/lib/capistrano/unicorn_nginx/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module UnicornNginx
-    VERSION = "2.1.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/generators/capistrano/unicorn_nginx/templates/nginx_conf.erb

@@ -1,5 +1,11 @@
 upstream unicorn_<%= fetch(:nginx_config_name) %> {
+<% if fetch(:unicorn_use_tcp) %>
+  <% roles(:app).each do |role| %>
+    server <%= role.hostname %>:<%= fetch(:unicorn_tcp_listen_port)%> fail_timeout=0;
+  <% end %>
+<% else %>
   server unix:/tmp/unicorn.<%= fetch(:nginx_config_name) %>.sock fail_timeout=0;
+<% end %>
 }
 
 <% if fetch(:nginx_use_ssl) %>

data/lib/generators/capistrano/unicorn_nginx/templates/unicorn.rb.erb

@@ -3,7 +3,12 @@ pid "<%= fetch(:unicorn_pid) %>"
 stdout_path "<%= unicorn_log_file %>"
 stderr_path "<%= unicorn_error_log_file %>"
 
+<% if fetch(:unicorn_use_tcp) %>
+listen <%= fetch(:unicorn_tcp_listen_port) %>
+<% else %>
 listen "/tmp/unicorn.<%= fetch(:nginx_config_name) %>.sock"
+<% end %>
+
 worker_processes <%= fetch(:unicorn_workers) %>
 timeout 30
 

data/lib/generators/capistrano/unicorn_nginx/templates/unicorn_init.erb

@@ -15,9 +15,9 @@ TIMEOUT=${TIMEOUT-60}
 APP_ROOT=<%= current_path %>
 PID=<%= fetch(:unicorn_pid) %>
 
-CMD="cd $APP_ROOT && <%= bundle_unicorn("-D -c", fetch(:unicorn_config), "-E", fetch(:stage)) %>"
-
 AS_USER=<%= fetch(:unicorn_user) %>
+CMD="export HOME; true "${HOME:=$(getent passwd "$AS_USER" | cut -d: -f6;)}" ; cd $APP_ROOT && <%= bundle_unicorn("-D -c", fetch(:unicorn_config), "-E", fetch(:unicorn_app_env)) %>"
+
 set -u
 
 OLD_PIN="$PID.oldbin"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-unicorn-nginx
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Bruno Sutic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano