luban-nginx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d56320d742c77de9f7c3f5940849211f958500de
+  data.tar.gz: 74ffd91524d3a5b4f8789d12bf16abbcabc43166
+SHA512:
+  metadata.gz: a446438849629953e9d6cbc3f31fe566e28fe1d48084dcdb03fbf4ef9293b618729d9d97bfbe9430492a159a5d327e611aef3f0753ba612a6d6abbb4546acaff
+  data.tar.gz: d8f32737378e85caf57457340280bf81825660670e50002f7730bc3871f3a5a571f4f25eb292cbdb25c59aa1c18c9794e36c3267f5119fe56af331c63a03ce50

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change log
+
+## Version 0.1.0 (May 11, 2016)
+
+New features:
+  * Initialized Luban deployment package of Nginx

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chi Man Lei
+
+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,39 @@
+# Luban::Nginx
+
+Luban deployment package to manage Nginx installation, deployment and control
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'luban-nginx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install luban-nginx
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nginx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "luban/nginx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/luban/deployment/packages/nginx.rb

@@ -0,0 +1,7 @@
+require 'luban'
+require_relative 'nginx/base'
+require_relative 'nginx/configurator'
+require_relative 'nginx/controller'
+require_relative 'nginx/installer'
+require_relative 'nginx/version'
+

data/lib/luban/deployment/packages/nginx/base.rb

@@ -0,0 +1,54 @@
+module Luban
+  module Deployment
+    module Packages
+      class Nginx < Luban::Deployment::Service::Base
+        apply_to :all do
+          before_install do
+            depend_on 'pcre', version: '8.38'
+            depend_on 'openssl', version: '1.0.2h'
+          end
+        end
+
+        def default_templates_path
+          @default_templates_path ||= Pathname.new(File.join(File.dirname(__FILE__), 'templates')).realpath
+        end
+
+        %i(config_test quit_process reload_process reopen_logs).each do |action|
+          service_action action, dispatch_to: :controller
+        end
+
+        protected
+
+        def setup_install_tasks
+          super
+          commands[:install].option :pcre, "PCRE version"
+          commands[:install].option :openssl, "OpenSSL version"
+        end
+
+        def setup_control_tasks
+          super
+
+          task :config_test do
+            desc "Syntax check on config file"
+            action! :config_test
+          end
+
+          task :quit do
+            desc "Stop process gracefully"
+            action! :quit_process
+          end
+
+          task :reload do
+            desc "Reload process"
+            action! :reload_process
+          end
+
+          task :reopen do
+            desc "Reopen log files"
+            action! :reopen_logs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/luban/deployment/packages/nginx/configurator.rb

@@ -0,0 +1,47 @@
+module Luban
+  module Deployment
+    module Packages
+      class Nginx
+        class Configurator < Luban::Deployment::Service::Configurator
+          module Paths
+            def bin_path
+              @bin_path ||= install_path.join('sbin')
+            end
+          end
+
+          include Paths
+
+          def error_log_file_path
+            @error_log_file_path ||= log_path.join(error_log_file_name)
+          end
+
+          def error_log_file_name
+            @error_log_file_name ||= "#{service_name}.error.log"
+          end
+
+          def log_file_name
+            @log_file_name ||= "#{service_name}.access.log"
+          end
+
+          alias_method :access_log_file_path, :log_file_path
+          alias_method :access_log_file_name, :log_file_name
+
+          def mime_types_file_path
+            @mime_types_file_path ||=
+              if file?(stage_profile_path.join(mime_types_file_name))
+                profile_path.join(mime_types_file_name)
+              else
+                #Pathname.new('conf').join(mime_types_file_name)
+                current_path.join('conf').join(mime_types_file_name)
+                #install_path.join('conf').join(mime_types_file_name)
+              end
+          end
+
+          def mime_types_file_name
+            @mime_types_file_name ||= 'mime.types'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/luban/deployment/packages/nginx/controller.rb

