kuby-core 0.8.0 → 0.10.1

data/lib/kuby/kubernetes/provider.rb

@@ -55,20 +55,24 @@ 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(environment)
-      end
-
       def spec
         environment.kubernetes
       end

data/lib/kuby/kubernetes/spec.rb

@@ -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(environment)
-          @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)
@@ -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,7 +153,7 @@ module Kuby
           namespace,
           registry_secret,
           *@plugins.flat_map { |_, plugin| plugin.resources }
-        ])
+        ].compact)
       end
 
       def selector_app

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/rails_app/database.rb

@@ -1,4 +1,3 @@
-require 'erb'
 require 'yaml'
 
 module Kuby
@@ -51,7 +50,7 @@ module Kuby
         end
 
         def db_configs
-          @db_configs ||= YAML.load(ERB.new(File.read(db_config_path)).result)
+          @db_configs ||= YAML.load(File.read(db_config_path))
         end
 
         def db_config_path

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

@@ -2,25 +2,18 @@ require 'rails/generators'
 require 'rails/generators/base'
 
 class KubyGenerator < Rails::Generators::Base
-  def create_initializer_file
-    initializer(
-      'kuby.rb',
-      <<~END
-        require 'kuby'
-
-        Kuby.load!
-      END
-    )
-  end
-
   def create_config_file
     create_file(
       'kuby.rb',
       <<~END
+        require 'active_support/core_ext'
         require 'active_support/encrypted_configuration'
 
         # Define a production Kuby deploy environment
         Kuby.define(:production) do
+          # Because the Rails environment isn't always loaded when
+          # your Kuby config is loaded, provide access to Rails
+          # credentials manually.
           app_creds = ActiveSupport::EncryptedConfiguration.new(
             config_path: File.join('config', 'credentials.yml.enc'),
             key_path: File.join('config', 'master.key'),
@@ -46,17 +39,22 @@ class KubyGenerator < Rails::Generators::Base
 
           kubernetes do
             # Add a plugin that facilitates deploying a Rails app.
-            add_plugin :rails_app
+            add_plugin :rails_app do
+              # configure database credentials
+              database do
+                user app_creds[:KUBY_DB_USER]
+                password app_creds[:KUBY_DB_PASSWORD]
+              end
+            end
 
-            # Use minikube as the provider, which is the default installed by
-            # Docker Desktop.
-            # See: https://github.com/kubernetes/minikube
+            # Use Docker Desktop as the provider.
+            # See: https://www.docker.com/products/docker-desktop
             #
             # Note: you will likely want to use a different provider when deploying
             # your application into a production environment. To configure a different
             # provider, add the corresponding gem to your gemfile and update the
             # following line according to the provider gem's README.
-            provider :minikube
+            provider :docker_desktop
           end
         end
       END

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

@@ -12,9 +12,6 @@ module Kuby
         def initialize(environment, configs)
           @environment = environment
           @configs = configs
-
-          user(config['username'])
-          password(config['password'])
         end
 
         def name

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

@@ -32,6 +32,7 @@ module Kuby
           @asset_url = DEFAULT_ASSET_URL
           @packs_url = DEFAULT_PACKS_URL
           @asset_path = DEFAULT_ASSET_PATH
+          @database = Database.get(self)
         end
 
         def configure(&block)
@@ -41,32 +42,39 @@ module Kuby
         def after_configuration
           context = self
 
-          if @database = Database.get(self)
+          if database
             environment.kubernetes.plugins[database.plugin_name] = @database.plugin
             environment.kubernetes.add_plugin(:kube_db)
 
-            environment.docker do
-              insert :rewrite_db_config, RewriteDbConfig.new, after: :copy_phase
+            unless environment.development?
+              environment.docker do
+                insert :rewrite_db_config, RewriteDbConfig.new, after: :copy_phase
+              end
             end
           end
 
-          # do we always want this?
-          environment.kubernetes.add_plugin(:nginx_ingress)
-          environment.kubernetes.add_plugin(:rails_assets) do
-            asset_url context.asset_url
-            packs_url context.packs_url
-            asset_path context.asset_path
-          end
+          unless environment.development?
+            environment.kubernetes.add_plugin(:nginx_ingress)
+            environment.kubernetes.add_plugin(:rails_assets) do
+              asset_url context.asset_url
+              packs_url context.packs_url
+              asset_path context.asset_path
+            end
 
-          if @tls_enabled
-            context = self
+            if @tls_enabled
+              context = self
 
-            environment.kubernetes.add_plugin(:cert_manager) do
-              email context.environment.docker.credentials.email
+              environment.kubernetes.add_plugin(:cert_manager) do
+                email context.environment.docker.credentials.email
+              end
             end
           end
         end
 
+        def database_host
+          database.plugin.host
+        end
+
         def before_deploy(manifest)
           # Make sure plugin has been configured. If not, do nothing.
           if cert_manager = environment.kubernetes.plugin(:cert_manager)
@@ -80,6 +88,8 @@ module Kuby
             assets.configure_deployment(deployment, image_with_tag)
           end
 
+          spec = self
+
           deployment do
             spec do
               template do
@@ -88,12 +98,14 @@ module Kuby
                     image image_with_tag
                   end
 
-                  init_container(:create_db) do
-                    image image_with_tag
-                  end
+                  unless spec.environment.development?
+                    init_container(:create_db) do
+                      image image_with_tag
+                    end
 
-                  init_container(:migrate_db) do
-                    image image_with_tag
+                    init_container(:migrate_db) do
+                      image image_with_tag
+                    end
                   end
                 end
               end
@@ -102,7 +114,7 @@ module Kuby
         end
 
         def database(&block)
-          @database.instance_eval(&block) if block
+          @database.plugin.instance_eval(&block) if block
           @database
         end
 
@@ -130,7 +142,7 @@ module Kuby
 
               port do
                 name 'http'
-                port 8080
+                port spec.docker.webserver_phase.port
                 protocol 'TCP'
                 target_port 'http'
               end
@@ -226,6 +238,13 @@ module Kuby
                 add :app, kube_spec.selector_app
                 add :role, kube_spec.role
               end
+
+              annotations do
+                add(
+                  'getkuby.io/dockerfile-checksum',
+                  kube_spec.environment.docker.to_dockerfile.checksum
+                )
+              end
             end
 
             spec do
@@ -278,33 +297,93 @@ module Kuby
                       end
                     end
 
-                    readiness_probe do
-                      success_threshold 1
-                      failure_threshold 2
-                      initial_delay_seconds 15
-                      period_seconds 3
-                      timeout_seconds 1
-
-                      http_get do
-                        path '/healthz'
-                        port kube_spec.docker.webserver_phase.port
-                        scheme 'HTTP'
+                    unless kube_spec.environment.development?
+                      readiness_probe do
+                        success_threshold 1
+                        failure_threshold 2
+                        initial_delay_seconds 15
+                        period_seconds 3
+                        timeout_seconds 1
+
+                        http_get do
+                          path '/healthz'
+                          port kube_spec.docker.webserver_phase.port
+                          scheme 'HTTP'
+                        end
                       end
                     end
-                  end
 
-                  init_container(:create_db) do
-                    name "#{kube_spec.selector_app}-create-db"
-                    command %w(bundle exec rake kuby:rails_app:db:create_unless_exists)
-                  end
+                    if kube_spec.environment.development?
+                      env do
+                        name 'BUNDLE_PATH'
+                        value '/bundle'
+                      end
+
+                      env do
+                        name 'GEM_HOME'
+                        value '/bundle'
+                      end
+
+                      env do
+                        name 'BOOTSNAP_CACHE_DIR'
+                        value '/usr/src/bootsnap'
+                      end
+
+                      volume_mount do
+                        name "#{kube_spec.selector_app}-code"
+                        mount_path '/usr/src/app'
+                      end
 
-                  init_container(:migrate_db) do
-                    name "#{kube_spec.selector_app}-migrate-db"
-                    command %w(bundle exec rake db:migrate)
+                      volume_mount do
+                        name "#{kube_spec.selector_app}-bundle"
+                        mount_path '/bundle'
+                      end
+
+                      volume_mount do
+                        name "#{kube_spec.selector_app}-bootsnap"
+                        mount_path '/usr/src/bootsnap'
+                      end
+                    end
                   end
 
-                  image_pull_secret do
-                    name kube_spec.environment.kubernetes.registry_secret.metadata.name
+                  if kube_spec.environment.development?
+                    volume do
+                      name "#{kube_spec.selector_app}-code"
+
+                      persistent_volume_claim do
+                        claim_name kube_spec.code_volume_claim.metadata.name
+                      end
+                    end
+
+                    volume do
+                      name "#{kube_spec.selector_app}-bundle"
+
+                      persistent_volume_claim do
+                        claim_name kube_spec.bundle_volume_claim.metadata.name
+                      end
+                    end
+
+                    volume do
+                      name "#{kube_spec.selector_app}-bootsnap"
+
+                      persistent_volume_claim do
+                        claim_name kube_spec.bootsnap_volume_claim.metadata.name
+                      end
+                    end
+                  else
+                    init_container(:create_db) do
+                      name "#{kube_spec.selector_app}-create-db"
+                      command %w(bundle exec rake kuby:rails_app:db:create_unless_exists)
+                    end
+
+                    init_container(:migrate_db) do
+                      name "#{kube_spec.selector_app}-migrate-db"
+                      command %w(bundle exec rake db:migrate)
+                    end
+
+                    image_pull_secret do
+                      name kube_spec.environment.kubernetes.registry_secret.metadata.name
+                    end
                   end
 
                   restart_policy 'Always'
@@ -361,6 +440,118 @@ module Kuby
           @ingress
         end
 
+        def code_volume(&block)
+          spec = self
+
+          if environment.development?
+            @code_volume ||= KubeDSL.persistent_volume do
+              metadata do
+                name "#{spec.selector_app}-code"
+              end
+
+              spec do
+                access_modes ['ReadWriteMany']
+
+                capacity do
+                  add :storage, '1Mi'
+                end
+
+                host_path do
+                  path File.expand_path(spec.root)
+                end
+
+                storage_class_name 'hostpath'
+              end
+            end
+
+            @code_volume.instance_eval(&block) if block
+            @code_volume
+          end
+        end
+
+        def code_volume_claim(&block)
+          spec = self
+
+          if environment.development?
+            @code_volume_claim ||= KubeDSL.persistent_volume_claim do
+              metadata do
+                name "#{spec.selector_app}-code"
+                namespace spec.namespace.metadata.name
+              end
+
+              spec do
+                access_modes ['ReadWriteMany']
+
+                resources do
+                  requests do
+                    add :storage, '1Mi'
+                  end
+                end
+
+                storage_class_name 'hostpath'
+                volume_name spec.code_volume.metadata.name
+              end
+            end
+
+            @code_volume_claim.instance_eval(&block) if block
+            @code_volume_claim
+          end
+        end
+
+        def bundle_volume_claim(&block)
+          spec = self
+
+          if environment.development?
+            @bundle_volume_claim ||= KubeDSL.persistent_volume_claim do
+              metadata do
+                name "#{spec.selector_app}-bundle"
+                namespace spec.namespace.metadata.name
+              end
+
+              spec do
+                access_modes ['ReadWriteMany']
+                storage_class_name 'hostpath'
+
+                resources do
+                  requests do
+                    add :storage, '2Gi'
+                  end
+                end
+              end
+            end
+
+            @bundle_volume_claim.instance_eval(&block) if block
+            @bundle_volume_claim
+          end
+        end
+
+        def bootsnap_volume_claim(&block)
+          spec = self
+
+          if environment.development?
+            @bootsnap_volume_claim ||= KubeDSL.persistent_volume_claim do
+              metadata do
+                name "#{spec.selector_app}-bootsnap"
+                namespace spec.namespace.metadata.name
+              end
+
+              spec do
+                access_modes ['ReadWriteMany']
+                storage_class_name 'hostpath'
+
+                resources do
+                  requests do
+                    add :storage, '2Gi'
+                  end
+                end
+              end
+            end
+
+            @bootsnap_volume_claim.instance_eval(&block) if block
+            @bootsnap_volume_claim
+          end
+        end
+
         def resources
           @resources ||= [
             service,
@@ -369,6 +560,10 @@ module Kuby
             app_secrets,
             deployment,
             ingress,
+            code_volume,
+            code_volume_claim,
+            bundle_volume_claim,
+            bootsnap_volume_claim,
             *database&.plugin&.resources
           ]
         end