kubernetes-deploy 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1e66d28cabf4ab39da9f1418817e5466ea2e73f
-  data.tar.gz: 69967786f96afae72c074a49c44763e1e0377d1e
+  metadata.gz: d6c0635aa2dd4ca87b4cea59f90b783251f93418
+  data.tar.gz: 9859f840e6b082188e50e8545546b756b399e95c
 SHA512:
-  metadata.gz: 1aba4d518ff8cb0afad70fd9d5a2710ee6696f02c06fe497907a1ac593fc94191e970b1afabe119032dbf5ad361dd9fc06255d1ca817748e36d9c66b581037e9
-  data.tar.gz: d4213a7380ac484572837a8723713ebfb8cc93448cab122e89a80c55d36bd0399397f8d93e8a27b858fae34dcaa6a4783a65d220e1b561079f5c323eb890105d
+  metadata.gz: f637386dec36fb619f319d22109f113b621587c0e1b6f8774d76801582a3c349355ed2f2ac3de57e7d2c1f30792e9c796abd27fde46c58b1bd558ec849290209
+  data.tar.gz: 57c73ae638bab026343598ae9f503f9a1af48d11a77ceed8e4c73238d3795314ff1eacf775101dcc19cdf76c2fd3ef584c13c53ca9910db8f69b61bf6a8f7cd4

data/.gitignore

@@ -12,3 +12,4 @@
 .rubocop-http---shopify-github-io-ruby-style-guide-rubocop-yml
 
 .byebug_history
+.ruby-version

data/README.md

@@ -40,6 +40,27 @@ The following command will restart all pods in the `web` and `jobs` deployments:
 
 `kubernetes-restart <kube namespace> <kube context> --deployments=web,jobs`
 
