mkit 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ddd1f77569b1f7982812ae1cf236b76816bd6fc31a27cde9067e010a296c981
-  data.tar.gz: cedb9272ef3c6ce621989c94a2fd08bf917e7a1f242c4f465306d82749af103c
+  metadata.gz: fa9363526eb6b57ea708a370424cfa71ede7d50f7d91d0d8700e1170f3af5930
+  data.tar.gz: 9c50d7cd862d5573b986f4c3231f76769ab4e5f930839c821232acd0bedf2923
 SHA512:
-  metadata.gz: 5ae6c65f2c6b68e116c66c8ac5716f5668d7642922869fdccbf55264d9f9bd96bc36320148bcd9e7d0f2909d010f1caf55e18095c301415432e48a2ecb5845dc
-  data.tar.gz: ad171bc7fa68ac93813dd15675119bc328f929063694c4627c7db013a5ad938dfdbedb0c8a7a9e45fbfc5b2ae834ef11ca4a24fae16ff37cd81c1f9d0a1da2b4
+  metadata.gz: 4c30c9847cdada9bbc87c059b1824430462e29d169498144d7e690d5848e30db29aee6008da4b09a59038355d20ee28688fce7a45d018f76b4afeee82ef3e660
+  data.tar.gz: 770e96f7cb6be72e5c0442c51b2f0229ccdb53a6611c8569a58fe370ec1f405a5d7cadd77a22dae8de1075f9202467a79b26c736f158fb661b5b50dd68aa6c66

data/README.md

@@ -9,7 +9,7 @@ The database is a simple sqlite3 db and the server is a Sinatra based applicatio
 
 A client is also included to access the API, e.g. `mkit ps`.
 
-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. 
+The daemon is responsible for HAProxy pods routing configuration. It also provides the cluster DNS and manages the internal host interface and the pod instances. 
 
 ## Requirements
 
