active_job_kubernetes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20cb5ea1a776e1bdc7a93510580960fafea94e8dbb8fa739c849b27b772491cb
-  data.tar.gz: 392ea4a6686dce2dc6811e4bf42a0216d1273daad44ed33cd164b1c2fb63f102
+  metadata.gz: bc3a0f0c67119085c1ef9ccbadc5e0638a1383639ae5023f653da136d6b7bdc9
+  data.tar.gz: 7207e005df5da81be6dae280f14ad1f9fb97a34294706ee5f5f2bb580e745f4f
 SHA512:
-  metadata.gz: 8c546c75198de4773100c310bf24dfebc7f9904813380545de75b02a0b64fdd0d95b19c33e3251f5bcbc3de201bba677c5005f61bfebdbb1a8d28288d06de123
-  data.tar.gz: 601c2c186a5316b08207f01edfe4f55716678790d9c779e278fd27078a04e759465368b94029f1fdb144f1097065f235ec415a272f63a075faa89f8fd97c7055
+  metadata.gz: 5fe318433e2ca0c3e41370d37777ae482a3420c3da7b50cc7641cb5b20c077c0cd6452d5f5f08d69d1d784cd672fc9ceb461b2b9d857e683ecbde256a0ea62e2
+  data.tar.gz: '097844e57fa772ecaf01e2303d3b393e233099604e9c405e3b3dc196ce1ac797a1ff99ba6a74d971d91c375184c298fda91c233d3b10eb375180aed78afdecaa'

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.2.0
+
+- Support Rails 7 and 8
+- Require Ruby 2.7+
+- Inherit from `ActiveJob::QueueAdapters::AbstractAdapter` where available
+- Set `provider_job_id` for enqueued jobs
+- Support delayed jobs by creating a suspended Kubernetes Job labelled
+  `active-job-kubernetes/suspend` and annotated with
+  `active-job-kubernetes/suspend-until`. `ActiveJobKubernetes.unsuspend_jobs`
+  must be called periodically to unsuspend jobs that are ready to run
+
 ## 0.1.0
 
 - Initial release

data/README.md

@@ -20,7 +20,7 @@ bundle install
 Or install it yourself as:
 
 ```bash
-gem install active-job-kubernetes
+gem install active_job_kubernetes
 ```
 
 ## Usage
@@ -39,7 +39,7 @@ class HelloWorldJob < ApplicationJob
         apiVersion: batch/v1
         kind: Job
         metadata:
-          generatedName: hello-world
+          generateName: hello-world
         spec:
           template:
             metadata:

data/active_job_kubernetes.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/omjadas/active-job-kubernetes'
@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activejob', '>= 7.0'
   spec.add_dependency 'kubeclient', '~> 4.0'
-  spec.add_dependency 'rails', '>= 5.0', '<7'
+  spec.add_dependency 'railties', '>= 7.0'
 end

data/lib/active_job/queue_adapters/kubernetes_adapter.rb

@@ -1,27 +1,17 @@
 # frozen_string_literal: true
 
-require 'kubeclient'
+require 'active_job'
+require 'active_job_kubernetes'
 
 module ActiveJob
   module QueueAdapters
-    class KubernetesAdapter
+    class KubernetesAdapter < (const_defined?(:AbstractAdapter) ? AbstractAdapter : Object)
       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)
+        ActiveJobKubernetes.create_job(job)
       end
 
-      def enqueue_at(_job, _timestamp)
-        raise NotImplementedError, 'Enqueueing jobs in the future is not supported.'
+      def enqueue_at(job, timestamp)
+        ActiveJobKubernetes.create_job(job, timestamp)
       end
     end
   end

data/lib/active_job_kubernetes/tasks.rb

@@ -2,6 +2,6 @@
 
 namespace :active_job_kubernetes do
   task run_job: :environment do
