kuby-core 0.7.2 → 0.10.0

data/lib/kuby/kubernetes/{minikube_provider.rb → docker_desktop_provider.rb}

@@ -2,7 +2,7 @@ require 'kube-dsl'
 
 module Kuby
   module Kubernetes
-    class MinikubeProvider < Provider
+    class DockerDesktopProvider < Provider
       STORAGE_CLASS_NAME = 'hostpath'.freeze
 
       class Config
@@ -20,12 +20,16 @@ module Kuby
       def after_configuration
         if rails_app = spec.plugin(:rails_app)
           # Remove ingress and change service type from ClusterIP to
-          # LoadBalancer. No need to set up ingress for minikube since
-          # it handles all the localhost mapping, etc if you set up a
-          # service LB.
+          # LoadBalancer. No need to set up ingress for Docker Desktop
+          # since it handles all the localhost mapping, etc if you set
+          # up a service LB.
           rails_app.resources.delete(rails_app.ingress)
           rails_app.service.spec { type 'LoadBalancer' }
         end
+
+        if assets = spec.plugin(:rails_assets)
+          assets.service.spec { type 'LoadBalancer' }
+        end
       end
 
       def kubeconfig_path

data/lib/kuby/kubernetes/provider.rb

@@ -3,10 +3,10 @@ require 'kubernetes-cli'
 module Kuby
   module Kubernetes
     class Provider
-      attr_reader :definition
+      attr_reader :environment
 
-      def initialize(definition)
-        @definition = definition
+      def initialize(environment)
+        @environment = environment
         after_initialize
       end
 
@@ -55,22 +55,26 @@ module Kuby
         @kubernetes_cli ||= ::KubernetesCLI.new(kubeconfig_path)
       end
 
+      def helm_cli
+        @helm_cli ||= ::HelmCLI.new(kubeconfig_path)
+      end
+
       def kubeconfig_path
         raise NotImplementedError, "please define #{__method__} in #{self.class.name}"
       end
 
+      def deployer
+        @deployer ||= Kuby::Kubernetes::Deployer.new(environment)
+      end
+
       private
 
       def after_initialize
         # override this in derived classes
       end
 
-      def deployer
-        @deployer ||= Kuby::Kubernetes::Deployer.new(definition)
-      end
-
       def spec
-        definition.kubernetes
+        environment.kubernetes
       end
     end
   end

data/lib/kuby/kubernetes/spec.rb

@@ -5,10 +5,10 @@ module Kuby
     class Spec
       extend ::KubeDSL::ValueFields
 
-      attr_reader :definition, :plugins, :tag
+      attr_reader :environment, :plugins, :tag
 
-      def initialize(definition)
-        @definition = definition
+      def initialize(environment)
+        @environment = environment
         @plugins = TrailingHash.new
 
         # default plugins
@@ -18,7 +18,7 @@ module Kuby
       def provider(provider_name = nil, &block)
         if provider_name
           if @provider || provider_klass = Kuby.providers[provider_name]
-            @provider ||= provider_klass.new(definition)
+            @provider ||= provider_klass.new(environment)
             @provider.configure(&block)
           else
             msg = if provider_name
@@ -36,13 +36,12 @@ module Kuby
       end
 
       def configure_plugin(plugin_name, &block)
-        if @plugins[plugin_name] || plugin_klass = Kuby.plugins[plugin_name]
-          @plugins[plugin_name] ||= plugin_klass.new(definition)
-          @plugins[plugin_name].configure(&block) if block
-        else
-          raise MissingPluginError, "no plugin registered with name #{plugin_name}, "\
-            'do you need to add a gem to your Gemfile?'
+        unless @plugins.include?(plugin_name)
+          plugin_klass = Kuby.plugins.find(plugin_name)
+          @plugins[plugin_name] = plugin_klass.new(environment)
         end
+
+        @plugins[plugin_name].configure(&block) if block
       end
 
       alias_method :add_plugin, :configure_plugin
