kuber_kit 0.3.3 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae284766e125c54579032cd54c29d602848f95a9a91e07c357ab1b985632a9d1
-  data.tar.gz: 9a9c7a194893cdc39c7629fbda8e03bb7da6b77583899995c14a511f3b152943
+  metadata.gz: cdefb838f103f417001c7ff0167d95bc985a1db8b8b97b505426e5f2b98db7f3
+  data.tar.gz: 13f8f1103796553e56a874064e36a33e66931e73917a141e6fad049c5ced73da
 SHA512:
-  metadata.gz: 3cbef254939ce54ff789fcde11ca3db500bfc552f75768bb9424dbdef682830eceed216b046f5930b95e45c8985c2b77e6ce2947e277951e718b1f38df62af29
-  data.tar.gz: bb571f10d8f4e41612c31e1616138e45a54134b92b4b8f9a9577083fc175982e3e5f1a77f1ec564a160ce88f46f76d57d143a8968b8282c92d66f4cb2e2f4220
+  metadata.gz: cbd45f1537f9ecc3b2d29a090f85921b47ffda91093aefa7f150d5101ff3bc147f30966febdb37352e6dfb3f7e245a84423a649a0f9d9cdd586dd597634be96c
+  data.tar.gz: 947ced5481b927993ed9462255fcf7ed656c718e9642fc0f8888b14a41aa630947b89d96f56d9b5a571956c5475c6e711c3a1b604e333b617a5208292e39e9ca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kuber_kit (0.3.3)
+    kuber_kit (0.3.8)
       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.4.10)
+    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,30 @@ 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
+  end
+
   def self.exit_on_failure?
     true
   end

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

data/lib/kuber_kit/core/context_helper/base_helper.rb

@@ -33,6 +33,13 @@ class KuberKit::Core::ContextHelper::BaseHelper
     KuberKit.global_build_vars
   end
 
+  def global_build_args
+    unless KuberKit.deprecation_warnings_disabled?
+      puts "DEPRECATION: global_build_args is deprecated, please use global_build_vars instead"
+    end
+    global_build_vars
+  end
+
   def get_binding
     binding
   end

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

@@ -8,6 +8,7 @@ class KuberKit::ServiceDeployer::Strategies::Docker < KuberKit::ServiceDeployer:
   STRATEGY_OPTIONS = [
     :container_name,
     :image_name,
+    :detached,
     :docker_run_args,
     :docker_run_command,
     :delete_if_exists
@@ -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, 
+      run_args:     docker_run_args, 
+      run_command:  docker_run_command,
+      detached:     !!strategy_options[:detached]
+    )
   end
 end

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

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

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

@@ -14,9 +14,10 @@ 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, run_args: nil, run_command: nil, detached: false)
     command_parts = []
     command_parts << "docker run"
+    command_parts << "-d" if detached
     command_parts << run_args if run_args
     command_parts << image_name
     command_parts << run_command if run_command

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

@@ -1,13 +1,18 @@
 class KuberKit::Shell::Commands::DockerComposeCommands
-  def run(shell, path, service:, command:, interactive: false)
+  def run(shell, path, service:, command:, interactive: false, detached: false)
     command_parts = [
       "docker-compose",
       "-f #{path}",
       "run",
-      service,
-      command
     ]
     
+    if detached
+      command_parts << "-d"
+    end
+
+    command_parts << service
+    command_parts << 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/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.3"
+  VERSION = "0.3.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuber_kit
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.8
 platform: ruby
 authors:
 - Iskander Khaziev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2021-01-07 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