nginxinator 0.2.0 → 0.2.1

data/lib/nginxinator/built-in.rb

@@ -0,0 +1,20 @@
+set :webserver_log_level,           "info"
+set :webserver_config_files,        ["nginx.conf", "ssl.crt", "ssl.key", "mime.types"]
+set :webserver_data_path,           -> { current_path }
+set :webserver_logs_path,           -> { shared_path.join('log') }
+set :webserver_config_path,         -> { shared_path.join('nginx') }
+set :webserver_socket_path,         -> { shared_path.join('run') }
+set :webserver_templates_path,      "templates/nginx"
+set :webserver_container_name,      -> { "#{fetch(:domain)}-nginx-#{fetch(:webserver_publish_ports).join('-')}" }
+set :webserver_ports_options,       -> { fetch(:webserver_publish_ports).collect { |p| ["--publish", "0.0.0.0:#{p}:#{p}"] }.flatten }
+
+def webserver_run(host)
+  execute("docker", "run", "--detach", "--tty",
+    "--name",   fetch(:webserver_container_name),
+    "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
+    "--entrypoint", "/usr/sbin/nginx",
+    "--restart", "always",
+    fetch(:webserver_ports_options),
+    fetch(:webserver_image_name),
+    "-c", shared_path.join('nginx', 'nginx.conf'))
+end

data/lib/nginxinator/config.rb

@@ -1,24 +1,107 @@
+module Capistrano
+  module TaskEnhancements
+    alias_method :nginx_original_default_tasks, :default_tasks
+    def default_tasks
+      nginx_original_default_tasks + [
+        "nginxinator:write_built_in",
+        "nginxinator:write_example_configs",
+        "nginxinator:write_example_configs:in_place"
+      ]
+    end
+  end
+end
+
 namespace :nginxinator do
 
-  desc 'Write example config files'
+  set :example, "_example"
+
+  desc "Write example config files (with '_example' appended to their names)."
   task :write_example_configs do
     run_locally do
-      execute "mkdir", "-p", "config/deploy", "templates/nginx"
+      execute "mkdir", "-p", "config/deploy", fetch(:webserver_templates_path, 'templates/nginx')
       {
-        'examples/Capfile'                              => 'Capfile_example',
-        'examples/config/deploy.rb'                     => 'config/deploy_example.rb',
-        'examples/config/deploy/staging.rb'             => 'config/deploy/staging_example.rb',
-        'examples/Dockerfile'                           => 'templates/nginx/Dockerfile_example',
-        'examples/nginx.conf.erb'                       => 'templates/nginx/nginx_example.conf.erb',
-        'examples/ssl.crt.erb'                          => 'templates/nginx/ssl.crt_example.erb',
-        'examples/ssl.key.erb'                          => 'templates/nginx/ssl.key_example.erb',
-        'examples/mime.types.erb'                       => 'templates/nginx/mime.types_example.erb'
+        "examples/Capfile"                    => "Capfile#{fetch(:example)}",
+        "examples/config/deploy.rb"           => "config/deploy#{fetch(:example)}.rb",
+        "examples/config/deploy/staging.rb"   => "config/deploy/staging#{fetch(:example)}.rb",
+        "examples/Dockerfile"                 => "#{fetch(:webserver_templates_path, 'templates/nginx')}/Dockerfile#{fetch(:example)}",
+        "examples/nginx.conf.erb"             => "#{fetch(:webserver_templates_path, 'templates/nginx')}/nginx#{fetch(:example)}.conf.erb",
+        "examples/ssl.crt.erb"                => "#{fetch(:webserver_templates_path, 'templates/nginx')}/ssl.crt#{fetch(:example)}.erb",
+        "examples/ssl.key.erb"                => "#{fetch(:webserver_templates_path, 'templates/nginx')}/ssl.key#{fetch(:example)}.erb",
+        "examples/mime.types.erb"             => "#{fetch(:webserver_templates_path, 'templates/nginx')}/mime.types#{fetch(:example)}.erb"
       }.each do |source, destination|
         config = File.read(File.dirname(__FILE__) + "/#{source}")
         File.open("./#{destination}", 'w') { |f| f.write(config) }
         info "Wrote '#{destination}'"
       end
