kuber_kit 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a909cb70758ec37ce6c7aefdf42ca9f2ab211635bff12b8cc0e228ce6ba5a3
-  data.tar.gz: edfbf0a103ef115b5acee93d0109f6ebc3b2da32918686b78583c9bad8ba449b
+  metadata.gz: 8321dfb87de00ef987aa2c826e5310fd721664135b90e194562a9c9f26ad044e
+  data.tar.gz: dccbfdc6df8ed8bedd6e6d30ddfd576c42c1a12ec36aa465769a1fcc207d38af
 SHA512:
-  metadata.gz: 35eae928da948dbf38673608035ee34674980b9551e3a8a16e60a829db50984fa6f518d131a1914a9e6111d9189e45499ea7660da41da83ab84df1ee65006940
-  data.tar.gz: d85768ead64d8ea7e1516ddabad52c9349975d72ed2dbc5e31658083845dcc0d790a3283b820999c8f22bcfd0ad5c878142c0add0d29c98e32123e1ff4633130
+  metadata.gz: cde945512a525f1ef577f540ae3919bc602d442fb44eb14505fe2a4761ad1c15061f9bab1540b9b8de2592cf4d4f4f7396bfe451499af45cd6198659ad7cfaeb
+  data.tar.gz: cca667290f77ff94934ce302666655d1bdefc414f074915c8a6d091590786b20ff2aa26a04c02f9d07b5e3c88f2e48439c3cbe71add7d374ea255deda753e125

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kuber_kit (0.3.4)
+    kuber_kit (0.3.9)
       cli-ui
       contracts-lite
       dry-auto_inject
@@ -19,16 +19,14 @@ GEM
     docile (1.3.2)
     dry-auto_inject (0.7.0)
       dry-container (>= 0.3.4)
-    dry-configurable (0.11.6)
+    dry-configurable (0.12.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
     dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
     method_source (1.0.0)
     net-ssh (6.1.0)
     pry (0.13.1)

data/TODO.md

@@ -1,8 +1,8 @@
+- https://ttytoolkit.org/
+- kit status should show the list of services and their status, with ability to select & view logs
 - list services and require confirmation before deployment
-- kit attach should list available deployments/pods, and ask for specific container if it has multiple containers
 - add kit logs support, should work similar to kit attach
 - allow deploying only services enabled for specific configuration
 - find a way to always deploy some service, e.g. for migrations and env_files
-- add ability to set container health checks
 - template should be able to set default attributes
 - template should be able to depend on image?

data/lib/kuber_kit.rb

@@ -166,6 +166,8 @@ module KuberKit
     autoload :ConfigurationLoader, 'actions/configuration_loader'
     autoload :KubectlApplier, 'actions/kubectl_applier'
     autoload :KubectlAttacher, 'actions/kubectl_attacher'
+    autoload :KubectlConsole, 'actions/kubectl_console'
+    autoload :KubectlLogs, 'actions/kubectl_logs'
   end
 
   module Extensions

data/lib/kuber_kit/actions/kubectl_attacher.rb

@@ -5,11 +5,17 @@ class KuberKit::Actions::KubectlAttacher
     "ui"
   ]
 
-  Contract String, Hash => Any
+  Contract Maybe[String], Hash => Any
   def call(pod_name, options)
     kubeconfig_path = KuberKit.current_configuration.kubeconfig_path
     deployer_namespace = KuberKit.current_configuration.deployer_namespace
 
