mkit 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbf4273a9458c659131f42dff9f804d23632b282bb6ee04d803c8e8623262fa1
-  data.tar.gz: f9c7cdff9a122c90c714fd16de80bfc07f19ded8d88806d2b7e7f3af2f7dc246
+  metadata.gz: fb997b1bc61151dde6209eeaefdf4f669df9255b7e69735eb0c5c56e346222f1
+  data.tar.gz: 3819a29d9335a2d4831051d133d9e0056b93d54803701a27ed596a750f907d7b
 SHA512:
-  metadata.gz: e0975eb515e8b4b91006953f293206b02b1b377a3668b8478af9dfa84f9a58216cbbe83928c8458bb3d9676543cb748dedfa00c26f65279ffe59f15f847cab5d
-  data.tar.gz: d790f9aa1edcac942df9a72317295c9c091eb88ec029d2584c0275bbd7740fe94272504a984a3248d0aa1d77949e7343ee189fa0018b5724ecfd0de44308a567
+  metadata.gz: c95a967e4a016554700b9e844de87481fd8f4b1f71e2cb4cdae16509104b177485f6cdcc3aa114f3d4ab8680e8d39fb05c125fca4dd81edbb089800d08ec275e
+  data.tar.gz: f62ac16133370c7bc41f901fe148b708c046f4598331848daefd4bb108419f7b2fc510a9176bff771fbff3afa4e38d5ce000d70d8cad1feeb41b8f339956d802

data/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+      - v[0-9]*.[0-9]*.[0-9]*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          RUBYGEMS_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration

data/Gemfile

@@ -1,21 +1,23 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-#ruby '2.6.10'
+source 'https://rubygems.org'
+
+# ruby '3.0.2'
 
-gem 'net-ping'
 gem 'dry-container'
+gem 'net-ping'
+gem 'rake'
 gem 'sqlite3'
 gem 'standalone_migrations'
+gem 'text-table'
 
-gem 'sinatra-activerecord', :require => 'sinatra/activerecord'
-gem 'rack', '>= 2.0.6'
+gem 'async-dns'
 gem 'pry'
+gem 'rack', '>= 2.0.6'
 gem 'rubydns'
-gem 'async-dns'
+gem 'sinatra-activerecord'
 # rest http server
+gem 'net_http_unix' # socket client
 gem 'sinatra'
 gem 'thin' # socket server
-gem 'net_http_unix' # socket client
-#gem 'puma'
-
-
+# gem 'puma'

data/Gemfile.lock

@@ -104,6 +104,7 @@ GEM
       nokogiri (~> 1.14)
       railties (>= 6.0.0, < 7.1.0)
       rake (>= 10.0)
+    text-table (1.2.4)
     thin (1.8.2)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
@@ -126,11 +127,13 @@ DEPENDENCIES
   net_http_unix
   pry
   rack (>= 2.0.6)
+  rake
   rubydns
   sinatra
   sinatra-activerecord
   sqlite3
   standalone_migrations
+  text-table
   thin
 
 BUNDLED WITH

data/README.md

@@ -53,35 +53,47 @@ There's also samples on the samples dir, for daemontools and systemd.
 
 ### Accessing the API
 
-* Create new service
-  * `mkitc create samples/apps/rabbitmq.yml`
-* Update service
-  * `mkitc update samples/apps/rabbitmq.yml`
-* Get service
-  * `mkitc ps {id|service_name}`
-* Delete service
-  * `mkitc rm {id|service_name}`
-* List services
-  * `mkitc ps [-v (verbose)]`
-* Control service
-  * `mkitc start {id|service_name}`
-  * `mkitc stop {id|service_name}`
+A client is provided to interact with mkit server.
+
+Run `mkitc help` to list current supported commands.
+
+```
+Usage: mkitc <command> [options]
+
+Micro k8s on Ruby - a simple tool to mimic a (very) minimalistic k8 cluster
+
+Commands:
+
+ps         show services status (alias for status)
+status     show services status
+logs       prints service logs
+start      start service
+stop       stop service
+restart    restart service
+create     create new service
+update     update service
+rm         remove service
+version    prints mkit server version
+proxy      haproxy status and control
+
+Run 'mkitc help <command>' for specific command information.
+```
 
 Example:
 
 ```
 $ mkitc ps postgres
-id      name                 addr             ports                      status
-4       postgres             10.210.198.10    tcp/5432                   RUNNING
-  pods
-    id      pod_id            pod_name          pod_ip            status
-    19      4ce31a007211      5d148a16f3aa      172.17.0.2        RUNNING
++----+----------+---------------+----------+--------------+---------+
+| id |   name   |     addr      |  ports   |     pods     | status  |
++----+----------+---------------+----------+--------------+---------+
+| 2  | postgres | 10.210.198.10 | tcp/4532 | 49b5e4c8f247 | RUNNING |
++----+----------+---------------+----------+--------------+---------+
 ```
 The service `postgres` is available on IP `10.210.198.10:5432`
 
 ## Configuration
 
