kcu 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ce1f8358a691f2bb4fe73a2d74fe7e9af6775ba
-  data.tar.gz: 1e02aa503e1da760686a663153e8de70a9c7b612
+  metadata.gz: b390824d729ff0b0d28f3b453aef75ee5d5e7da7
+  data.tar.gz: 2ca5b1df6afd4ec36facb653592df40194731ab4
 SHA512:
-  metadata.gz: b99940b59e086dd9c45a0e1348d24dc830db891113200d813af6246e1dcb4b3d7425885952163d8896d33f0562be239709623cb66837c7d70558637ba1d9c364
-  data.tar.gz: e4a4085bef52aef30252a84aea42a57cad5dd8c6426b28e1825b964ba0c400668a480bf6a96040a28020432fe219fa85ff2bd85fa43133a6db85f4e9a63a0b67
+  metadata.gz: c2ac93598773b7c07008adadb66f96b628229010ca34aa03da0f9de22c19fc3ef1cab36922f54f1ac4b4e48f1c9a062fdd493157bb220b4536cfd9c7cd5d57fd
+  data.tar.gz: 568488c1fe0d3aeebec2e848e0ec5b214e94336339ca9379bec27af891ad12df97b8ed8be788d7516041f95d9d543c59933f0453512f2dadeef4d3be62d8b423

data/CHANGELOG.md

@@ -4,7 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [0.2.0] -2017-11-26
+## [0.3.0] - 2017-11-26
+### Added
+- Add easy deployment
+- Restart a deployment
+
+## [0.2.0] - 2017-11-26
 ### Added
 - Get a single secret's decoded value
 - Set a single secret's value, given a non-encoded value (yes, we properly encode for you!)

data/README.md

@@ -14,13 +14,64 @@ gem install kcu
 
 ## Usage
 
-All actions are documented in the executable:
+All actions are documented in the executable. Use `--help`:
 
 ```
 kcu --help
 kcu secret list --help
 ```
 
+Some examples:
+
+```
+kcu secret list production/worker
+kcu secret get production/worker sidekiq_concurrency
+kcu secret set production/worker sidekiq_concurrency 10
+kcu controller restart production/website
+```
+
+### Easy Deployment
+
+Some teams prefer not to deploy via CD -- perhaps more planning needs to go through the deployment phase. For this type of workflow, KCU provides a simple way to deploy:
+
+```
+kcu deploy master
+```
+
+This must be executed in the project which contains the configuration file `kcu.yml`:
+
+```
+---
+deploys:
+  - branch: master
+    namespace: production
+    template: "gcr.io/bloom-solutions/website:prod-$GIT_COMMIT"
+    targets:
+      - deployment_name: web
+        container: website
+      - deployment_name: worker
+        container: sidekiq
+  - branch: /staging_(\d+)/
+    namespace: staging
+    template: "gcr.io/bloom-solutions/website:staging-$GIT_COMMIT"
+    targets:
+      - deployment_name: web
+        container: website
+      - deployment_name: worker
+        container: sidekiq
+```
+
+The command above is the short version of `kcu deploy master production`. If you will deploy the master branch to production/web/website and production/worker/sidekiq then you need not specify the target details, since this is already defined in the config file.
+
+When deploying the a specific branch to a different namespace (like deploying the production image to the staging namespace), you may specify the namespace. For example, these commands deploy the `master` branch to the staging/web/website and staging/worker/sidekiq containers:
+
+```
+kcu deploy master staging
+```
+
+- Variables:
+  - `GIT_COMMIT`: the full, latest git commit hash of the *local* git copy in the branch
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/kcu

@@ -8,4 +8,4 @@ $: << LIB_DIR
 
 require 'kcu'
 
-Kcu::Client.new.run if $0 == __FILE__
+Kcu::Client.new.run(working_dir: FileUtils.pwd)

data/kcu.gemspec

@@ -26,15 +26,20 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = ["kcu"]
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport", ">= 3.0"
   spec.add_dependency "awesome_print", "~> 1.8"
   spec.add_dependency "commander", "~> 4.4"
+  spec.add_dependency "dry-initializer", "~> 2.3"
   spec.add_dependency "light-service", "0.8.3"
