kuby-sidekiq 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16ba8d64983f10c83431ce728402e36c40664b0ba89ff55f5c3677fc2291bcfe
-  data.tar.gz: 158df48cc2d19408fe295fb745f561a8a93858cfec765fac3fdb6a06fe2cee8e
+  metadata.gz: a3d59d851bea4b84f5e198288cb2392b374a1a5bbd750cc669e771598bd0c828
+  data.tar.gz: 8360b03ccdb9e024cb92c3b2511d08349e4ffedabd4ef128cbfb947e61b091a4
 SHA512:
-  metadata.gz: 26e27f3fc64531c064e70596d384e2d6279c63141ea0f7f1c481dbccbd144a8749927878bd1b11e64a19644e2144d02c974e2fd133981ac282b2a5bc9672f7ac
-  data.tar.gz: 6b9f8ab50e6d994d7bbd2d8874ce1c84e7d21d41491e98017eac61d6f38b40cfef34331423b62b7bcc9027da82318aa09255c847c9cbcb286276ac64a463bfe7
+  metadata.gz: 00d1ba24c781023e82453e345bc8fdb68a28cb138b9e7181ba80b5692b1964b8dd138e01b46d7d67e1b414f741380e78c7a9417f9da93e5a6352a8077112c91e
+  data.tar.gz: c001858e4d4b8a82c631482a990da8c3b3aa5eb8fdf89766f4e1e067406ae641512919be2f8f893519b0a9d49ed41e64f52e67d4b03b8c1bf334e3e18c56310c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.4.0
+* Use kuby-redis v0.2, which uses the Spotahome Redis operator instead of KubeDB.
+
 ## 0.3.0
 * Conform to new plugin architecture.
 * Accept `environment` instead of `definition` instances.

data/Gemfile

@@ -6,6 +6,7 @@ gem 'kuby-core', path: '../kuby-core'
 gem 'sidekiq', '>= 6'
 
 group :development, :test do
+  gem 'sorbet-runtime'
   gem 'pry-byebug'
   gem 'rake'
 end

data/README.md

