kuber_kit 0.2.7 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2735934312125fca63822a1f45333ae928f4e053d9b6e9509a99036285e171a
-  data.tar.gz: 3045f6fb2cbe3d77313af0c3740edc3ae2dcd838cc46c65f672d419d6590d815
+  metadata.gz: 339883bd875277f494fdef1fe01035920e6a867ea98394e10c4d08e5a8b5a108
+  data.tar.gz: 96448b7bb059d60e55ec0b8bceb70e1a02b8740773dcdbc4944afa3fafda3192
 SHA512:
-  metadata.gz: 613792df522946cf5b5fdf83447214549ca47976c5d5a3c2c24c32813535237674fb72e62ccca378ba437e0b3a2675047ed4db32e7a6f53dc8b2598377497ae4
-  data.tar.gz: e0f187c76817f7af79716816459683b731726b2ae296481229fbcee23f75c65b0d7e7d934da4c18330b5b20602c43688a1c4e02d7d9852a19bf68703df6cd819
+  metadata.gz: 49b5bf9c115c06ab88f67b60bc54f55b254a3a1a4de58ebe0fa834c04b352d8e759ed66747bd98e1d62a8adbb794cbda948dbd324c06165113af29d28ce02aad
+  data.tar.gz: 77354cf127ad50ff4f5f092aeaebfdb7568030ea8120e990dc01eb109a9ca679da83f1124cd5df225d37053ce2abe84d4e9016c0d284b47a323a4d175ba28b40

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kuber_kit (0.2.7)
+    kuber_kit (0.3.2)
       cli-ui
       contracts-lite
       dry-auto_inject
