kuber_kit 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b70bdef220e67c9789122ab7eb7ee064dff475174ec1e497b0baf11566da6e1f
-  data.tar.gz: 004b9a6c4e8265f1f3f498b1b42fa35a0447567ef428abef4b571cce635c0cd9
+  metadata.gz: 107bd2fce24cb2f396cbca12bb77b5b83c412f8a1e7f2bdf034b382235c9c570
+  data.tar.gz: fd76a3ca50d55f869e114dd1a5f3a1bae2eebee3c67bbde664c9365ea89ff606
 SHA512:
-  metadata.gz: 1e60b51c8108814fc41f89b41a28732e59a8f5bddb938ee94d8cb765ccc5f2ea3de260aed0a52a212649389814884c40734c7f60fe77502e78e3814821c31790
-  data.tar.gz: 5f165249b8d91cd8bc148f9cc5f3a3a9a57402355c371b30f7f8511fcb6bf8d0650a7ba7a08c072dcba550837e52aced3a1d9cec4959be98c18d5b526678fb29
+  metadata.gz: a13c1734350136c2474c3333fc2540096e95aabe05039f2eb0cbdb7fb426aa150e1413a3841d7329cbd09ada0f8302443c42df6875f3b486b2e35100bf84fc0e
+  data.tar.gz: f2278b48b2d37cdd526acdf57841505d524fefecc0eba83fa2929722d629e7398c8909fffe717c98ff41619aefce3411bfba2c0f1e18ebbbd11ee518eba5d557

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+**1.3.1**
+- Fix upgrade command for helm strategy
+
+**1.3.0**
+- Allow sending custom apply command for k8s deploy strategy
+- Added initial support for helm deploy strategy
+
+**1.2.7**
+- Added an option to skip deployment and only build images for `deploy` command
+
+**1.2.6**
+- Lock cli-ui version on 2.1.0 (2.2.x has some bugs)
+
+**1.2.5**
+- Improve handling ContextVars, ability to convert context var to OpenStruct
+
+**1.2.4**
+- Fix a mistake in setting env variables
+- Added an option to set "use local deployment" variable
+- Allow finding job resources in kit attach and kit log
+
+**1.2.2**
+- Support Ruby 3.2.0
+
 **1.2.1**
 - Update shell commands so that STDERR stream won't be merged for commands using the command result.
 - kit sh would also set current default configuration

data/README.md

@@ -19,7 +19,8 @@ Please install specific kuber_kit version, depending on Ruby version.
 | Ruby Version | KuberKit Version |
 | ------------ | ------------ |
 | 2.6 | 1.0.1 |
-| 2.7 | 1.1.4 |
+| 2.7 | 1.1.3 |
+| > 3.0 | 1.2.6 |
 
 ## Usage
 

data/kuber_kit.gemspec

@@ -25,11 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.7.0"
 
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
-    spec.add_dependency "contracts", '0.17.0'
-  else
-    spec.add_dependency "contracts", '0.16.0'
-  end
+  spec.add_dependency "contracts", '0.16.0'
 
   spec.add_dependency "dry-auto_inject", "~> 0.9.0"
   spec.add_dependency "dry-core", "~> 0.8.1"
@@ -37,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-container", "~> 0.10.1"
 
   spec.add_dependency "thor"
-  spec.add_dependency "cli-ui"
+  spec.add_dependency "cli-ui", '2.1.0'
   spec.add_dependency "net-ssh"
   spec.add_dependency "tty-prompt"
 

data/lib/kuber_kit/actions/configuration_loader.rb

@@ -20,6 +20,7 @@ class KuberKit::Actions::ConfigurationLoader
     configurations_path  = options[:configurations_path]  || File.join(root_path, configs.configurations_dirname)
     configuration_name   = options[:configuration] || ENV["KUBER_KIT_CONFIGURATION"]
     load_inventory = options.fetch(:load_inventory, true)