@@ -0,0 +1,75 @@
+**NOTE**: The documentation below refers to an unreleased version of kuby-sidekiq.
+
+## kuby-sidekiq
+
+Sidekiq plugin for [Kuby](https://github.com/getkuby/kuby-core).
+
+## Intro
+
+The Sidekiq plugin makes it easy to run a deployment of Sidekiq workers for your Rails app. Behind the scenes it uses [kuby-redis](https://github.com/getkuby/kuby-redis) to stand up an instance of Redis and Kubernetes deployments to start the desired number of workers.
+
+## Configuration
+
+Add the kuby-sidekiq and [sidekiq](https://github.com/mperham/sidekiq) gems to your Gemfile and run `bundle install`.
+
+Require the plugin in your kuby.rb file and configure it, eg:
+
+```ruby
+require 'kuby/sidekiq'
+
+Kuby.define(:production) do
+  kubernetes do
+
+    add_plugin(:sidekiq) do
+      replicas 2  # run two workers
+    end
+
+  end
+end
+```
+
+Next, run the setup command, eg:
+
+```bash
+bundle exec kuby -e production setup
+```
+
+## Connecting to Redis
+
+Add a Sidekiq initializer to your Rails app and tell Sidekiq how to connect to Redis:
+
+```ruby
+# config/initializers/sidekiq.rb
+
+if Rails.env.production?
+  require 'kuby'
+
+  Kuby.load!
+
+  Sidekiq.configure_server do |config|
+    config.redis = Kuby.environment.kubernetes.plugin(:sidekiq).connection_params
+  end
+
+  Sidekiq.configure_client do |config|
+    config.redis = Kuby.environment.kubernetes.plugin(:sidekiq).connection_params
+  end
+end
+```
+
+### Build and Deploy
+
+Now that Sidekiq has been installed and configured, build, push, and deploy your app the usual way, eg:
+
+```bash
+bundle exec kuby -e production build
+bundle exec kuby -e production push
+bundle exec kuby -e production deploy
+```
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -2,6 +2,7 @@ require 'bundler'
 require 'rspec/core/rake_task'
 require 'rubygems/package_task'
 
+require 'sorbet-runtime'
 require 'kuby/sidekiq'
 
 Bundler::GemHelper.install_tasks

data/kuby-sidekiq.gemspec

@@ -12,8 +12,9 @@ Gem::Specification.new do |s|
 
   s.platform = Gem::Platform::RUBY
 
-  s.add_dependency 'kuby-kube-db', '~> 0.4'
-  s.add_dependency 'kube-dsl', '~> 0.3'
+  s.add_dependency 'kuby-core', '>= 0.16.0', '< 1.0'
+  s.add_dependency 'kube-dsl', '~> 0.7'
+  s.add_dependency 'kuby-redis', '~> 0.2'
 
   s.require_path = 'lib'
   s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'LICENSE', 'CHANGELOG.md', 'README.md', 'Rakefile', 'kuby-sidekiq.gemspec']

data/lib/kuby/sidekiq/plugin.rb

@@ -1,4 +1,5 @@
 require 'securerandom'
+require 'kuby/redis'
 
 module Kuby
   module Sidekiq
@@ -7,26 +8,36 @@ module Kuby
 
       ROLE = 'worker'.freeze
 
-      value_fields :replicas
+      value_field :replicas, default: 1
 
-      def url
-        @url ||= "redis://#{redis.metadata.name}:6379/0"
+      def connection_params
+        redis_instance.connection_params
       end
 
-      def after_initialize
-        @replicas = 1
+      def configure(&block)
+        instance_eval(&block) if block
       end
 
       def after_configuration
+        environment.kubernetes.add_plugin(:redis) do
+          instance :sidekiq do
+            custom_config (custom_config || []).concat(['maxmemory-policy noeviction'])
+          end
+        end
+
         return unless rails_app
 
         deployment.spec.template.spec.container(:worker).merge!(
           rails_app.deployment.spec.template.spec.container(:web), fields: [:env_from]
         )
+
+        if rails_app.manage_database? && database = Kuby::Plugins::RailsApp::Database.get(rails_app)
+          database.plugin.configure_pod_spec(deployment.spec.template.spec)
+        end
       end
 
       def before_deploy(manifest)
-        image_with_tag = "#{docker.metadata.image_url}:#{kubernetes.tag}"
+        image_with_tag = "#{docker.image.image_url}:#{kubernetes.tag || Kuby::Docker::LATEST_TAG}"
 
         deployment do
           spec do
@@ -44,8 +55,7 @@ module Kuby
       def resources
         @resources ||= [
           service_account,
-          deployment,
-          redis
+          deployment
         ]
       end
 
@@ -131,40 +141,8 @@ module Kuby
         @deployment
       end
 
-      def redis(&block)
-        context = self
-
-        @redis ||= Kuby::KubeDB.redis do
-          api_version 'kubedb.com/v1alpha1'
-
-          metadata do
-            name "#{context.selector_app}-sidekiq-redis"
-            namespace context.kubernetes.namespace.metadata.name
-          end
-
-          spec do
-            version '5.0.3-v1'
-            storage_type 'Durable'
-
-            storage do
-              storage_class_name context.storage_class_name
-              access_modes ['ReadWriteOnce']
-
-              resources do
-                requests do
-                  add :storage, '1Gi'
-                end
-              end
-            end
-          end
-        end
-
-        @redis.instance_eval(&block) if block
-        @redis
-      end
-
-      def storage_class_name
-        kubernetes.provider.storage_class_name
+      def redis_instance
+        kubernetes.plugin(:redis).instance(:sidekiq)
       end
 
       def kubernetes

data/lib/kuby/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Kuby
   module Sidekiq
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,43 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: kuby-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-30 00:00:00.000000000 Z
+date: 2022-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: kuby-kube-db
+  name: kuby-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: kube-dsl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: kube-dsl
+  name: kuby-redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.2'
 description: Sidekiq plugin for Kuby.
 email:
 - camertron@gmail.com
@@ -48,6 +68,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - kuby-sidekiq.gemspec
 - lib/kuby/sidekiq.rb
@@ -71,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Sidekiq plugin for Kuby.