redirus 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a52df1a66b61631d4906babcba2bf20aed4e0ad
-  data.tar.gz: 30cdec5ac63efaa135a8ce7c53e55e05899b63c3
+  metadata.gz: 956920b5a2b187d43ffc475d478a7baa00139206
+  data.tar.gz: fd00a3f1d54e8601f6b22a9cffbc785002bac863
 SHA512:
-  metadata.gz: c71b3d6dde486e69153d3250180f4a3ffe3dcbdebe5d696c4c22ce876ed35357f4b28ae6429d4b14b3beb79764634d210d116419ed1d219716a00d4acbbb7a6f
-  data.tar.gz: 053f86bdaf783adec2a26d28d0cf3b1a5d6cca0676f742c9927df6b671ca50a07de8f4baf4cd2670a7986c2bb73ca60316032ad775261eca8c29c77233cebb8a
+  metadata.gz: 057063d0c94cd37502b27949dc3f8ace2e5bac69920078a9999bdeb7aa21556a73e4e9315ceef10515a125a00e570d9fcf9e4e1cd1b9847187b3e02d9ba86d64
+  data.tar.gz: da1615d53261279f36fc8e2a84f7a688ab55191adea4f1ea9b9059ab1493bf281fd89f5c7e7fa607c489e8f2a4828e22ffd348f8354433d7cf85f02ccc4c9a09

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p353
+2.1.4

data/CHANGELOG

@@ -1,3 +1,14 @@
+v 0.2.1
+  - set minimal dependency versions in gemspec
+
+v 0.2.0
+  - erb used to create nginx http and https config templates
+  - redirus-init command added to bootstrap redirus configuration
+  - possiblity to pass location parameters and options using redirus-client
+  - better error messages
+  - fix problem with showing redirus version using redirus executables
+  - help for redirus executable
+
 v 0.1.2
   - ssl_protocols set to TLSv1 TLSv1.1 TLSv1.2 in default nginx configurations
 

data/Gemfile.lock

@@ -1,104 +1,113 @@
 PATH
   remote: .
   specs:
-    redirus (0.1.2)
-      sidekiq
+    redirus (0.2.0)
+      sidekiq (~> 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.14)
+      tzinfo (~> 1.1)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     coderay (1.1.0)
-    colorize (0.5.8)
     connection_pool (2.0.0)
-    coveralls (0.6.7)
-      colorize
+    coveralls (0.7.1)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
+      term-ansicolor
       thor
     diff-lcs (1.2.5)
-    ffi (1.9.3)
-    formatador (0.2.4)
-    guard (2.3.0)
+    docile (1.1.5)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.6.1)
       formatador (>= 0.2.4)
-      listen (~> 2.1)
+      listen (~> 2.7)
       lumberjack (~> 1.0)
       pry (>= 0.9.12)
       thor (>= 0.18.1)
-    guard-rspec (3.0.3)
-      guard (>= 1.8)
-      rspec (~> 2.13)
-    i18n (0.6.9)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    i18n (0.6.11)
     json (1.8.1)
-    listen (2.4.0)
+    listen (2.7.11)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    lumberjack (1.0.4)
+    lumberjack (1.0.9)
     method_source (0.8.2)
-    mime-types (1.25.1)
-    minitest (4.7.5)
-    multi_json (1.8.2)
-    pry (0.9.12.4)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
+    mime-types (2.4.2)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    netrc (0.7.8)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.1.1)
+    rake (10.4.2)
     rb-fsevent (0.9.4)
-    rb-inotify (0.9.3)
+    rb-inotify (0.9.5)
       ffi (>= 0.5.0)
     redis (3.1.0)
     redis-namespace (1.5.1)
       redis (~> 3.0, >= 3.0.4)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    rspec-sidekiq (0.5.1)
-      rspec (~> 2.0)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-sidekiq (2.0.0)
+      rspec (~> 3.0, >= 3.0.0)
       sidekiq (>= 2.4.0)
-    shoulda-matchers (2.4.0)
+    rspec-support (3.1.2)
+    shoulda-matchers (2.7.0)
       activesupport (>= 3.0.0)
