mkit 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e23a426169a1815c4f92ef46461db9275e60aabe3ac62e9eb57d5a36e34ded
-  data.tar.gz: f05140fed7e69015dcfe19e2f9d52498a7cf260da0ffb31fbcbaddf505f204f0
+  metadata.gz: '03388845cec9ae0e648bd0692ce1f3b0608127bfd3f4da3019ca78fa8c188d1c'
+  data.tar.gz: 9aa7ded98a1198a4f3dc81a313cd4eddee05df42ec0da5e3e48eb53ab639fd3f
 SHA512:
-  metadata.gz: dcfb2eca9b54bd5871c9899640abba32e6da653f3db94ba9701ccc7271225d0634c77361444c1683f1f71bb138afc4e3d86e416fb930a3f6bf74a6bd93449974
-  data.tar.gz: 9d3efacb12c9dc6959501101d3f2ad31b8367909beb36eb139d7a702e57ad05046363330d253dc6f39c163541c24d62f42ce780aca900ca82754054b93ed4404
+  metadata.gz: 55978a84196d4bd5f72ef0f8fa745d5f74a24d4e6ecb62d4b52bc5076b8b1a63a9e3fdfc2c80a07f8b8d6a7d19fae99b6d2b2f7365a2258678d46380c60e4803
+  data.tar.gz: c1c2dea9ae37f80db6a8bca1c63b3556e5642b84d882e96fd323f483df767600ee5b58e72ba930af6ec086641d41eeee0252bfec567fff182cfc4fcfe45157fc

data/README.md

@@ -2,12 +2,12 @@
 
 This is micro kubernetes(tm) on Ruby(tm), a simple tool to deploy containers to mimic a (very) minimalistic k8 cluster with a nice REST API.
 
-It contains a internal DNS and uses HAProxy for routing/balancing/fail-over for Pods access.
+It contains an internal DNS and uses HAProxy for routing/balancing/fail-over for Pods access.
 The database is a simple sqlite3 db and the server is a Sinatra based application.
 
-The client is not done yet, only includes a simple wrapper to `curl`
+A client is also included to access the API, e.g. `mkitc ps`.
 
-The daemon is responsible for HAProxy pods routing configuration. It also provides the cluster DNS and manages the internal host interface. 
+The daemon is responsible for HAProxy pods routing configuration. It also provides the cluster DNS and manages the internal host interface and the docker instances. 
 
 ## Requirements
 
@@ -16,9 +16,16 @@ The daemon is responsible for HAProxy pods routing configuration. It also provid
 * Docker
 * Linux (iproute2 package)
 
+## Install
+
+This is a simple ruby gem, so to install run
+```
+# gem install mkit
+```
+
 ## Running
 
-The `daemon` requires `root` user, you can run it directly on the repository root...
+The `daemon` requires `root` user (due to `ip` and `haproxy`), you can run it directly on the repository root...
 
 ```
 # ./mkitd  --help
@@ -47,22 +54,23 @@ There's also samples on the samples dir, for daemontools and systemd.
 ### Accessing the API
 
 * Create new service
-  * `mkitc POST services -F "file=@samples/apps/rabbitmq.yml"`
+  * `mkitc create samples/apps/rabbitmq.yml`
 * Update service
-  * `mkitc PUT services/{id|service_name} -F "file=@samples/apps/rabbitmq.yml"`
-* Get services
-  * `mkitc GET services/{id|service_name}[?verbose=true]`
+  * `mkitc update samples/apps/rabbitmq.yml`
+* Get service
+  * `mkitc ps {id|service_name}`
 * Delete service
-  * `mkitc DELETE services/{id|service_name}`
+  * `mkitc rm {id|service_name}`
 * List services
-  * `mkitc GET services?verbose=true`
+  * `mkitc ps [-v (verbose)]`
 * Control service
-  * `mkitc PUT services/{id|service_name}/start`
-  * `mkitc PUT services/{id|service_name}/stop`
+  * `mkitc start {id|service_name}`
+  * `mkitc stop {id|service_name}`
 
 Example:
 
 ```
+$ mkitc ps postgres
 id      name                 addr             ports                      status
 4       postgres             10.210.198.10    tcp/5432                   RUNNING
   pods
@@ -98,15 +106,19 @@ CONFIG="/etc/haproxy/haproxy.d"
 service:
   name: rabbitmq # unique
   image: rabbitmq:3-management-alpine # image