+    use_local_deploy = options.fetch(:use_local_deploy, false)
 
     ui.print_debug "ConfigurationLoader", "Launching kuber_kit with:"
     ui.print_debug "ConfigurationLoader", "  Root path: #{root_path.to_s.yellow}"
@@ -28,10 +29,11 @@ class KuberKit::Actions::ConfigurationLoader
     ui.print_debug "ConfigurationLoader", "  Infrastructure path: #{infra_path.to_s.yellow}"
     ui.print_debug "ConfigurationLoader", "  Configurations path: #{configurations_path.to_s.yellow}"
     ui.print_debug "ConfigurationLoader", "  Configuration name: #{configuration_name.to_s.yellow}"
+    ui.print_debug "ConfigurationLoader", "  Use local deploy: #{use_local_deploy.to_s.yellow}"
 
     ui.print_info("Logs", "See logs at: #{configs.log_file_path}")
 
-    unless File.exists?(root_path)
+    unless File.exist?(root_path)
       ui.print_warning "ConfigurationLoader", "KuberKit root path #{root_path} doesn't exist. You may want to pass it --path parameter."
     end
 
@@ -39,6 +41,10 @@ class KuberKit::Actions::ConfigurationLoader
       raise KuberKit::Error, "The minimal required kuber_kit version is #{configs.kuber_kit_min_version}"
     end
 
+    if use_local_deploy
+      ENV["KUBER_KIT_USE_LOCAL_DEPLOYMENT"] = "true"
+    end
+
     load_configurations(configurations_path, configuration_name)
     load_infrastructure(infra_path)
 

data/lib/kuber_kit/actions/kubectl_attacher.rb

@@ -7,17 +7,20 @@ class KuberKit::Actions::KubectlAttacher
   ]
 
   Contract Maybe[String], Hash => Any
-  def call(pod_name, options)
+  def call(resource_name, options)
     kubeconfig_path    = KuberKit.current_configuration.kubeconfig_path
     kubectl_entrypoint = KuberKit.current_configuration.kubectl_entrypoint
     deployer_namespace = KuberKit.current_configuration.deployer_namespace
 
-    if !pod_name
-      pod_name  = resource_selector.call("attach")
+    if !resource_name 
+      resource_name  = resource_selector.call("attach", additional_resources: [
+        KuberKit::Kubernetes::Resources::POD,
+        KuberKit::Kubernetes::Resources::JOB
+      ])
     end
 
     kubectl_commands.exec(
-      local_shell, pod_name, "bash", args: "-it", 
+      local_shell, resource_name, "bash", args: "-it", 
       kubeconfig_path: kubeconfig_path, 
       interactive:  true,
       namespace:    deployer_namespace,

data/lib/kuber_kit/actions/kubectl_logs.rb

@@ -7,12 +7,15 @@ class KuberKit::Actions::KubectlLogs
   ]
 
   Contract Maybe[String], Hash => Any
-  def call(pod_name, options)
+  def call(resource_name, options)
     kubeconfig_path = KuberKit.current_configuration.kubeconfig_path
     deployer_namespace = KuberKit.current_configuration.deployer_namespace
 
-    if !pod_name 
-      pod_name = resource_selector.call("attach")
+    if !resource_name 
+      resource_name  = resource_selector.call("attach", additional_resources: [
+        KuberKit::Kubernetes::Resources::POD,
+        KuberKit::Kubernetes::Resources::JOB
+      ])
     end
 
     args = nil