@@ -57,7 +56,7 @@ module Kuby
       end
 
       def before_deploy
-        @tag ||= docker.metadata.tag
+        @tag ||= docker.tag
 
         provider.before_deploy(resources)
         @plugins.each { |_, plg| plg.before_deploy(resources) }
@@ -66,7 +65,7 @@ module Kuby
       end
 
       def after_deploy
-        @tag ||= docker.metadata.tag
+        @tag ||= docker.tag
 
         @plugins.each { |_, plg| plg.after_deploy(resources) }
         provider.after_deploy(resources)
@@ -118,7 +117,7 @@ module Kuby
 
         @namespace ||= KubeDSL.namespace do
           metadata do
-            name "#{spec.selector_app}-#{spec.definition.environment.name}"
+            name "#{spec.selector_app}-#{spec.environment.name}"
           end
         end
 
@@ -129,22 +128,24 @@ module Kuby
       def registry_secret(&block)
         spec = self
 
-        @registry_secret ||= RegistrySecret.new do
-          metadata do
-            name "#{spec.selector_app}-registry-secret"
-            namespace spec.namespace.metadata.name
-          end
+        unless environment.development?
+          @registry_secret ||= RegistrySecret.new do
+            metadata do
+              name "#{spec.selector_app}-registry-secret"
+              namespace spec.namespace.metadata.name
+            end
 
-          docker_config do
-            registry_host spec.docker.metadata.image_host
-            username spec.docker.credentials.username
-            password spec.docker.credentials.password
-            email spec.docker.credentials.email
+            docker_config do
+              registry_host spec.docker.metadata.image_host
+              username spec.docker.credentials.username
+              password spec.docker.credentials.password
+              email spec.docker.credentials.email
+            end
           end
-        end
 
-        @registry_secret.instance_eval(&block) if block
-        @registry_secret
+          @registry_secret.instance_eval(&block) if block
+          @registry_secret
+        end
       end
 
       def resources
@@ -152,15 +153,15 @@ module Kuby
           namespace,
           registry_secret,
           *@plugins.flat_map { |_, plugin| plugin.resources }
-        ])
+        ].compact)
       end
 
       def selector_app
-        @selector_app ||= definition.app_name.downcase
+        @selector_app ||= environment.app_name.downcase
       end
 
       def docker
-        definition.docker
+        environment.docker
       end
     end
   end

data/lib/kuby/plugin.rb

@@ -0,0 +1,59 @@
+module Kuby
+  class Plugin
+    attr_reader :environment
+
+    def initialize(environment)
+      @environment = environment
+      after_initialize
+    end
+
+    def configure(&block)
+      # do nothing by default
+    end
+
+    def setup
+      # do nothing by default
+    end
+
+    # additional kubernetes resources that should be deployed
+    def resources
+      []
+    end
+
+    # additional dockerfiles that should be built and pushed
+    def dockerfiles
+      []
+    end
+
+    # called after all plugins have been configured
+    def after_configuration
+      # do nothing by default
+    end
+
+    # called before any plugins have been setup
+    def before_setup
+      # do nothing by default
+    end
+
+    # called after all plugins have been setup
+    def after_setup
+      # do nothing by default
+    end
+
+    # called before deploying any resources
+    def before_deploy(manifest)
+      # do nothing by default
+    end
+
+    # called after deploying all resources
+    def after_deploy(manifest)
+      # do nothing by default
+    end
+
+    private
+
+    def after_initialize
+      # override this in derived classes
+    end
+  end
+end

data/lib/kuby/plugin_registry.rb