-  network: bridge # docker network
-  ports:  # haproxy port mapping: <external_port>|<internal_port>|<tcp|http>|round_robin
+  network: bridge # docker network - it will be created if it does not exists
+  ports:  # haproxy port mapping
+          #   <external_port>:[internal_port]:<tcp|http>:[round_robin (default)|leastconn]
+          # to define a range on `external_port`, leave `internal_port` blank
+          #   - 5000-5100::tcp:round_robin
+          # range on `internal_port` is not supported 
     - 5672:5672:tcp:round_robin
     - 80:15672:http:round_robin
   resources:
     max_replicas: 1
     min_replicas: 1
   volumes:
-    - docker://mkit_rabbitmq_data:/var/lib/rabbitmq # a docker volume
+    - docker://mkit_rabbitmq_data:/var/lib/rabbitmq # a docker volume - it will be created if it does not exists
     - /var/log/rabbitmq/logs:/var/log/rabbitmq # a local volume
   environment:
     RABBITMQ_DEFAULT_USER: admin

data/bin/mkitc

@@ -2,30 +2,157 @@
 # frozen_string_literal: true
 
 require 'rubygems'
+require 'optparse'
+require 'yaml'
+require 'net/http'
+require 'json'
+require 'net_http_unix'
+require 'securerandom'
 
 class MKItClient
 
-  VERBS = %w{GET POST PUT DELETE}
-  def usage
-    puts 
-    puts  "usage: mkitc <verb> <path>"
-    puts  "  where <verb> is one of GET | POST | PUT | DELETE"
-    puts  "e.g."
-    puts  "  mkitc GET applications"
-    puts 
+  def initialize
+    @client = NetX::HTTPUnix.new("localhost",4567)
   end
 
-  def run
-    if ARGV.size < 2 || VERBS.index(ARGV[0]).nil?
-      usage
-      exit 1
+  def parse_args(args)
+    request = nil
+    case args[0]
+    when /^ps$/
+      if args.include?('-v')
+        params = {verbose: 'true'}
+        args.delete('-v')
+      else
+        params = {}
+      end
+      case args.size
+      when 1
+        #mkitc ps [-v] GET services[?verbose=true]
+        request = { verb: :get, uri: '/services', params: params }
+      when 2
+        #mkitc ps {id} GET services/{id}
+        id = args[1]
+        request = { verb: :get, uri: "/services/#{id}" }
+      else
+        raise 'invalid parameters'
+      end
+    when /^config:show$/
+      #mkitc config:show {id} => GET services/{id}/config
+      #TODO
+    when /^stop$/
+      #mkitc stop  {id} => PUT services/{id}/stop
+      case args.size
+      when 2
+        id = args[1]
+        request = { verb: :put, uri: "/services/#{id}/stop" }
+      else
+        raise 'invalid parameters'
+      end
+    when /^start$/
+      #mkitc start {id} => PUT services/{id}/start
+      case args.size
+      when 2
+        id = args[1]
+        request = { verb: :put, uri: "/services/#{id}/start" }
+      else
+        raise 'invalid parameters'
+      end
+    when /^rm$/
+      #mkitc rm {id} => DELETE services/{id}
+      case args.size
+      when 2
+        id = args[1]
+        request = { verb: :delete, uri: "/services/#{id}" }
+      else
+        raise 'invalid parameters'
+      end
+    when /^create$/
+      #mkitc create service.yaml => POST services service.yaml
+      case args.size
+      when 2
+        file = args[1]
+        request = { verb: :post, uri: "/services", file: file }
+      else
+        raise 'invalid parameters'
+      end
+    when /^update$/
+      #mkitc update service.yaml => PUT services/{id} service.yaml
+      case args.size
+      when 2
+        file = args[1]
+        yaml = YAML.load_file(file)
+        if yaml["service"].nil?
+          raise 'invalid configuration file'
+        else
+          id = yaml["service"]["name"]
+          request = { verb: :put, uri: "/services/#{id}", file: file }
+        end
+      else
+        raise 'invalid parameters'
+      end
+    else
+      raise "Usage: invalid parameters"
     end