@@ -21,7 +24,7 @@ class KuberKit::Actions::KubectlLogs
     end
 
     kubectl_commands.logs(
-      local_shell, pod_name,
+      local_shell, resource_name,
       args: args,
       kubeconfig_path: kubeconfig_path, 
       namespace: deployer_namespace

data/lib/kuber_kit/cli.rb

@@ -11,6 +11,7 @@ class KuberKit::CLI < Thor
   class_option :debug, :type => :boolean, aliases: ["-d"]
   class_option :configuration, :type => :string, aliases: ["-C"]
   class_option :user, :type => :string, aliases: ["-u"]
+  class_option :use_local_deploy, :type => :boolean, aliases: ["-l"]
 
   desc "compile IMAGE_NAMES", "Compile image with IMAGE_NAMES (comma-separated)"
   def compile(image_names_str)
@@ -211,7 +212,7 @@ class KuberKit::CLI < Thor
       # We should load config before loading any bean, to make sure that bean won't be built with default config
       root_path = KuberKit::Container['tools.workdir_detector'].call(options)
       config_file_path = File.join(root_path, APP_CONFIG_FILENAME)
-      if File.exists?(config_file_path)
+      if File.exist?(config_file_path)
         require config_file_path
       end
     end

data/lib/kuber_kit/container.rb

@@ -181,6 +181,10 @@ class KuberKit::Container
     KuberKit::Shell::Commands::SystemCommands.new
   end
 
+  register "shell.helm_commands" do
+    KuberKit::Shell::Commands::HelmCommands.new
+  end
+
   register "shell.local_shell" do
     KuberKit::Shell::LocalShell.new
   end

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

@@ -1,3 +1,4 @@
+require 'ostruct'
 class KuberKit::Core::ContextHelper::ContextVars
   attr_reader :parent, :parent_name
 
@@ -37,12 +38,27 @@ class KuberKit::Core::ContextHelper::ContextVars
     dig(name)
   end
 
+  def keys
+    @context_vars.keys
+  end
+
   def to_h
-    if @context_vars.is_a?(Hash)
-      return @context_vars
-    else
-      return {value: @context_vars}
+    values = keys.map do |key|
+      value = get_variable_value(key)
+      hash_value = value.respond_to?(:to_h) ? value.to_h : value
+      [key, hash_value]
+    end
+    Hash[values]
+  end
+
+  def to_struct
+    values = keys.map do |key|
+      value = get_variable_value(key)
+      hash_value = value.respond_to?(:to_struct) ? value.to_struct : value
+      [key, hash_value]
     end
+    hash = Hash[values]
+    OpenStruct.new(hash)
   end
 
   def get_variable_value(variable_name)

data/lib/kuber_kit/defaults.rb

@@ -39,6 +39,10 @@ class KuberKit::Defaults
         :docker_compose,
         KuberKit::ServiceDeployer::Strategies::DockerCompose.new
       )
+      container["service_deployer.deployer"].register_strategy(
+        :helm,
+        KuberKit::ServiceDeployer::Strategies::Helm.new
+      )
 
       container["shell_launcher.launcher"].register_strategy(
         :kubernetes,

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

@@ -0,0 +1,41 @@
+class KuberKit::ServiceDeployer::Strategies::Helm < KuberKit::ServiceDeployer::Strategies::Abstract
+  include KuberKit::Import[
+    "service_reader.reader",
+    "shell.helm_commands",
+    "shell.bash_commands",
+    "configs",
+  ]
+
+  Contract KuberKit::Shell::AbstractShell, KuberKit::Core::Service => Any
+  def deploy(shell, service)
+    service_config        = reader.read(shell, service)
+    chart_root_path       = File.join(configs.service_config_dir, "#{service.name}_chart")
+    chart_templates_path  = File.join(chart_root_path, "templates")
+    chart_config_path = File.join(chart_root_path, "Chart.yaml")
+    release_path      = File.join(chart_templates_path, "release.yaml")
+
+    bash_commands.mkdir_p(shell, File.dirname(chart_root_path))
+    bash_commands.mkdir_p(shell, File.dirname(chart_templates_path))
+
+    shell.write(release_path, service_config)
+    shell.write(chart_config_path, chart_config_content(service.uri))
+
+    kubeconfig_path = KuberKit.current_configuration.kubeconfig_path
+    namespace       = KuberKit.current_configuration.deployer_namespace
+
+    upgrade_result = helm_commands.upgrade(shell, service.uri, chart_root_path, kubeconfig_path: kubeconfig_path, namespace: namespace)
+    
+    upgrade_result
+  end
+
+  def chart_config_content(release_name)
+    query = <<-CHART
+apiVersion: v2
+name: #{release_name}
+description: #{release_name}
+type: application
+version: 1.0.0
+appVersion: "1.0.0"
+    CHART
+  end
+end

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

@@ -10,7 +10,8 @@ class KuberKit::ServiceDeployer::Strategies::Kubernetes < KuberKit::ServiceDeplo
     :resource_name,
     :delete_if_exists,
     :restart_if_exists,
-    :wait_for_rollout
+    :wait_for_rollout,
+    :apply_command
   ]
 
   Contract KuberKit::Shell::AbstractShell, KuberKit::Core::Service => Any
