nginxinator 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b829943382a3708dfe4e28c665d8fe93d65168cd
+  data.tar.gz: c055ef06028e3bf7bcdca0ccd2c77d7745816ef4
+SHA512:
+  metadata.gz: 1ce2ff7f57db5da8c751ed6756ac3cab26598b5285763793e86d6d25139e73abb1bb637a6ee15e744a0a8d342fa16ae370b32d5ebaf3bd1d2303c5612773e3b9
+  data.tar.gz: 15184a3635cb2ffaf163002b9da4567ea6957f6e14fb139c77195c2f0f7fb12cfa4eb7bea967db1d266f2e011c2b9fa8a623906df4311add5df002f63ce4bd4f

data/lib/nginxinator.rb

@@ -0,0 +1,6 @@
+require 'rake'
+require 'sshkit'
+require 'sshkit/dsl'
+
+load 'nginxinator/nginx.rb'
+load 'nginxinator/config.rb'

data/lib/nginxinator/config.rb

@@ -0,0 +1,30 @@
+namespace :nginx do
+
+  task :ensure_setup do |t, args|
+    @settings = NginxInstance.new
+    # use 'rake pg:COMMAND debug=true' for debugging (you can also add --trace if you like)
+    SSHKit.config.output_verbosity = Logger::DEBUG if ENV['debug'] == "true"
+  end
+
+  desc 'Write example config files'
+  task :write_example_configs do
+    run_locally do
+      execute "mkdir -p templates/nginx/sites-enabled"
+      {
+        'examples/Dockerfile'               => 'Dockerfile_example',
+        'examples/nginxinator_example.rb'   => 'nginxinator_example.rb',
+        'examples/nginx_example.conf.erb'   => 'templates/nginx/nginx_example.conf.erb',
+        'examples/site-enabled_example.erb' => 'templates/nginx/sites-enabled/client-app_example.erb',
+        'examples/ssl.crt_example.erb'      => 'templates/nginx/ssl.crt_example.erb',
+        'examples/ssl.key_example.erb'      => 'templates/nginx/ssl.key_example.erb',
+        'examples/mime.types_example.erb'   => 'templates/nginx/mime.types_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."
+    end
+  end
+
+end

data/lib/nginxinator/examples/Dockerfile

@@ -0,0 +1,10 @@
+# vi: ft=config
+FROM ubuntu:12.04
+MAINTAINER david amick <docker@davidamick.com>
+
+ENV DEBIAN_FRONTEND noninteractive
+
+RUN /bin/bash -l -c "apt-get update -qq && apt-get install -qy nginx"
+
+ENTRYPOINT ["/usr/sbin/nginx"]
+CMD ["-c", "/etc/nginx/nginx.conf"]

data/lib/nginxinator/examples/mime.types_example.erb

@@ -0,0 +1,79 @@
+types {
+        text/html                               html htm shtml;
+        text/css                                css;
+        text/xml                                xml rss;
+        image/gif                               gif;
+        image/jpeg                              jpeg jpg;
+        application/x-javascript                js;
+        application/atom+xml                    atom;
+
+        text/mathml                             mml;
+        text/plain                              txt;
+        text/vnd.sun.j2me.app-descriptor        jad;
+        text/vnd.wap.wml                        wml;
+        text/x-component                        htc;
+
+        image/png                               png;
+        image/tiff                              tif tiff;
+        image/vnd.wap.wbmp                      wbmp;
+        image/x-icon                            ico;
+        image/x-jng                             jng;
+        image/x-ms-bmp                          bmp;
+        image/svg+xml                           svg svgz;
+
+        application/java-archive                jar war ear;
+        application/json                        json;
+        application/mac-binhex40                hqx;
+        application/msword                      doc;
+        application/pdf                         pdf;
+        application/postscript                  ps eps ai;
+        application/rtf                         rtf;
+        application/vnd.ms-excel                xls;
+        application/vnd.ms-powerpoint           ppt;
+        application/vnd.wap.wmlc                wmlc;
+        application/vnd.google-earth.kml+xml    kml;
+        application/vnd.google-earth.kmz        kmz;
+        application/x-7z-compressed             7z;
+        application/x-cocoa                     cco;
+        application/x-java-archive-diff         jardiff;
+        application/x-java-jnlp-file            jnlp;
+        application/x-makeself                  run;
+        application/x-perl                      pl pm;
+        application/x-pilot                     prc pdb;
+        application/x-rar-compressed            rar;
+        application/x-redhat-package-manager    rpm;
+        application/x-sea                       sea;
+        application/x-shockwave-flash           swf;
+        application/x-stuffit                   sit;
+        application/x-tcl                       tcl tk;
+        application/x-x509-ca-cert              der pem crt;
+        application/x-xpinstall                 xpi;
+        application/xhtml+xml                   xhtml;
+        application/zip                         zip;
+
+        application/octet-stream                bin exe dll;
+        application/octet-stream                deb;
+        application/octet-stream                dmg;
+        application/octet-stream                eot;
+        application/octet-stream                iso img;
+        application/octet-stream                msi msp msm;
+        application/ogg                         ogx;
+
+        audio/midi                              mid midi kar;
+        audio/mpeg                              mpga mpega mp2 mp3 m4a;
+        audio/ogg                               oga ogg spx;
+        audio/x-realaudio                       ra;
+        audio/webm                              weba;
+
+        video/3gpp                              3gpp 3gp;
+        video/mp4                               mp4;
+        video/mpeg                              mpeg mpg mpe;
+        video/ogg                               ogv;
+        video/quicktime                         mov;
+        video/webm                              webm;
+        video/x-flv                             flv;
+        video/x-mng                             mng;
+        video/x-ms-asf                          asx asf;
+        video/x-ms-wmv                          wmv;
+        video/x-msvideo                         avi;
+}

data/lib/nginxinator/examples/nginx_example.conf.erb

@@ -0,0 +1,39 @@
+# deamon off is imporant to keep the docker container running
+daemon off;
+
+user www-data;
+worker_processes  4;
+
+error_log  <%= @settings.internal_logs_path %>/error.log warn;
+pid        /var/run/nginx.pid;
+
+events {
+  worker_connections  2048;
+}
+
+http {
+  include     <%= @settings.internal_conf_path %>/mime.types;
+  default_type  application/octet-stream;
+
+  access_log	<%= @settings.internal_logs_path %>/access.log;
+
+  sendfile on;
+  tcp_nopush on;
+  tcp_nodelay on;
+
+  keepalive_timeout  65;
+
+  gzip  on;
+  gzip_http_version 1.0;
+  gzip_comp_level 2;
+  gzip_proxied any;
+  gzip_types text/plain text/html text/css application/x-javascript text/xml application/xml application/xml+rss text/javascript;
+
+  server_names_hash_bucket_size 64;
+  types_hash_max_size 2048;
+  types_hash_bucket_size 64;
+
+
+  include <%= @settings.internal_conf_path %>/conf.d/*.conf;
+  include <%= @settings.internal_sites_enabled_path %>/*;
+}

data/lib/nginxinator/examples/nginxinator_example.rb

@@ -0,0 +1,115 @@
+class NginxInstance
+
+  ## For a standard Ubuntu 12.04 Nginx Docker image you should only
+  ##  need to change the following values to get started:
+    def domain
+      "client.example.com"
+    end
+
+    def sites_enabled
+      ['client-app']
+    end
+
+    def publish_ports
+      [
+        {
+          "external" => "80",
+          "internal" => "80"
+        },
+        {
+          "external" => "443",
+          "internal" => "443"
+        }
+      ]
+    end
+
+    def image_name
+      "snarlysodboxer/nginx:0.0.0"
+    end
+
+    def external_data_path
+      "/var/www/current"
+    end
+
+    def external_logs_path
+      "/var/log/nginx"
+    end
+
+
+
+  ## The values below may be commonly changed to match specifics
+  ##  relating to a particular Docker image or setup:
+    def config_files
+      ["nginx.conf", "ssl.crt", "ssl.key", "mime.types"]
+    end
+
+    def internal_data_path
+      "/var/www/current"
+    end
+
+    def internal_conf_path
+      "/etc/nginx"
+    end
+
+    def internal_sites_enabled_path
+      "/etc/nginx/sites-enabled"
+    end
+
+    def internal_logs_path
+      "/var/log/nginx"
+    end
+
+    def internal_sock_path
+      "/var/run/unicorn"
+    end
+
+    def ssh_user
+      ENV["USER"]
+    end
+
+
+
+  ## The values below are not meant to be changed and shouldn't
+  ##  need to be under the majority of circumstances:
+
+  def external_conf_path
+    "/#{container_name}-conf"
+  end
+
+  def external_sites_enabled_path
+    "#{external_conf_path}/sites-enabled"
+  end
+
+  def external_sock_path
+    "#{external_conf_path}/run"
+  end
+
+  def container_name
+    "#{domain}-nginx-#{publish_ports.collect { |p| p['external'] }.join('-')}"
+  end
+
+  def docker_run_command
+    ports_options = []
+    publish_ports.each do |port_set|
+      ports_options += ["--publish", "0.0.0.0:#{port_set['external']}:#{port_set['internal']}"]
+    end
+    [ "--detach", "--tty",
+      "--name",   container_name,
+      "--volume", "#{external_data_path}:#{internal_data_path}:rw",
+      "--volume", "#{external_conf_path}:#{internal_conf_path}:rw",
+      "--volume", "#{external_sock_path}:#{internal_sock_path}:rw",
+      "--volume", "#{external_logs_path}:#{internal_logs_path}:rw",
+      ports_options,
+      image_name
+    ].flatten
+  end
+
+  def local_templates_path
+    "templates/nginx"
+  end
+
+  def local_site_templates_path
+    "#{local_templates_path}/sites-enabled"
+  end
+
+end

data/lib/nginxinator/examples/site-enabled_example.erb

@@ -0,0 +1,65 @@
+upstream unicorn {
+  server unix:<%= @settings.internal_sock_path %>/unicorn.socket fail_timeout=0;
+}
+
+
+server {
+  listen 80;
+  location / {
+    rewrite ^/(.*)$ https://<%= @settings.domain %>/$1 redirect;
+  }
+}
+
+server {
+  listen 443;
+  set $public_root <%= @settings.internal_data_path %>/public;
+  set $rails_root <%= @settings.internal_data_path %>;
+
+  root $public_root;
+
+  ssl on;
+  ssl_certificate <%= @settings.internal_conf_path %>/ssl.crt;
+  ssl_certificate_key <%= @settings.internal_conf_path %>/ssl.key;
+  ssl_ciphers HIGH;
+  ssl_protocols SSLv3 TLSv1;
+  ssl_prefer_server_ciphers on;
+
+  if (-f $document_root/system/maintenance.html) {
+    rewrite  ^(.*)$  /system/maintenance.html last;
+    break;
+  }
+
+  location / {
+    client_max_body_size 4096M;
+    proxy_read_timeout 900;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto https;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_max_temp_file_size 0;
+    proxy_set_header X-Sendfile-Type X-Accel-Redirect;
+    proxy_set_header X-Accel-Remote-Mapping webdav_redirect;
+    proxy_set_header X-Accel-Mapping $rails_root=$rails_root;
+
+    if (-f $request_filename) {
+      expires max;
+      break;
+    }
+
+    if (!-f $request_filename) {
+      proxy_pass http://unicorn;
+      break;
+    }
+  }
+
+  location ~ /files/(.*) {
+    alias $rails_root/$1;
+    internal;
+  }
+
+  error_page 500 502 503 504  /500.html;
+  location = /500.html {
+    root $public_root;
+  }
+}

data/lib/nginxinator/examples/ssl.crt_example.erb

@@ -0,0 +1 @@
+# Remove this line and add your cert here

data/lib/nginxinator/examples/ssl.key_example.erb

@@ -0,0 +1 @@
+# Remove this line and add your key here

data/lib/nginxinator/nginx.rb

@@ -0,0 +1,185 @@
+require 'erb'
+
+require './nginxinator.rb' if File.exists?('./nginxinator.rb')
+
+## NOTES:
+# tasks without 'desc' description lines are for manual debugging of this
+#   deployment code.
+#
+# we've choosen to only pass strings (if anything) to tasks. this allows tasks to be
+#   debugged individually. only private methods take ruby objects.
+
+namespace :nginx do
+
+  desc "Idempotently setup one or more Nginx instances using values in ./nginxinator.rb"
+  task :setup => :ensure_setup do
+    # instance variables are lost inside SSHKit's 'on' block, so
+    #   at the beginning of each task we assign 'settings' to @settings.
+    settings = @settings
+    Rake::Task['nginx:ensure_access_docker'].invoke
+    Rake::Task['nginx:open_firewall'].invoke
+    # 'on', 'run_locally', 'as', 'execute', 'info', 'warn', and 'fatal' are from SSHKit
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      config_file_changed = false
+      settings.config_files.each do |config_file|
+        if config_file_differs?(settings, settings.local_templates_path, settings.external_conf_path, config_file)
+          warn "Config file #{config_file} on #{settings.domain} is being updated."
+          Rake::Task['nginx:install_config_file'].invoke(settings.local_templates_path, settings.external_conf_path, config_file)
+          Rake::Task['nginx:install_config_file'].reenable
+          config_file_changed = true
+        end
+      end
+      settings.sites_enabled.each do |config_file|
+        if config_file_differs?(settings, settings.local_site_templates_path, settings.external_sites_enabled_path, config_file)
+          warn "Config file #{config_file} on #{settings.domain} is being updated."
+          Rake::Task['nginx:install_config_file'].invoke(settings.local_site_templates_path, settings.external_sites_enabled_path, config_file)
+          Rake::Task['nginx:install_config_file'].reenable
+          config_file_changed = true
+        end
+      end
+      unless container_exists?(settings.container_name)
+        Rake::Task['nginx:create_container'].invoke
+      else
+        unless container_is_running?(settings.container_name)
+          Rake::Task['nginx:start_container'].invoke
+        else
+          if config_file_changed
+            Rake::Task['nginx:restart_container'].invoke
+          else
+            info "No config file changes for #{settings.container_name} and it is already running; we're setup!"
+          end
+        end
+      end
+    end
+  end
+
+  desc "Check the status of the Nginx instance."
+  task :status => :ensure_setup do |t, args|
+    settings = @settings
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      info ""
+      if container_exists?(settings.container_name)
+        info "#{settings.container_name} exists on #{settings.domain}"
+        info ""
+        if container_is_running?(settings.container_name)
+          info "#{settings.container_name} is running on #{settings.domain}"
+          info ""
+        else
+          info "#{settings.container_name} is not running on #{settings.domain}"
+          info ""
+        end
+      else
+        info "#{settings.container_name} does not exist on #{settings.domain}"
+        info ""
+      end
+    end
+  end
+
+  task :create_container => :ensure_setup do |t, args|
+    settings = @settings
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      warn "Starting a new container named #{settings.container_name} on #{settings.domain}"
+      execute("docker", "run", settings.docker_run_command)
+      sleep 2
+      fatal stay_running_message(settings) and raise unless container_is_running?(settings.container_name)
+    end
+  end
+
+  task :start_container => :ensure_setup do |t, args|
+    settings = @settings
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      warn "Starting an existing but non-running container named #{settings.container_name}"
+      execute("docker", "start", settings.container_name)
+      sleep 2
+      fatal stay_running_message(settings) and raise unless container_is_running?(settings.container_name)
+    end
+  end
+
+  task :restart_container => :ensure_setup do |t, args|
+    settings = @settings
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      warn "Restarting a running container named #{settings.container_name}"
+      execute("docker", "restart", settings.container_name)
+      sleep 2
+      fatal stay_running_message(settings) and raise unless container_is_running?(settings.container_name)
+    end
+  end
+
+  task :ensure_access_docker => :ensure_setup do |t, args|
+    settings = @settings
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      as settings.ssh_user do
+        unless test("bash", "-c", "\"docker", "ps", "&>", "/dev/null\"")
+          execute("sudo", "usermod", "-a", "-G", "docker", settings.ssh_user)
+          fatal "Newly added to docker group, this run will fail, next run will succeed. Simply try again."
+        end
+      end
+    end
+  end
+
+  task :install_config_file, [:template_path, :config_path, :config_file] => :ensure_setup do |t, args|
+    settings = @settings
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      as 'root' do
+        execute("mkdir", "-p", args.config_path) unless test("test", "-d", args.config_path)
+        generated_config_file = generate_config_file(settings, "#{args.template_path}/#{args.config_file}.erb")
+        upload! StringIO.new(generated_config_file), "/tmp/#{args.config_file}"
+        execute("mv", "/tmp/#{args.config_file}", "#{args.config_path}/#{args.config_file}")
+        execute("chown", "-R", "root:root", args.config_path)
+        execute("chmod", "-R", "700", args.config_path)
+      end
+    end
+  end
+
+  task :open_firewall => :ensure_setup do |t, args|
+    settings = @settings
+    on "#{settings.ssh_user}@#{settings.domain}" do
+      as "root" do
+        if test "ufw", "status"
+          settings.publish_ports.collect { |port_set| port_set['external'] }.each do |port|
+            raise "Error during opening UFW firewall" unless test("ufw", "allow", "#{port}/tcp")
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+    def stay_running_message(settings)
+      "Container #{settings.container_name} on #{settings.domain} did not stay running more than 2 seconds"
+    end
+
+    def config_file_differs?(settings, local_templates_path, external_config_path, config_file)
+      generated_config_file = generate_config_file(settings, "#{local_templates_path}/#{config_file}.erb")
+      as 'root' do
+        config_file_path = "#{external_config_path}/#{config_file}"
+        if file_exists?(config_file_path)
+          capture("cat", config_file_path).chomp != generated_config_file.chomp
+        else
+          true
+        end
+      end
+    end
+
+    def generate_config_file(settings, template_file_path)
+      @settings     = settings # needed for ERB
+      template_path = File.expand_path(template_file_path)
+      ERB.new(File.new(template_path).read).result(binding)
+    end
+
+    def container_exists?(container_name)
+      test "docker", "inspect", container_name, ">", "/dev/null"
+    end
+
+    def container_is_running?(container_name)
+      (capture "docker", "inspect",
+        "--format='{{.State.Running}}'",
+        container_name).strip == "true"
+    end
+
+    def file_exists?(file_name_path)
+      test "[", "-f", file_name_path, "]"
+    end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: nginxinator
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- david amick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: An Opinionated Nginx Deployment gem
+email: davidamick@ctisolutionsinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nginxinator.rb
+- lib/nginxinator/nginx.rb
+- lib/nginxinator/config.rb
+- lib/nginxinator/examples/nginxinator_example.rb
+- lib/nginxinator/examples/nginx_example.conf.erb
+- lib/nginxinator/examples/site-enabled_example.erb
+- lib/nginxinator/examples/ssl.crt_example.erb
+- lib/nginxinator/examples/ssl.key_example.erb
+- lib/nginxinator/examples/mime.types_example.erb
+- lib/nginxinator/examples/Dockerfile
+homepage: https://github.com/snarlysodboxer/nginxinator
+licenses:
+- GNU
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Deploy Nginx
+test_files: []