+  spec.add_dependency "git", "~> 1.3"
+  spec.add_dependency "to_regexp", "0.2.1"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop"
 end

data/lib/kcu/actions/deploy_action.rb

@@ -0,0 +1,23 @@
+module Kcu
+  class DeployAction
+
+    extend LightService::Organizer
+
+    def self.call(repo_dir, git_branch, target_namespace=nil)
+      with(
+        repo_dir: repo_dir,
+        git_branch: git_branch,
+        target_namespace: target_namespace,
+      ).reduce(
+        Deploys::GetConfig,
+        Deploys::GetImageConfig,
+        Deploys::GenImageName,
+        Deploys::SetTargetNamespace,
+        Deploys::GetTargetContainersConfig,
+        Deploys::GetTargetContainers,
+        Deploys::SetImage,
+      )
+    end
+
+  end
+end

data/lib/kcu/actions/restart_deployment_action.rb

@@ -0,0 +1,14 @@
+module Kcu
+  class RestartDeploymentAction
+
+    extend LightService::Organizer
+
+    def self.call(resource)
+      ctx = with(resource: resource).reduce(
+        GetResourceNamespaceAndName,
+        Deployments::RestartDeployment,
+      )
+    end
+
+  end
+end

data/lib/kcu/client.rb

@@ -5,7 +5,7 @@ module Kcu
 
     include Commander::Methods
 
-    def run
+    def run(working_dir:)
       program :name, "Kubectl Utils (KCU)"
       program :version, Kcu::VERSION
       program :description, Kcu::SUMMARY
@@ -34,6 +34,22 @@ module Kcu
         end
       end
 
+      command :"deployment restart" do |c|
+        c.syntax = "deployment restart namespace/deployment_name"
+        c.description = "Restarts a deployment"
+        c.action do |args, options|
+          RestartDeploymentAction.(*args)
+        end
+      end
+
+      command :deploy do |c|
+        c.syntax = "deploy master"
+        c.description = "Deploy a branch"
+        c.action do |args, options|
+          DeployAction.(*args.insert(0, working_dir))
+        end
+      end
+
       run!
     end
 

data/lib/kcu/models/container.rb

@@ -0,0 +1,11 @@
+module Kcu
+  class Container
+
+    extend Dry::Initializer
+
+    option :namespace
+    option :deployment_name
+    option :name
+
+  end
+end

data/lib/kcu/services/deployments/restart_deployment.rb

@@ -0,0 +1,27 @@
+module Kcu
+  module Deployments
+    class RestartDeployment
+
+      extend LightService::Action
+      expects :resource_namespace, :resource_name
+
+      executed do |c|
+        json = { spec: { template: { metadata: { annotations: {
+          kcu_restarted_at: Time.now.to_i.to_s,
+        } } } } }.to_json
+
+        stdout_str, stderr_str, status = ExecShell.(
+          "kubectl",
+          "patch",
+          "deployment",
+          c.resource_name,
+          "--namespace" => c.resource_namespace,
+          "--patch" => "'#{json}'",
+        )
+
+        puts stdout_str
+      end
+
+    end
+  end
+end

data/lib/kcu/services/deploys/gen_image_name.rb

@@ -0,0 +1,20 @@
+module Kcu
+  module Deploys
+    class GenImageName
+
+      extend LightService::Action
+      expects :image_config, :git_branch, :repo_dir
+      promises :image_name
+
+      executed do |c|
+        git = Git.open(c.repo_dir)
+        git.branch(c.git_branch)
+        git_commit = git.log(1).first.sha
+
+        c.image_name = c.image_config["template"].
+          gsub("$GIT_COMMIT", git_commit)
+      end
+
+    end
+  end
+end

data/lib/kcu/services/deploys/get_config.rb

@@ -0,0 +1,21 @@
+module Kcu
+  module Deploys
+    class GetConfig
+
+      CONFIG_FILE_NAME = "kcu.yml"
+      extend LightService::Action
+      expects :repo_dir
+      promises :config
+
+      executed do |c|
+        file_path = File.join(c.repo_dir, CONFIG_FILE_NAME)
+        if File.exists?(file_path)
+          c.config = YAML.load_file(file_path)
+        else
+          fail ArgumentError, "#{CONFIG_FILE_NAME} is not present in #{c.repo_dir}"
+        end
+      end
+
+    end
+  end
+end