-    sidekiq (3.2.2)
-      celluloid (>= 0.15.2)
+    sidekiq (3.2.5)
+      celluloid (= 0.15.2)
       connection_pool (>= 2.0.0)
       json
       redis (>= 3.0.6)
       redis-namespace (>= 1.3.1)
-    simplecov (0.7.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    slop (3.4.7)
-    thor (0.18.1)
-    thread_safe (0.1.3)
-      atomic
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
     timers (1.1.0)
-    tzinfo (0.3.38)
+    tins (1.3.3)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  coveralls
-  guard-rspec
-  rake
+  bundler (~> 1.7)
+  coveralls (~> 0)
+  guard-rspec (~> 4.3)
+  rake (~> 10)
   redirus!
-  rspec-sidekiq
-  shoulda-matchers
+  rspec-sidekiq (~> 2.0)
+  shoulda-matchers (~> 2.7)

data/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec do
+guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})       { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')    { "spec" }

data/README.md

@@ -131,11 +131,13 @@ chmod 400 host.key host.pem
 # install redirus
 gem install redirus
 
-# Download sample redirus configuration
-curl -L --progress https://raw.githubusercontent.com/dice-cyfronet/redirus/master/config.yml.example > config.yml
+# Generate inital redirus and nginx configuration
+redirus-init
 
 # Customise redis configuration and nginx config files locations
 edit config.yml
+edit http.erb.conf
+edit https.erb.conf
 ```
 
 ## Example config.yml
@@ -151,26 +153,8 @@ namespace: redirus
 nginx:
   configs_path: /path/to/generated/nginx/configurations/
   pid: /nginx/installation/path/nginx.pid
-  http_template: |
-    listen *:80;
-  https_template: |
-    listen *:443 ssl;
-    ssl_certificate     /path/to/cert/dir/server.crt;
-    ssl_certificate_key /path/to/cert/dir/server.key;
-    ssl_protocols       TLSv1 TLSv1.1 TLSv1.2;
-  config_template: |
-    #{upstream}
-    server {
-      #{listen}
-      server_name #{name}.my-domain.pl;
-      server_tokens off;
-      proxy_set_header X-Server-Address $scheme://#{name}.my-domain.pl;
-      proxy_set_header Host $http_host;
-      location / {
-        proxy_pass http://#{upstream_name};
-        #{properties}
-      }
-    }
+  http_template: /path/to/http/nginx/config/template
+  https_template: /path/to/https/nginx/config/template
   allowed_properties:
     - proxy_sent_timeout \d
     - proxy_read_timeout \d
@@ -182,29 +166,84 @@ specific for concrete redirection will be created. Value of this path **need** t
 be the same as in nginx configuration file.
 + `/nginx/installation/path/nginx.pid` is a file containing nginx pid. To this pid
 `SIGHUP` signal will be sent, which will triggers nginx configuration reload.
-+ `/path/to/cert/dir/server.crt` path to ssl certificate used in https redirections.
-This certificate need to have `*` in CN field.
-+ `/path/to/cert/dir/server.key` path to ssl certificate key file.
-
-By using `http_template`, `https_template`, `config_template` and
-`allowed_properties` you can customize how nginx configuration looks like for each
-subdomain.
-
-+ `http_template` is used when an http redirection is created
-+ `https_template` is used when an https redirection is created
-+ `config_template` is used for http and https redirections.
-Inside this template, the `listen` variable section is specific to http or https
-redirections.
-+ `allowed_properties` is used to define allowed parameters which can be
++ `allowed_properties` is used to define allowed location parameters which can be
 passed in the generated configuration. Regular expressions can be used here.
 
+## Example `http.erb.conf` and `https.erb.conf`
+
+`http.erb.conf` used to create `http` redirections:
+
+```
+upstream <%= @name %>_http {
+<% if @options[:load_balancing] == :ip_hash -%>
+  ip_hash;
+<% end -%>
+<% for worker in @workers -%>
+  server <%= worker %>;
+<% end -%>
+}
+
+server {
+  listen 127.0.0.1:80;
+  server_name <%= @name %>.localhost;
+  location / {
+    proxy_pass http://<%= @name %>_http;
+<% for property in @location_properties -%>
+    <%= property %>;
+<% end -%>
+  }
+}
+```
+
+`https.erb.conf` used to create `https` redirections:
+
+```
+upstream <%= @name %>_https {
+<% for worker in @workers -%>
+  server <%= worker %>;
+<% end -%>
+}
+
+server {
+  listen 127.0.0.1:443 ssl;
+  server_name <%= @name %>.localhost;
+
+  ssl_certificate     /path/to/cert/dir/server.crt;
+  ssl_certificate_key /path/to/cert/dir/server.key;
+  ssl_protocols       TLSv1 TLSv1.1 TLSv1.2;
+
+  location / {
+    proxy_pass http://<%= @name %>_https;
+<% for property in @location_properties -%>
+    <%= property %>;
+<% end -%>
+  }
+}
+```
+
+In presented templates following dynamic elements are used:
+
+  - `@name` - redirection name used as a url prefix
+  - `@workers` - list of upstream addresses in following format `ip:port`
+  - `@location_properties` - list of location properties
+    (possible properties can be limitted using `allowed_properties` section
+    in `config.yml` file)
+  - `@options` - other properties passed by the redirus client,
+    can be used e.g. to allow sticky session configuration like presented in
+    `http.erb.conf`
+
 For example - when a redirection with the following parameters is requested:
 
 ```ruby
 Sidekiq::Client.push(
   'queue' => 'cyfronet',
   'class' => Redirus::Worker::AddProxy,
-  'args' => ['subdomain', ['127.0.0.1:80'], :http, ["proxy_send_timeout 6000"]])
+  'args' => [
+              'subdomain', ['127.0.0.1:80'], :http,
+              ["proxy_send_timeout 6000"],
+              { load_balancing: :ip_hash }
+            ]
+  )
 ```
 
 ...then the following `/nginx/sites-enabled/subdomain_http` subdomain config file
@@ -212,6 +251,7 @@ will be created:
 
 ```
 upstream subdomain_http {
+  ip_hash;
   server 127.0.0.1:80;
 }
 server {
@@ -225,6 +265,25 @@ server {
 }
 ```
 
+**NOTE:** It is redirus administrator role to prepare `http` and `https`
+templates in such a way that generated configuration will be valid.
+If at least one nginx configuration will be invalid then nginx will fail to
+reboot.
+
+## Redirus generator
+
+By running following command:
+
+```
+redirus-init
+```
+
+set of `redirus` and `nginx` configuration files will be created.
+You can customize generated files by providing additional `redirus-init`
+parameters.
+
+See `redirus-init -h` for details.
+
 ## Run redirus
 
 ```bash
@@ -300,7 +359,12 @@ end
 Sidekiq::Client.push(
   'queue' => Redirus::Worker.config.queues.first,
   'class' => Redirus::Worker::AddProxy,
-  'args' => ['subdomain', ['127.0.0.1'], :http, ["proxy_send_timeout 6000"]])
+  'args' => [
+              'subdomain', ['127.0.0.1'], :http,
+              ["proxy_send_timeout 6000"],
+              { load_balancing: :ip_hash }
+            ]
+)
 
 # remove redirection
 Sidekiq::Client.push(

data/bin/redirus

@@ -2,6 +2,6 @@
 
 require 'redirus'
 
-cli = Redirus::ServerCLI.instance
+cli = Redirus::Cli::Server.instance
 cli.parse
-cli.run
+cli.run

data/bin/redirus-client

@@ -2,6 +2,6 @@
 
 require 'redirus'
 
-cli = Redirus::CLI.instance
+cli = Redirus::Cli::Client.instance
 cli.parse
-cli.run
+cli.run

data/bin/redirus-init

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'redirus'
+
+cli = Redirus::Cli::Init.instance
+cli.parse
+cli.run

data/lib/redirus/cli/client.rb

@@ -0,0 +1,183 @@
+require 'optparse'
+require 'singleton'
+
+module Redirus
+  module Cli
+    class Client
+      include Singleton
+
+      attr_reader :options
+
+      def parse(args = ARGV)
+        init_options(args)
+        validate!
+      end
+
+      def run
+        Redirus.config_path = options[:config_path]
+        init_sidekiq
+
+        add? ? add : rm
+      end
+
+      private
+
+      def init_sidekiq
+        Sidekiq.configure_client do |c|
+          c.redis = {
+            namespace: Redirus.config.namespace,
+            url: Redirus.config.redis_url
+          }
+        end
+      end
+
+      def init_options(args)
+        opts = parse_options(args)
+        opts[:config_path] ||= 'config.yml'
+
+        Redirus.config_path = opts[:config_path]
+
+        @options = defaults.merge(opts)
+      end
+
+      def parse_options(args)
+        opts = {}
+
+        parser = OptionParser.new do |o|
+          o.on('-c', '--configuration PATH', 'Configuration path') do |arg|
+            opts[:config_path] = arg
+          end
+
+          o.on('-a',
+               '--action TYPE', [:add, :rm],
+               'Action type (add, rm)') do |arg|
+            opts[:action] = arg
+          end
+
+          o.on('-q', '--queue NAME', 'Queue name') do |arg|
+            opts[:queue] = arg
+          end
+
+          o.on('-t',
+               '--type TYPE',
+               [:http, :https],
+               'Rediraction type') do |arg|
+            opts[:type] = arg
+          end
+
+          o.on('-l',
+               '--location-property LIST',
+               Array,
+               'List of location properties (e.g. prop1,prop2)') do |arg|
+            opts[:location_properties] = arg
+          end
+
+          o.on('-o',
+               '--options MAP',
+               Array,
+               'Option map (e.g. key1:value1,key2:value2)') do |arg|
+            opts[:options] = to_hsh(arg)
+          end
+
+          o.on_tail('-h', '--help', 'Show this message') do
+            puts o
+            exit
+          end
+
+          o.on_tail('-v', '--version', 'Show version') do
+            puts "Redirus #{Redirus::VERSION}"
+            exit
+          end
+        end
+
+        parser.banner = 'redirus-client [options] name '\
+                        '[upstream1,upstream2,...]'
+
+        parser.parse!(args)
+
+        opts[:name] = args.shift
+
+        upstreams_str = args.shift
+        opts[:upstreams] = upstreams_str.split(',') if upstreams_str
+
+        opts
+      end
+
+      def to_hsh(array)
+        array.inject({}) do |hsh, item|
+          kv = item.split(':')
+          if kv.size >= 2
+            hsh[kv[0]] = kv[1]
+          end
+          hsh
+        end
+      end
+
+      def defaults
+        {
+          config_path: 'config.yml',
+          type: :http,
+          action: :add,
+          location_properties: [],
+          options: {},
+          queue: Redirus.config.queues.first
+        }
+      end
+
+      def validate!
+        unless File.exist?(options[:config_path])
+          puts "ERROR: Configuration file #{options[:config_path]} "\
+               'does not exist'
+          exit(1)
+        end
+
+        unless options[:name]
+          puts 'ERROR: Redirection name is not set'
+          exit(1)
+        end
+
+        if add?
+          if options[:upstreams]
+            options[:upstreams].each do |u|
+              next if u.match(/\A\d{1,3}\.\d{1,3}\.\d{1,3}.\d{1,3}:\d+\z/)
+              puts "ERROR: #{u} is not valid upstream definition, "\
+                   'use IP:PORT schema'
+              exit(1)
+            end
+          else
+            puts 'ERROR: Upstream locations are not set'
+            exit(1)
+          end
+        end
+
+        Redirus.config_path = options[:config_path]
+      end
+
+      def add?
+        options[:action] == :add
+      end
+
+      def add
+        puts "Adding new redirection #{options[:name]} with following "\
+             "upstreams #{options[:upstreams]}"
+
+        Sidekiq::Client.push(
+          'queue' => options[:queue],
+          'class' => Redirus::Worker::AddProxy,
+          'args' => [options[:name],
+                     options[:upstreams],
+                     options[:type], options[:location_properties],
+                     options[:options]])
+      end
+
+      def rm
+        puts "Removing redirection #{options[:name]}"
+
+        Sidekiq::Client.push(
+          'queue' => options[:queue],
+          'class' => Redirus::Worker::RmProxy,
+          'args' => [options[:name], options[:type]])
+      end
+    end
+  end
+end