+    request
+  end
+
+  def doIt(args)
+    operation = parse_args(args)
+    puts request(operation).body
+  end
+
+  def request(request)
+    req = nil
+    uri = request[:uri]
+    unless request[:params].nil? || request[:params].empty?
+      uri = uri + '?' + request[:params].map{|k,v| "#{k}=#{v}"}.join('&')
+    end
+    case request[:verb]
+    when :post
+      req = Net::HTTP::Post.new(uri)
+      unless request[:file].nil?
+        (body, boundary) = attach(request[:file])
+        req.body = body
+        req["Content-Type"] = "multipart/form-data, boundary=#{boundary}"
+      end
+    when :put
+      req = Net::HTTP::Put.new(uri)
+      unless request[:file].nil?
+        (body, boundary) = attach(request[:file])
+        req.body = body
+        req["Content-Type"] = "multipart/form-data, boundary=#{boundary}"
+      end
+    when :patch
+      req = Net::HTTP::Patch.new(uri)
+    when :get
+      req = Net::HTTP::Get.new(uri)
+    when :delete
+      req = Net::HTTP::Delete.new(uri)
+    end
+    @client.request(req)
+  end
 
-    response = %x{curl -sL -X #{ARGV[0]} http://localhost:4567/#{ARGV[1]} #{ARGV[2]} #{ARGV[3]} #{ARGV[4]} #{ARGV[5]} #{ARGV[6]} #{ARGV[7]}}
-    puts response
+  def attach(file)
+    boundary=SecureRandom.alphanumeric
+    body = []
+    body << "--#{boundary}\r\n"
+    body << "Content-Disposition: form-data; name=file; filename='#{File.basename(file)}'\r\n"
+    body << "Content-Type: text/plain\r\n"
+    body << "\r\n"
+    body << File.read(file)
+    body << "\r\n--#{boundary}--\r\n"
+    [ body.join, boundary]
   end
 end
 
+#
+# go
+#
 client = MKItClient.new
-client.run
+client.doIt(ARGV.dup)
+#
+# if ARGV.any?
+# parse args
+#  host, socket, config file
+# end
 

data/lib/mkit/app/controllers/services_controller.rb

@@ -41,9 +41,6 @@ class ServicesController < MKIt::Server
       srv.update!(yaml.to_o)
     end
     format_response(srv)
-  rescue MKIt::BaseException => e
-    MKItLogger.debug e
-    error e.error_code, e.message
   end
 
   # curl -X DELETE localhost:4567/services/1
@@ -62,9 +59,6 @@ class ServicesController < MKIt::Server
       srv = Service.create(yaml.to_o)
     end
     format_response(srv)
-  rescue MKIt::BaseException => e
-    MKItLogger.debug e
-    error e.error_code, e.message
   end
 
   #
@@ -84,4 +78,3 @@ class ServicesController < MKIt::Server
     format_response(srv)
   end
 end
-

data/lib/mkit/app/helpers/docker_helper.rb

@@ -38,9 +38,9 @@ module MKIt
       MKIt::CmdRunner.run("docker network create #{network_name}")
     end
 
-    def inspect_network(network_name)
-      x = MKIt::CmdRunner.run("docker network inspect #{network_name}")
-      JSON.parse(x).first
+    def network_exists?(network_name)
+      x = MKIt::CmdRunner.run("docker network ls")
+      x.match(/\b#{network_name}\b/)
     end
 
     def dettach_network(network_id, instance_id)

data/lib/mkit/app/mkit_server.rb

@@ -3,6 +3,18 @@ require 'mkit/exceptions'
 module MKIt
   class Server < Sinatra::Base
     set :default_content_type, :json
-    # set :dump_errors, false
+    set :dump_errors, true
+    set :show_exceptions, false
+    set :raise_errors, false
+
+    error MKIt::BaseException do |e|
+      MKItLogger.debug e
+      error e.error_code, e.message
+    end
+
+    error do |e|
+      MKItLogger.debug e
+      error 500, e.message
+    end
   end
 end

data/lib/mkit/app/model/pool.rb

@@ -16,21 +16,20 @@ class Pool < ActiveRecord::Base
     ips = range.split('-')
     next_ip = ips[0]
     next_ip = next_ip.to_i
-    lease.select(:status == MKIt::PoolStatus::IN_USE || :status == MKIt::PoolStatus::RESERVED).each { |l|
-      leased_ip = l.ip.split('.')[3]
-      leased_ip = leased_ip.to_i
-      if leased_ip >= next_ip
-        next_ip = leased_ip+1
+    ip_add = self.ip.split('.')
+    while next_ip <= ips[1].to_i + 1 do
+      if (lease.select{|l| l.ip == "#{ip_add[0]}.#{ip_add[1]}.#{ip_add[2]}.#{next_ip}"}.size == 0)
+        break
+      else
+        next_ip+=1
       end
-    }
+    end
+
     if next_ip > ips[1].to_i
       self.status = MKIt::PoolStatus::EXAUSTED
       self.save
       raise PoolExaustedException.new
     end
-
-    ip_add = self.ip.split('.')
-
     "#{ip_add[0]}.#{ip_add[1]}.#{ip_add[2]}.#{next_ip}"
   end
 

data/lib/mkit/app/model/service.rb

@@ -9,11 +9,7 @@ require 'mkit/status'
 require 'mkit/utils'
 require 'mkit/ctypes'
 require 'mkit/app/model/pool'
-require 'mkit/app/model/service'
-require 'mkit/app/model/pod'
 require 'mkit/app/model/dns_host'
-require 'mkit/app/helpers/erb_helper'
-require 'mkit/app/helpers/docker_helper'
 require 'mkit/app/helpers/haproxy'
 
 #
@@ -46,13 +42,6 @@ class Service < ActiveRecord::Base
       status: MKIt::Status::CREATING
     )
 
-    # docker network
-    if config.network.nil? || config.network.empty?
-      srv.pods_network="mkit"
-    else
-      srv.pods_network=config.network
-    end
-
     # reserve pool ip
     srv.lease = Pool.find_by_name(MKIt::Utils.me).reserve_for(srv)
 
@@ -91,6 +80,14 @@ class Service < ActiveRecord::Base
     end
     self.max_replicas = self.min_replicas if self.min_replicas > self.max_replicas
 
+    # docker network
+    if config.network.nil? || config.network.empty?
+      self.pods_network="mkit"
+    else
+      self.pods_network=config.network
+    end
+    self.create_pods_network
+
     # haproxy ports
     self.service_port = []
     config.ports&.each do |p|
@@ -130,16 +127,13 @@ class Service < ActiveRecord::Base
   end
 
   def create_pods_network
-    netw = inspect_network(self.pods_network)
-    create_network(self.pods_network) if netw.nil?
+    create_network(self.pods_network) if !network_exists?(self.pods_network)
   end
 
   def deploy_network
     # create service interface...
     self.lease.confirm
     self.lease.up
-    # ...and pods network
-    self.create_pods_network
   end
 
   def add_volume(volume_config)
@@ -201,19 +195,6 @@ class Service < ActiveRecord::Base
   #
   # ha proxy configs & template
   #
-  def public_ports
-    self.service_port.each.map{|p| p.external_port}.uniq
-  end
-
-  def ports_by_external(external_port)
-    self.service_port.where('external_port = ?', external_port)
-  end
-
-  def ports_mode_by_external(external_port)
-    ports = self.service_port.where('external_port = ?', external_port).first
-    ports.mode if ports
-  end
-
   def update_proxy
     MkitJob.publish(topic: :update_proxy_config, application_id: self.id, data: proxy_config)
   end

data/lib/mkit/app/model/service_port.rb

@@ -1,30 +1,47 @@
 require 'mkit/app/model/service'
+require 'mkit/exceptions'
 
 class ServicePort < ActiveRecord::Base
   belongs_to :service
 
+  CONFIG_EXPRESSION=/^(.*?):(.*?):(tcp|http):(.*?)$/
+
   def self.create(service:, config:)
     sp = ServicePort.new(service: service, version: service.version)
     sp.parse_config(config)
     sp
   end
 
-  # haproxy support for port range - leave src blank
+  # haproxy support for port range - leave dest blank
   # service:
   #   ports:
-  #     # src:dest:tcp|http:load-balancing
+  #     # src:dest:tcp|http:round_robin|leastconn
   #     - 5532:5432:tcp:round_robin
+  #     - 5532-6000::tcp:round_robin
   # model:
   #  service_ports:
   #     - external: 5432
   #       internal: 5432
   #       mode: tcp|http
-  #       load_bal:
+  #       load_bal: round_robin
   def parse_config(config)
-    ports = config.split(':')
-    self.external_port = ports[0]
-    self.internal_port = ports[1]
-    self.mode = ports[2]
-    self.load_bal = ports[3]
+    ports = config.match(CONFIG_EXPRESSION)
+    raise MKIt::InvalidPortsConfiguration.new("no match with config expression $#{CONFIG_EXPRESSION}") if ports.nil?
+
+    self.external_port = ports[1]
+    self.internal_port = ports[2]
+    self.mode = ports[3]
+    self.load_bal = ports[4]
+  end
+
+  def load_balance
+    case self.load_bal
+    when /^round_robin$/
+      "roundrobin"
+    when /^leastconn$/
+      "leastconn"
+    else
+      "roundrobin"
+    end
   end
 end

data/lib/mkit/app/templates/haproxy/xapp_haproxy.cfg.erb

@@ -1,30 +1,27 @@
 #
 # MKIt generated file
 #
-<% public_ports.each { |external_port|%>
+<% service_port.each { |port|%>
 #
-# start <%=name%>-<%=external_port%>
+# start <%=name%>-<%=port.external_port%>
 #
-frontend <%=name%>-<%=external_port%>-front
-  bind <%=lease.ip%>:<%=external_port%>
-  mode <%=ports_mode_by_external(external_port)%>
+frontend <%=name%>-<%=port.external_port%>-front
+  bind <%=lease.ip%>:<%=port.external_port%>
+  mode <%=port.mode%>
   #
-  use_backend <%=name%>-<%=external_port%>-back
+  use_backend <%=name%>-<%=port.external_port%>-back
 
-backend <%=name%>-<%=external_port%>-back
-   mode <%=ports_mode_by_external(external_port)%>
-   #balance leastconn
-   balance  roundrobin
- <%if ports_mode_by_external(external_port) == 'http'%>
-   option httpclose
-   option forwardfor
-   cookie JSESSIONID prefix
- <%end%>
-<%ports_by_external(external_port).each { |port| %>
-   <%port.service.pod.each { | pod | %>
-   server <%=pod.name%>  <%=pod.ip%>:<%=port.internal_port%> <%if port.mode == 'http'%>cookie A<%end%>  check<%}%><%}%>
-# 
-# end of <%=name%>-<%=external_port%>
+backend <%=name%>-<%=port.external_port%>-back
+  mode <%=port.mode%>
+  balance <%=port.load_balance%>
+ <%if port.mode == 'http'%>
+  option httpclose
+  option forwardfor
+  cookie JSESSIONID prefix
+ <%end%><%port.service.pod.each { | pod | %>
+  server <%=pod.name%>  <%=pod.ip%><%unless port.internal_port.nil? || port.internal_port.empty? then%><%=":#{port.internal_port}"%> <%if port.mode == 'http'%>cookie A<%end%> check<%end%>
+  <%}%>
 #
-<%}%>
-
+# end of <%=name%>-<%=port.external_port%>
+#
+<%}%>

data/lib/mkit/exceptions.rb

@@ -17,6 +17,11 @@ module MKIt
       super(400, message)
     end
   end
+  class InvalidPortsConfiguration < BaseException
+    def initialize(message = nil)
+      super(400, message)
+    end
+  end
   class ServiceNotFoundException < StandardError; end
   class PodNotFoundException     < StandardError; end
   class AppAlreadyDeployedException < StandardError; end

data/lib/mkit/version.rb

@@ -1,4 +1,4 @@
 module MKIt
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end
 

data/lib/mkit.rb

@@ -110,6 +110,9 @@ module MKIt
       srv.deploy_network
       srv.update_status!
     }