-On startup, configuration files on `config` directory will be copied to `/etc/mkit`. HAProxy config dir and control commands are defined on `mkit_config.yml`
+On startup, configuration files on `config` directory will be copied to `/etc/mkit`. HAProxy config directory and control commands are defined on `mkit_config.yml`
 
 You must configure `haproxy` to use config directory. e.g. on Ubuntu
 
@@ -115,8 +127,8 @@ service:
     - 5672:5672:tcp:round_robin
     - 80:15672:http:round_robin
   resources:
-    max_replicas: 1
-    min_replicas: 1
+    min_replicas: 1 # default value
+    max_replicas: 1 # default value
   volumes:
     - 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

data/Rakefile

@@ -1,42 +1,45 @@
-ENV["SINATRA_ENV"] ||= "development"
+# frozen_string_literal: true
+
+ENV['SINATRA_ENV'] ||= 'development'
 
 require 'rubygems'
-require 'sinatra/activerecord/rake'
 require 'standalone_migrations'
 require 'rubygems/package_task'
 require 'rubygems/specification'
 require 'rake/testtask'
 require 'pry'
 require 'fileutils'
+require 'bundler'
 require 'bundler/setup'
 require 'dry-container'
 require 'sinatra/activerecord'
+require 'sinatra/activerecord/rake'
 require 'rubydns'
 require_relative 'lib/mkit/version.rb'
 require_relative 'lib/mkit/utils'
 require_relative 'lib/mkit'
 
 $LOAD_PATH.unshift File.expand_path('lib')
-rails_env=ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+rails_env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
 # db migrations, use database config
-ENV["DATABASE_URL"]=MKIt::Utils.db_config_to_uri(rails_env)
+ENV['DATABASE_URL'] = MKIt::Utils.db_config_to_uri(rails_env)
 
 desc 'Builds the gem'
 task :package do
-  sh %{gem build "mkit.gemspec"}
+  sh %(gem build "mkit.gemspec")
 end
 