+    if !pod_name 
+      resources = kubectl_commands.get_resources(local_shell, "deployments", jsonpath: ".items[*].metadata.name")
+      options   = resources.split(" ").map{|d| "deploy/#{d}" }
+      pod_name  = ui.prompt("Please select deployment to attach", options)
+    end
+
     kubectl_commands.exec(
       local_shell, pod_name, "bash", args: "-it", 
       kubeconfig_path: kubeconfig_path, 

data/lib/kuber_kit/actions/kubectl_console.rb

@@ -0,0 +1,32 @@
+class KuberKit::Actions::KubectlConsole
+  include KuberKit::Import[
+    "shell.kubectl_commands",
+    "shell.local_shell",
+    "ui"
+  ]
+
+  Contract Maybe[String], Hash => Any
+  def call(pod_name, options)
+    kubeconfig_path = KuberKit.current_configuration.kubeconfig_path
+    deployer_namespace = KuberKit.current_configuration.deployer_namespace
+
+    if !pod_name 
+      resources = kubectl_commands.get_resources(local_shell, "deployments", jsonpath: ".items[*].metadata.name")
+      options   = resources.split(" ").map{|d| "deploy/#{d}" }
+      pod_name  = ui.prompt("Please select deployment to attach", options)
+    end
+
+    kubectl_commands.exec(
+      local_shell, pod_name, "bin/console", args: "-it", 
+      kubeconfig_path: kubeconfig_path, 
+      interactive: true,
+      namespace: deployer_namespace
+    )
+
+    true
+  rescue KuberKit::Error => e
+    ui.print_error("Error", e.message)
+    
+    false
+  end
+end

data/lib/kuber_kit/actions/kubectl_logs.rb

@@ -0,0 +1,37 @@
+class KuberKit::Actions::KubectlLogs
+  include KuberKit::Import[
+    "shell.kubectl_commands",
+    "shell.local_shell",
+    "ui"
+  ]
+
+  Contract Maybe[String], Hash => Any
+  def call(pod_name, options)
+    kubeconfig_path = KuberKit.current_configuration.kubeconfig_path
+    deployer_namespace = KuberKit.current_configuration.deployer_namespace
+
+    if !pod_name 
+      deployments     = kubectl_commands.get_resources(local_shell, "deployments", jsonpath: ".items[*].metadata.name")
+      deploy_options  = deployments.split(" ").map{|d| "deploy/#{d}" }
+      pod_name  = ui.prompt("Please select deployment to attach", deploy_options)
+    end
+
+    args = nil
+    if options[:follow]
+      args = "-f"
+    end
+
+    kubectl_commands.logs(
+      local_shell, pod_name,
+      args: args,
+      kubeconfig_path: kubeconfig_path, 
+      namespace: deployer_namespace
+    )
+
+    true
+  rescue KuberKit::Error => e
+    ui.print_error("Error", e.message)
+    
+    false
+  end
+end

data/lib/kuber_kit/actions/service_deployer.rb

@@ -10,10 +10,11 @@ class KuberKit::Actions::ServiceDeployer
   ]
 
   Contract KeywordArgs[
-    services:   Maybe[ArrayOf[String]],
-    tags:       Maybe[ArrayOf[String]],
+    services:     Maybe[ArrayOf[String]],
+    tags:         Maybe[ArrayOf[String]],
+    skip_compile: Maybe[Bool],
   ] => Any
-  def call(services:, tags:)
+  def call(services:, tags:, skip_compile: false)
     if services.empty? && tags.empty?
       services, tags = show_tags_selection
     end
@@ -33,7 +34,7 @@ class KuberKit::Actions::ServiceDeployer
 
     images_names = services.map(&:images).flatten.uniq
 
-    compile_images(images_names)
+    compile_images(images_names) unless skip_compile
     deploy_services(service_names)
 
     true

data/lib/kuber_kit/cli.rb

@@ -31,15 +31,17 @@ class KuberKit::CLI < Thor
   end
 
   desc "deploy CONTEXT_NAME", "Deploy CONTEXT_NAME with kubectl"
-  method_option :services,   :type => :array, aliases: ["-s"]
-  method_option :tags,       :type => :array, aliases: ["-t"]
+  method_option :services,      :type => :array,    aliases: ["-s"]
+  method_option :tags,          :type => :array,    aliases: ["-t"]
+  method_option :skip_compile,  :type => :boolean,  aliases: ["-B"]
   def deploy
     KuberKit.set_debug_mode(options[:debug])
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       result = KuberKit::Container['actions.service_deployer'].call(
-        services: options[:services] || [], 
-        tags:     options[:tags] || []
+        services:     options[:services] || [], 
+        tags:         options[:tags] || [],
+        skip_compile: options[:skip_compile] || false
       )
     end
 
@@ -91,8 +93,8 @@ class KuberKit::CLI < Thor
     end
   end
 
-  desc "attach POD_NAME", "Attach to POD_NAME with kubectl"
-  def attach(pod_name)
+  desc "attach POD_NAME", "Attach to POD_NAME using kubectl"
+  def attach(pod_name = nil)
     KuberKit.set_debug_mode(options[:debug])
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
@@ -100,6 +102,25 @@ class KuberKit::CLI < Thor
     end
   end
 