-      info "Now remove the '_example' portion of their names or diff with existing files and add the needed lines."
+      unless fetch(:example).empty?
+        info "Now remove the '#{fetch(:example)}' portion of their names or diff with existing files and add the needed lines."
+      end
+    end
+  end
+
+  desc 'Write example config files (will overwrite any existing config files).'
+  namespace :write_example_configs do
+    task :in_place do
+      set :example, ""
+      Rake::Task['nginxinator:write_example_configs'].invoke
+    end
+  end
+
+  desc 'Write a file showing the built-in overridable settings.'
+  task :write_built_in do
+    run_locally do
+      {
+        'built-in.rb'                         => 'built-in.rb',
+      }.each do |source, destination|
+        config = File.read(File.dirname(__FILE__) + "/#{source}")
+        File.open("./#{destination}", 'w') { |f| f.write(config) }
+        info "Wrote '#{destination}'"
+      end
+      info "Now examine the file and copy-paste into your deploy.rb or <stage>.rb and customize."
+    end
+  end
+
+  # These are the only two tasks using :preexisting_ssh_user
+  namespace :deployment_user do
+    #desc "Setup or re-setup the deployment user, idempotently"
+    task :setup do
+      on roles(:all) do |h|
+        on "#{fetch(:preexisting_ssh_user)}@#{h}" do |host|
+          as :root do
+            deployment_user_setup(fetch(:webserver_templates_path))
+          end
+        end
+      end
+    end
+  end
+
+  task :deployment_user do
+    on roles(:all) do |h|
+      on "#{fetch(:preexisting_ssh_user)}@#{h}" do |host|
+        as :root do
+          if unix_user_exists?(fetch(:deployment_username))
+            info "User #{fetch(:deployment_username)} already exists. You can safely re-setup the user with 'nginxinator:deployment_user:setup'."
+          else
+            Rake::Task['nginxinator:deployment_user:setup'].invoke
+          end
+        end
+      end
+    end
+  end
+
+  task :webserver_user do
+    on roles(:app) do
+      as :root do
+        unix_user_add(fetch(:webserver_username)) unless unix_user_exists?(fetch(:webserver_username))
+      end
+    end
+  end
+
+  task :file_permissions => [:deployment_user, :webserver_user] do
+    on roles(:app) do
+      as :root do
+        setup_file_permissions
+      end
     end
   end
 

data/lib/nginxinator/examples/Capfile

@@ -2,7 +2,7 @@
 require 'capistrano/setup'
 
 # Includes default deployment tasks
-require 'capistrano/deploy'
+#require 'capistrano/deploy'
 
 # Includes tasks from other gems included in your Gemfile
 #

data/lib/nginxinator/examples/config/deploy/staging.rb

@@ -1,13 +1,9 @@
+##### nginxinator
+### ------------------------------------------------------------------
 set :domain,                        "my-app.example.com"
-set :user_host,                     "#{fetch(:deployment_username)}@#{fetch(:domain)}"
-
-role :app,                          fetch(:user_host)
-role :web,                          fetch(:user_host)
-role :db,                           fetch(:user_host)
-
-
-# nginxinator
-#--------------------------------------------------------------------------
+server fetch(:domain),
+  :user                             => fetch(:deployment_username),
+  :roles                            => ["app", "web", "db"]
 set :webserver_publish_ports,       ["80", "443"]
 set :webserver_image_name,          "snarlysodboxer/nginx:0.0.0"
-#--------------------------------------------------------------------------
+### ------------------------------------------------------------------

data/lib/nginxinator/examples/config/deploy.rb

@@ -1,27 +1,14 @@
-# config valid only for Capistrano 3.1
+# config valid only for Capistrano 3.2.1
 lock '3.2.1'
 
+##### nginxinator
+### ------------------------------------------------------------------
+set :application,                   "my_app_name"
 set :preexisting_ssh_user,          ENV['USER']
 set :deployment_username,           "deployer"
 set :webserver_username,            "www-data"