@@ -40,7 +41,12 @@ class KuberKit::ServiceDeployer::Strategies::Kubernetes < KuberKit::ServiceDeplo
       kubectl_commands.delete_resource(shell, resource_type, resource_name, kubeconfig_path: kubeconfig_path, namespace: namespace)
     end
 
-    apply_result = kubectl_commands.apply_file(shell, config_path, kubeconfig_path: kubeconfig_path, namespace: namespace)
+    apply_result = kubectl_commands.apply_file(
+      shell, config_path, 
+      kubeconfig_path: kubeconfig_path, 
+      namespace: namespace,
+      apply_command: strategy_options.fetch(:apply_command, "apply")
+    )
 
     restart_enabled  = strategy_options.fetch(:restart_if_exists, true)
     wait_for_rollout = strategy_options.fetch(:wait_for_rollout, true)

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

@@ -44,7 +44,7 @@ class KuberKit::Shell::Commands::DockerCommands
     if status
       command_parts << "--filter=\"status=#{status}\""
     end
-    command_parts << "--filter=\"name=#{container_name}\""
+    command_parts << "--filter=\"name=^/#{container_name}$\""
 
     shell.exec!(command_parts.join(" "))
   end

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

@@ -0,0 +1,42 @@
+class KuberKit::Shell::Commands::HelmCommands
+  Contract KuberKit::Shell::AbstractShell, Or[String, ArrayOf[String]], KeywordArgs[
+    kubeconfig_path: Maybe[Or[
+      String, KuberKit::Core::ArtifactPath
+    ]],
+    namespace:              Maybe[Or[Symbol, String]],
+    interactive:            Optional[Bool],
+  ] => Any
+  def helm_run(shell, command_list, kubeconfig_path: nil, namespace: nil, interactive: false)
+    command_parts = []
+
+    if kubeconfig_path.is_a?(KuberKit::Core::ArtifactPath)
+      kubeconfig_path = artifact_path_resolver.call(kubeconfig_path)
+    end
+
+    if kubeconfig_path
+      command_parts << "KUBECONFIG=#{kubeconfig_path}"
+    end
+
+    command_parts << "helm"
+
+    if namespace
+      command_parts << "-n #{namespace}"
+    end
+
+    command_parts += Array(command_list).compact
+
+    if interactive
+      shell.interactive!(command_parts.join(" "))
+    else
+      shell.exec!(command_parts.join(" "))
+    end
+  end
+
+  def install(shell, release_name, chart_path, kubeconfig_path: nil, namespace: nil)
+    helm_run(shell, "install #{release_name} #{chart_path}", kubeconfig_path: kubeconfig_path, namespace: namespace)
+  end
+
+  def upgrade(shell, release_name, chart_path, kubeconfig_path: nil, namespace: nil)
+    helm_run(shell, "upgrade #{release_name} #{chart_path} --install", kubeconfig_path: kubeconfig_path, namespace: namespace)
+  end
+end

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

@@ -39,8 +39,9 @@ class KuberKit::Shell::Commands::KubectlCommands
     end
   end
   
-  def apply_file(shell, file_path, kubeconfig_path: nil, namespace: nil)
-    kubectl_run(shell, "apply -f #{file_path}", kubeconfig_path: kubeconfig_path, namespace: namespace)
+  def apply_file(shell, file_path, kubeconfig_path: nil, namespace: nil, apply_command: nil)
+    apply_command ||= "apply"
+    kubectl_run(shell, "#{apply_command} -f #{file_path}", kubeconfig_path: kubeconfig_path, namespace: namespace)
   end
 
   def exec(shell, pod_name, command, args: nil, kubeconfig_path: nil, interactive: false, namespace: nil, entrypoint: nil)