+    # daemontools would eventually start haproxy; systemd does not.
+    # so, restart here.
+    MKIt::HAProxy.restart
   end
 
   def self.startup(options: {})

data/mkit.gemspec

@@ -6,12 +6,12 @@ require "mkit/version"
 
 Gem::Specification.new do |s|
         s.name         = 'mkit'
-        s.summary      = 'micro kubernets'
+        s.summary      = 'Micro Kubernets on Ruby'
         s.bindir       = 'bin'
-        s.homepage     = 'http://vars.pt'
+        s.homepage     = 'https://github.com/valexsantos/mkit'
         s.license      = 'Apache-2.0'
         s.rubyforge_project = ''
-        s.description  = 'micro kubernets impl'
+        s.description  = 'Micro k8s on Ruby - a simple tool to deploy containers to mimic a (very) minimalistic k8 cluster with a nice REST API'
         # s.require_paths = ["."]
         s.author      = 'Vasco Santos'
         s.email        = ['valexsantos@gmail.com']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Vasco Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ping
@@ -290,7 +290,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.2
-description: micro kubernets impl
+description: Micro k8s on Ruby - a simple tool to deploy containers to mimic a (very)
+  minimalistic k8 cluster with a nice REST API
 email:
 - valexsantos@gmail.com
 executables:
@@ -367,7 +368,7 @@ files:
 - samples/daemontools/log/run
 - samples/daemontools/run
 - samples/systemd/mkitd.service
-homepage: http://vars.pt
+homepage: https://github.com/valexsantos/mkit
 licenses:
 - Apache-2.0
 metadata: {}
@@ -389,5 +390,5 @@ requirements: []
 rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
-summary: micro kubernets
+summary: Micro Kubernets on Ruby
 test_files: []