@@ -0,0 +1,27 @@
+module Kuby
+  class PluginRegistry
+    ANY = 'any'.freeze
+
+    def register(plugin_name, plugin_klass, environment: ANY)
+      plugins[plugin_name] ||= {}
+      plugins[plugin_name][environment] ||= plugin_klass
+    end
+
+    def find(plugin_name, environment: Kuby.env)
+      plugins_by_env = plugins[plugin_name]
+
+      unless plugins_by_env
+        raise MissingPluginError, "no plugin registered with name #{plugin_name}, "\
+          'do you need to add a gem to your Gemfile?'
+      end
+
+      plugins_by_env[environment] || plugins_by_env[ANY]
+    end
+
+    private
+
+    def plugins
+      @plugins ||= {}
+    end
+  end
+end

data/lib/kuby/plugins.rb

@@ -0,0 +1,6 @@
+module Kuby
+  module Plugins
+    autoload :NginxIngress, 'kuby/plugins/nginx_ingress'
+    autoload :RailsApp,     'kuby/plugins/rails_app'
+  end
+end

data/lib/kuby/plugins/nginx_ingress.rb

@@ -0,0 +1,71 @@
+require 'kube-dsl'
+
+module Kuby
+  module Plugins
+    class NginxIngress < ::Kuby::Plugin
+      class Config
+        extend ::KubeDSL::ValueFields
+
+        value_fields :provider
+      end
+
+      VERSION = '0.27.1'.freeze
+      DEFAULT_PROVIDER = 'cloud-generic'.freeze
+      NAMESPACE = 'ingress-nginx'.freeze
+      SERVICE_NAME = 'ingress-nginx'.freeze
+
+      SETUP_RESOURCES = [
+        "https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-#{VERSION}/deploy/static/mandatory.yaml",
+        "https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-#{VERSION}/deploy/static/provider/%{provider}.yaml"
+      ].freeze
+
+      def configure(&block)
+        @config.instance_eval(&block) if block
+      end
+
+      def setup
+        Kuby.logger.info('Deploying nginx ingress resources')
+
+        if already_deployed?
+          Kuby.logger.info('Nginx ingress already deployed, skipping')
+          return
+        end
+
+        SETUP_RESOURCES.each do |uri|
+          uri = uri % { provider: @config.provider || DEFAULT_PROVIDER }
+          kubernetes_cli.apply_uri(uri)
+        end
+
+        Kuby.logger.info('Nginx ingress resources deployed!')
+      rescue => e
+        Kuby.logger.fatal(e.message)
+        raise
+      end
+
+      def namespace
+        NAMESPACE
+      end
+
+      def service_name
+        SERVICE_NAME
+      end
+
+      private
+
+      def already_deployed?
+        kubernetes_cli.get_object('Service', 'ingress-nginx', 'ingress-nginx')
+        true
+      rescue KubernetesCLI::GetResourceError
+        return false
+      end
+
+      def after_initialize
+        @config = Config.new
+      end
+
+      def kubernetes_cli
+        environment.kubernetes.provider.kubernetes_cli
+      end
+    end
+  end
+end

data/lib/kuby/plugins/rails_app.rb

@@ -0,0 +1,18 @@
+module Kuby
+  module Plugins
+    module RailsApp
+      autoload :AssetCopyTask,   'kuby/plugins/rails_app/asset_copy_task'
+      autoload :Assets,          'kuby/plugins/rails_app/assets'
+      autoload :Database,        'kuby/plugins/rails_app/database'
+      autoload :MySQL,           'kuby/plugins/rails_app/mysql'
+      autoload :Plugin,          'kuby/plugins/rails_app/plugin'
+      autoload :Postgres,        'kuby/plugins/rails_app/postgres'
+      autoload :RewriteDbConfig, 'kuby/plugins/rails_app/rewrite_db_config'
+      autoload :Sqlite,          'kuby/plugins/rails_app/sqlite'
+    end
+  end
+end
+
+Kuby.register_plugin(:rails_assets, Kuby::Plugins::RailsApp::Assets)
+
+load File.expand_path(File.join('rails_app', 'tasks.rake'), __dir__)

data/lib/kuby/plugins/rails_app/asset_copy_task.rb

