active_job_kubernetes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20cb5ea1a776e1bdc7a93510580960fafea94e8dbb8fa739c849b27b772491cb
+  data.tar.gz: 392ea4a6686dce2dc6811e4bf42a0216d1273daad44ed33cd164b1c2fb63f102
+SHA512:
+  metadata.gz: 8c546c75198de4773100c310bf24dfebc7f9904813380545de75b02a0b64fdd0d95b19c33e3251f5bcbc3de201bba677c5005f61bfebdbb1a8d28288d06de123
+  data.tar.gz: 601c2c186a5316b08207f01edfe4f55716678790d9c779e278fd27078a04e759465368b94029f1fdb144f1097065f235ec415a272f63a075faa89f8fd97c7055

data/.gitignore

@@ -0,0 +1,161 @@
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+- Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Omja Das
+
+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,86 @@
+# active-job-kubernetes
+
+Rails Active Job adapter to run background jobs using
+[Kubernetes Jobs](https://kubernetes.io/docs/concepts/workloads/controllers/job/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_job_kubernetes'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install active-job-kubernetes
+```
+
+## Usage
+
+```ruby
+class HelloWorldJob < ApplicationJob
+  self.queue_adapter = :kubernetes
+
+  def perform
+    puts 'Hello, world'
+  end
+
+  def manifest
+    YAML.safe_load(
+      <<~MANIFEST
+        apiVersion: batch/v1
+        kind: Job
+        metadata:
+          generatedName: hello-world
+        spec:
+          template:
+            metadata:
+              name: hello-world
+            spec:
+              restartPolicy: Never
+              containers:
+                - name: worker
+                  image: example:latest
+                  command: ["rake"]
+                  args: ["active_job_kubernetes:run_job"]
+      MANIFEST
+    )
+  end
+
+  def kubeclient(scope)
+    endpoint = '' # cluster endpoint
+
+    Kubeclient::Client.new(endpoint + scope, 'v1')
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/omjadas/active-job-kubernetes>.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/active_job_kubernetes.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/active_job_kubernetes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_job_kubernetes'
+  spec.version       = ActiveJobKubernetes::VERSION
+  spec.authors       = ['omjadas']
+  spec.email         = ['omja.das@gmail.com']
+
+  spec.summary       = 'Active Job Adapter for Kubernetes'
+  spec.description   = 'Run Rails Active Jobs as Kubernetes Jobs'
+  spec.homepage      = 'https://github.com/omjadas/active-job-kubernetes'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/omjadas/active-job-kubernetes'
+  spec.metadata['changelog_uri'] = 'https://github.com/omjadas/active-job-kubernetes/blob/main/CHANGELOG.md'
+
+  # 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']
+
+  spec.add_dependency 'kubeclient', '~> 4.0'
+  spec.add_dependency 'rails', '>= 5.0', '<7'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'active_job_kubernetes'
+
+# 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/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/active_job/queue_adapters/kubernetes_adapter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'kubeclient'
+
+module ActiveJob
+  module QueueAdapters
+    class KubernetesAdapter
+      def enqueue(job)
+        serialized_job = JSON.dump(job.serialize)
+        kube_job = Kubeclient::Resource.new(job.manifest)
+
+        kube_job.spec.template.spec.containers.map do |container|
+          container.env ||= []
+          container.env.push({
+            'name' => 'SERIALIZED_JOB',
+            'value' => serialized_job
+          })
+        end
+
+        job.kubeclient('/apis/batch').create_job(kube_job)
+      end
+
+      def enqueue_at(_job, _timestamp)
+        raise NotImplementedError, 'Enqueueing jobs in the future is not supported.'
+      end
+    end
+  end
+end

data/lib/active_job_kubernetes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'active_job/queue_adapters/kubernetes_adapter'
+require 'active_job_kubernetes/version'
+require 'active_job_kubernetes/railtie' if defined?(Rails::Railtie)

data/lib/active_job_kubernetes/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveJobKubernetes
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'active_job_kubernetes/tasks'
+    end
+  end
+end

data/lib/active_job_kubernetes/tasks.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+namespace :active_job_kubernetes do
+  task run_job: :environment do
+    ActiveJob::Base.execute(JSON.parse(ENV['SERIALIZED_JOB']))
+  end
+end

data/lib/active_job_kubernetes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveJobKubernetes
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: active_job_kubernetes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- omjadas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kubeclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: Run Rails Active Jobs as Kubernetes Jobs
+email:
+- omja.das@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_job_kubernetes.gemspec
+- bin/console
+- bin/setup
+- lib/active_job/queue_adapters/kubernetes_adapter.rb
+- lib/active_job_kubernetes.rb
+- lib/active_job_kubernetes/railtie.rb
+- lib/active_job_kubernetes/tasks.rb
+- lib/active_job_kubernetes/version.rb
+homepage: https://github.com/omjadas/active-job-kubernetes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/omjadas/active-job-kubernetes
+  source_code_uri: https://github.com/omjadas/active-job-kubernetes
+  changelog_uri: https://github.com/omjadas/active-job-kubernetes/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Active Job Adapter for Kubernetes
+test_files: []