@@ -0,0 +1,75 @@
+module Luban
+  module Deployment
+    module Packages
+      class Nginx
+        class Controller < Luban::Deployment::Service::Controller
+          include Configurator::Paths
+
+          default_executable 'nginx'
+
+          def nginx_command
+            @nginx_command ||= "#{nginx_executable} -c #{control_file_path}"
+          end
+          alias_method :process_pattern, :nginx_command
+
+          def config_test
+            update_result config_test!
+          end
+
+          def quit_process
+            if process_stopped?
+              update_result "Skipped! Already stopped #{package_full_name}", status: :skipped
+              return
+            end
+
+            output = quit_process!
+            if check_until { process_stopped? }
+              unmonitor_process
+              update_result "Gracefully stop #{package_full_name}: [OK] #{output}"
+            else
+              remove_orphaned_pid_file
+              update_result "Gracefully stop #{package_full_name}: [FAILED] #{output}",
+                            status: :failed, level: :error
+            end
+          end
+
+          def before_quit; unmonitor_process; end
+
+          def reload_process
+            update_result reload_process!
+          end
+
+          def reopen_logs
+            update_result reopen_logs!
+          end
+
+          protected
+
+          def config_test!
+            capture("#{nginx_command} -t 2>&1")
+          end
+
+          def start_process!
+            capture("#{nginx_command} 2>&1")
+          end
+
+          def quit_process!
+            capture("#{nginx_command} -s quit 2>&1")
+          end
+
+          def stop_process!
+            capture("#{nginx_command} -s stop 2>&1")
+          end
+
+          def reload_process!
+            capture("#{nginx_command} -s reload 2>&1")
+          end
+
+          def reopen_logs!
+            capture("#{nginx_command} -s reopen 2>&1")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/luban/deployment/packages/nginx/installer.rb

@@ -0,0 +1,52 @@
+module Luban
+  module Deployment
+    module Packages
+      class Nginx
+        class Installer < Luban::Deployment::Service::Installer
+          include Configurator::Paths
+
+          default_executable 'nginx'
+
+          def source_repo
+            @source_repo ||= "http://nginx.org"
+          end
+
+          def source_url_root
+            @source_url_root ||= "download"
+          end
+
+          def installed?
+            return false unless file?(nginx_executable)
+            pattern = "nginx version: nginx/#{package_major_version}"
+            match?("#{nginx_executable} -v 2>&1", pattern)
+          end
+
+          def with_opt_dir(dir)
+            @cc_opts << "-I #{dir.join('include')}"
+            @ld_opts << "-L #{dir.join('lib')} -Wl,-rpath,#{dir.join('lib')}"
+          end
+          alias_method :with_pcre_dir, :with_opt_dir
+          alias_method :with_openssl_dir, :with_opt_dir
+
+          protected
+
+          def configure_build_options
+            super
+            @configure_opts.unshift('--with-http_stub_status_module')
+            @configure_opts.unshift('--with-stream')
+            @configure_opts.unshift('--with-http_ssl_module')
+            @configure_opts.unshift('--with-http_gzip_static_module')
+            @cc_opts = []
+            @ld_opts = []
+          end
+
+          def compose_build_options
+            @configure_opts << "--with-cc-opt=\"#{@cc_opts.join(' ')}\""
+            @configure_opts << "--with-ld-opt=\"#{@ld_opts.join(' ')}\""
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/luban/deployment/packages/nginx/templates/nginx.conf.erb

@@ -0,0 +1,20 @@
+# Nginx master configuration file
+
+# Environment: <%= env_name %>
+# Revision: <%= revision %>
+# Created at <%= now %>
+
+pid <%= pid_file_path %>;
+error_log <%= error_log_file_path %> info;
+
+include <%= profile_path.join('nginx.main.conf') %>;
+
+http {
+  include <%= mime_types_file_path %>;
+  include <%= profile_path.join('nginx.http.conf') %>;
+  include <%= profile_path.join('nginx.http.*.conf') %>;
+
+  access_log <%= access_log_file_path %> main;
+}
+
+

data/lib/luban/deployment/packages/nginx/templates/nginx.http.conf