-set :webserver_config_files,        ["nginx.conf", "ssl.crt", "ssl.key", "mime.types"]
-set :webserver_data_path,           current_path
-set :webserver_logs_path,           shared_path.join('log')
-set :webserver_config_path,         shared_path.join('nginx')
-set :webserver_socket_path,         shared_path.join('run')
-set :webserver_writeable_dirs,      [shared_path.join('run'), shared_path.join('log')]
+set :webserver_owned_dirs,          [shared_path.join('tmp', 'cache'), shared_path.join('public', 'assets')]
+set :webserver_writeable_dirs,      [shared_path.join('run'), shared_path.join('tmp'), shared_path.join('log')]
 set :webserver_executable_dirs,     [shared_path.join('bundle', 'bin')]
 set :ignore_permissions_dirs,       [shared_path.join('postgres'), shared_path.join('nginx')]
-set :webserver_container_name,      -> { "#{fetch(:domain)}-nginx-#{fetch(:webserver_publish_ports).join('-')}" }
-set :webserver_ports_options,       -> { fetch(:webserver_publish_ports).collect { |p| ["--publish", "0.0.0.0:#{p}:#{p}"] }.flatten }
-set :webserver_docker_run_command,  -> { [
-  "--detach", "--tty",
-  "--name",   fetch(:webserver_container_name),
-  "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
-  "--entrypoint", "/usr/sbin/nginx",
-  "--restart", "always",
-  fetch(:webserver_ports_options),
-  fetch(:webserver_image_name),
-  "-c", shared_path.join('nginx', 'nginx.conf')
-].flatten }
-set :local_templates_path,          "templates/nginx"
+### ------------------------------------------------------------------

data/lib/nginxinator/nginx.rb

@@ -1,24 +1,30 @@
 namespace :nginx do
 
+  task :ensure_setup => ['nginxinator:deployment_user', 'nginxinator:webserver_user', 'deployinator:sshkit_umask'] do
+    SSHKit.config.output_verbosity = fetch(:webserver_log_level)
+  end
+
   desc "Idempotently setup an Nginx instance."
-  task :setup => ['deployinator:deployment_user', 'deployinator:webserver_user', 'deployinator:sshkit_umask'] do
+  task :setup => [:ensure_setup] do
     Rake::Task['nginx:open_firewall'].invoke
     # 'on', 'run_locally', 'as', 'execute', 'info', 'warn', and 'fatal' are from SSHKit
-    on roles(:app) do
+    on roles(:app) do |host|
       as :root do
         set :config_file_changed, false
         Rake::Task['nginx:install_config_files'].invoke
-        Rake::Task['deployinator:file_permissions'].invoke
-        unless container_exists?(fetch(:webserver_container_name))
-          create_container(fetch(:webserver_container_name), fetch(:webserver_docker_run_command))
+        Rake::Task['nginxinator:file_permissions'].invoke
+        name = fetch(:webserver_container_name)
+        unless container_exists?(name)
+          warn "Starting a new container named #{name} on #{host}"
+          webserver_run(host)
         else
-          unless container_is_running?(fetch(:webserver_container_name))
-            start_container(fetch(:webserver_container_name))
+          unless container_is_running?(name)
+            start_container(name)
           else
             if fetch(:config_file_changed)
-              restart_container(fetch(:webserver_container_name))
+              restart_container(name)
             else
-              info "No config file changes for #{fetch(:webserver_container_name)} and it is already running; we're setup!"
+              info "No config file changes for #{name} and it is already running; we're setup!"
             end
           end
         end
@@ -27,34 +33,35 @@ namespace :nginx do
   end
 
   desc "Check the status of the Nginx instance."
-  task :status => ['deployinator:deployment_user'] do
+  task :status => [:ensure_setup] do
     on roles(:app) do
       info ""
-      if container_exists?(fetch(:webserver_container_name))
-        info "#{fetch(:webserver_container_name)} exists on #{fetch(:domain)}"
+      name = fetch(:webserver_container_name)
+      if container_exists?(name)
+        info "#{name} exists on #{fetch(:domain)}"
         info ""