data/lib/kcu/services/deploys/get_image_config.rb

@@ -0,0 +1,26 @@
+module Kcu
+  module Deploys
+    class GetImageConfig
+
+      extend LightService::Action
+      expects :git_branch, :config
+      promises :image_config
+
+      executed do |c|
+        c.image_config = catch(:config) do
+          c.config["deploys"].find do |conf|
+            config_branch = conf["branch"]
+            if config_branch.include?("/")
+              throw(:config, conf) if c.git_branch =~ config_branch.to_regexp
+            else
+              throw(:config, conf) if c.git_branch == config_branch
+            end
+          end
+
+          fail ArgumentError, "`#{c.git_branch}` branch is not configured"
+        end
+      end
+
+    end
+  end
+end

data/lib/kcu/services/deploys/get_target_containers.rb

@@ -0,0 +1,23 @@
+module Kcu
+  module Deploys
+    class GetTargetContainers
+
+      extend LightService::Action
+      expects :target_containers_config, :target_namespace
+      promises :target_containers
+
+      executed do |c|
+        config = c.target_containers_config
+        targets = config["targets"]
+        c.target_containers = targets.map do |target_config|
+          Container.new(
+            namespace: c.target_namespace,
+            deployment_name: target_config["deployment_name"],
+            name: target_config["container"],
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/kcu/services/deploys/get_target_containers_config.rb

@@ -0,0 +1,25 @@
+module Kcu
+  module Deploys
+    class GetTargetContainersConfig
+
+      extend LightService::Action
+      expects :config, :target_namespace, :image_config
+      promises :target_containers_config
+
+      executed do |c|
+        c.target_containers_config = catch(:config) do
+          if c.target_namespace.present?
+            c.config["deploys"].find do |conf|
+              throw(:config, conf) if conf["namespace"] == c.target_namespace
+            end
+
+            fail ArgumentError, "`#{c.target_namespace}` namespace is not configured"
+          end
+
+          throw :config, c.image_config
+        end
+      end
+
+    end
+  end
+end

data/lib/kcu/services/deploys/set_image.rb

@@ -0,0 +1,32 @@
+module Kcu
+  module Deploys
+    class SetImage
+
+      extend LightService::Action
+      expects :image_name, :target_containers
+
+      executed do |c|
+        c.target_containers.each do |container|
+          stdout_str, stderr_str, status = ExecShell.(
+            "kubectl",
+            "set",
+            "image",
+            "deployment",
+            container.deployment_name,
+            "--namespace" => container.namespace,
+            container.name => c.image_name,
+          )
+
+          if status.exitstatus.zero?
+            puts "Updated #{container.namespace} deployment " +
+              "#{container.deployment_name} #{container.name} to " +
+              "#{c.image_name}"
+          else
+            puts stderr_str
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/kcu/services/deploys/set_target_namespace.rb

@@ -0,0 +1,15 @@
+module Kcu
+  module Deploys
+    class SetTargetNamespace
+
+      extend LightService::Action
+      expects :image_config, :target_namespace
+
+      executed do |c|
+        next c if c.target_namespace.present?
+        c.target_namespace = c.image_config["namespace"]
+      end
+
+    end
+  end
+end

data/lib/kcu/services/exec_shell.rb

@@ -0,0 +1,22 @@
+module Kcu
+  class ExecShell
+
+    def self.call(*args)
+      command_parts = []
+      args.each do |arg|
+        if arg.is_a?(Hash)
+          arg.each do |key, value|
+            command_parts << [key, value].join("=")
+          end
+        else
+          command_parts << arg
+        end
+      end
+
+      command = command_parts.join(" ")
+
+      Open3.capture3(command)
+    end
+
+  end
+end

data/lib/kcu/services/secrets/get_json.rb

@@ -7,16 +7,14 @@ module Kcu
       promises :secret_json
 
       executed do |c|
-        shell_command = [
+        stdout_str, stderr_str, status = ExecShell.(
           "kubectl",
           "get",
           "secret",
           c.resource_name,
-          "--namespace=#{c.resource_namespace}",
-          "--output=json",
-        ].join(" ")
-
-        stdout_str, stderr_str, status = Open3.capture3(shell_command)
+          "--namespace" => c.resource_namespace,
+          "--output" => "json",
+        )
 
         c.secret_json = JSON.parse(stdout_str)
       end

data/lib/kcu/services/secrets/set_entry_value.rb

@@ -16,16 +16,15 @@ module Kcu
             c.entry_name => c.encoded_entry_value,
           },
         }.to_json