@@ -0,0 +1,43 @@
+# This section configures Nginx http context
+
+# Basic Settings
+# -------------------------------------
+default_type application/octet-stream;
+
+sendfile on;
+client_max_body_size 5M;
+
+# tcp_nopush causes nginx to attempt to send its HTTP response header
+# in one package instead of using partial frames. This is useful for
+# prepending headers before calling sendfile, or for throughput optimization
+tcp_nopush on;
+
+# Do not buffer data-sends (disable Nagle algorithm).
+# Good for sending frequent small bursts of data in real time
+tcp_nodelay on;
+
+# Gzip Settings
+# -------------------------------------
+gzip on;
+gzip_http_version 1.1;
+gzip_proxied any;
+gzip_min_length 500;
+gzip_disable "MSIE [1-6]\.";
+gzip_types text/plain text/xml text/css text/javascript
+           application/json application/xml
+           application/javascript application/x-javascript
+           application/rss+xml application/atom+xml;
+
+# Proxy Settings
+# -------------------------------------
+proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+proxy_set_header X-Real-IP $remote_addr;
+proxy_set_header X-Forwarded-Proto $scheme;
+proxy_set_header Host $http_host;
+proxy_redirect off;
+
+# Access Log Settings
+# -------------------------------------
+log_format main '$remote_addr - $remote_user [$time_local] $status '
+                '"$request" $body_bytes_sent "$http_referer" '
+                '"$http_user_agent" "$http_x_forwarded_for" "$request_time"';

data/lib/luban/deployment/packages/nginx/templates/nginx.http.proxy.conf

@@ -0,0 +1,46 @@
+# Nginx reverse proxy configuration
+
+# Environment: <%= env_name %>
+# Revision: <%= revision %>
+# Created at <%= now %>
+
+upstream <%= serivce_entry %> {
+    # fail_timeout=0 means we always retry an upstream even if it failed
+    # to return a good HTTP response (in case the Puma master nukes a
+    # single worker for timing out).
+
+    # for UNIX domain socket setups:
+    # server unix:<%= ruby_socket_file %> fail_timeout=0;
+
+    # for TCP setups, point these to the backend servers
+    # server 192.168.0.7:<%= tcp_port %> fail_timeout=0;
+    # server 192.168.0.8:<%= tcp_port %> fail_timeout=0;
+    # server 192.168.0.9:<%= tcp_port %> fail_timeout=0;
+}
+
+server {
+    # listen <%= tcp_port %>;
+    # server_name <%= virtual_host %>;
+
+    # ~2 seconds is often enough for most cases to parse HTML/CSS and
+    # retrieve needed images/icons/frames, connections are cheap in
+    # nginx so increasing this is generally safe...
+    keepalive_timeout 5;
+
+    # path for static files
+    # root <%= current_path %>/public;
+
+    location ~ ^/assets/ {
+        gzip_static on; # to serve pre-gizpped version
+        expires 1y;
+        add_header Cache-Control public;
+        add_header ETag "";
+        break;
+    }
+
+    try_files $uri/index.html $uri.html $uri @app;
+
+    location @app {
+      proxy_pass http://<%= service_entry %>;
+    }
+}

data/lib/luban/deployment/packages/nginx/templates/nginx.logrotate.erb

@@ -0,0 +1,18 @@
+# Nginx logrotate configuration
+
+# Environment: <%= env_name %>
+# Revision: <%= revision %>
+# Created at <%= now %>
+
+<%= log_path.join('*.log') %> {
+  daily
+  missingok
+  rotate 14
+  compress
+  dateext
+  notifempty
+  sharedscripts
+  postrotate
+    [ ! -f <%= pid_file_path %> ] || kill -USR1 $(cat <%= pid_file_path %>) 2>/dev/null || true
+  endscript
+}

data/lib/luban/deployment/packages/nginx/templates/nginx.main.conf

@@ -0,0 +1,9 @@
+# This section configures Nginx main context
+
+# user nobody;
+worker_processes 2;
+worker_rlimit_nofile 4096;
+
+events {
+  worker_connections 2048;
+}