-    ActiveJob::Base.execute(JSON.parse(ENV['SERIALIZED_JOB']))
+    ActiveJob::Base.execute(JSON.parse(ENV.fetch(ActiveJobKubernetes::SERIALIZED_JOB)))
   end
 end

data/lib/active_job_kubernetes/version.rb

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

data/lib/active_job_kubernetes.rb

@@ -1,5 +1,101 @@
 # 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)
+require 'active_job_kubernetes/version'
+require 'json'
+require 'kubeclient'
+require 'time'
+
+module ActiveJobKubernetes
+  BATCH_API = '/apis/batch'
+  CHUNK_SIZE = 100
+  SERIALIZED_JOB = 'SERIALIZED_JOB'
+  SERVICE_ACCOUNT = '/var/run/secrets/kubernetes.io/serviceaccount'
+  SUSPEND = 'active-job-kubernetes/suspend'
+  SUSPEND_UNTIL = 'active-job-kubernetes/suspend-until'
+
+  private_constant :BATCH_API, :CHUNK_SIZE, :SERVICE_ACCOUNT
+
+  class << self
+    attr_writer :kubeclient, :namespace
+
+    def kubeclient
+      @kubeclient ||= lambda do |scope|
+        Kubeclient::Client.new(
+          "https://kubernetes.default.svc#{scope}",
+          'v1',
+          auth_options: { bearer_token_file: "#{SERVICE_ACCOUNT}/token" },
+          ssl_options: { ca_file: "#{SERVICE_ACCOUNT}/ca.crt" }
+        )
+      end
+    end
+
+    def namespace
+      @namespace ||= File.read("#{SERVICE_ACCOUNT}/namespace")
+    end
+
+    def create_job(job, timestamp = nil)
+      serialized_job = JSON.dump(job.serialize)
+      kube_job = Kubeclient::Resource.new(job.manifest)
+      kube_job.metadata.namespace ||= namespace
+
+      kube_job.spec.template.spec.containers.each do |container|
+        container.env ||= []
+        container.env.push({
+          'name' => SERIALIZED_JOB,
+          'value' => serialized_job
+        })
+      end
+
+      if timestamp
+        kube_job.spec.suspend = true
+
+        kube_job.metadata.labels ||= {}
+        kube_job.metadata.labels[SUSPEND] = 'true'
+
+        kube_job.metadata.annotations ||= {}
+        kube_job.metadata.annotations[SUSPEND_UNTIL] = Time.at(timestamp).utc.iso8601
+      end
+
+      job.provider_job_id = kubeclient_for(job).create_job(kube_job).metadata.name
+    end
+
+    def unsuspend_jobs
+      now = Time.now
+      client = kubeclient.call(BATCH_API)
+      continue = nil
+
+      loop do
+        kube_jobs = client.get_jobs(
+          namespace: namespace,
+          label_selector: "#{SUSPEND}=true",
+          limit: CHUNK_SIZE,
+          continue: continue
+        )
+
+        kube_jobs.each do |kube_job|
+          suspend_until = kube_job.metadata.annotations&.[](SUSPEND_UNTIL)
+          next unless suspend_until && Time.iso8601(suspend_until) <= now
+
+          client.patch_job(
+            kube_job.metadata.name,
+            { metadata: { labels: { SUSPEND => 'false' } }, spec: { suspend: false } },
+            namespace
+          )
+        end
+
+        continue = kube_jobs.continue
+        break if kube_jobs.last?
+      end
+    end
+
+    private
+
+    def kubeclient_for(job)
+      return job.kubeclient(BATCH_API) if job.respond_to?(:kubeclient)
+
+      kubeclient.call(BATCH_API)
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: active_job_kubernetes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - omjadas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2026-08-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: kubeclient
   requirement: !ruby/object:Gem::Requirement
@@ -25,25 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.0'
 description: Run Rails Active Jobs as Kubernetes Jobs
 email:
 - omja.das@gmail.com
@@ -80,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="