-        shell_command = [
+
+        stdout_str, stderr_str, status = ExecShell.(
           "kubectl",
           "patch",
           "secret",
           c.resource_name,
-          "--namespace=#{c.resource_namespace}",
-          ["--patch", "'#{patch_json}'"].join("="),
-        ].join(" ")
-
-        stdout_str, stderr_str, status = Open3.capture3(shell_command)
+          "--namespace" => c.resource_namespace,
+          "--patch" => "'#{patch_json}'",
+        )
 
         puts stdout_str
       end

data/lib/kcu/version.rb

@@ -1,3 +1,3 @@
 module Kcu
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/kcu.rb

@@ -1,25 +1,40 @@
+require "active_support/core_ext/object/blank"
 require "awesome_print"
 require "base64"
 require "commander"
+require "dry-initializer"
+require "git"
 require "json"
 require "light-service"
 require "open3"
+require "to_regexp"
 
 module Kcu
 end
 
 require "kcu/version"
 require "kcu/summary"
+require "kcu/models/container"
+require "kcu/services/exec_shell"
 require "kcu/services/get_resource_namespace_and_name"
 require "kcu/services/secrets/get_json"
 require "kcu/services/secrets/decode_data"
 require "kcu/services/secrets/get_entry_value"
 require "kcu/services/secrets/encode_entry_value"
 require "kcu/services/secrets/set_entry_value"
-require "kcu/services/secrets/get_entry_value"
+require "kcu/services/deployments/restart_deployment"
+require "kcu/services/deploys/get_config"
+require "kcu/services/deploys/set_target_namespace"
+require "kcu/services/deploys/get_image_config"
+require "kcu/services/deploys/gen_image_name"
+require "kcu/services/deploys/set_image"
+require "kcu/services/deploys/get_target_containers_config"
+require "kcu/services/deploys/get_target_containers"
 require "kcu/actions/list_secret_action"
 require "kcu/actions/get_secret_action"
 require "kcu/actions/set_secret_action"
+require "kcu/actions/restart_deployment_action"
+require "kcu/actions/deploy_action"
 require "kcu/client"
 
 Kcu.new.run if $0 == __FILE__

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kcu
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-11-26 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: light-service
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: to_regexp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +150,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - ramon@tayag.net
-executables: []
+executables:
+- kcu
 extensions: []
 extra_rdoc_files: []
 files:
@@ -117,10 +188,22 @@ files:
 - bin/setup
 - kcu.gemspec
 - lib/kcu.rb
+- lib/kcu/actions/deploy_action.rb
 - lib/kcu/actions/get_secret_action.rb
 - lib/kcu/actions/list_secret_action.rb
+- lib/kcu/actions/restart_deployment_action.rb
 - lib/kcu/actions/set_secret_action.rb
 - lib/kcu/client.rb
+- lib/kcu/models/container.rb
+- lib/kcu/services/deployments/restart_deployment.rb
+- lib/kcu/services/deploys/gen_image_name.rb
+- lib/kcu/services/deploys/get_config.rb
+- lib/kcu/services/deploys/get_image_config.rb
+- lib/kcu/services/deploys/get_target_containers.rb
+- lib/kcu/services/deploys/get_target_containers_config.rb
+- lib/kcu/services/deploys/set_image.rb
+- lib/kcu/services/deploys/set_target_namespace.rb
+- lib/kcu/services/exec_shell.rb
 - lib/kcu/services/get_resource_namespace_and_name.rb
 - lib/kcu/services/secrets/decode_data.rb
 - lib/kcu/services/secrets/encode_entry_value.rb