-        if container_is_running?(fetch(:webserver_container_name))
-          info "#{fetch(:webserver_container_name)} is running on #{fetch(:domain)}"
+        if container_is_running?(name)
+          info "#{name} is running on #{fetch(:domain)}"
           info ""
         else
-          info "#{fetch(:webserver_container_name)} is not running on #{fetch(:domain)}"
+          info "#{name} is not running on #{fetch(:domain)}"
           info ""
         end
       else
-        info "#{fetch(:webserver_container_name)} does not exist on #{fetch(:domain)}"
+        info "#{name} does not exist on #{fetch(:domain)}"
         info ""
       end
     end
   end
 
-  task :install_config_files => ['deployinator:deployment_user', 'deployinator:webserver_user', 'deployinator:sshkit_umask'] do
-    require 'erb'
+  task :install_config_files => [:ensure_setup] do
+    require 'erb' unless defined?(ERB)
     on roles(:app) do
       as 'root' do
         execute "mkdir", "-p", fetch(:webserver_socket_path),
           fetch(:webserver_logs_path), fetch(:webserver_config_path)
         fetch(:webserver_config_files).each do |config_file|
-          template_path = File.expand_path("#{fetch(:local_templates_path)}/#{config_file}.erb")
+          template_path = File.expand_path("#{fetch(:webserver_templates_path)}/#{config_file}.erb")
           generated_config_file = ERB.new(File.new(template_path).read).result(binding)
           upload! StringIO.new(generated_config_file), "/tmp/#{config_file}.file"
           unless test "diff", "-q", "/tmp/#{config_file}.file", "#{fetch(:webserver_config_path)}/#{config_file}"
@@ -65,7 +72,6 @@ namespace :nginx do
             execute "rm", "/tmp/#{config_file}.file"
           end
         end
-        #execute("chown", "-R", "#{fetch(:deployment_user_id)}:#{fetch(:webserver_user_id)}", fetch(:webserver_config_path))
         execute("chown", "-R", "root:root", fetch(:webserver_config_path))
         execute "find", fetch(:webserver_config_path), "-type", "d", "-exec", "chmod", "2775", "{}", "+"
         execute "find", fetch(:webserver_config_path), "-type", "f", "-exec", "chmod", "0600", "{}", "+"
@@ -73,7 +79,7 @@ namespace :nginx do
     end
   end
 
-  task :open_firewall do
+  task :open_firewall => [:ensure_setup] do
     on roles(:app) do
       as "root" do
         if test "bash", "-c", "\"ufw", "status", "&>" "/dev/null\""

data/lib/nginxinator.rb

@@ -3,4 +3,5 @@ require 'capistrano/setup'
 load 'nginxinator/nginx.rb'
 load 'nginxinator/config.rb'
 load 'nginxinator/check.rb'
+load 'nginxinator/built-in.rb'
 load 'deployinator/helpers.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nginxinator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.1
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.1
 - !ruby/object:Gem::Dependency
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,13 +42,13 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 10.3.2
   type: :runtime
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 10.3.2
 - !ruby/object:Gem::Dependency
@@ -64,7 +64,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
@@ -72,10 +72,10 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.1
-description: An Opinionated Nginx Deployment gem
+description: Deploy Nginx instances using Capistrano and Docker
 email: davidamick@ctisolutionsinc.com
 executables: []
 extensions: []
@@ -85,6 +85,7 @@ files:
 - lib/nginxinator/nginx.rb
 - lib/nginxinator/config.rb
 - lib/nginxinator/check.rb
+- lib/nginxinator/built-in.rb
 - lib/nginxinator/examples/Capfile
 - lib/nginxinator/examples/config/deploy.rb
 - lib/nginxinator/examples/config/deploy/staging.rb
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- Docker ~1.3.1
+- Docker ~> 1.3.1
 rubyforge_project: 
 rubygems_version: 1.8.23.2
 signing_key: