kuby-redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a76527037e4b0dc6d60be52d6ae1b9c93bf3bd41d3188b562f8140a4d45dc007
+  data.tar.gz: a98a3e23693aa65f9e8964d37754c5c4e0612c6250b5b2d9a4047f99ab3f1fa7
+SHA512:
+  metadata.gz: e288064f9f39ff7c223e34c0e9f75dd5e3e0b94c4a6983b849fc78469ceeb2ed2577594695eba5dca8d4019e5cac4ea26b49ebc59ba3c782d1cada87f335f9d7
+  data.tar.gz: 7c68f5b0bea7c5aa285e3164562f5ea514577c0b608a346cb74f8c976a15360d22495c5013108a886f935bb2592a7f20910c6f82817ccc05d8221cb4285db431

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+* Birthday!

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'kuby-core', path: '../kuby-core'
+gem 'kube-dsl', path: '../kube-dsl'
+
+group :development, :test do
+  gem 'pry-byebug'
+  gem 'rake'
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Cameron Dutro
+
+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,106 @@
+## kuby-redis
+
+Redis plugin for [Kuby](https://github.com/getkuby/kuby-core).
+
+## Intro
+
+The redis plugin provides the ability to stand up arbitrary redis instances. Behind the scenes it uses the excellent [kubedb](https://kubedb.com/) Kubernetes operator.
+
+## Configuration
+
+Add the kuby-redis gem to your Gemfile, then add a redis instance like this:
+
+```ruby
+require 'kuby/redis'
+
+Kuby.define(:production) do
+  kubernetes do
+
+    add_plugin(:redis) do
+      instance(:my_rails_cache)
+    end
+
+  end
+end
+```
+
+The kuby-redis plugin allows a number of additional configuration options too:
+
+
+value_field :storage_type, default: 'Durable'
+value_field :storage, default: '1Gi'
+value_field :access_modes, default: ['ReadWriteOnce']
+
+
+```ruby
+Kuby.define(:production) do
+  kubernetes do
+
+    add_plugin(:redis) do
+      instance(:my_rails_cache) do
+        # set the version of redis you want to use
+        version '5.0.3-v1'  # this is the default version
+
+        # set the port redis listens on and that you'll
+        # use to connect to the instance
+        port 6379  # this is the default port
+
+        # the amount of durable storage to allocate
+        storage '1Gi'
+      end
+    end
+
+  end
+end
+```
+
+Get a list of the redis versions your cluster supports by running:
+
+```bash
+bundle exec kuby -e production kubectl -- get redisversions
+```
+
+## Usage
+
+Redis instances defined in your Kuby config respond to `#hostname`, `#port`, and `#url` methods to help point at them in your Rails configuration. The `#url` method returns a complete URL to the redis instance, including the host and port.
+
+### Rails Cache
+
+In your Rails config (eg. config/environments/production.rb), point your cache store at your redis instance like so:
+
+
+```ruby
+Kuby.load!
+
+url = Kuby.environment.kubernetes
+  .plugin(:redis)
+  .instance(:my_rails_cache)
+  .url
+
+config.cache_store = :redis_cache_store, { url: url }
+```
+
+### Redis Gem
+
+You can also use a redis client like the [Redis gem](https://github.com/redis/redis-rb) directly:
+
+```ruby
+require 'redis'
+
+url = Kuby.environment.kubernetes
+  .plugin(:redis)
+  .instance(:my_rails_cache)
+  .url
+
+redis = Redis.new(url: url)
+redis.set('abc', 123)
+value = redis.get('abc')
+```
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require 'kuby/redis'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/kuby-redis.gemspec

@@ -0,0 +1,20 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'kuby/redis/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'kuby-redis'
+  s.version  = ::Kuby::Redis::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/getkuby/kuby-redis'
+
+  s.description = s.summary = 'Redis plugin for Kuby.'
+
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency 'kuby-kube-db', '~> 0.4'
+  s.add_dependency 'kube-dsl', '~> 0.4'
+
+  s.require_path = 'lib'
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'LICENSE', 'CHANGELOG.md', 'README.md', 'Rakefile', 'kuby-redis.gemspec']
+end

data/lib/kuby/redis.rb

@@ -0,0 +1,10 @@
+require 'kuby'
+require 'kuby/redis/plugin'
+
+module Kuby
+  module Redis
+    autoload :Instance, 'kuby/redis/instance'
+  end
+end
+
+Kuby.register_plugin(:redis, Kuby::Redis::Plugin)

data/lib/kuby/redis/instance.rb

@@ -0,0 +1,81 @@
+require 'kube-dsl'
+
+module Kuby
+  module Redis
+    class Instance
+      extend ::KubeDSL::ValueFields
+
+      attr_reader :name, :environment
+
+      value_field :version, default: '5.0.3-v1'
+      value_field :storage_class_name, default: -> (inst) { inst.kubernetes.provider.storage_class_name }
+      value_field :storage_type, default: 'Durable'
+      value_field :storage, default: '1Gi'
+      value_field :access_modes, default: ['ReadWriteOnce']
+      value_field :port, default: 6379
+
+      def initialize(name, environment)
+        @name = name
+        @environment = environment
+      end
+
+      def resources
+        @resources ||= [redis]
+      end
+
+      def hostname
+        name
+      end
+
+      def url
+        @url ||= "redis://#{hostname}:#{port}/0"
+      end
+
+      def redis(&block)
+        context = self
+
+        @redis ||= Kuby::KubeDB.redis do
+          api_version 'kubedb.com/v1alpha1'
+
+          metadata do
+            name "#{context.name}-redis"
+            namespace context.kubernetes.namespace.metadata.name
+          end
+
+          spec do
+            version context.version
+            storage_type context.storage_type
+
+            storage do
+              storage_class_name context.storage_class_name
+              access_modes context.access_modes
+
+              resources do
+                requests do
+                  add :storage, context.storage
+                end
+              end
+            end
+
+            service_template do
+              spec do
+                type 'NodePort'
+                port do
+                  name 'memcached'
+                  port context.port
+                end
+              end
+            end
+          end
+        end
+
+        @redis.instance_eval(&block) if block
+        @redis
+      end
+
+      def kubernetes
+        environment.kubernetes
+      end
+    end
+  end
+end

data/lib/kuby/redis/plugin.rb

@@ -0,0 +1,27 @@
+require 'kuby'
+
+module Kuby
+  module Redis
+    class Plugin < ::Kuby::Plugin
+      def configure(&block)
+        instance_eval(&block) if block
+      end
+
+      def instance(name, &block)
+        instances[name] ||= Instance.new(name, environment)
+        instances[name].instance_eval(&block) if block
+        instances[name]
+      end
+
+      def resources
+        instances.flat_map { |_, instance| instance.resources }
+      end
+
+      private
+
+      def instances
+        @instances ||= {}
+      end
+    end
+  end
+end

data/lib/kuby/redis/version.rb

@@ -0,0 +1,5 @@
+module Kuby
+  module Redis
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: kuby-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kuby-kube-db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: kube-dsl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Redis plugin for Kuby.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kuby-redis.gemspec
+- lib/kuby/redis.rb
+- lib/kuby/redis/instance.rb
+- lib/kuby/redis/plugin.rb
+- lib/kuby/redis/version.rb
+homepage: http://github.com/getkuby/kuby-redis
+licenses: []
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Redis plugin for Kuby.
+test_files: []