resque-kubernetes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a5d6e3560f6a7393489b6fe7509e0777e2d60b6
+  data.tar.gz: bf7ea17b439598dc9ac2946138178dc61eaedf42
+SHA512:
+  metadata.gz: 0066365884c83d8479316ddbb340e50222496a6eabf7fc75822ad0d9088c92375bd285c5049fb9566d7c6524575ee0786637eb12f53c46de5fdb2262283279ee
+  data.tar.gz: c339b564294da1834720fe92a916f82c2b05b110c6c32e30882c3eb65883499862215116aa259fe7b84b27d057d578041daf115627be9f377c5edbd3621b439e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+resque-kubernetes

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-kubernetes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Keylime Toolbox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# Resque::Kubernetes
+
+Run Resque Jobs as Kubernetes Jobs!
+
+Kubernetes has a concept of "Job" which is a pod that runs a container until
+the container finishes and then it terminates the pod (as opposed to trying to
+restart the container).
+
+This gem takes advantage of that feature by starting up a Kubernetes Job when 
+a Resque Job is enqueued. It then allows the Resque Worker to be modified to 
+terminate when there are no more jobs in the queue.
+
+Why would you do this?
+
+We have unpredictable, resource-intensive jobs. Rather than dedicating large 
+nodes in our cluster to run the resque workers, where the resources would be 
+idle when there are no jobs to run, we can use auto-scaling to add nodes when
+Kubernetes Job gets created and shut them down when those jobs are complete. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-kubernetes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-kubernetes
+
+## Usage
+
+For any Resque job that you want to run in a Kubernetes job, you'll need to
+modify the job class with two things:
+
+- extend the class with `Resque::Kubernetes::Job`
+- and add a method `job_manifest` that returns the Kubernetes manifest for the job
+
+```ruby
+class ResourceIntensiveJob
+  extend Resque::Kubernetes::Job
+  
+  def perform
+    # ... your existing code
+  end
+  
+  def job_manifest
+    <<-EOD
+metadata:
+  name: worker-job
+spec:
+  template:
+    metadata:
+      name: worker-job
+    spec:
+      containers:
+      - name: worker
+        image: us.gcr.io/project-id/some-resque-worker
+        env:
+        - name: QUEUE
+          value: high-memory
+    EOD
+  end
+end
+```
+
+Make sure that the container image above, which is used to run the resque 
+worker, is built to include the `resque-kubernetes` gem as well. The gem will 
+add `TERM_ON_EMPTY` to the environment variables. This tells the worker that 
+whenever the queue is empty it should terminate the worker. Kubernetes will 
+then terminate the Job when the container is done running and will release the 
+resources.
+
+## Configuration
+
+You can modify the configuration of the gem by creating an initializer in
+your project:
+
+```ruby
+# config/initializers/resque-kubernetes.rb
+
+Resque::Kubernetes.configuration do |config|
+
+ config.environments << "staging"
+ config.max_workers = 10
+
+end
+```
+
+### `environments`
+
+By default `Resque::Kubernetes` will only manage Kubernetes Jobs in
+`:production`. If you want to add other environments you can update this list
+(`config.environments << "staging"`) or replace it (`config.environments =
+["production", "development"]`).
+
+Note that this only works under Rails, when `Rails.env` is set.
+
+### `max_workers`
+
+`Resque::Kubernetes` will spin up a Kuberentes Job each time you enqueue a 
+Resque Job. This allows for parallel processing of jobs using the resources
+available to your cluster. By default this is limited to 10 workers, so an not
+to have run-away cloud resource usage.
+
+You can set this higher if you need massive scaling and your structure supports
+it.
+
+If you don't want more than one job running at a time then set this to 1.
+
+## To Do
+
+- We probably need better namespace support, particularly for reaping 
+  finished jobs and pods.
+- Support for other authentication and server URL options for `kubeclient`.
+  See [the many examples](https://github.com/abonas/kubeclient#usage) in their
+  README.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `version.rb`, and then 
+run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to 
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/keylime-toolbox/resque-kubernetes.
+
+
+## License
+
+The gem is available as open source under the terms of the 
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resque/kubernetes"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/resque/kubernetes.rb

@@ -0,0 +1,18 @@
+require "resque/kubernetes/job"
+require "resque/kubernetes/version"
+require "resque/kubernetes/worker"
+require "resque/kubernetes/configurable"
+
+module Resque
+  module Kubernetes
+    extend Configurable
+
+    # By default only manage kubernetes jobs in :production
+    define_setting :environments, [:production]
+
+    # Limit the number of workers that should be spun up, default 10
+    define_setting :max_workers, 10
+  end
+end
+
+Resque::Worker.include Resque::Kubernetes::Worker

data/lib/resque/kubernetes/configurable.rb

@@ -0,0 +1,32 @@
+module Resque
+  module Kubernetes
+    module Configurable
+
+      def configuration
+        yield self
+      end
+
+      def define_setting(name, default = nil)
+        class_variable_set("@@#{name}", default)
+
+        define_class_method "#{name}=" do |value|
+          class_variable_set("@@#{name}", value)
+        end
+
+        define_class_method name do
+         class_variable_get("@@#{name}")
+        end
+      end
+
+      private
+
+      def define_class_method(name, &block)
+        (class << self; self; end).instance_eval do
+          define_method(name, &block)
+        end
+      end
+
+
+     end
+  end
+end

data/lib/resque/kubernetes/job.rb

@@ -0,0 +1,140 @@
+require "securerandom"
+require "kubeclient"
+
+module Resque
+  module Kubernetes
+    module Job
+
+      def before_enqueue_kubernetes_job(*_)
+        if defined? Rails
+          return unless Resque::Kubernetes.environments.include?(Rails.env)
+        end
+
+        reap_finished_jobs
+        reap_finished_pods
+        apply_kubernetes_job
+      end
+
+      private
+
+      def jobs_client
+        return @jobs_client if @jobs_client
+        @jobs_client = client("/apis/batch")
+      end
+
+      def pods_client
+        return @pods_client if @pods_client
+        @pods_client = client("")
+      end
+
+      def client(scope)
+        kubeconfig = File.join(ENV["HOME"], ".kube", "config")
+
+        if File.exist?("/var/run/secrets/kubernetes.io/serviceaccount/token")
+          # When running in k8s cluster, use the service account secret token
+          auth_options = {bearer_token_file: "/var/run/secrets/kubernetes.io/serviceaccount/token"}
+          @jobs_client = Kubeclient::Client.new("https://localhost:8443/apis/batch" , "v1", auth_options: auth_options)
+        elsif File.exist?(kubeconfig)
+          # When running in development, use the config file for `kubectl`
+          kubeconfig = File.join(ENV["HOME"], ".kube", "config")
+          config = Kubeclient::Config.read(kubeconfig)
+          Kubeclient::Client.new(
+              config.context.api_endpoint + scope,
+              config.context.api_version,
+              {
+                  ssl_options: config.context.ssl_options,
+                  auth_options: {use_default_gcp: true}
+              }
+          )
+        end
+      end
+
+      def reap_finished_jobs
+        resque_jobs = jobs_client.get_jobs(label_selector: "resque-kubernetes=job")
+        finished = resque_jobs.select { |job| job.spec.completions == job.status.succeeded }
+
+        finished.each do |job|
+          jobs_client.delete_job(job.metadata.name, job.metadata.namespace)
+        end
+      end
+
+      def reap_finished_pods
+        resque_jobs = pods_client.get_pods(label_selector: "resque-kubernetes=pod")
+        finished = resque_jobs.select { |pod| pod.status.phase == "Succeeded" }
+
+        finished.each do |pod|
+          pods_client.delete_pod(pod.metadata.name, pod.metadata.namespace)
+        end
+      end
+
+      def apply_kubernetes_job
+        manifest = job_manifest.dup
+        ensure_namespace(manifest)
+
+        # Do not start job if we have reached our maximum count
+        return if jobs_maxed?(manifest["metadata"]["name"], manifest["metadata"]["namespace"])
+
+        add_labels(manifest)
+        ensure_term_on_empty(manifest)
+        ensure_reset_policy(manifest)
+        update_job_name(manifest)
+
+        job = Kubeclient::Resource.new(manifest)
+        jobs_client.create_job(job)
+      end
+
+      def jobs_maxed?(name, namespace)
+        resque_jobs = jobs_client.get_jobs(label_selector: "resque-kubernetes=job,resque-kubernetes-group=#{name}", namespace: namespace)
+        running = resque_jobs.select { |job| job.spec.completions != job.status.succeeded }
+        running.size == Resque::Kubernetes.max_workers
+      end
+
+      def add_labels(manifest)
+        manifest["metadata"] ||= {}
+        manifest["metadata"]["labels"] ||= {}
+        manifest["metadata"]["labels"]["resque-kubernetes"] = "job"
+        manifest["metadata"]["labels"]["resque-kubernetes-group"] = manifest["metadata"]["name"]
+        manifest["spec"]["template"]["metadata"] ||= {}
+        manifest["spec"]["template"]["metadata"]["labels"] ||= {}
+        manifest["spec"]["template"]["metadata"]["labels"]["resque-kubernetes"] = "pod"
+      end
+
+      def ensure_term_on_empty(manifest)
+        manifest["spec"]["template"]["spec"] ||= {}
+        manifest["spec"]["template"]["spec"]["containers"] ||= []
+        manifest["spec"]["template"]["spec"]["containers"].each do |container|
+          container["env"] ||= []
+          term_on_empty = container["env"].find { |env| env["name"] == "TERM_ON_EMPTY" }
+          unless term_on_empty
+            term_on_empty = {"name" => "TERM_ON_EMPTY"}
+            container["env"] << term_on_empty
+          end
+          term_on_empty["value"] = "1"
+        end
+      end
+
+      def ensure_reset_policy(manifest)
+        manifest["spec"]["template"]["spec"]["restartPolicy"] ||= "OnFailure"
+      end
+
+
+      def ensure_namespace(manifest)
+        manifest["metadata"]["namespace"] ||= "default"
+      end
+
+      def update_job_name(manifest)
+        manifest["metadata"]["name"] += "-#{dns_safe_random}"
+      end
+
+      # Returns an n-length string of characters [a-z0-9]
+      def dns_safe_random(n = 5)
+        s = [SecureRandom.random_bytes(n)].pack("m*")
+        s.delete!("=\n")
+        s.tr!("+/_-", "0")
+        s.tr!("A-Z", "a-z")
+        s[0...n]
+      end
+
+    end
+  end
+end

data/lib/resque/kubernetes/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module Kubernetes
+    VERSION = "0.1.0"
+  end
+end

data/lib/resque/kubernetes/worker.rb

@@ -0,0 +1,41 @@
+require "resque"
+
+module Resque
+  module Kubernetes
+    module Worker
+      def self.included(base)
+        base.class_eval do
+          prepend InstanceMethods
+        end
+      end
+
+      attr_accessor :term_on_empty
+
+      module InstanceMethods
+        def prepare
+          self.term_on_empty = ENV["TERM_ON_EMPTY"] if ENV["TERM_ON_EMPTY"]
+          super
+        end
+
+        def shutdown?
+          if term_on_empty
+            if queues_empty?
+              log_with_severity :info, "shutdown: queues are empty"
+              shutdown
+            end
+          end
+
+          super
+        end
+      end
+
+
+      private
+
+      def queues_empty?
+        queues.all? { |queue| Resque.size(queue) == 0 }
+      end
+
+    end
+  end
+end

data/resque-kubernetes.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/kubernetes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-kubernetes"
+  spec.version       = Resque::Kubernetes::VERSION
+  spec.authors       = ["Jeremy Wadsack"]
+  spec.email         = ["jeremy.wadsack@gmail.com"]
+
+  spec.summary       = %q{Run Resque Jobs as Kubernetes Jobs}
+  spec.description   = %q{Launches a Kubernetes Job when a Resque Job is enqueued, then terminates the worker when there are no more jobs in the queue.}
+  spec.homepage      = "https://github.com/keylimetoolbox/resque-kubernetes"
+  spec.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "resque", "~> 1.26"
+  spec.add_dependency "kubeclient", "~> 2.2"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: resque-kubernetes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Wadsack
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: kubeclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Launches a Kubernetes Job when a Resque Job is enqueued, then terminates
+  the worker when there are no more jobs in the queue.
+email:
+- jeremy.wadsack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resque/kubernetes.rb
+- lib/resque/kubernetes/configurable.rb
+- lib/resque/kubernetes/job.rb
+- lib/resque/kubernetes/version.rb
+- lib/resque/kubernetes/worker.rb
+- resque-kubernetes.gemspec
+homepage: https://github.com/keylimetoolbox/resque-kubernetes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Run Resque Jobs as Kubernetes Jobs
+test_files: []