data/lib/luban/deployment/packages/nginx/templates/nginx.monitrc.erb

@@ -0,0 +1,15 @@
+# Monit control file for Nginx
+
+# Environment: <%= env_name %>
+# Revision: <%= revision %>
+# Created at <%= now %>
+
+<% nginx_command = "#{bin_path.join('nginx')} -c #{control_file_path}" %>
+check process <%= service_entry %>
+  with pidfile <%= pid_file_path %>
+  start program = "/bin/bash -c 'sleep 1; <%= nginx_command %>'"
+  stop program = "/bin/bash -c '<%= "#{nginx_command} -s stop" %>'"
+  if totalmem is greater than 10.0 MB for 40 cycles then restart
+  if failed port 8080 for 3 times within 6 cycles then restart
+  if cpu is greater than 80% for 20 cycles then alert
+  if loadavg(5min) greater than 10 for 40 cycles then restart

data/lib/luban/deployment/packages/nginx/version.rb

@@ -0,0 +1,9 @@
+module Luban
+  module Deployment
+    module Packages
+      class Nginx
+        VERSION = '0.1.0'
+      end
+    end
+  end
+end

data/lib/luban/deployment/packages/pcre.rb

@@ -0,0 +1,32 @@
+require 'luban'
+
+module Luban
+  module Deployment
+    module Packages
+      class Pcre < Luban::Deployment::Package::Base
+        class Installer < Luban::Deployment::Package::Installer
+          def pcre_executable
+            @default_executable ||= bin_path.join('pcre-config')
+          end
+
+          def source_repo
+            @source_repo ||= "http://sourceforge.net"
+          end
+
+          def source_url_root
+            @source_url_root ||= "projects/pcre/files/pcre/#{@package_major_version}"
+          end
+
+          def installed?
+            return false unless file?(pcre_executable)
+            match?("#{pcre_executable} --version", package_major_version)
+          end
+
+          protected
+          
+          def update_binstubs!; end
+        end
+      end
+    end
+  end
+end

data/lib/luban/nginx.rb

@@ -0,0 +1 @@
+require_relative "deployment/packages/nginx"

data/luban-nginx.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'luban/deployment/packages/nginx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "luban-nginx"
+  spec.version       = Luban::Deployment::Packages::Nginx::VERSION
+  spec.authors       = ["Rubyist Chi"]
+  spec.email         = ["rubyist.chi@gmail.com"]
+
+  spec.summary       = %q{Monit support for Luban}
+  spec.description   = %q{Luban::Nginx is a Luban package to manage Nginx installation, deployment and control}
+  spec.homepage      = "https://github.com/lubanrb/monit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1.0"
+  spec.add_dependency 'luban'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: luban-nginx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rubyist Chi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: luban
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Luban::Nginx is a Luban package to manage Nginx installation, deployment
+  and control
+email:
+- rubyist.chi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/luban-nginx.rb
+- lib/luban/deployment/packages/nginx.rb
+- lib/luban/deployment/packages/nginx/base.rb
+- lib/luban/deployment/packages/nginx/configurator.rb
+- lib/luban/deployment/packages/nginx/controller.rb
+- lib/luban/deployment/packages/nginx/installer.rb
+- lib/luban/deployment/packages/nginx/templates/nginx.conf.erb
+- lib/luban/deployment/packages/nginx/templates/nginx.http.conf
+- lib/luban/deployment/packages/nginx/templates/nginx.http.proxy.conf
+- lib/luban/deployment/packages/nginx/templates/nginx.logrotate.erb
+- lib/luban/deployment/packages/nginx/templates/nginx.main.conf
+- lib/luban/deployment/packages/nginx/templates/nginx.monitrc.erb
+- lib/luban/deployment/packages/nginx/version.rb
+- lib/luban/deployment/packages/pcre.rb
+- lib/luban/nginx.rb
+- luban-nginx.gemspec
+homepage: https://github.com/lubanrb/monit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Monit support for Luban
+test_files: []