-task :install => [:package] do
-  sh %{gem install mkit-#{MKIt::VERSION}.gem}
+task install: [:package] do
+  sh %(gem install mkit-#{MKIt::VERSION}.gem)
 end
 
 desc 'Copy rb to packaging dir'
-task :build => [:init] do
-  FileUtils.cp_r('app', 'target/build', {:remove_destination=>true})
-  FileUtils.cp_r('config', 'target/build', {:remove_destination=>true})
-  FileUtils.cp_r('bin', 'target/build', {:remove_destination=>true})
-  FileUtils.cp_r('lib', 'target/build', {:remove_destination=>true})
-  FileUtils.cp_r('config.ru', 'target/build', {:remove_destination=>true})
+task build: [:init] do
+  FileUtils.cp_r('app', 'target/build', { remove_destination: true })
+  FileUtils.cp_r('config', 'target/build', { remove_destination: true })
+  FileUtils.cp_r('bin', 'target/build', { remove_destination: true })
+  FileUtils.cp_r('lib', 'target/build', { remove_destination: true })
+  FileUtils.cp_r('config.ru', 'target/build', { remove_destination: true })
 end
 
 desc 'Create build dirs'
@@ -45,10 +48,9 @@ task :init do
   FileUtils.mkdir_p('target/package')
 end
 
-desc "Rake Console"
+desc 'Rake Console'
 task :console do
   Pry.start
 end
 
 StandaloneMigrations::Tasks.load_tasks
-

data/bin/mkitc

@@ -8,104 +8,279 @@ require 'net/http'
 require 'json'
 require 'net_http_unix'
 require 'securerandom'
+require 'erb'
 
-class MKItClient
+class InvalidParametersException < RuntimeError
+  attr_reader :command
+  def initialize(cause, command = nil)
+    super(cause)
+    @command = command
+  end
+end
 
+class MKItClient
   def initialize
-    @client = NetX::HTTPUnix.new("localhost",4567)
+    @client = NetX::HTTPUnix.new('localhost', 4567)
   end
 
-  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'
+  def dict
+    global_args = [
+      { short: '-v', long: '--verbose', help: 'verbose', mandatory: false, value: nil }
+    ]
+    command_dict = [
+      {
+        cmd: 'ps',
+        args: [
+          { name: 'id', mandatory: false, uri: '/<%=id%>' }
+        ],
+        help: 'show services status (alias for status)',
+        usage: ['[service_id_or_name]'],
+        request: { verb: :get, uri: '/services' }
+      },
+      {
+        cmd: 'status',
+        args: [
+          { name: 'id', mandatory: false, uri: '/<%=id%>' }
+        ],
+        help: 'show services status',
+        usage: ['[service_id_or_name]'],
+        request: { verb: :get, uri: '/services' }
+      },
+      {
+        cmd: 'logs',
+        args: [
+          { name: 'id', mandatory: true }
+        ],
+        help: 'prints service logs',
+        usage: ['<service_id_or_name>'],
+        request: { verb: :get, uri: '/services/<%=id%>/logs' }
+      },
+      {
+        cmd: 'start',
+        args: [
+          { name: 'id', mandatory: true }
+        ],
+        help: 'start service',
+        usage: ['<service_id_or_name>'],
+        request: { verb: :put, uri: '/services/<%=id%>/start' }
+      },
+      {
+        cmd: 'stop',
+        args: [
+          { name: 'id', mandatory: true }
+        ],
+        help: 'stop service',
+        usage: ['<service_id_or_name>'],
+        request: { verb: :put, uri: '/services/<%=id%>/stop' }
+      },
+      {
+        cmd: 'restart',
+        args: [
+          { name: 'id', mandatory: true }
+        ],
+        help: 'restart service',
+        usage: ['<service_id_or_name>'],
+        request: { verb: :put, uri: '/services/<%=id%>/restart' }
+      },
+      {
+        cmd: 'create',
+        args: [
+          { name: 'file', mandatory: true }
+        ],
+        help: 'create new service',
+        usage: ['<service.yaml>'],
+        request: { verb: :post, uri: '/services' }
+      },
+      {
+        cmd: 'update',
+        args: [
+          { name: 'file', mandatory: true }
+        ],
+        help: 'update service',
+        usage: ['<service.yaml>'],
+        request: { verb: :put, uri: '/services/<%=id%>' }
+      },
+      {
+        cmd: 'rm',
+        args: [
+          { name: 'id', mandatory: true }
+        ],
+        help: 'remove service',
+        usage: ['<service_id_or_name>'],
+        request: { verb: :delete, uri: '/services/<%=id%>' }
+      },
+      {
+        cmd: 'version',
+        help: 'prints mkit server version',
+        request: { verb: :get, uri: '/mkit/version' }
+      },
+      {
+        cmd: 'proxy',
+        options: [
+          {
+            cmd: 'start',
+            request: { verb: :put, uri: '/mkit/proxy/start' },
+            help: 'start proxy service'
+          },
+          {
+            cmd: 'stop',
+            request: { verb: :put, uri: '/mkit/proxy/stop' },
+            help: 'stop proxy service'
+          },
+          {
+            cmd: 'restart',
+            request: { verb: :put, uri: '/mkit/proxy/restart' },
+            help: 'restarts proxy service'
+          },
+          {
+            cmd: 'status',
+            request: { verb: :get, uri: '/mkit/proxy/status' },
+            help: 'proxy service status'
+          }
+        ],
+        help: 'haproxy status and control',
+        usage: ['<start|stop|restart|status>']
+      }
+    ]
+    command_dict
+  end
+
+  def help(cause: nil, cmd: nil)
+    msg = ''
+    if cause.nil?
+      my_cmd = cmd
+    else
+      msg += "MKItc: #{cause.message}\n"
+      my_cmd = cause.command
+    end
+    if my_cmd.nil?
+      msg += "\nUsage: mkitc <command> [options]\n\n"
+      msg += "Micro k8s on Ruby - a simple tool to mimic a (very) minimalistic k8 cluster\n\n"
+      msg += "Commands:\n\n"
+      dict.each do |c|
+        msg += format("%-10s %s\n", c[:cmd], c[:help])
       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'
+      msg += "\n"
+      msg += "Run 'mkitc help <command>' for specific command information.\n\n"
+    else
+      msg += format("\nUsage: mkitc %s %s\n\n", my_cmd[:cmd], my_cmd[:usage].nil? ? '' : my_cmd[:usage].join(' '))
+      msg += format("%s\n", my_cmd[:help])
+      unless my_cmd[:options].nil?
+        msg += "\nOptions:\n"
+        my_cmd[:options].each  do |c|
+          msg += format("%-10s %s\n", c[:cmd], c[:help])
+        end
       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'
+      msg += "\n"
+    end
+    puts msg
+    exit 1
+  end
+
+  def create(request, request_hash = nil)
+    unless File.file?(request_hash[:file])
+      raise InvalidParametersException.new('File not found.', c = dict.select { |k| k[:cmd] == 'create' }.first)
+    end
+
+    yaml = YAML.load_file(request_hash[:file])
+    if yaml['service'].nil?
+      raise InvalidParametersException.new('Invalid configuration file', c = dict.select { |k| k[:cmd] == 'create' }.first)
+    else
+      request(request, request_hash)
+    end
+  end
+
+  def update(request, request_hash = nil)
+    unless File.file?(request_hash[:file])
+      raise InvalidParametersException.new('File not found.', c = dict.select { |k| k[:cmd] == 'update' }.first)
+    end
+
+    yaml = YAML.load_file(request_hash[:file])
+    if yaml['service'].nil?
+      raise InvalidParametersException.new('Invalid configuration file', c = dict.select { |k| k[:cmd] == 'update' }.first)
+    else
+      id = yaml['service']['name']
+      request_hash[:id] = id
+      request(request, request_hash)
+    end
+  end
+
+  def parse_args(args)
+    cmd = args[0]
+    c = nil
+    # short circuit for help
+    if cmd == 'help' || args.empty?
+      if args.size > 1
+        c = dict.select { |k| k[:cmd] == args[1] }.first
+        raise InvalidParametersException, "'#{args[1]}' is not a valid help topic." if c.nil?
       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'
+      return help(cmd: c)
+    else
+      c = dict.select { |k| k[:cmd] == cmd }.first
+    end
+    raise InvalidParametersException, 'Command not found' if c.nil?
+
+    myargs = args.dup
+    myargs.delete(cmd)
+
+    max_args_size = c[:args].nil? ? 0 : c[:args].size
+    max_options_size = c[:options].nil? ? 0 : 1
+    max_args_size += max_options_size
+
+    min_args_size = c[:args].nil? ? 0 : c[:args].select { |a| a[:mandatory] == true }.size
+    min_options_size = c[:options].nil? ? 0 : 1
+    min_args_size += min_options_size
+
+    if myargs.size > max_args_size || myargs.size < min_args_size
+      raise InvalidParametersException.new('Invalid parameters found.', c)
+    end
+
+    request_hash = {}
+    request = c[:request]
+    unless myargs.empty?
+      unless c[:args].nil?
+        idx = 0
+        c[:args].each do |a|
+          request_hash[a[:name].to_sym] = myargs[idx]
+          request[:uri] = request[:uri] + a[:uri] unless a[:uri].nil?
+          idx += 1
+        end
       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 }
+      # options
+      unless c[:options].nil?
+        option = nil
+        myargs.each do |s|
+          option = c[:options].select { |o| o[:cmd] == s }.first
+          raise InvalidParametersException.new('Invalid parameters found.', c) if option.nil? || option.empty?
         end
-      else
-        raise 'invalid parameters'
+        raise InvalidParametersException.new('Invalid parameters found.', c) if option.nil? || option.empty?
+
+        request = option[:request]
       end
+    end
+    raise InvalidParametersException, "Can't find request." if request.nil?
+
+    if respond_to? c[:cmd]
+      send(c[:cmd], request, request_hash)
     else
-      raise "Usage: invalid parameters"
+      request(request, request_hash)
     end
-    request
   end
 
   def doIt(args)
-    operation = parse_args(args)
-    puts request(operation).body
+    result = parse_args(args)
+    puts result
+  rescue InvalidParametersException => e
+    help(cause: e)
   end
 
-  def request(request)
+  def request(request, request_args = nil)
     req = nil
-    uri = request[:uri]
+    uri = ERB.new(request[:uri]).result_with_hash(request_args)
+    request[:file] = request_args[:file]
+
     unless request[:params].nil? || request[:params].empty?
-      uri = uri + '?' + request[:params].map{|k,v| "#{k}=#{v}"}.join('&')
+      uri = uri + '?' + request[:params].map { |k, v| "#{k}=#{v}" }.join('&')
     end
     case request[:verb]
     when :post
@@ -113,14 +288,14 @@ class MKItClient
       unless request[:file].nil?
         (body, boundary) = attach(request[:file])
         req.body = body
-        req["Content-Type"] = "multipart/form-data, boundary=#{boundary}"
+        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}"
+        req['Content-Type'] = "multipart/form-data, boundary=#{boundary}"
       end
     when :patch
       req = Net::HTTP::Patch.new(uri)
@@ -129,11 +304,11 @@ class MKItClient
     when :delete
       req = Net::HTTP::Delete.new(uri)
     end
-    @client.request(req)
+    @client.request(req).body
   end
 
   def attach(file)
-    boundary=SecureRandom.alphanumeric
+    boundary = SecureRandom.alphanumeric
     body = []
     body << "--#{boundary}\r\n"
     body << "Content-Disposition: form-data; name=file; filename='#{File.basename(file)}'\r\n"
@@ -141,7 +316,7 @@ class MKItClient
     body << "\r\n"
     body << File.read(file)
     body << "\r\n--#{boundary}--\r\n"
-    [ body.join, boundary]
+    [body.join, boundary]
   end
 end
 
@@ -155,4 +330,3 @@ client.doIt(ARGV.dup)
 # parse args
 #  host, socket, config file
 # end
-