mkit 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03e23a426169a1815c4f92ef46461db9275e60aabe3ac62e9eb57d5a36e34ded
+  data.tar.gz: f05140fed7e69015dcfe19e2f9d52498a7cf260da0ffb31fbcbaddf505f204f0
+SHA512:
+  metadata.gz: dcfb2eca9b54bd5871c9899640abba32e6da653f3db94ba9701ccc7271225d0634c77361444c1683f1f71bb138afc4e3d86e416fb930a3f6bf74a6bd93449974
+  data.tar.gz: 9d3efacb12c9dc6959501101d3f2ad31b8367909beb36eb139d7a702e57ad05046363330d253dc6f39c163541c24d62f42ce780aca900ca82754054b93ed4404

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,137 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.8)
+      actionview (= 7.0.8)
+      activesupport (= 7.0.8)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.8)
+      activesupport (= 7.0.8)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activerecord (7.0.8)
+      activemodel (= 7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    async (1.31.0)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-dns (1.3.0)
+      async-io (~> 1.15)
+    async-io (1.38.0)
+      async
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    console (1.23.2)
+      fiber-annotation
+      fiber-local
+    crass (1.0.6)
+    daemons (1.4.1)
+    dry-container (0.11.0)
+      concurrent-ruby (~> 1.0)
+    erubi (1.12.0)
+    eventmachine (1.2.7)
+    fiber-annotation (0.2.0)
+    fiber-local (1.0.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    minitest (5.20.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    net-ping (2.0.8)
+    net_http_unix (0.2.2)
+    nio4r (2.7.0)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-protection (3.1.0)
+      rack (~> 2.2, >= 2.2.4)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.1.0)
+    ruby2_keywords (0.0.5)
+    rubydns (2.0.2)
+      async-dns (~> 1.0)
+    sinatra (3.1.0)
+      mustermann (~> 3.0)
+      rack (~> 2.2, >= 2.2.4)
+      rack-protection (= 3.1.0)
+      tilt (~> 2.0)
+    sinatra-activerecord (2.0.27)
+      activerecord (>= 4.1)
+      sinatra (>= 1.0)
+    sqlite3 (1.6.8-x86_64-darwin)
+    sqlite3 (1.6.8-x86_64-linux)
+    standalone_migrations (7.1.2)
+      activerecord (>= 6.0.0, < 7.1.0)
+      nokogiri (~> 1.14)
+      railties (>= 6.0.0, < 7.1.0)
+      rake (>= 10.0)
+    thin (1.8.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thor (1.3.0)
+    tilt (2.3.0)
+    timers (4.3.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  async-dns
+  dry-container
+  net-ping
+  net_http_unix
+  pry
+  rack (>= 2.0.6)
+  rubydns
+  sinatra
+  sinatra-activerecord
+  sqlite3
+  standalone_migrations
+  thin
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Vasco Santos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,126 @@
+# MKIt - Micro Kubernetes on Ruby
+
+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.
+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`
+
+The daemon is responsible for HAProxy pods routing configuration. It also provides the cluster DNS and manages the internal host interface. 
+
+## Requirements
+
+* Ruby
+* HAProxy
+* Docker
+* Linux (iproute2 package)
+
+## Running
+
+The `daemon` requires `root` user, you can run it directly on the repository root...
+
+```
+# ./mkitd  --help
+Usage: mkitd [options]
+    -c config-dir                    set the config dir (default is /etc/mkit)
+    -p port                          set the port (default is 4567)
+    -b bind                          specify bind address (e.g. /tmp/app.sock)
+    -s server                        specify rack server/handler
+    -q                               turn on quiet mode (default is off)
+    -x                               turn on the mutex lock (default is off)
+    -e env                           set the environment (default is development)
+    -o addr                          set the host (default is (env == 'development' ? 'localhost' : '0.0.0.0'))
+   
+```
+
+or after the `gem install mkit-<version>.gem`. The server and client will be installed on host.
+
+```
+# mkitd
+...
+ 0.65s     info: MKIt is up and running! [ec=0xbe0] [pid=45804] [2023-12-29 15:46:04 +0000]
+```
+
+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"`
+* Update service
+  * `mkitc PUT services/{id|service_name} -F "file=@samples/apps/rabbitmq.yml"`
+* Get services
+  * `mkitc GET services/{id|service_name}[?verbose=true]`
+* Delete service
+  * `mkitc DELETE services/{id|service_name}`
+* List services
+  * `mkitc GET services?verbose=true`
+* Control service
+  * `mkitc PUT services/{id|service_name}/start`
+  * `mkitc PUT services/{id|service_name}/stop`
+
+Example:
+
+```
+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
+```
+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`
+
+You must configure `haproxy` to use config directory. e.g. on Ubuntu
+
+```
+# /etc/default/haproxy
+
+# Defaults file for HAProxy
+#
+# This is sourced by both, the initscript and the systemd unit file, so do not
+# treat it as a shell script fragment.
+
+# Change the config file location if needed
+CONFIG="/etc/haproxy/haproxy.d"
+
+# Add extra flags here, see haproxy(1) for a few options
+#EXTRAOPTS="-de -m 16"
+```
+
+### Service
+
+```
+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
+    - 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
+    - /var/log/rabbitmq/logs:/var/log/rabbitmq # a local volume
+  environment:
+    RABBITMQ_DEFAULT_USER: admin
+    RABBITMQ_DEFAULT_PASS: admin
+    RABBITMQ_DEFAULT_VHOST: mkit
+```
+
+## Development
+
+* build the gem
+  * `rake package`
+* console
+  * `rake console`
+
+# Thanks
+
+For my kids. :) 

data/Rakefile

@@ -0,0 +1,54 @@
+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/setup'
+require 'dry-container'
+require 'sinatra/activerecord'
+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"
+# db migrations, use database config
+ENV["DATABASE_URL"]=MKIt::Utils.db_config_to_uri(rails_env)
+
+desc 'Builds the gem'
+task :package do
+  sh %{gem build "mkit.gemspec"}
+end
+
+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})
+end
+
+desc 'Create build dirs'
+task :init do
+  FileUtils.mkdir_p('target/build')
+  FileUtils.mkdir_p('target/package')
+end
+
+desc "Rake Console"
+task :console do
+  Pry.start
+end
+
+StandaloneMigrations::Tasks.load_tasks
+

data/bin/mkitc

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+
+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 
+  end
+
+  def run
+    if ARGV.size < 2 || VERBS.index(ARGV[0]).nil?
+      usage
+      exit 1
+    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
+  end
+end
+
+client = MKItClient.new
+client.run
+

data/bin/mkitd

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+
+PARAMS_CONFIG = {}
+
+def up
+  require 'sinatra'
+  require 'sinatra/base'
+  require 'mkit'
+  # defaults
+  PARAMS_CONFIG[:bind] ||= "localhost"
+  PARAMS_CONFIG[:port] ||= 4567
+  #
+  MKIt.startup(options: PARAMS_CONFIG)
+
+  use Rack::MethodOverride
+  use ServicesController
+  use MkitJobsController
+
+  # sinatra::base ignores in parameters
+  # set it here or via configure...
+  Sinatra::Application.run!({port: PARAMS_CONFIG[:port], bind: PARAMS_CONFIG[:bind] })
+  # MKIt::Server.run
+end
+
+
+#
+if ARGV.any?
+  require 'optparse'
+  parser = OptionParser.new do |op|
+    op.on('-c config-dir', 'set the config dir (default is /etc/mkit)') { |val| PARAMS_CONFIG[:config_dir] = val }
+    op.on('-p port',   'set the port (default is 4567)')               { |val| PARAMS_CONFIG[:port] = Integer(val) }
+    op.on('-b bind  ', 'specify bind address (e.g. /tmp/app.sock)')    { |val| PARAMS_CONFIG[:bind] = val }
+    op.on('-s server', 'specify rack server/handler')                  { |val| PARAMS_CONFIG[:server] = val }
+    op.on('-q',        'turn on quiet mode (default is off)')          {       PARAMS_CONFIG[:quiet] = true }
+    op.on('-x',        'turn on the mutex lock (default is off)')      {       PARAMS_CONFIG[:lock] = true }
+    op.on('-e env',    'set the environment (default is development)') do |val|
+      ENV['RACK_ENV'] = val
+      PARAMS_CONFIG[:environment] = val.to_sym
+    end
+    op.on('-o addr', "set the host (default is (env == 'development' ? 'localhost' : '0.0.0.0'))") do |val|
+      PARAMS_CONFIG[:bind] = val
+    end
+  end
+  begin
+    parser.parse!(ARGV.dup)
+  rescue StandardError => e
+    PARAMS_CONFIG[:optparse_error] = e
+  end
+end
+
+up
+

data/config/database.yml

@@ -0,0 +1,5 @@
+
+development:
+  adapter: "sqlite3"
+  database: "/tmp/development.sqlite"
+  pool: 1024

data/config/mkit_config.yml

@@ -0,0 +1,15 @@
+mkit:
+  my_network:
+    ip: 10.210.198.1
+  haproxy:
+    config_dir: /etc/haproxy/haproxy.d
+    ctrl:
+      start:   /etc/init.d/haproxy start
+      stop:    /etc/init.d/haproxy stop
+      reload:  /etc/init.d/haproxy restart
+      restart: /etc/init.d/haproxy restart
+      status:  /etc/init.d/haproxy status
+      bin: /usr/sbin/haproxy
+  database:
+    env: development
+

data/config/mkitd_config.sh

@@ -0,0 +1,5 @@
+#
+# kidsd server options (for systemd unit | daemontools)
+#
+OPTIONS=""
+

data/db/migrate/001_setup.rb

@@ -0,0 +1,105 @@
+class Setup < ActiveRecord::Migration[5.1]
+
+  def up
+    create_table :services do |t|
+      t.string :name
+      t.string :image
+      t.string :qdm
+      t.string :command
+      t.integer :max_replicas, default: 1
+      t.integer :min_replicas, default: 1
+      t.string :lease_id # ip config
+      t.string :pods_network, default: 'mkit' # docker network bridge|specific
+      t.integer :version # active version - later
+      t.string :status
+      t.timestamp :created_at, default: DateTime.now
+      t.timestamp :updated_at
+    end
+
+    add_index "services", ["name"], :name => "services_name_id"
+
+    create_table :service_configs do |t|
+      t.string :service_id
+      t.string :key
+      t.string :value
+      t.string :ctype # docker_param|env|volume?|....
+      t.integer :version
+    end
+
+    create_table :pods do |t|
+      t.string :service_id
+      t.string :pod_id
+      t.string :name
+      t.string :ip
+      t.string :image
+      t.string :status
+      t.integer :version
+    end
+
+    create_table :volumes do |t|
+      t.string :service_id
+      t.string :name
+      t.string :path
+      t.string :ctype # docker|local....
+      t.string :status
+      t.integer :version
+    end
+
+    create_table :service_ports do |t|
+      t.string :service_id
+      t.string :internal_port
+      t.string :external_port
+      t.string :mode # tcp | http
+      t.string :load_bal
+      t.integer :version
+    end
+
+    create_table :pools do |t|
+      t.string :name
+      t.string :ip
+      t.string :range
+      t.string :netmask
+      t.string :status # in_use|exausted
+      t.boolean :preferred, default: false
+    end
+
+    create_table :leases do |t|
+      t.string :pool_id
+      t.string :service_id
+      t.string :interface_name
+      t.string :interface_type # tun|tap
+      t.string :status # reserved|in_use|expired|deleted|....
+      t.string :ip
+      t.timestamp :expires_at
+    end
+
+    create_table :dns_hosts do |t|
+      t.string :service_id
+      t.string :pod_id
+      t.string :name # fqdn
+      t.string :ip
+      t.string :ipv6
+    end
+
+    # mkit configs
+    # e.g. 
+    #   default network pool
+    #   rabbitmq address
+    #   haproxy 
+    #     config.d path
+    #     reload command - pq quero usar o daemontools
+    #     stop
+    #     start
+    #     status
+    #
+    create_table :settings do |t|
+      t.string :key
+      t.string :value
+    end
+  end
+
+  def down
+    drop_table :services
+  end
+end
+

data/db/migrate/002_mkit_jobs.rb

@@ -0,0 +1,17 @@
+class MkitJobs < ActiveRecord::Migration[5.1]
+
+  def up
+    create_table :mkit_jobs do |t|
+      t.string :topic
+      t.string :service_id
+      t.string :pod_id
+      t.string :status
+      t.string :retries
+      t.string :payload
+      t.timestamp :created_at
+      t.timestamp :updated_at
+    end
+  end
+
+end
+