+  desc "launch console in POD_NAME", "Attach to POD_NAME using kubectl & launch bin/console"
+  def console(pod_name = nil)
+    KuberKit.set_debug_mode(options[:debug])
+
+    if KuberKit::Container['actions.configuration_loader'].call(options)
+      KuberKit::Container['actions.kubectl_console'].call(pod_name, options)
+    end
+  end
+
+  desc "show logs for POD_NAME", "Show logs for POD_NAME using kubectl"
+  method_option :follow,  :type => :boolean,  aliases: ["-f"]
+  def logs(pod_name = nil)
+    KuberKit.set_debug_mode(options[:debug])
+
+    if KuberKit::Container['actions.configuration_loader'].call(options)
+      KuberKit::Container['actions.kubectl_logs'].call(pod_name, options)
+    end
+  end
+
   desc "version", "Print current version"
   def version
     puts KuberKit::VERSION

data/lib/kuber_kit/configs.rb

@@ -5,7 +5,7 @@ class KuberKit::Configs
     :image_dockerfile_name, :image_build_context_dir, :image_tag, :docker_ignore_list, :image_compile_dir, 
     :kuber_kit_dirname, :kuber_kit_min_version, :images_dirname, :services_dirname, :infra_dirname, :configurations_dirname,
     :artifact_clone_dir, :service_config_dir, :deployer_strategy, :compile_simultaneous_limit,
-    :additional_images_paths, :deprecation_warnings_disabled
+    :additional_images_paths, :deprecation_warnings_disabled, :log_file_path
   ]
   DOCKER_IGNORE_LIST = [
     'Dockerfile',
@@ -51,6 +51,7 @@ class KuberKit::Configs
     set :compile_simultaneous_limit, 5
     set :additional_images_paths, []
     set :deprecation_warnings_disabled, false
+    set :log_file_path,           "/tmp/kuber_kit.log"
   end
 
   def items

data/lib/kuber_kit/container.rb

@@ -33,6 +33,14 @@ class KuberKit::Container
     KuberKit::Actions::KubectlAttacher.new
   end
 
+  register "actions.kubectl_console" do
+    KuberKit::Actions::KubectlConsole.new
+  end
+
+  register "actions.kubectl_logs" do
+    KuberKit::Actions::KubectlLogs.new
+  end
+
   register "configs" do
     KuberKit::Configs.new
   end
@@ -106,7 +114,7 @@ class KuberKit::Container
   end
 
   register "tools.logger" do
-    KuberKit::Container["tools.logger_factory"].create("/tmp/kuber_kit.log")
+    KuberKit::Container["tools.logger_factory"].create()
   end
 
   register "shell.bash_commands" do

data/lib/kuber_kit/core/service.rb

@@ -4,11 +4,11 @@ class KuberKit::Core::Service
   attr_reader :name, :template_name, :tags, :images, :attributes, :deployer_strategy
 
   Contract KeywordArgs[
-    name:             Symbol,
-    template_name:    Symbol,
-    tags:             ArrayOf[Symbol],
-    images:           ArrayOf[Symbol],
-    attributes:       HashOf[Symbol => Any],
+    name:               Symbol,
+    template_name:      Maybe[Symbol],
+    tags:               ArrayOf[Symbol],
+    images:             ArrayOf[Symbol],
+    attributes:         HashOf[Symbol => Any],
     deployer_strategy:  Maybe[Symbol]
   ] => Any
   def initialize(name:, template_name:, tags:, images:, attributes:, deployer_strategy:)

data/lib/kuber_kit/core/service_factory.rb

@@ -1,13 +1,7 @@
 class KuberKit::Core::ServiceFactory
-  AttributeNotSetError = Class.new(KuberKit::Error)
-
   def create(definition)
     service_attrs = definition.to_service_attrs
 
-    if service_attrs.template_name.nil?
-      raise AttributeNotSetError, "Please set template for service using #template method"
-    end
-
     configuration_attributes = KuberKit.current_configuration.service_attributes(service_attrs.name)
     attributes = (service_attrs.attributes || {}).merge(configuration_attributes)
 

data/lib/kuber_kit/service_deployer/strategies/docker.rb

@@ -8,8 +8,9 @@ class KuberKit::ServiceDeployer::Strategies::Docker < KuberKit::ServiceDeployer:
   STRATEGY_OPTIONS = [
     :container_name,
     :image_name,
-    :docker_run_args,
-    :docker_run_command,
+    :detached,
+    :command_name,
+    :command_args,
     :delete_if_exists
   ]
 
@@ -21,9 +22,9 @@ class KuberKit::ServiceDeployer::Strategies::Docker < KuberKit::ServiceDeployer:
       raise KuberKit::Error, "Unknow options for deploy strategy: #{unknown_options}. Available options: #{STRATEGY_OPTIONS}"
     end
     
-    container_name    = strategy_options.fetch(:container_name, service.uri)
-    docker_run_args   = strategy_options.fetch(:docker_run_args, nil)
-    docker_run_command = strategy_options.fetch(:docker_run_command, nil)
+    container_name = strategy_options.fetch(:container_name, service.uri)
+    command_name   = strategy_options.fetch(:command_name, "bash")
+    command_args   = strategy_options.fetch(:command_args, nil)
 
     image_name = strategy_options.fetch(:image_name, nil)
     if image_name.nil?
@@ -36,6 +37,11 @@ class KuberKit::ServiceDeployer::Strategies::Docker < KuberKit::ServiceDeployer:
       docker_commands.delete_container(shell, container_name)
     end
 
-    docker_commands.run(shell, image.remote_registry_url, run_args: docker_run_args, run_command: docker_run_command)
+    docker_commands.run(
+      shell, image.remote_registry_url, 
+      command:    command_name,
+      args:       command_args, 
+      detached:   !!strategy_options[:detached]
+    )
   end
 end

data/lib/kuber_kit/service_deployer/strategies/docker_compose.rb

@@ -7,7 +7,9 @@ class KuberKit::ServiceDeployer::Strategies::DockerCompose < KuberKit::ServiceDe
 
   STRATEGY_OPTIONS = [
     :service_name, 
-    :command_name
+    :command_name,
+    :command_args,
+    :detached
   ]
 
   Contract KuberKit::Shell::AbstractShell, KuberKit::Core::Service => Any
@@ -24,10 +26,13 @@ class KuberKit::ServiceDeployer::Strategies::DockerCompose < KuberKit::ServiceDe
 
     service_name = strategy_options.fetch(:service_name, service.name.to_s)
     command_name = strategy_options.fetch(:command_name, "bash")
+    command_args = strategy_options.fetch(:command_args, nil)
 
     docker_compose_commands.run(shell, config_path, 
-      service:      service_name, 
-      command:      command_name,
+      service:  service_name, 
+      command:  command_name,
+      args:     command_args, 
+      detached: !!strategy_options[:detached]
     )
   end
 end

data/lib/kuber_kit/service_reader/reader.rb

@@ -6,8 +6,14 @@ class KuberKit::ServiceReader::Reader
     "preprocessing.text_preprocessor"
   ]
 