@@ -35,23 +35,25 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (10.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    simplecov (0.19.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    simplecov (0.20.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     thor (1.0.1)
 
 PLATFORMS

data/TODO.md

@@ -1,10 +1,8 @@
-- add config file support to kuber_kit root folder
-- find a way to always deploy some service, e.g. for migrations and env_files
-- allow setting default configuration for kuberkit using env variable
-- add ability to set container health  checks
-- implement interactive shell.exec!
-- allow deploying only services enabled for specific configuration
 - list services and require confirmation before deployment
-- add build vars support (use images instead of containers)
+- 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/example/app_data/docker_compose.yml

@@ -0,0 +1,6 @@
+version: "3.3"
+services:
+  <%= service_name %>:
+    container_name: <%= service_name %>
+    hostname: <%= service_name %>
+    image: <%= image_url(attribute(:image_name, default: service_name.to_sym)) %>

data/example/config.rb

@@ -0,0 +1,3 @@
+KuberKit.configure do |config|
+  config.kuber_kit_min_version = "0.2.0"
+end

data/example/configurations/review.rb

@@ -2,4 +2,4 @@ KuberKit
   .define_configuration(:review)
   .use_registry(:review_default, as: :default)
   .use_artifact(:kuber_kit_repo, as: :kuber_kit_repo)
-  .use_build_server(:remote_bs)
+  #.use_build_server(:remote_bs)

data/example/images/ruby_app/Dockerfile

@@ -8,4 +8,4 @@ COPY README.md README.md
 
 RUN ruby /app/source.rb
 
-COPY example_file.txt example_file.txt
+COPY example_file.txt <%= build_vars.example_file_name %>

data/example/images/ruby_app/image.rb

@@ -2,6 +2,9 @@ KuberKit
   .define_image(:ruby_app)
   .registry(:default)
   .depends_on(:ruby, :app_sources)
+  .build_vars({
+    example_file_name: "example.txt"
+  })
   .before_build do |context_helper, build_dir|
     # copy file: local artifact
     source_path = context_helper.artifact_path(:kuber_kit_example_data, "test.txt")

data/example/infrastructure/build_servers.rb

@@ -1,8 +1,8 @@
 ENV['SSH_TEST_HOST'] ||= "indocker.artstn.ninja"
 ENV['SSH_TEST_USER'] ||= "kuber_kit"
 
-KuberKit.add_build_server(
-  KuberKit::Core::BuildServers::BuildServer
-    .new(:remote_bs)
-    .setup(host: ENV['SSH_TEST_HOST'], user: ENV['SSH_TEST_USER'], port: 22)
-)
+# KuberKit.add_build_server(
+#   KuberKit::Core::BuildServers::BuildServer
+#     .new(:remote_bs)
+#     .setup(host: ENV['SSH_TEST_HOST'], user: ENV['SSH_TEST_USER'], port: 22)
+# )

data/example/infrastructure/templates.rb

@@ -6,4 +6,9 @@ KuberKit.add_template(
 KuberKit.add_template(
   KuberKit::Core::Templates::ArtifactFile
     .new(:env_file, artifact_name: :kuber_kit_example_data, file_path: "env_file.yml")
+)
+
+KuberKit.add_template(
+  KuberKit::Core::Templates::ArtifactFile
+    .new(:docker_compose, artifact_name: :kuber_kit_example_data, file_path: "docker_compose.yml")
 )

data/example/services/compose_app.rb

@@ -0,0 +1,10 @@
+KuberKit
+  .define_service(:compose_app)
+  .template(:docker_compose)
+  .images(:ruby_app)
+  .tags(:compose)
+  .deployer_strategy(:docker_compose)
+  .attributes(
+    image_name: :ruby_app,
+    deployer_interactive: true
+  )

data/example/services/env_file.rb

@@ -3,5 +3,5 @@ KuberKit
   .template(:env_file)
   .tags("env_file")
   .attributes(
-    deployment_restart_enabled: false
+    deployer_restart_enabled: false
   )

data/lib/kuber_kit.rb

@@ -57,6 +57,7 @@ module KuberKit
       autoload :ImageHelper, 'core/context_helper/image_helper'
       autoload :ServiceHelper, 'core/context_helper/service_helper'
       autoload :ContextHelperFactory, 'core/context_helper/context_helper_factory'
+      autoload :ContextVars, 'core/context_helper/context_vars'
     end
 
     module Registries
@@ -87,6 +88,7 @@ module KuberKit
     module Commands
       autoload :BashCommands, 'shell/commands/bash_commands'
       autoload :DockerCommands, 'shell/commands/docker_commands'
+      autoload :DockerComposeCommands, 'shell/commands/docker_compose_commands'
       autoload :GitCommands, 'shell/commands/git_commands'
       autoload :RsyncCommands, 'shell/commands/rsync_commands'
       autoload :KubectlCommands, 'shell/commands/kubectl_commands'
@@ -127,9 +129,13 @@ module KuberKit
   end
 
   module TemplateReader
+    autoload :ActionHandler, 'template_reader/action_handler'
     autoload :Reader, 'template_reader/reader'
-    autoload :AbstractTemplateReader, 'template_reader/abstract_template_reader'
-    autoload :ArtifactFileReader, 'template_reader/artifact_file_reader'
+
+    module Strategies
+      autoload :Abstract, 'template_reader/strategies/abstract'
+      autoload :ArtifactFile, 'template_reader/strategies/artifact_file'
+    end
   end
 
   module ServiceDeployer
@@ -140,6 +146,7 @@ module KuberKit
 
     module Strategies
       autoload :Abstract, 'service_deployer/strategies/abstract'
+      autoload :DockerCompose, 'service_deployer/strategies/docker_compose'
       autoload :Kubernetes, 'service_deployer/strategies/kubernetes'
       autoload :KubernetesRunner, 'service_deployer/strategies/kubernetes_runner'
     end
@@ -170,9 +177,9 @@ module KuberKit
     autoload :Simple, 'ui/simple'
   end
 
-  autoload :Configs, 'configs'
   autoload :CLI, 'cli'
   autoload :Container, 'container'
+  autoload :Configs, 'configs'
 
   Import = Dry::AutoInject(Container)
 
@@ -204,6 +211,10 @@ module KuberKit
       !!@debug_mode
     end
 
+    def deprecation_warnings_disabled?
+      Container["configs"].deprecation_warnings_disabled
+    end
+
     def current_configuration
       if @configuration_name.nil?
         raise "Please set configuration name before calling current_configuration"
@@ -211,6 +222,10 @@ module KuberKit
       @current_configuration ||= Container['core.configuration_store'].get_configuration(@configuration_name)
     end
 
+    def global_build_vars
+      KuberKit::Core::ContextHelper::ContextVars.new(current_configuration.global_build_vars)
+    end
+
     def add_registry(registry)
       Container["core.registry_store"].add(registry)
     end
@@ -234,6 +249,10 @@ module KuberKit
     def build_helper(&proc)
       KuberKit::Core::ContextHelper::BaseHelper.class_exec(&proc)
     end
+
+    def configure(&proc)
+      yield(Container["configs"])
+    end
   end
 end
 

data/lib/kuber_kit/actions/configuration_loader.rb

@@ -1,4 +1,6 @@
 class KuberKit::Actions::ConfigurationLoader
+  APP_CONFIG_FILENAME = "config.rb".freeze
+
   include KuberKit::Import[
     "core.registry_store",
     "core.image_store",
@@ -14,11 +16,18 @@ class KuberKit::Actions::ConfigurationLoader
   Contract Hash => Any
   def call(options)
     root_path     = options[:path] || File.join(Dir.pwd, configs.kuber_kit_dirname)
+
+    # require config file first, in case if other dirs are overriden in config
+    config_file_path = File.join(root_path, APP_CONFIG_FILENAME)
+    if File.exists?(config_file_path)
+      require config_file_path
+    end
+
     images_path   = options[:images_path] || File.join(root_path, configs.images_dirname)
     services_path = options[:services_path] || File.join(root_path, configs.services_dirname)
     infra_path    = options[:infra_path]  || File.join(root_path, configs.infra_dirname)
     configurations_path  = options[:configurations_path]  || File.join(root_path, configs.configurations_dirname)
-    configuration_name   = options[:configuration]
+    configuration_name   = ENV["KUBER_KIT_CONFIGURATION"] || options[:configuration]
 
     logger.info "Launching kuber_kit with:"
     logger.info "  Root path: #{root_path.to_s.yellow}"
@@ -32,6 +41,10 @@ class KuberKit::Actions::ConfigurationLoader
       ui.print_warning "WARNING", "KuberKit root path #{root_path} doesn't exist. You may want to pass it --path parameter."
     end
 
+    if Gem::Version.new(KuberKit::VERSION) < Gem::Version.new(configs.kuber_kit_min_version)
+      raise KuberKit::Error, "The minimal required kuber_kit version is #{configs.kuber_kit_min_version}"
+    end
+
     load_configurations(configurations_path, configuration_name)
     load_infrastructure(infra_path)
 
@@ -43,6 +56,11 @@ class KuberKit::Actions::ConfigurationLoader
 
     ui.create_task("Loading image definitions") do |task|
       files = image_store.load_definitions(images_path)
+
+      configs.additional_images_paths.each do |path|
+        files += image_store.load_definitions(path)
+      end
+
       task.update_title("Loaded #{files.count} image definitions")
     end
 

data/lib/kuber_kit/actions/kubectl_applier.rb

@@ -8,9 +8,9 @@ class KuberKit::Actions::KubectlApplier
   Contract String, Hash => Any
   def call(file_path, options)
     kubeconfig_path  = KuberKit.current_configuration.kubeconfig_path
-    deploy_namespace = KuberKit.current_configuration.deploy_namespace
+    deployer_namespace = KuberKit.current_configuration.deployer_namespace
     ui.create_task("Applying file: #{file_path}") do |task|
-      kubectl_commands.apply_file(local_shell, file_path, kubeconfig_path: kubeconfig_path, namespace: deploy_namespace)
+      kubectl_commands.apply_file(local_shell, file_path, kubeconfig_path: kubeconfig_path, namespace: deployer_namespace)
       task.update_title("Applied file: #{file_path}")
     end
 

data/lib/kuber_kit/actions/kubectl_attacher.rb

@@ -8,13 +8,13 @@ class KuberKit::Actions::KubectlAttacher
   Contract String, Hash => Any
   def call(pod_name, options)
     kubeconfig_path = KuberKit.current_configuration.kubeconfig_path
-    deploy_namespace = KuberKit.current_configuration.deploy_namespace
+    deployer_namespace = KuberKit.current_configuration.deployer_namespace
 
     kubectl_commands.exec(
       local_shell, pod_name, "bash", args: "-it", 
       kubeconfig_path: kubeconfig_path, 
       interactive: true,
-      namespace: deploy_namespace
+      namespace: deployer_namespace
     )
 
     true

data/lib/kuber_kit/actions/template_reader.rb

@@ -1,16 +1,13 @@
 class KuberKit::Actions::TemplateReader
   include KuberKit::Import[
-    "core.template_store",
-    "template_reader.reader",
     "shell.local_shell",
-    "ui"
+    "ui",
+    template_reader: "template_reader.action_handler",
   ]
 
   Contract Symbol, Hash => Any
   def call(template_name, options)
-    template = template_store.get(template_name)
-
-    result = reader.read(local_shell, template)
+    result = template_reader.call(local_shell, template_name)
 
     ui.print_info(template_name.to_s, result)
 

data/lib/kuber_kit/configs.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 class KuberKit::Configs
-  IMAGE_DOCKERFILE_NAME = "Dockerfile".freeze
-  IMAGE_BUILD_CONTEXT_DIR = "build_context".freeze
-  IMAGE_TAG = 'latest'.freeze
-  IMAGE_COMPILE_DIR = "/tmp/kuber_kit/image_builds"
+  AVAILABLE_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
+  ]
   DOCKER_IGNORE_LIST = [
     'Dockerfile',
     '.DS_Store',
@@ -14,35 +18,62 @@ class KuberKit::Configs
     'tmp',
     'logs'
   ]
-  KUBER_KIT_DIRNAME           = "kuber_kit".freeze
-  IMAGES_DIRNAME              = "images".freeze
-  SERVICES_DIRNAME            = "services".freeze
-  INFRA_DIRNAME               = "infrastructure".freeze
-  CONFIGURATIONS_DIRNAME      = "configurations".freeze
-  ARTIFACT_CLONE_DIR          = "/tmp/kuber_kit/artifacts"
-  SERVICE_CONFIG_DIR          = "/tmp/kuber_kit/services"
-  DEPLOY_STRATEGY             = :kubernetes
-  COMPILE_SIMULTANEOUS_LIMIT  = 5
-
-  attr_accessor :image_dockerfile_name, :image_build_context_dir, :image_tag,
-                :docker_ignore_list, :image_compile_dir, 
-                :kuber_kit_dirname, :images_dirname, :services_dirname, :infra_dirname, :configurations_dirname,
-                :artifact_clone_dir, :service_config_dir, :deploy_strategy, :compile_simultaneous_limit
+
+  AVAILABLE_CONFIGS.each do |config_name|
+    define_method(config_name) do
+      get(config_name.to_sym)
+    end
+
+    define_method(:"#{config_name}=") do |value|
+      set(config_name.to_sym, value)
+    end
+  end
 
   def initialize
-    @image_dockerfile_name      = IMAGE_DOCKERFILE_NAME
-    @image_build_context_dir    = IMAGE_BUILD_CONTEXT_DIR
-    @image_tag                  = IMAGE_TAG
-    @image_compile_dir          = IMAGE_COMPILE_DIR
-    @docker_ignore_list         = DOCKER_IGNORE_LIST
-    @kuber_kit_dirname          = KUBER_KIT_DIRNAME
-    @images_dirname             = IMAGES_DIRNAME
-    @services_dirname           = SERVICES_DIRNAME
-    @infra_dirname              = INFRA_DIRNAME
-    @configurations_dirname     = CONFIGURATIONS_DIRNAME
-    @artifact_clone_dir         = ARTIFACT_CLONE_DIR
-    @service_config_dir         = SERVICE_CONFIG_DIR
-    @deploy_strategy            = DEPLOY_STRATEGY
-    @compile_simultaneous_limit = COMPILE_SIMULTANEOUS_LIMIT
+    add_default_configs unless items.any?
+  end
+
+  def add_default_configs
+    set :image_dockerfile_name,   "Dockerfile"
+    set :image_build_context_dir, "build_context"
+    set :image_tag,               'latest'
+    set :image_compile_dir,       "/tmp/kuber_kit/image_builds"
+    set :docker_ignore_list,      DOCKER_IGNORE_LIST
+    set :kuber_kit_dirname,       "kuber_kit"
+    set :kuber_kit_min_version,   KuberKit::VERSION
+    set :images_dirname,          "images"
+    set :services_dirname,        "services"
+    set :infra_dirname,           "infrastructure"
+    set :configurations_dirname,  "configurations"
+    set :artifact_clone_dir,      "/tmp/kuber_kit/artifacts"
+    set :service_config_dir,      "/tmp/kuber_kit/services"
+    set :deployer_strategy,         :kubernetes
+    set :compile_simultaneous_limit, 5
+    set :additional_images_paths, []
+    set :deprecation_warnings_disabled, false
+  end
+
+  def items
+    @@items ||= {}
+  end
+
+  def set(key, value)
+    unless AVAILABLE_CONFIGS.include?(key)
+      raise ArgumentError, "#{key} is not a valid configuration key"
+    end
+
+    items[key] = value
+  end
+
+  def get(key)
+    unless AVAILABLE_CONFIGS.include?(key)
+      raise ArgumentError, "#{key} is not a valid configuration key"
+    end
+
+    items[key]
+  end
+
+  def reset!
+    @@items = {}
   end
 end

data/lib/kuber_kit/container.rb

@@ -117,6 +117,10 @@ class KuberKit::Container
     KuberKit::Shell::Commands::DockerCommands.new
   end
 
+  register "shell.docker_compose_commands" do
+    KuberKit::Shell::Commands::DockerComposeCommands.new
+  end
+
   register "shell.git_commands" do
     KuberKit::Shell::Commands::GitCommands.new
   end
@@ -197,12 +201,16 @@ class KuberKit::Container
     KuberKit::EnvFileReader::Strategies::ArtifactFile.new
   end
 
+  register "template_reader.action_handler" do
+    KuberKit::TemplateReader::ActionHandler.new
+  end
+
   register "template_reader.reader" do
     KuberKit::TemplateReader::Reader.new
   end
 
-  register "template_reader.artifact_file_reader" do
-    KuberKit::TemplateReader::ArtifactFileReader.new
+  register "template_reader.strategies.artifact_file" do
+    KuberKit::TemplateReader::Strategies::ArtifactFile.new
   end
 
   register "service_deployer.action_handler" do
@@ -229,6 +237,10 @@ class KuberKit::Container
     KuberKit::ServiceDeployer::Strategies::KubernetesRunner.new
   end
 
+  register "service_deployer.strategies.docker_compose" do
+    KuberKit::ServiceDeployer::Strategies::DockerCompose.new
+  end
+
   register "service_reader.action_handler" do
     KuberKit::ServiceReader::ActionHandler.new
   end