resque-kubernetes-probes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f3d4cee1fc200619809dabb192e0d413029e16032f779f2fe98af3df136f64c
+  data.tar.gz: 4e28446cba8d457ac3b13b9b5fe5d2ecca8abc470f0a169545a097e01094e11e
+SHA512:
+  metadata.gz: 360111824372d9c5881ef82c0f3d3af1708d086fe3030aa09809683939f886238b66a00125394604d7d8771c4490a0cbf1e35d5ab6b2f33ac505d0d07ca5d472
+  data.tar.gz: 7ac6683d5a63d5ef9fd7a3cf0bb4fb5c5b1aba73cc61135ddf31adc47aeda5462ec94c94c059498405e20873dfeefbd355b698adfe464906d0d9f7c1c6b4837c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in resque-kubernetes-probes.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    resque-kubernetes-probes (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  resque-kubernetes-probes!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Micke Lisinge
+
+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,89 @@
+# Resque::Kubernetes::Probes
+
+This gem injects code into Resque and Resque::Scheduler that touches a file in
+the `tmp` directory `resque_health` for Resque and `resque_scheduler_health` for
+Resque::Scheduler. These files can then be used by the Kubernetes liveness
+probes to check that the worker and scheduler is running properly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-kubernetes-probes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install resque-kubernetes-probes
+
+## Usage
+
+### Download the script in your Dockerfile
+
+The script is simple and checks that the heartbeat file has been updated in the
+last `interval` seconds.
+
+```dockerfile
+RUN curl -f -o /usr/local/bin/resque_health_check -L "https://raw.githubusercontent.com/apoex/resque-kubernetes-probes/master/bin/resque_health_check" && \
+      chmod +x /usr/local/bin/resque_health_check
+```
+
+### Resque
+
+The gem hooks into resque's heartbeat logic and by default the heartbeat
+interval is quite high (60 seconds). We recommend lowering the default value and
+making it configurable through environment variables.
+
+```ruby
+Resque.heartbeat_interval = ENV.fetch("RESQUE_HEARTBEAT_INTERVAL", 10).to_i
+Resque.prune_interval = Resque.heartbeat_interval * 5
+```
+
+```yaml
+livenessProbe:
+  timeoutSeconds: 1
+  periodSeconds: 5
+  exec:
+    command:
+      - resque_health_check
+      - tmp/resque_health
+```
+
+### Resque Scheduler
+
+The gem does not inject itself into resque-scheduler by default, to do that you
+need to add the probe to the list of required files.
+
+```ruby
+gem "resque-kubernetes-probes", require: ["resque/kubernetes/probes/resque", "resque/kubernetes/probes/resque-scheduler"]
+```
+
+```yaml
+livenessProbe:
+  timeoutSeconds: 1
+  periodSeconds: 5
+  exec:
+    command:
+      - resque_health_check
+      - tmp/resque_scheduler_health
+```
+
+## 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/micke/resque-kubernetes-probes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resque/kubernetes/probes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/resque_health_check

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -e
+
+FILE="${1:-tmp/resque_health}"
+
+if [[ $FILE =~ "scheduler" ]]; then
+  INTERVAL=${RESQUE_SCHEDULER_INTERVAL:-5}
+else
+  INTERVAL=${RESQUE_HEARTBEAT_INTERVAL:-60}
+fi
+
+if test -f "$FILE"; then
+  if [ "$(( $(date +"%s") - $(date -r $FILE +%s) ))" -gt "$INTERVAL" ]; then
+    echo "UNHEALTHY. $FILE is older than $INTERVAL seconds."
+    exit 2
+  else
+    echo "HEALTHY"
+    exit 0
+  fi
+else
+  echo "$FILE does not exist"
+  exit 1
+fi

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/probes.rb

@@ -0,0 +1,2 @@
+require "resque/kubernetes/probes/version"
+require "resque/kubernetes/probes/resque"

data/lib/resque/kubernetes/probes/resque-scheduler.rb

@@ -0,0 +1,18 @@
+unless defined?(Resque::Scheduler)
+  raise ResqueNotLoadedError, "[resque-kubernetes-probes] resque-scheduler is not loaded. " \
+    "Make sure the resque-scheduler gem is loaded before `resque-kubernetes-probes` in your Gemfile"
+end
+
+module Resque
+  module Scheduler
+    class << self
+      alias original_poll_sleep poll_sleep
+
+      def poll_sleep
+        FileUtils.touch(File.join(Rails.root, "tmp", "resque_scheduler_health"))
+
+        original_poll_sleep
+      end
+    end
+  end
+end

data/lib/resque/kubernetes/probes/resque.rb

@@ -0,0 +1,18 @@
+class ResqueNotLoadedError < StandardError; end
+
+unless defined?(Resque)
+  raise ResqueNotLoadedError, "[resque-kubernetes-probes] resque is not loaded. " \
+    "Make sure the resque gem is loaded before `resque-kubernetes-probes` in your Gemfile"
+end
+
+module Resque
+  class Worker
+    alias original_heartbeat! heartbeat!
+
+    def heartbeat!
+      FileUtils.touch(File.join(Rails.root, "tmp", "resque_health"))
+
+      original_heartbeat!
+    end
+  end
+end

data/lib/resque/kubernetes/probes/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Kubernetes
+    module Probes
+      VERSION = "1.0.0"
+    end
+  end
+end

data/resque-kubernetes-probes.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/resque/kubernetes/probes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-kubernetes-probes"
+  spec.version       = Resque::Kubernetes::Probes::VERSION
+  spec.authors       = ["Micke Lisinge"]
+  spec.email         = ["hi@micke.me"]
+
+  spec.summary       = %q{Kubernetes probes for resque}
+  spec.description   = %q{Kubernetes probes for resque}
+  spec.homepage      = "https://github.com/apoex/resque-kubernetes-probes"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/apoex/resque-kubernetes-probes"
+  spec.metadata["changelog_uri"] = "https://github.com/apoex/resque-kubernetes-probes"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: resque-kubernetes-probes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Micke Lisinge
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-07 00:00:00.000000000 Z
+dependencies: []
+description: Kubernetes probes for resque
+email:
+- hi@micke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/resque_health_check
+- bin/setup
+- lib/resque/kubernetes/probes.rb
+- lib/resque/kubernetes/probes/resque-scheduler.rb
+- lib/resque/kubernetes/probes/resque.rb
+- lib/resque/kubernetes/probes/version.rb
+- resque-kubernetes-probes.gemspec
+homepage: https://github.com/apoex/resque-kubernetes-probes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/apoex/resque-kubernetes-probes
+  source_code_uri: https://github.com/apoex/resque-kubernetes-probes
+  changelog_uri: https://github.com/apoex/resque-kubernetes-probes
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Kubernetes probes for resque
+test_files: []