+  AttributeNotSetError = Class.new(KuberKit::Error)
+
   Contract KuberKit::Shell::AbstractShell, KuberKit::Core::Service => Any
   def read(shell, service)
+    if service.template_name.nil?
+      raise AttributeNotSetError, "Please set template for service using #template method"
+    end
+
     template = template_store.get(service.template_name)
 
     context_helper = context_helper_factory.build_service_context(shell, service)

data/lib/kuber_kit/shell/commands/docker_commands.rb

@@ -14,14 +14,19 @@ class KuberKit::Shell::Commands::DockerCommands
     shell.exec!(%Q{docker push #{tag_name}})
   end
 
-  def run(shell, image_name, run_args: nil, run_command: nil)
+  def run(shell, image_name, args: nil, command: nil, detached: false, interactive: false)
     command_parts = []
     command_parts << "docker run"
-    command_parts << run_args if run_args
+    command_parts << "-d" if detached
+    command_parts << args if args
     command_parts << image_name
-    command_parts << run_command if run_command
+    command_parts << command if command
 
-    shell.exec!(command_parts.join(" "))
+    if interactive
+      shell.interactive!(command_parts.join(" "))
+    else
+      shell.exec!(command_parts.join(" "))
+    end
   end
 
   def container_exists?(shell, container_name)

data/lib/kuber_kit/shell/commands/docker_compose_commands.rb

@@ -1,13 +1,17 @@
 class KuberKit::Shell::Commands::DockerComposeCommands
-  def run(shell, path, service:, command:, interactive: false)
+  def run(shell, path, service:, args: nil, command: nil, detached: false, interactive: false)
     command_parts = [
       "docker-compose",
       "-f #{path}",
       "run",
-      service,
-      command
     ]
     
+
+    command_parts << "-d" if detached
+    command_parts << args if args
+    command_parts << service
+    command_parts << command if command
+    
     if interactive
       shell.interactive!(command_parts.join(" "))
     else

data/lib/kuber_kit/shell/commands/kubectl_commands.rb

@@ -40,15 +40,38 @@ class KuberKit::Shell::Commands::KubectlCommands
     kubectl_run(shell, command_parts, kubeconfig_path: kubeconfig_path, interactive: interactive, namespace: namespace)
   end
 
-  def resource_exists?(shell, resource_type, resource_name, kubeconfig_path: nil, namespace: nil)
-    result = find_resources(shell, resource_type, resource_name, kubeconfig_path: kubeconfig_path, namespace: namespace)
-    result && result != ""
+  def logs(shell, pod_name, args: nil, kubeconfig_path: nil, namespace: nil)
+    command_parts = []
+    command_parts << "logs"
+
+    if args
+      command_parts << args
+    end
+
+    command_parts << pod_name
+    kubectl_run(shell, command_parts, kubeconfig_path: kubeconfig_path, interactive: true, namespace: namespace)
   end
 
-  def find_resources(shell, resource_type, resource_name, jsonpath: ".items[*].metadata.name", kubeconfig_path: nil, namespace: nil)
-    command = %Q{get #{resource_type} --field-selector=metadata.name=#{resource_name} -o jsonpath='{#{jsonpath}}'}
+  def get_resources(shell, resource_type, field_selector: nil, jsonpath: ".items[*].metadata.name", kubeconfig_path: nil, namespace: nil)
+    command_parts = []
+    command_parts << "get #{resource_type}"
 
-    kubectl_run(shell, command, kubeconfig_path: kubeconfig_path, namespace: namespace)
+    if field_selector
+      command_parts << "--field-selector=#{field_selector}"
+    end
+
+    if jsonpath 
+      command_parts << "-o jsonpath='{#{jsonpath}}'"
+    end
+
+    kubectl_run(shell, command_parts, kubeconfig_path: kubeconfig_path, namespace: namespace)
+  end
+
+  def resource_exists?(shell, resource_type, resource_name, kubeconfig_path: nil, namespace: nil)
+    result = get_resources(shell, resource_type, 
+      field_selector: "metadata.name=#{resource_name}", kubeconfig_path: kubeconfig_path, namespace: namespace
+    )
+    result && result != ""
   end
 
   def delete_resource(shell, resource_type, resource_name, kubeconfig_path: nil, namespace: nil)

data/lib/kuber_kit/tools/logger_factory.rb

@@ -9,8 +9,12 @@ class KuberKit::Tools::LoggerFactory
     Logger::FATAL  => String::Colors::PURPLE,
   }
 
-  def create(stdout, level = nil)
-    logger = Logger.new(stdout)
+  include KuberKit::Import[
+    "configs",
+  ]
+
+  def create(stdout = nil, level = nil)
+    logger = Logger.new(stdout || configs.log_file_path)
 
     logger.level = level || Logger::DEBUG
 

data/lib/kuber_kit/ui/interactive.rb

@@ -29,7 +29,13 @@ class KuberKit::UI::Interactive
   def prompt(text, options, &callback)
     CLI::UI::Prompt.ask(text) do |handler|
       options.each do |option|
-        handler.option(option, &callback)
+        if callback
+          handler.option(option, &callback)
+        else
+          handler.option(option) do |selection|
+            selection
+          end
+        end
       end
     end
   end

data/lib/kuber_kit/ui/simple.rb

@@ -71,7 +71,8 @@ class KuberKit::UI::Simple
   def prompt(text, options, &callback)
     print_info("Select", text)
     result = $stdin.gets.chomp
-    callback.call(result)
+    callback.call(result) if callback
+    result
   end
 
   private

data/lib/kuber_kit/version.rb

@@ -1,3 +1,3 @@
 module KuberKit
-  VERSION = "0.3.4"
+  VERSION = "0.3.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuber_kit
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.9
 platform: ruby
 authors:
 - Iskander Khaziev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts-lite
@@ -191,6 +191,8 @@ files:
 - lib/kuber_kit/actions/image_compiler.rb
 - lib/kuber_kit/actions/kubectl_applier.rb
 - lib/kuber_kit/actions/kubectl_attacher.rb
+- lib/kuber_kit/actions/kubectl_console.rb
+- lib/kuber_kit/actions/kubectl_logs.rb
 - lib/kuber_kit/actions/service_deployer.rb
 - lib/kuber_kit/actions/service_reader.rb
 - lib/kuber_kit/actions/template_reader.rb