@@ -124,7 +124,7 @@ my_id: unique_id # this id is generated running mkit init
 
 ```
 service:
-  name: rabbitmq # unique
+  name: rabbitmq # unique. Available on internal DNS as 'rabbitmq'
   image: rabbitmq:3-management-alpine # image
   network: bridge # docker network - it will be created if it does not exists
   ports:  # haproxy port mapping
@@ -140,7 +140,7 @@ service:
     - 5672:5672:tcp:round_robin
     - 80:15672:http:round_robin
   resources:
-    min_replicas: 1 # default value
+    min_replicas: 1 # default value. Pods will be available on internal DNS as '<service_name>.internal'
     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
@@ -192,8 +192,9 @@ restart      restart service
 create       create new service
 update       update service
 rm           remove service
+exec         execute a command in a running pod
 logs         view service logs
-version      prints mkit server version
+version      prints mkit client and server version
 proxy        haproxy status and control
 profile      mkit client configuration profile
 

data/bin/mkit

@@ -13,6 +13,7 @@ require 'uri'
 require 'fileutils'
 require 'mkit/client/command_parser'
 require 'mkit/client/mkitd_client'
+require 'mkit/version'
 
 class InvalidConfigurationException < Exception
   attr_reader :command
@@ -91,6 +92,10 @@ class MKItClient
     client.request(request, request_data)
   end
 
+  def version(request, request_data)
+    puts "MKIt Client version #{MKIt::VERSION}"
+    request(request, request_data)
+  end
   #
   # commands
   #
@@ -174,8 +179,3 @@ end
 #
 client = MKItClient.new
 client.doIt(ARGV.dup)
-#
-# if ARGV.any?
-# parse args
-#  host, socket, config file
-# end

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

@@ -4,7 +4,7 @@ require 'mkit/version'
 
 class MkitController < MKIt::Server
   get '/mkit/version' do
-    "MKIt version #{MKIt::VERSION}\n"
+    "MKIt Server version #{MKIt::VERSION}\n"
   end
 
   put '/mkit/proxy/restart' do

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

@@ -1,16 +1,42 @@
 # frozen_string_literal: true
 
-class PodsController < MKIt::Server
-  get '/services/:service_id/pods' do
-    "Not implemented\n"
-  end
+require 'mkit/app/model/pod'
+require 'mkit/app/helpers/pods_helper'
+require 'mkit/app/helpers/params_helper'
+require 'mkit/pods/docker_exec_command'
+require 'mkit/exceptions'
 
-  get '/services/:service_id/pods/:pod_id' do
-    "Not implemented\n"
-  end
+class PodsController < MKIt::Server
+  helpers MKIt::PodsHelper
+  helpers MKIt::ParamsHelper
 
-  put '/services/:service_id/pods/:pod_id' do
-    "Not implemented\n"
+  get '/pods/:id/exec' do
+    pod = find_by_id_or_name
+    if request.websocket?
+      options_parameter = build_options_hash(params: params, options: [:varargs])
+      raise MKIt::BaseException.new(400, "Missing parameters") unless options_parameter[:varargs]
+      options_parameter[:varargs] = JSON.parse(params['varargs'])
+      request.websocket do |ws|
+        listener = nil
+        ws.onopen do
+          settings.sockets << ws
+          listener = MKIt::DockerExecCommand.new(pod, ws, options: options_parameter)
+          settings.listeners << listener
+          listener.register
+        end
+        ws.onclose do
+          MKItLogger.info("websocket closed [#{listener}]")
+          settings.sockets.delete(ws)
+          if listener
+            MKItLogger.info("unregister [#{listener}]")
+            settings.listeners.delete(listener)
+            listener.unregister
+          end
+        end
+      end
+    else
+      raise MKIt::BaseException.new(400, "Bad request")
+    end
   end
 
   delete '/services/:service_id/pods/:pod_id' do

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

@@ -2,10 +2,13 @@
 
 require 'mkit/app/model/service'
 require 'mkit/app/helpers/services_helper'
-require 'mkit/docker_log_listener'
+require 'mkit/app/helpers/params_helper'
+require 'mkit/pods/docker_log_listener'
+require 'mkit/pods/docker_exec_command'
 
 class ServicesController < MKIt::Server
   helpers MKIt::ServicesHelper
+  helpers MKIt::ParamsHelper
 
   # curl localhost:4567/services
   get '/services' do
@@ -37,13 +40,14 @@ class ServicesController < MKIt::Server
     if !request.websocket?
       srv.log
     else
+      pod = find_srv_pod_by_id_or_name(srv)
       options_parameter = build_options_hash(params: params, options: [:nr_lines, :pods, :follow])
       request.websocket do |ws|
         listener = nil
         ws.onopen do
           settings.sockets << ws
           ws.send("<<<< %s | %s >>>>\n" % [srv.name, srv.pod.first.name])
-          listener = MKIt::DockerLogListener.new(srv.pod.first, ws, options: options_parameter)
+          listener = MKIt::DockerLogListener.new(pod, ws, options: options_parameter)
           settings.listeners << listener
           listener.register
         end
@@ -115,4 +119,34 @@ class ServicesController < MKIt::Server
     MkitJob.publish(topic: :start_service, service_id: srv.id)
     format_response(srv)
   end
+
+  get '/services/:id/pods/exec' do
+    srv = find_by_id_or_name
+    if request.websocket?
+      pod = find_srv_pod_by_id_or_name(srv)
+      options_parameter = build_options_hash(params: params, options: [:varargs, :interactive, :detached])
+      raise MKIt::BaseException.new(400, "Missing parameters") unless options_parameter[:varargs]
+      options_parameter[:varargs] = JSON.parse(params['varargs'])
+      request.websocket do |ws|
+        listener = nil
+        ws.onopen do
+          settings.sockets << ws
+          listener = MKIt::DockerExecCommand.new(pod, ws, options: options_parameter)
+          settings.listeners << listener
+          listener.register
+        end
+        ws.onclose do
+          MKItLogger.info("websocket closed [#{listener}]")
+          settings.sockets.delete(ws)
+          if listener
+            MKItLogger.info("unregister [#{listener}]")
+            settings.listeners.delete(listener)
+            listener.unregister
+          end
+        end
+      end
+    else
+      raise MKIt::BaseException.new(400, "Bad request")
+    end
+  end
 end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MKIt
+  module ParamsHelper
+
+    def build_options_hash(params:, options:)
+      hash = {}
+      options.each do |option|
+        hash[option] = params[option]
+      end
+      hash
+    end
+
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module MKIt
+  module PodsHelper
+
+    def find_by_id_or_name
+      pod = Pod.find_by_id(params[:id])
+      pod ||= Pod.find_by_name(params[:id])
+      error 404, "Couldn't find Pod '#{params[:id]}'\n" unless pod
+      pod
+    end
+
+  end
+end

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

@@ -16,13 +16,6 @@ module MKIt
       table.to_s
     end
 
-    def build_options_hash(params:, options:)
-      hash = {}
-      options.each do |option|
-        hash[option] = params[option]
-      end
-      hash
-    end
     def find_by_id_or_name
       srv = Service.find_by_id(params[:id])
       srv ||= Service.find_by_name(params[:id])
@@ -30,6 +23,16 @@ module MKIt
       srv
     end
 
+    def find_srv_pod_by_id_or_name(srv)
+      if params[:pod_id]
+        pod = srv.find_pod_by_id_or_name(params[:pod_id])
+        error 404, "Service pod not found." unless pod
+      else
+        pod = srv.pod.first
+      end
+      pod
+    end
+
     def build_table_row(data)
       ports = data.service_port&.each.map { |p| build_port(p) }.join(',')
       pods = data.pod.each.map { |p| p.name.to_s }.join(' ')

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

@@ -32,7 +32,7 @@ class Pod < ActiveRecord::Base
   def update_dns
     self.dns_host ||= DnsHost.new(
       service: self.service,
-      name:    "#{name}.#{self.service.name}",
+      name:    "#{self.service.name}.internal",
       ip:      self.ip
     )
     self.dns_host.ip = self.ip

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

@@ -222,6 +222,11 @@ class Service < ActiveRecord::Base
     MkitJob.publish(topic: :destroy_proxy_config, data: {filename: filename})
   end
 
+  def find_pod_by_id_or_name(pod_id)
+    pod = self.pod.find_by(id: pod_id)
+    pod = self.pod.find_by(name: pod_id) unless pod
+    pod
+  end
   #
   # ctrl
   #

data/lib/mkit/client/command_parser.rb

@@ -71,10 +71,22 @@ class CommandParser
   # request_data = {}
   def fill_cmd_args(args, argv, request, request_data)
     return if args.nil?
-    # add to schema
     args.each do |arg|
       arg[:type] = 'value' unless arg[:type]
     end
+    split = split_argv(argv)
+    argv = split[0]
+    varargs = split[1]
+    varargs = nil if varargs.empty?
+
+    # find vararg and fill it
+    vararg = args.select { |arg| arg[:type].to_sym == :varargs }.first
+    if vararg
+      request_data[vararg[:name].to_sym] = varargs
+      request[:params] ||= []
+      request[:params] << ["#{vararg[:name].to_sym}",  varargs ]
+    end
+
     # flag and options
     fill_flag_and_options_args(args, argv, request, request_data)
     idx = 0
@@ -88,6 +100,18 @@ class CommandParser
     end
   end
 
+  def split_argv(argv)
+    separator_index = argv.index('--')
+    if separator_index
+      left_side = argv[0...separator_index]
+      right_side = argv[(separator_index + 1)..-1]
+    else
+      left_side = argv
+      right_side = []
+    end
+    [left_side, right_side]
+  end
+
   def fill_flag_and_options_args(args, argv, request, request_data)
     # flags
     # checking flags first, avoids -n -f, with -f being the value of -n
@@ -122,7 +146,7 @@ class CommandParser
     request[:uri] = request[:uri] + arg[:uri] unless arg[:uri].nil?
     unless arg[:param].nil?
       request[:params] ||= []
-      request[:params] << [ "#{arg[:name]}", "#{arg[:param]}"]
+      request[:params] << %W[#{arg[:name]} #{arg[:param]}]
     end
   end
 

data/lib/mkit/client/commands.yaml

@@ -108,9 +108,53 @@
   request:
     verb: delete
     uri: "/services/<%=id%>"
+- cmd: exec
+  usage:
+    - "<service_id_or_name> [options] -- <command> [args...]"
+  help: execute a command in a running pod
+  request:
+    verb: ws_console
+    uri: "/services/<%=id%>/pods/exec"
+  args:
+    - name: id
+      help:
+        - id
+        - Service id or name
+      mandatory: true
+    - name: pod_id
+      help:
+        - -p <pod_id>
+        - Execute command for specified pod (default first)
+      mandatory: false
+      param: "<%=pod_id%>"
+      type: option
+      switch:
+        - "-p"
+    - name: detached
+      help:
+        - -d
+        - Run command in background
+      mandatory: false
+      param: "<%=true%>"
+      type: flag
+      switch:
+        - "-d"
+    - name: separator
+      help:
+        - --
+        - Ends mkit options and starts the command
+      mandatory: false
+      type: separator
+    - name: varargs
+      help:
+        - command
+        - Command and options
+      mandatory: true
+      type: varargs
+      param: <%=varargs%>
 - cmd: logs
   usage:
-    - "<service_id_or_name> [-f] [-n <lines>]"
+    - "<service_id_or_name> [-p <pod_id>] [-f] [-n <lines>]"
   help: view service logs
   request:
     verb: ws # new type
@@ -123,6 +167,15 @@
       help:
         - id
         - Service id or name
+    - name: pod_id
+      help:
+        - -p <pod_id>
+        - Show logs for specified pod (default first)
+      mandatory: false
+      param: "<%=pod_id%>"
+      type: option
+      switch:
+        - "-p"
     - name: follow
       help:
         - -f
@@ -141,17 +194,8 @@
       type: option
       switch:
         - "-n"
-    - name: pods
-      help:
-        - -p <[pods]>
-        - Show logs for specified pods, e.g. pod1, pod2 (default first)
-      mandatory: false
-      param: "<%=pods%>"
-      type: option
-      switch:
-        - "-n"
 - cmd: version
-  help: prints mkit server version
+  help: prints mkit client and server version
   request:
     verb: get
     uri: "/mkit/version"

data/lib/mkit/client/console_websocket_client.rb

@@ -0,0 +1,57 @@
+# # frozen_string_literal: true
+require 'faye/websocket'
+require 'eventmachine'
+require 'json'
+require 'io/console'
+
+module MKIt
+  class ConsoleWebSocketClient
+
+    def initialize(uri, options)
+      @uri = uri
+      @options = options
+    end
+
+    def doIt
+      EM.run {
+        ws = Faye::WebSocket::Client.new(@uri, nil, @options)
+
+        ws.on :open do |_event|
+          puts "Connected to WebSocket server"
+          puts "\r\n"
+        end
+
+        ws.on :message do |event|
+          print event.data
+        end
+
+        ws.on :error do |event|
+          p [:error, event.message]
+          ws = nil
+          EventMachine.stop
+        end
+
+        ws.on :close do |_event|
+          ws = nil
+          puts "\r\n"
+          EventMachine.stop
+        end
+
+        Thread.new do
+          STDIN.raw do
+            loop do
+              input = STDIN.getc.chr
+              # if input == "\u0003" # Ctrl+C
+              #   puts "bye..."
+              #   EventMachine.stop
+              #   break
+              # else
+                ws.send(input)
+              # end
+            end
+          end
+        end
+      }
+    end
+  end
+end

data/lib/mkit/client/log_websocket_client.rb

@@ -0,0 +1,46 @@
+# # frozen_string_literal: true
+require 'faye/websocket'
+require 'eventmachine'
+require 'json'
+require 'io/console'
+
+module MKIt
+  class LogWebSocketClient
+
+    def initialize(uri, options)
+      @uri = uri
+      @options = options
+      trap("SIGINT") do
+        puts "Bye..."
+        EventMachine.stop
+      end
+    end
+
+    def doIt
+      EM.run {
+        ws = Faye::WebSocket::Client.new(@uri, nil, @options)
+
+        ws.on :open do |_event|
+          puts "Connected to WebSocket server"
+          puts "\r\n"
+        end
+
+        ws.on :message do |event|
+          puts event.data
+        end
+
+        ws.on :error do |event|
+          p [:error, event.message]
+          ws = nil
+          EventMachine.stop
+        end
+
+        ws.on :close do |_event|
+          ws = nil
+          puts "\r\n"
+          EventMachine.stop
+        end
+      }
+    end
+  end
+end

data/lib/mkit/client/mkitd_client.rb

@@ -6,7 +6,7 @@ module MKIt
   class MKItdClient
     def initialize(request, server_url, my_id)
       case request[:verb].to_sym
-      when :ws
+      when :ws, :ws_console
         @client = MKIt::WebSocketClient.new(server_url, my_id)
       else
         @client = MKIt::HttpClient.new(server_url, my_id)
@@ -14,6 +14,8 @@ module MKIt
     end
 
     def request(request, request_data)
+      # puts "Request: #{request}"
+      # puts "Request data: #{request_data}"
       @client.request(request, request_data)
     end 
   end

data/lib/mkit/client/websocket_client.rb

@@ -2,9 +2,13 @@
 require 'faye/websocket'
 require 'eventmachine'
 require 'json'
+require 'io/console'
+require 'mkit/client/console_websocket_client'
+require 'mkit/client/log_websocket_client'
 
 module MKIt
   class WebSocketClient
+
     def initialize(server_url, my_id)
       @server_url = server_url
       @my_id = my_id
@@ -14,10 +18,6 @@ module MKIt
       @options[:headers] = { 'X-API-KEY' => @my_id }
       url_prefix = use_ssl ? "wss" : "ws"
       @ws_url = "#{url_prefix}://#{uri.host}:#{uri.port}"
-      trap("SIGINT") do
-        puts "Bye..."
-        EventMachine.stop
-      end
     end
 
     def request(request, request_data)
@@ -26,40 +26,15 @@ module MKIt
         uri = uri + '?' + request[:params].map { |k, v| "#{k}=#{v}" }.join('&')
       end
       uri = ERB.new("#{@ws_url}#{uri}").result_with_hash(request_data)
-      
-      EM.run {
-        ws = Faye::WebSocket::Client.new(uri, nil, @options) 
-
-        ws.on :open do |event|
-          # no op
-        end
 
-        ws.on :message do |event|
-          puts event.data
-        end
-
-        ws.on :error do |event|
-          p [:error, event.message]
-          ws = nil
-          return
-        end
-
-        ws.on :close do |event|
-          ws = nil
-          EventMachine.stop
-        end
+      case request[:verb].to_sym
+      when :ws_console
+        client = ConsoleWebSocketClient.new(uri, @options)
+      when :ws
+        client = LogWebSocketClient.new(uri, @options)
+      end
+      client.doIt
 
-        Thread.new do
-          loop do
-            input = STDIN.gets.chomp
-            if input == 'exit'
-              puts "bye..."
-              EventMachine.stop
-              break
-            end
-          end
-        end
-      }
     end
   end
 end

data/lib/mkit/pods/docker_exec_command.rb

@@ -0,0 +1,38 @@
+require "mkit/cmd/shell_client"
+
+module MKIt
+  class DockerExecCommand < MKIt::ShellClient
+
+    def initialize(pod, ws, options: {})
+      puts "DockerExecCommand: #{options}"
+      @pod = pod
+      @ws = ws
+      command = "docker exec"
+      command += " -it" unless options[:detached] == 'true'
+      command += " -d" if options[:detached] == 'true'
+      command += " #{@pod.name}"
+      command += " #{options[:varargs].join(' ')}" if options[:varargs]
+      super(command: command)
+    end
+
+    def register
+      super do |stdout, stdin, pid|
+          @stdout_thread = Thread.new do
+            stdout.each_char { |line| @ws.send(line) }
+          end
+
+          @stdin_thread = Thread.new do
+            @ws.onmessage do |msg|
+              stdin.putc msg
+            end
+          end
+          @stdout_thread.join
+      end
+    end
+
+    def close
+      @ws.close_websocket unless @ws.nil?
+    end
+  end
+end
+

data/lib/mkit/version.rb

@@ -1,4 +1,4 @@
 module MKIt
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end
 

data/lib/mkit.rb

@@ -16,7 +16,7 @@ require 'mkit/config/load_default_configs'
 require_relative 'mkit/version'
 require_relative 'mkit/mkit_interface'
 require_relative 'mkit/mkit_dns'
-require_relative 'mkit/docker_listener'
+require_relative 'mkit/pods/docker_listener'
 require 'mkit/app/helpers/haproxy'
 require 'mkit/app/controllers/services_controller'
 require 'mkit/app/controllers/mkitjobs_controller'
@@ -26,7 +26,6 @@ require 'mkit/mkit_dns'
 require 'mkit/job_manager'
 require 'mkit/workers/worker_manager'
 require 'mkit/sagas/saga_manager'
-require 'mkit/docker_listener'
 require 'mkit/app/helpers/haproxy'
 require 'active_record/tasks/database_tasks'
 require 'mkit/utils'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mkit
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Vasco Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-dns
@@ -385,6 +385,8 @@ files:
 - lib/mkit/app/helpers/erb_helper.rb
 - lib/mkit/app/helpers/haproxy.rb
 - lib/mkit/app/helpers/interface_helper.rb
+- lib/mkit/app/helpers/params_helper.rb
+- lib/mkit/app/helpers/pods_helper.rb
 - lib/mkit/app/helpers/services_helper.rb
 - lib/mkit/app/mkit_server.rb
 - lib/mkit/app/model/dns_host.rb
@@ -402,7 +404,9 @@ files:
 - lib/mkit/app/templates/haproxy/xapp_haproxy.cfg.erb
 - lib/mkit/client/command_parser.rb
 - lib/mkit/client/commands.yaml
+- lib/mkit/client/console_websocket_client.rb
 - lib/mkit/client/http_client.rb
+- lib/mkit/client/log_websocket_client.rb
 - lib/mkit/client/mkitd_client.rb
 - lib/mkit/client/websocket_client.rb
 - lib/mkit/cmd/shell_client.rb
@@ -414,12 +418,13 @@ files:
 - lib/mkit/config/load_default_configs.rb
 - lib/mkit/config/the_config.yml
 - lib/mkit/ctypes.rb
-- lib/mkit/docker_listener.rb
-- lib/mkit/docker_log_listener.rb
 - lib/mkit/exceptions.rb
 - lib/mkit/job_manager.rb
 - lib/mkit/mkit_dns.rb
 - lib/mkit/mkit_interface.rb
+- lib/mkit/pods/docker_exec_command.rb
+- lib/mkit/pods/docker_listener.rb
+- lib/mkit/pods/docker_log_listener.rb
 - lib/mkit/sagas/asaga.rb
 - lib/mkit/sagas/create_pod_saga.rb
 - lib/mkit/sagas/saga_manager.rb