kumonos 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1c6b3644e754690e6ee2fba82f9a709442eabbb
-  data.tar.gz: 8dcc5a060d2a29d248e409d8b248b8253611fcc3
+  metadata.gz: 981d08ab41459f0b6974d1e9db66bf36298319cd
+  data.tar.gz: a8f4fbb16ebb30de0b587a5820a37beb1d6e4da6
 SHA512:
-  metadata.gz: '0408e86373950df921c58276ba93b76b3429f0ad9a3dbea2068a104b6cfde44fd59e903a0874c2f6edbdf9efe70e67449356b047a1e2e2b6aeb44b399440df8a'
-  data.tar.gz: 3fc7fed7add9ff302c6e9ec7931055989d0265cda8af3180e0db955394b5cd683ef15181a9965dd9fb23c573cbeb16d24e2fe9e5543b344a60f549c59e3926da
+  metadata.gz: ecec920e45a4165cb2774c3e8b8b5d21990da3da8b0077ae8f18c0158800623faa95570d7f610dc54510444b192c8a93096516bf15ec58da482223a26b4c1496
+  data.tar.gz: 4ef6d9a17b3ee7fc7b1307cf0d5b11a2092b7ee75a4468629e6683e4f0ccec664bba8b6b8f3c8bc391a298f9ddbcf705ef1a758de37eb2e615927685dfae9d7f

data/.gitignore

@@ -12,3 +12,4 @@
 
 Gemfile.lock
 test/config.json
+test/srv

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  DisplayCopNames: true
+
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,7 @@
-sudo: false
 language: ruby
+sudo: false
 rvm:
-  - 2.3.5
-before_install: gem install bundler -v 1.16.0
+  - 2.4.1
+before_install:
+  - gem update --system # https://github.com/rubygems/rubygems/pull/1819
+  - gem install bundler

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in kumonos.gemspec
 gemspec

data/README.md

@@ -1,39 +1,23 @@
 # Kumonos