data/lib/kuber_kit/shell/local_shell.rb

@@ -138,7 +138,7 @@ class KuberKit::Shell::LocalShell < KuberKit::Shell::AbstractShell
     def ensure_directory_exists(file_path)
       dir_path = File.dirname(file_path)
 
-      unless Dir.exists?(dir_path)
+      unless Dir.exist?(dir_path)
         FileUtils.mkdir_p(dir_path)
       end
     end

data/lib/kuber_kit/shell_launcher/strategies/kubernetes.rb

@@ -26,6 +26,6 @@ class KuberKit::ShellLauncher::Strategies::Kubernetes < KuberKit::ShellLauncher:
       env_vars << "KUBER_KIT_CONFIGURATION=#{KuberKit.current_configuration.name}"
     end
 
-    shell.replace!(env: ["KUBECONFIG=#{kubeconfig_path}", "KUBER_KIT_SHELL_CONFIGURATION=#{KuberKit.current_configuration.name}"])
+    shell.replace!(env: env_vars)
   end
 end

data/lib/kuber_kit/tools/logger_factory.rb

@@ -45,7 +45,7 @@ class KuberKit::Tools::LoggerFactory
   private
     def prepare_log_file(file_path)
       dir_path = File.dirname(file_path)
-      unless Dir.exists?(dir_path)
+      unless Dir.exist?(dir_path)
         FileUtils.mkdir_p(dir_path)
       end
       FileUtils.touch(file_path)

data/lib/kuber_kit/version.rb

@@ -1,3 +1,3 @@
 module KuberKit
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

data/lib/kuber_kit.rb

@@ -104,6 +104,7 @@ module KuberKit
       autoload :RsyncCommands, 'shell/commands/rsync_commands'
       autoload :KubectlCommands, 'shell/commands/kubectl_commands'
       autoload :SystemCommands, 'shell/commands/system_commands'
+      autoload :HelmCommands, 'shell/commands/helm_commands'
     end
   end
 
@@ -166,6 +167,7 @@ module KuberKit
       autoload :Docker, 'service_deployer/strategies/docker'
       autoload :DockerCompose, 'service_deployer/strategies/docker_compose'
       autoload :Kubernetes, 'service_deployer/strategies/kubernetes'
+      autoload :Helm, 'service_deployer/strategies/helm'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuber_kit
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Iskander Khaziev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -98,16 +98,16 @@ dependencies:
   name: cli-ui
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -343,6 +343,7 @@ files:
 - lib/kuber_kit/service_deployer/strategies/abstract.rb
 - lib/kuber_kit/service_deployer/strategies/docker.rb
 - lib/kuber_kit/service_deployer/strategies/docker_compose.rb
+- lib/kuber_kit/service_deployer/strategies/helm.rb
 - lib/kuber_kit/service_deployer/strategies/kubernetes.rb
 - lib/kuber_kit/service_deployer/strategy_detector.rb
 - lib/kuber_kit/service_reader/action_handler.rb
@@ -353,6 +354,7 @@ files:
 - lib/kuber_kit/shell/commands/docker_commands.rb
 - lib/kuber_kit/shell/commands/docker_compose_commands.rb
 - lib/kuber_kit/shell/commands/git_commands.rb
+- lib/kuber_kit/shell/commands/helm_commands.rb
 - lib/kuber_kit/shell/commands/kubectl_commands.rb
 - lib/kuber_kit/shell/commands/rsync_commands.rb
 - lib/kuber_kit/shell/commands/system_commands.rb
@@ -382,7 +384,7 @@ homepage: https://github.com/ArtStation/kuber_kit
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -398,7 +400,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Docker Containers Build & Deployment
 test_files: []