kuby-kind 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b414415b8e0f72a7b264bbd3d1dfc06bd78206ff34226f07e880edfd11ff321
+  data.tar.gz: 603211fee0c7673e392aaff635a7efc2a87f90cc8108ec7d58fa078443b81870
+SHA512:
+  metadata.gz: de56877bbf471676c15efa6f70963ded9ca110fc702e9da5616ba53a0bb17e2db39109c7f74282d588e3982649a3488dc431e9331bddc4937052614252bc78ff
+  data.tar.gz: 25439df47e8cdcf4613f1cfe88f551f7b1371cea25aa570a09581219a4f9d589762648140701ef1cfea5ecff08ede97e51043c4eaf04d866bf9398dbe1e65e66

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+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) 2022 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,35 @@
+## kuby-kind
+
+Kind provider for [Kuby](https://github.com/getkuby/kuby-core).
+
+## Intro
+
+In Kuby parlance, a "provider" is an [adapter](https://en.wikipedia.org/wiki/Adapter_pattern) that enables Kuby to deploy apps to a specific cloud provider. In this case, we're talking about [Kind](https://kind.sigs.k8s.io/), which is a tool that makes it easy to run local, ephemeral Kubernetes clusters.
+
+All providers adhere to a specific interface, meaning you can swap out one provider for another without having to change your code.
+
+## Usage
+
+Enable the Kind provider like so:
+
+```ruby
+Kuby.define('MyApp') do
+  environment(:production) do
+    kubernetes do
+
+      provider :kind
+
+    end
+  end
+end
+```
+
+Once configured, you should be able to run all the Kuby commands as you would with any provider.
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

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

data/kuby-kind.gemspec

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

data/lib/kuby/kind/config.rb

@@ -0,0 +1,19 @@
+module Kuby
+  module Kind
+    class Config
+      attr_reader :exposed_ports
+
+      def initialize(&block)
+        @exposed_ports = []
+      end
+
+      def expose_port(port)
+        @exposed_ports << port
+      end
+
+      def hide_port(port)
+        @exposed_ports.delete(port)
+      end
+    end
+  end
+end

data/lib/kuby/kind/provider.rb

@@ -0,0 +1,212 @@
+require 'kuby'
+require 'kind-rb'
+require 'open3'
+
+module Kuby
+  module Kind
+    class Provider < ::Kuby::Kubernetes::Provider
+      STORAGE_CLASS_NAME = 'default'.freeze
+      DEFAULT_EXPOSED_PORTS = [80, 443].freeze
+
+      attr_reader :config
+
+      def configure(&block)
+        config.instance_eval(&block) if block
+      end
+
+      def kubeconfig_path
+        File.join(
+          kubeconfig_dir, "#{cluster_name}-kubeconfig.yaml"
+        )
+      end
+
+      def storage_class_name
+        STORAGE_CLASS_NAME
+      end
+
+      def setup
+        @setting_up = true
+        ensure_cluster!
+      end
+
+      def before_deploy(*)
+        ensure_cluster!
+        load_images
+      end
+
+      def after_configuration
+        if nginx_ingress = environment.kubernetes.plugin(:nginx_ingress)
+          nginx_ingress.configure do
+            provider('kind') unless provider
+          end
+        end
+      end
+
+      private
+
+      def after_initialize
+        @already_ensured = false
+        @config = Config.new
+
+        configure do
+          DEFAULT_EXPOSED_PORTS.each do |port|
+            expose_port port
+          end
+        end
+
+        kubernetes_cli.before_execute do
+          ensure_cluster!
+        end
+      end
+
+      def load_images
+        Kuby.logger.info("Loading Docker images into Kind cluster...")
+
+        environment.kubernetes.docker_images.each do |image|
+          image = image.current_version
+
+          # Only load the main tag because it's so darn expensive to load large
+          # images into Kind clusters. Kind doesn't seem to realize images with
+          # the same SHA but different tags are the same, :eyeroll:
+          cmd = [
+            KindRb.executable,
+            'load', 'docker-image', "#{image.image_url}:#{image.main_tag}",
+            '--name', cluster_name
+          ]
+
+          system(cmd.join(' '))
+        end
+
+        Kuby.logger.info("Docker images loaded into Kind cluster successfully.")
+      end
+
+      def ensure_cluster!
+        return if @already_ensured
+
+        if !cluster_defined? || !cluster_running? || !cluster_reachable?
+          recreate_cluster!
+
+          unless @setting_up
+            Kuby.logger.info("Local Kind cluster (re)created, please run `kuby setup`.")
+            exit 0
+          end
+        end
+
+        @already_ensured = true
+      end
+
+      def recreate_cluster!
+        delete_cluster! if cluster_running?
+        create_cluster!
+      end
+
+      def delete_cluster!
+        cmd = [
+          KindRb.executable, 'delete', 'cluster',
+          '--name', cluster_name,
+          '--kubeconfig', kubeconfig_path
+        ]
+
+        system(cmd.join(' '))
+
+        if $?.exitstatus != 0
+          raise 'Kind command failed'
+        end
+      end
+
+      def create_cluster!
+        cmd = [
+          KindRb.executable, 'create', 'cluster',
+          '--name', cluster_name,
+          '--kubeconfig', kubeconfig_path,
+        ]
+
+        if (cluster_config = make_cluster_config)
+          cmd << '--config -'
+
+          Open3.pipeline_w(cmd.join(' ')) do |stdin, wait_threads|
+            stdin.puts(YAML.dump(cluster_config))
+            stdin.close
+            wait_threads.each(&:join)
+
+            if wait_threads.first.value.exitstatus != 0
+              raise 'Kind command failed'
+            end
+          end
+        else
+          system(cmd.join(' '))
+
+          if $?.exitstatus != 0
+            raise 'Kind command failed'
+          end
+        end
+      end
+
+      def make_cluster_config
+        return nil if config.exposed_ports.empty?
+
+        {
+          'kind' => 'Cluster',
+          'apiVersion' => 'kind.x-k8s.io/v1alpha4',
+          'nodes' => [{
+            'role' => 'control-plane',
+            'kubeadmConfigPatches' => [
+              <<~END,
+                kind: InitConfiguration
+                nodeRegistration:
+                  kubeletExtraArgs:
+                    node-labels: "ingress-ready=true"
+              END
+            ],
+            'extraPortMappings' => config.exposed_ports.map do |port|
+              { 'containerPort' => port, 'hostPort' => port, 'protocol' => 'TCP' }
+            end
+          }]
+        }
+      end
+
+      def cluster_defined?
+        return false if !File.exist?(kubeconfig_path)
+
+        kubeconfig = YAML.load_file(kubeconfig_path)
+        cluster_config = (kubeconfig['clusters'] || []).find do |cluster|
+          cluster['name'] == context
+        end
+
+        !!cluster_config
+      end
+
+      def cluster_running?
+        cmd = [KindRb.executable, 'get', 'clusters']
+        cluster_names = `#{cmd.join(' ')}`.strip.split("\n")
+        cluster_names.include?(cluster_name)
+      end
+
+      def cluster_reachable?
+        cmd = [
+          kubernetes_cli.executable,
+          '--kubeconfig', kubeconfig_path,
+          '--context', context,
+          'get', 'ns'
+        ]
+
+        `#{cmd.join(' ')}`
+        $?.success?
+      end
+
+      def cluster_name
+        @cluster_name ||= environment.app_name.downcase
+      end
+
+      def context
+        @context ||= "kind-#{cluster_name}"
+      end
+
+      def kubeconfig_dir
+        @kubeconfig_dir ||= File.join(
+          Dir.tmpdir, 'kuby-kind'
+        )
+      end
+    end
+  end
+end

data/lib/kuby/kind/version.rb

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

data/lib/kuby/kind.rb

@@ -0,0 +1,9 @@
+require 'kuby/kind/provider'
+
+module Kuby
+  module Kind
+    autoload :Config, 'kuby/kind/config'
+  end
+end
+
+Kuby.register_provider(:kind, ::Kuby::Kind::Provider)

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: kuby-kind
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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: kind-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Kind provider for Kuby.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kuby-kind.gemspec
+- lib/kuby/kind.rb
+- lib/kuby/kind/config.rb
+- lib/kuby/kind/provider.rb
+- lib/kuby/kind/version.rb
+homepage: http://github.com/getkuby/kuby-kind
+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.2.22
+signing_key:
+specification_version: 4
+summary: Kind provider for Kuby.
+test_files: []