+[![Build Status](https://travis-ci.org/taiki45/kumonos.svg?branch=master)](https://travis-ci.org/taiki45/kumonos)
+[![Gem Version](https://badge.fury.io/rb/kumonos.svg)](https://badge.fury.io/rb/kumonos)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kumonos`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Manage and build a Service Mesh for Microservices.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'kumonos'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install kumonos
 
 ## Usage
-
 TODO: Write usage instructions here
 
 ## Development
-
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/kumonos.
+Bug reports and pull requests are welcome on GitHub at https://github.com/taiki45/kumonos.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,14 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "kumonos"
+require 'bundler/setup'
+require 'kumonos'
 
-# 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(__FILE__)
+require 'pry'
+Pry.start

data/bump.rb

@@ -0,0 +1,35 @@
+level = ARGV.first
+if level.nil?
+  warn "Example: ruby #{__FILE__} (tiny|minor|major)"
+  exit 1
+end
+
+path = 'lib/kumonos/version.rb'
+regexp = /VERSION = '(.+)'.freeze$/
+version = File.read(path).scan(regexp)[0][0]
+version_strs = version.split('.')
+
+if version_strs.size > 3
+  warn "Current version includes a prelease suffix, drop it: #{version}"
+  version_strs = version_strs[0..2]
+end
+
+case level
+when 'tiny'
+  version_strs[2] = version_strs[2].to_i + 1
+when 'minor'
+  version_strs[1] = version_strs[1].to_i + 1
+  version_strs[2] = 0
+when 'major'
+  version_strs[0] = version_strs[0].to_i + 1
+  version_strs[1] = 0
+  version_strs[2] = 0
+else
+  warn "Example: ruby #{__FILE__} (tiny|minor|major)"
+  exit 1
+end
+
+next_version = version_strs.join('.')
+File.write(path, File.read(path).gsub(regexp, "VERSION = '#{next_version}'.freeze"))
+system('git', 'add', path)
+system('git', 'commit', '-m', "v#{next_version}")

data/example/book.yml

@@ -1,4 +1,4 @@
-# A configuration for book service.
+# A definition for book service.
 # The book service uses user service and ab-testing service.
 version: 1
 services:
@@ -19,6 +19,10 @@ services:
   - name: 'ab-testing'
     lb: 'ab-testing:8080'
     connect_timeout_ms: 250
+    circuit_breaker:
+      max_connections: 64
+      max_pending_requests: 128
+      max_retries: 3
     routes:
       - prefix: '/'
         timeout_ms: 3000

data/example/kumonos.json

@@ -0,0 +1,37 @@
+{
+  "version": 1,
+  "ds": {
+    "name": "nginx",
+    "refresh_delay_ms": 30000,
+    "cluster": {
+      "name": "nginx",
+      "type": "strict_dns",
+      "connect_timeout_ms": 250,
+      "lb_type": "round_robin",
+      "hosts": [
+        {
+          "url": "tcp://nginx:80"
+        }
+      ]
+    }
+  },
+  "statsd": {
+    "name": "statsd",
+    "connect_timeout_ms": 250,
+    "type": "strict_dns",
+    "lb_type": "round_robin",
+    "hosts": [
+      {
+        "url": "tcp://socat:2000"
+      }
+    ]
+  },
+  "listener": {
+    "address": "tcp://0.0.0.0:9211",
+    "access_log_path": "/dev/stdout"
+  },
+  "admin": {
+    "address": "tcp://0.0.0.0:9901",
+    "access_log_path": "/dev/stdout"
+  }
+}

data/exe/kumonos

@@ -1,9 +1,55 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$:.unshift(File.expand_path('../lib', __dir__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 require 'kumonos'
 
-filename = ARGV[0]
-config = YAML.load_file(filename)
-puts JSON.dump(Kumonos.generate(config))
+require 'pathname'
+require 'thor'
+
+# KumonosCli
+class KumonosCli < Thor
+  desc 'envoy SERVIVE_NAME', 'Generate envoy configuration'
+  method_option :config, aliases: '-c', desc: 'Configuration file for kumonos'
+  def envoy(service_name)
+    h = JSON.parse(File.read(options[:config]))
+    result = Kumonos::Schemas.validate_kumonos_config(h)
+    unless result.empty?
+      warn("#{options[:config]} has invalid format:")
+      warn(result)
+      warn("A schema file for kumonos-configuration is #{Kumonos::Schemas::CONFIG_SCHEMA_PATH}")
+      exit 1
+    end
+
+    config = Kumonos::Configuration.from_hash(h)
+    puts JSON.dump(Kumonos.generate(config, service_name))
+  end
+
+  desc 'clusters FILEPATH OUT', 'Generate clusters configuration'
+  def clusters(filepath, output_dir)
+    name = File.basename(filepath, '.*')
+    definition = YAML.load_file(filepath)
+    out = JSON.dump(Kumonos.generate_clusters(definition))
+
+    output_dir = Pathname.new(output_dir)
+    target = output_dir.join('v1', 'clusters', name, name)
+    target.parent.mkpath unless target.parent.exist?
+    target.write(out)
+    puts target
+  end
+
+  desc 'routes FILEPATH OUT', 'Generate routes configuration'
+  def routes(filepath, output_dir)
+    name = File.basename(filepath, '.*')
+    definition = YAML.load_file(filepath)
+    out = JSON.dump(Kumonos.generate_routes(definition))
+
+    output_dir = Pathname.new(output_dir)
+    target = output_dir.join('v1', 'routes', name, name, name)
+    target.parent.mkpath unless target.parent.exist?
+    target.write(out)
+    puts target
+  end
+end
+
+KumonosCli.start(ARGV)

data/kumonos.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Taiki Ono']
   spec.email         = ['taiks.4559@gmail.com']
 
-  spec.summary       = %q{Manage configuration for Service Mesh.}
+  spec.summary       = 'Manage configuration for Service Mesh.'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/taiki45/kumonos'
   spec.license       = 'MIT'
@@ -20,9 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'json-schema'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-json_matcher'
+  spec.add_development_dependency 'rubocop', '~> 0.51.0'
 end

data/lib/kumonos/configuration.rb

@@ -0,0 +1,27 @@
+module Kumonos
+  Configuration = Struct.new(:version, :ds, :statsd, :listener, :admin) do
+    class << self
+      def from_hash(h)
+        new(
+          h.fetch('version'),
+          symbolize_keys(h.fetch('ds')),
+          symbolize_keys(h.fetch('statsd')),
+          symbolize_keys(h.fetch('listener')),
+          symbolize_keys(h.fetch('admin'))
+        )
+      end
+
+      private
+
+      def symbolize_keys(hash)
+        new = hash.map do |k, v|
+          [
+            k.to_sym,
+            v.is_a?(Hash) ? symbolize_keys(v) : v
+          ]
+        end
+        new.to_h
+      end
+    end
+  end
+end

data/lib/kumonos/schemas.rb

@@ -0,0 +1,23 @@
+require 'pathname'
+require 'json-schema'
+
+module Kumonos
+  # Schemas
+  module Schemas
+    ROOT = Pathname.new(File.expand_path('../schemas', __dir__))
+    CONFIG_SCHEMA_PATH = ROOT.join('kumonos_config.json')
+
+    class << self
+      def validate_kumonos_config(hash)
+        schema = load_schema(CONFIG_SCHEMA_PATH)
+        JSON::Validator.fully_validate(schema, hash)
+      end
+
+      private
+
+      def load_schema(path)
+        JSON.parse(File.read(path))
+      end
+    end
+  end
+end

data/lib/kumonos/version.rb

@@ -1,3 +1,3 @@
 module Kumonos
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/lib/kumonos.rb

@@ -1,41 +1,64 @@
 require 'json'
 require 'yaml'
+
 require 'kumonos/version'
+require 'kumonos/schemas'
+require 'kumonos/configuration'
 
+# Kumonos
 module Kumonos
   class << self
-    def generate(config)
-      virtual_hosts = config['services'].map {|s| service_to_vhost(s) }
-      clusters = config['services'].map {|s| service_to_cluster(s) }
+    def generate(config, name)
       {
         listeners: [
           {
-            address: 'tcp://0.0.0.0:9211',
+            address: config.listener.fetch(:address),
             filters: [
               type: 'read',
               name: 'http_connection_manager',
               config: {
                 codec_type: 'auto',
                 stat_prefix: 'ingress_http',
-                access_log: [{ path: '/dev/stdout' }],
-                route_config: {
-                  virtual_hosts: virtual_hosts,
+                access_log: [{ path: config.listener.fetch(:access_log_path) }],
+                rds: {
+                  cluster: config.ds.fetch(:name),
+                  route_config_name: name,
+                  refresh_delay_ms: config.ds.fetch(:refresh_delay_ms)
                 },
-                filters: [{ type: 'decoder', name: 'router', config: {} }],
+                filters: [{ type: 'decoder', name: 'router', config: {} }]
               }
-            ],
+            ]
           }
         ],
         admin: {
-          access_log_path: "/dev/stdout",
-          address: "tcp://0.0.0.0:9901"
+          access_log_path: config.admin.fetch(:access_log_path),
+          address: config.admin.fetch(:address)
         },
+        statsd_tcp_cluster_name: config.statsd.fetch(:name),
         cluster_manager: {
-          clusters: clusters,
+          clusters: [config.statsd],
+          cds: {
+            cluster: config.ds.fetch(:cluster),
+            refresh_delay_ms: config.ds.fetch(:refresh_delay_ms)
+          }
         }
       }
     end
 
+    def generate_routes(definition)
+      virtual_hosts = definition['services'].map { |s| service_to_vhost(s) }
+      {
+        validate_clusters: false,
+        virtual_hosts: virtual_hosts
+      }
+    end
+
+    def generate_clusters(definition)
+      {
+        clusters: definition['services'].map { |s| service_to_cluster(s) }
+      }
+    end
+
     private
 
     def service_to_vhost(service)
@@ -44,34 +67,35 @@ module Kumonos
       {
         name: name,
         domains: [name],
-        routes: service['routes'].flat_map {|r| split_route(r, name) }
+        routes: service['routes'].flat_map { |r| split_route(r, name) }
       }
     end
 
-    # Split route config to apply retry config only to GET/HEAD requests.
+    # Split route definition to apply retry definition only to GET/HEAD requests.
     def split_route(route, name)
       base = {
         prefix: route['prefix'],
         timeout_ms: route['timeout_ms'],
-        cluster: name,
+        cluster: name
       }
       with_retry = base.merge(
         retry_policy: route['retry_policy'],
-        headers: [{ name: ':method', value: '(GET|HEAD)', regex: true }],
+        headers: [{ name: ':method', value: '(GET|HEAD)', regex: true }]
       )
       [with_retry, base]
     end
 
     def service_to_cluster(service)
-      out = {
+      {
         name: service['name'],
         connect_timeout_ms: service['connect_timeout_ms'],
-        type: 'logical_dns',
+        type: 'strict_dns',
         lb_type: 'round_robin',
-        hosts: [ { url: "tcp://#{service['lb']}" }],
+        hosts: [{ url: "tcp://#{service['lb']}" }],
+        circuit_breakers: {
+          default: service['circuit_breaker']
+        }
       }
-      out.merge(circuit_breakers: [default: service['circuit_breaker']]) if service['circuit_breaker']
-      out
     end
   end
 end

data/lib/schemas/kumonos_config.json

@@ -0,0 +1,174 @@
+{
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "id": "kumonos-configuration",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "ds",
+    "statsd",
+    "listener",
+    "admin"
+  ],
+  "properties": {
+    "version": {
+      "type": "integer",
+      "id": "/properties/version"
+    },
+    "ds": {
+      "type": "object",
+      "id": "/properties/ds",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "refresh_delay_ms",
+        "cluster"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "id": "/properties/ds/properties/name"
+        },
+        "refresh_delay_ms": {
+          "type": "integer",
+          "id": "/properties/ds/properties/refresh_delay_ms"
+        },
+        "cluster": {
+          "type": "object",
+          "id": "/properties/ds/properties/cluster",
+          "additionalProperties": false,
+          "required": [
+            "name",
+            "type",
+            "connect_timeout_ms",
+            "lb_type",
+            "hosts"
+          ],
+          "properties": {
+            "name": {
+              "type": "string",
+              "id": "/properties/ds/properties/cluster/properties/name"
+            },
+            "type": {
+              "type": "string",
+              "id": "/properties/ds/properties/cluster/properties/type"
+            },
+            "connect_timeout_ms": {
+              "type": "integer",
+              "id": "/properties/ds/properties/cluster/properties/connect_timeout_ms"
+            },
+            "lb_type": {
+              "type": "string",
+              "id": "/properties/ds/properties/cluster/properties/lb_type"
+            },
+            "hosts": {
+              "type": "array",
+              "id": "/properties/ds/properties/cluster/properties/hosts",
+              "items": {
+                "type": "object",
+                "id": "/properties/ds/properties/cluster/properties/hosts/items",
+                "additionalProperties": false,
+                "required": [
+                  "url"
+                ],
+                "properties": {
+                  "url": {
+                    "type": "string",
+                    "id": "/properties/ds/properties/cluster/properties/hosts/items/properties/url"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "statsd": {
+      "type": "object",
+      "id": "/properties/statsd",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "connect_timeout_ms",
+        "type",
+        "lb_type",
+        "hosts"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "id": "/properties/statsd/properties/name"
+        },
+        "connect_timeout_ms": {
+          "type": "integer",
+          "id": "/properties/statsd/properties/connect_timeout_ms"
+        },
+        "type": {
+          "type": "string",
+          "id": "/properties/statsd/properties/type"
+        },
+        "lb_type": {
+          "type": "string",
+          "id": "/properties/statsd/properties/lb_type"
+        },
+        "hosts": {
+          "type": "array",
+          "id": "/properties/statsd/properties/hosts",
+          "items": {
+            "type": "object",
+            "id": "/properties/statsd/properties/hosts/items",
+            "additionalProperties": false,
+            "required": [
+              "url"
+            ],
+            "properties": {
+              "url": {
+                "type": "string",
+                "id": "/properties/statsd/properties/hosts/items/properties/url"
+              }
+            }
+          }
+        }
+      }
+    },
+    "listener": {
+      "type": "object",
+      "id": "/properties/listener",
+      "additionalProperties": false,
+      "required": [
+        "address",
+        "access_log_path"
+      ],
+      "properties": {
+        "address": {
+          "type": "string",
+          "id": "/properties/listener/properties/address"
+        },
+        "access_log_path": {
+          "type": "string",
+          "id": "/properties/listener/properties/access_log_path"
+        }
+      }
+    },
+    "admin": {
+      "type": "object",
+      "id": "/properties/admin",
+      "additionalProperties": false,
+      "required": [
+        "address",
+        "access_log_path"
+      ],
+      "properties": {
+        "address": {
+          "type": "string",
+          "id": "/properties/admin/properties/address"
+        },
+        "access_log_path": {
+          "type": "string",
+          "id": "/properties/admin/properties/access_log_path"
+        }
+      }
+    }
+  }
+}

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kumonos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Taiki Ono
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  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
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
 description: Manage configuration for Service Mesh.
 email:
 - taiks.4559@gmail.com
@@ -90,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -97,11 +126,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bump.rb
 - example/book.yml
+- example/kumonos.json
 - exe/kumonos
 - kumonos.gemspec
 - lib/kumonos.rb
+- lib/kumonos/configuration.rb
+- lib/kumonos/schemas.rb
 - lib/kumonos/version.rb
+- lib/schemas/kumonos_config.json
 homepage: https://github.com/taiki45/kumonos
 licenses:
 - MIT