@@ -0,0 +1,117 @@
+require 'fileutils'
+require 'pathname'
+
+module Kuby
+  module Plugins
+    module RailsApp
+      # Works by maintaining a directory structure where each deploy creates
+      # a new directory. Each directory is given a timestamped name. Assets
+      # are symlinked into a special 'current' directory from each of the
+      # timestamped directories. Each invocation overrides existing symlinks
+      # if they already exist. This technique ensures assets from the previous
+      # deploy remain available while the web servers are restarting.
+      class AssetCopyTask
+        TIMESTAMP_FORMAT = '%Y%m%d%H%M%S'.freeze
+        KEEP = 5
+
+        attr_reader :dest_path, :source_path
+
+        def initialize(to:, from:)
+          @dest_path = to
+          @source_path = from
+        end
+
+        def run
+          FileUtils.mkdir_p(ts_dir)
+          FileUtils.mkdir_p(current_dir)
+
+          copy_new_assets
+          delete_old_assets
+
+          nil
+        end
+
+        private
+
+        def copy_new_assets
+          # Copy all assets to new timestamp directory
+          #
+          # "source_path/." is special syntax. From the Ruby docs:
+          # cp_r('src', 'dest') makes dest/src, but cp_r('src/.', 'dest') doesn't
+          FileUtils.cp_r(File.join(source_path, '.'), ts_dir)
+
+          relative_source_files = Dir.chdir(ts_dir) do
+            Dir.glob(File.join('**', '*'))
+          end
+
+          relative_source_files.each do |relative_source_file|
+            source_file = Pathname(File.join(current_dir, relative_source_file))
+            source_ts_file = Pathname(File.join(ts_dir, relative_source_file))
+            next unless File.file?(source_ts_file)
+
+            # create individual symlinks for each file in source dir
+            target_file = File.join(current_dir, relative_source_file)
+            FileUtils.mkdir_p(File.dirname(target_file))
+            source_ln_file = source_ts_file.relative_path_from(source_file.dirname)
+            FileUtils.ln_s(source_ln_file, target_file, force: true)
+            Kuby.logger.info("Linked #{source_ln_file} -> #{target_file}")
+          end
+        end
+
+        def delete_old_assets
+          # find all asset directories; directories have timestamp names
+          asset_dirs = (Dir.glob(File.join(dest_path, '*')) - [current_dir])
+            .select { |dir| File.directory?(dir) && try_parse_ts(File.basename(dir)) }
+            .sort_by { |dir| parse_ts(File.basename(dir)) }
+            .reverse
+
+          # only keep the n most recent directories
+          dirs_to_delete = asset_dirs[KEEP..-1] || []
+
+          dirs_to_delete.each do |dir_to_delete|
+            relative_files_to_delete = Dir.chdir(dir_to_delete) do
+              Dir.glob(File.join('**', '*'))
+            end
+
+            relative_files_to_delete.each do |relative_file_to_delete|
+              file_to_delete = File.join(dir_to_delete, relative_file_to_delete)
+              next unless File.file?(file_to_delete)
+
+              link = File.join(current_dir, relative_file_to_delete)
+              next unless File.symlink?(link)
+
+              # Only remove a symlink if it still points to a resource
+              # in the directory we're currently deleting. Othewise, leave
+              # it there - it was added by another deploy.
+              if File.readlink(link) == file_to_delete
+                File.unlink(link)
+              end
+            end
+
+            FileUtils.rm_r(dir_to_delete)
+          end
+        end
+
+        def try_parse_ts(ts)
+          parse_ts(ts)
+        rescue ArgumentError
+          return nil
+        end
+
+        def parse_ts(ts)
+          Time.strptime(ts, TIMESTAMP_FORMAT)
+        end
+
+        def ts_dir
+          @ts_dir ||= File.join(
+            dest_path, Time.now.strftime(TIMESTAMP_FORMAT)
+          )
+        end
+
+        def current_dir
+          @current_dir ||= File.join(dest_path, 'current')
+        end
+      end
+    end
+  end
+end