+### Running one off tasks
+
+To trigger a one-off job such as a rake task _outside_ of a deploy, use the following command:
+
+`kubernetes-run <kube namespace> <kube context> <arguments> --entrypoint=/bin/bash`
+
+This command assumes that you've already deployed a `PodTemplate` named `task-runner-template`, which contains a full pod specification in its `data`. The pod specification in turn must have a container named `task-runner`. Based on this specification `kubernetes-run` will create a new pod with the entrypoint of the task-runner container overriden with the supplied arguments.
+
+#### Creating a PodTemplate
+
+The [`PodTemplate`](https://kubernetes.io/docs/api-reference/v1.6/#podtemplate-v1-core) object should have a field `template` containing a `Pod` specification which does not include the `apiVersion` or `kind` parameters. An example is provided in this repo in `test/fixtures/hello-cloud/template-runner.yml`. 
+
+#### Providing multiple different task-runner configurations
+
+If your application requires task runner templates you can specify which template to use by using the `--template` option. All templates are expected to provide a container called `task-runner`.
+
+#### Specifying environment variables for the container
+
+If you also need to specify environment variables on top of the arguments, you can specify the `--env-vars` flag which accepts a comma separated list of environment variables like so: `--env-vars="ENV=VAL,ENV2=VAL"`
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You currently need to [manually install kubectl version 1.6.0 or higher](https://kubernetes.io/docs/user-guide/prereqs/) as well if you don't already have it.

data/exe/kubernetes-run

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'kubernetes-deploy'
+require 'kubernetes-deploy/runner_task'
+require 'optparse'
+
+template = "task-runner-template"
+entrypoint = nil
+env_vars = []
+
+ARGV.options do |opts|
+  opts.on("--template=TEMPLATE") { |n| template = n }
+  opts.on("--env-vars=ENV_VARS") { |vars| env_vars = n.split(",")}
+  opts.on("--entrypoint=ENTRYPOINT") { |c| entrypoint = [c] }
+  opts.parse!
+end
+
+runner = KubernetesDeploy::RunnerTask.new(
+  namespace: ARGV[0],
+  context: ARGV[1],
+)
+
+ KubernetesDeploy::Runner.with_friendly_errors do
+  runner.run(
+    task_template: template,
+    entrypoint: entrypoint,
+    args: ARGV[2..-1],
+    env_vars: env_vars
+  )
+end

data/lib/kubernetes-deploy.rb

@@ -10,5 +10,12 @@ require 'kubernetes-deploy/runner'
 
 module KubernetesDeploy
   class FatalDeploymentError < StandardError; end
+
+  class NamespaceNotFoundError < FatalDeploymentError
+    def initialize(name, context)
+      super("Namespace `#{name}` not found in context `#{context}`. Aborting the task.")
+    end
+  end
+
   include Logger
 end

data/lib/kubernetes-deploy/kubernetes_resource.rb

@@ -35,6 +35,7 @@ module KubernetesDeploy
       when 'ingress' then Ingress.new(name, namespace, context, file)
       when 'persistentvolumeclaim' then PersistentVolumeClaim.new(name, namespace, context, file)
       when 'service' then Service.new(name, namespace, context, file)
+      when 'podtemplate' then PodTemplate.new(name, namespace, context, file)
       else self.new(name, namespace, context, file).tap { |r| r.type = type }
       end
     end

data/lib/kubernetes-deploy/kubernetes_resource/pod_template.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module KubernetesDeploy
+  class PodTemplate < KubernetesResource
+    def initialize(name, namespace, context, file)
+      @name = name
+      @namespace = namespace
+      @context = context
+      @file = file
+    end
+
+    def sync
+      _, _err, st = run_kubectl("get", type, @name)
+      @status = st.success? ? "Available" : "Unknown"
+      @found = st.success?
+      log_status
+    end
+
+    def deploy_succeeded?
+      exists?
+    end
+
+    def deploy_failed?
+      false
+    end
+
+    def exists?
+      @found
+    end
+  end
+end

data/lib/kubernetes-deploy/restart_task.rb

@@ -14,12 +14,6 @@ module KubernetesDeploy
       end
     end
 
-    class NamespaceNotFoundError < FatalDeploymentError
-      def initialize(name, context)
-        super("Namespace `#{name}` not found in context `#{context}`. Aborting the task.")
-      end
-    end
-
     class RestartError < FatalDeploymentError
       def initialize(deployment_name, response)
         super("Failed to restart #{deployment_name}. " \

data/lib/kubernetes-deploy/runner.rb

@@ -5,7 +5,6 @@ require 'erb'
 require 'yaml'
 require 'shellwords'
 require 'tempfile'
-
 require 'kubernetes-deploy/kubernetes_resource'
 %w(
   cloudsql
@@ -16,6 +15,7 @@ require 'kubernetes-deploy/kubernetes_resource'
   pod
   redis
   service
+  pod_template
   bugsnag
 ).each do |subresource|
   require "kubernetes-deploy/kubernetes_resource/#{subresource}"
@@ -116,6 +116,7 @@ MSG
       if PROTECTED_NAMESPACES.include?(@namespace) && @prune
         raise FatalDeploymentError, "Refusing to deploy to protected namespace '#{@namespace}' with pruning enabled"
       end
+
       deploy_resources(resources, prune: @prune)
 
       return unless wait_for_completion?

data/lib/kubernetes-deploy/runner_task.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+require 'tempfile'
+
+require 'kubernetes-deploy/kubeclient_builder'
+require 'kubernetes-deploy/ui_helpers'
+require 'kubernetes-deploy/kubectl'
+
+module KubernetesDeploy
+  class RunnerTask
+    include KubeclientBuilder
+    include Kubectl
+    include UIHelpers
+
+    class FatalTaskRunError < FatalDeploymentError; end
+    class TaskTemplateMissingError < FatalDeploymentError
+      def initialize(task_template, namespace, context)
+        super("Pod template `#{task_template}` cannot be found in namespace: `#{namespace}`, context: `#{context}`")
+      end
+    end
+
+    def initialize(namespace:, context:, logger: KubernetesDeploy.logger)
+      @logger = logger
+      @namespace = namespace
+      @kubeclient = build_v1_kubeclient(context)
+      @context = context
+    end
+
+    def run(task_template:, entrypoint:, args:, env_vars: [])
+      phase_heading("Validating configuration")
+      validate_configuration(task_template, args)
+
+      phase_heading("Fetching task template")
+      raw_template = get_template(task_template)
+
+      phase_heading("Constructing final pod specification")
+      rendered_template = build_pod_template(raw_template, entrypoint, args, env_vars)
+
+      validate_pod_spec(rendered_template)
+
+      phase_heading("Creating pod")
+      KubernetesDeploy.logger.info("Starting task runner pod: '#{rendered_template.metadata.name}'")
+      @kubeclient.create_pod(rendered_template)
+    end
+
+    private
+
+    def validate_configuration(task_template, args)
+      errors = []
+
+      if task_template.blank?
+        errors << "Task template name can't be nil"
+      end
+
+      if @namespace.blank?
+        errors << "Namespace can't be empty"
+      end
+
+      if args.blank?
+        errors << "Args can't be nil"
+      end
+
+      begin
+        @kubeclient.get_namespace(@namespace)
+      rescue KubeException => e
+        errors << if e.error_code == 404
+          "Namespace was not found"
+        else
+          "Could not connect to kubernetes cluster"
+        end
+      end
+
+      raise FatalTaskRunError, "Configuration invalid: #{errors.join(', ')}" unless errors.empty?
+    end
+
+    def get_template(template_name)
+      KubernetesDeploy.logger.info(
+        "Fetching task runner pod template: '#{template_name}' in namespace: '#{@namespace}'"
+      )
+
+      pod_template = @kubeclient.get_pod_template(template_name, @namespace)
+
+      pod_template.template
+    rescue KubeException => error
+      if error.error_code == 404
+        raise TaskTemplateMissingError.new(template_name, @namespace, @context)
+      else
+        raise
+      end
+    end
+
+    def build_pod_template(base_template, entrypoint, args, env_vars)
+      KubernetesDeploy.logger.info("Rendering template for task runner pod")
+
+      rendered_template = base_template.dup
+      rendered_template.kind = 'Pod'
+      rendered_template.apiVersion = 'v1'
+
+      container = rendered_template.spec.containers.find { |cont| cont.name == 'task-runner' }
+
+      raise FatalTaskRunError, "Pod spec does not contain a template container called 'task-runner'" if container.nil?
+
+      container.command = entrypoint
+      container.args = args
+      container.env ||= []
+
+      env_args = env_vars.map do |key, value|
+        key, value = env.split('=', 2)
+        { name: key, value: value }
+      end
+
+      container.env = container.env.map(&:to_h) + env_args
+
+      unique_name = rendered_template.metadata.name + "-" + SecureRandom.hex(8)
+
+      KubernetesDeploy.logger.warn("Name is too long, using '#{unique_name[0..62]}'") if unique_name.length > 63
+      rendered_template.metadata.name = unique_name[0..62]
+      rendered_template.metadata.namespace = @namespace
+
+      rendered_template
+    end
+
+    def validate_pod_spec(pod)
+      f = Tempfile.new(pod.metadata.name)
+      f.write recursive_to_h(pod).to_json
+      f.close
+
+      _out, err, status = Kubectl.run_kubectl(
+        "apply", "--dry-run", "-f", f.path,
+        namespace: @namespace,
+        context: @context
+      )
+
+      unless status.success?
+        raise FatalTaskRunError, "Invalid pod spec: #{err}"
+      end
+    end
+
+    def recursive_to_h(struct)
+      if struct.is_a?(Array)
+        return struct.map { |v| v.is_a?(OpenStruct) || v.is_a?(Array) || v.is_a?(Hash) ? recursive_to_h(v) : v }
+      end
+
+      hash = {}
+
+      struct.each_pair do |k, v|
+        recursive_val = v.is_a?(OpenStruct) || v.is_a?(Array) || v.is_a?(Hash)
+        hash[k] = recursive_val ? recursive_to_h(v) : v
+      end
+      hash
+    end
+  end
+end

data/lib/kubernetes-deploy/version.rb

@@ -1,3 +1,3 @@
 module KubernetesDeploy
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kir Shatrov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,6 +102,7 @@ email:
 executables:
 - kubernetes-deploy
 - kubernetes-restart
+- kubernetes-run
 extensions: []
 extra_rdoc_files: []
 files:
@@ -115,6 +116,7 @@ files:
 - bin/setup
 - exe/kubernetes-deploy
 - exe/kubernetes-restart
+- exe/kubernetes-run
 - kubernetes-deploy.gemspec
 - lib/kubernetes-deploy.rb
 - lib/kubernetes-deploy/kubeclient_builder.rb
@@ -127,12 +129,14 @@ files:
 - lib/kubernetes-deploy/kubernetes_resource/ingress.rb
 - lib/kubernetes-deploy/kubernetes_resource/persistent_volume_claim.rb
 - lib/kubernetes-deploy/kubernetes_resource/pod.rb
+- lib/kubernetes-deploy/kubernetes_resource/pod_template.rb
 - lib/kubernetes-deploy/kubernetes_resource/redis.rb
 - lib/kubernetes-deploy/kubernetes_resource/service.rb
 - lib/kubernetes-deploy/logger.rb
 - lib/kubernetes-deploy/resource_watcher.rb
 - lib/kubernetes-deploy/restart_task.rb
 - lib/kubernetes-deploy/runner.rb
+- lib/kubernetes-deploy/runner_task.rb
 - lib/kubernetes-deploy/ui_helpers.rb
 - lib/kubernetes-deploy/version.rb
 homepage: https://github.com/Shopify/kubernetes-deploy
@@ -155,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Kubernetes deploy scripts