kuby-core 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a163afc89c23d091afce04277e9308252ae8335f8137f2136b68355dccb74bc2
-  data.tar.gz: 617007a29710ec9359dc4f3d5b31d850e22a0eacdc70175c444cf6d94a53462f
+  metadata.gz: ac73b245f1fb75244ed166e23a6441cc56dabaec66f532f67517b4dd8d412091
+  data.tar.gz: 6418a3fbca89fdc195e277aeb8309caa2b519e1d3df0fccd53f3ae8b2e9f166f
 SHA512:
-  metadata.gz: 8fd6302f94ffa2a740928bd324ca5e2bbe251f49356ce582e581c4d91740b66425b6c1a3b392e40fe7c52e649781fe939fa377d6894e435e00386ddaed0f4ee3
-  data.tar.gz: 4ae55a8fc6c4aeceac417b54e41f679a988c34788e5740e268ddeb728223f949915c17e8bc738ffcd744a257a1d5ba74cf431d1df90c8b5b496eaa51861229d6
+  metadata.gz: 6f7bc8616cfdf23805bf9177198f62888b17372ae67b4fb4a77c4d325adbbcf6d734385edb0614094be95bb443d84b28f6d79fe70a8acaecdfb44b547bcf86b0
+  data.tar.gz: 815fd1ae302c35fdd0fb31f43bb1d607073a9cfb1f24d3c849578b0b8a5271bca5cbe49f2747bdf7bb22d1a4b98d1fa455c3a917e7d27f059f5a4778da215f87

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.8.0
+* Upgrade to Krane >= 1.1.4, < 2.0.
+* Remove Krane monkeypatch in ext/.
+* Implement a Rails static asset server.
+* Move plugins from `Kuby::Kubernetes` namespace to `Kuby` namespace.
+  - This is to eventually enable plugins to modify the Dockerfile and introduce additional Dockerfiles (i.e. to enable a development mode, etc).
+* Pass `Environment` instead of `Definition` instances around.
+  - Providers, plugins, etc all take `Definition` instances. `Definition#kubernetes`, for example, returns the Kubernetes spec for the `Environment` specified by `KUBY_ENV` (or the first env defined if `KUBY_ENV` is not set). This is a problem for Kuby configs that specify multiple environments, and causes plugins to make changes to the default environment instead of the one they've been specifically added to. For example, if the `:production` env is defined first, the `:development` env still gets a cluster issuer from cert-manager even though `enable_tls` is set to `false`.
+
 ## 0.7.2
 * Fix issue causing `Kuby.environment(...)` to raise an `UndefinedEnvironmentError` for existing environments.
 

data/kuby-core.gemspec

@@ -14,10 +14,12 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'colorize', '~> 0.8'
   s.add_dependency 'docker-remote', '~> 0.1'
-  s.add_dependency 'krane', '~> 1.0'
-  s.add_dependency 'kuby-cert-manager', '~> 0.2'
+  # See: https://github.com/Shopify/krane/pull/720
+  # See: https://github.com/Shopify/krane/blob/master/CHANGELOG.md#114
+  s.add_dependency 'krane', '>= 1.1.4', '< 2.0'
+  s.add_dependency 'kuby-cert-manager', '>= 0.3'
   s.add_dependency 'kube-dsl', '~> 0.3'
-  s.add_dependency 'kuby-kube-db', '~> 0.4'
+  s.add_dependency 'kuby-kube-db', '>= 0.5'
   s.add_dependency 'kubernetes-cli', '~> 0.2'
   s.add_dependency 'railties', '>= 5.1'
   s.add_dependency 'rouge', '~> 3.0'

data/lib/kuby.rb

@@ -1,7 +1,7 @@
 require 'kuby/railtie'
 
 begin
-  require 'kuby/kubernetes/plugins/rails_app/generators/kuby'
+  require 'kuby/plugins/rails_app/generators/kuby'
 rescue NameError
 end
 
@@ -13,6 +13,8 @@ module Kuby
   autoload :Environment,  'kuby/environment'
   autoload :Kubernetes,   'kuby/kubernetes'
   autoload :Middleware,   'kuby/middleware'
+  autoload :Plugin,       'kuby/plugin'
+  autoload :Plugins,      'kuby/plugins'
   autoload :Tasks,        'kuby/tasks'
   autoload :TrailingHash, 'kuby/trailing_hash'
 
@@ -107,8 +109,8 @@ end
 Kuby.register_provider(:minikube, Kuby::Kubernetes::MinikubeProvider)
 
 # plugins
-Kuby.register_plugin(:rails_app, Kuby::Kubernetes::Plugins::RailsApp::Plugin)
-Kuby.register_plugin(:nginx_ingress, Kuby::Kubernetes::Plugins::NginxIngress)
+Kuby.register_plugin(:rails_app, Kuby::Plugins::RailsApp::Plugin)
+Kuby.register_plugin(:nginx_ingress, Kuby::Plugins::NginxIngress)
 
 # distros
 Kuby.register_distro(:debian, Kuby::Docker::Debian)

data/lib/kuby/definition.rb

@@ -20,14 +20,6 @@ module Kuby
       environments[name]
     end
 
-    def docker(&block)
-      environment.docker(&block)
-    end
-
-    def kubernetes(&block)
-      environment.kubernetes(&block)
-    end
-
     def environments
       @environments ||= {}
     end

data/lib/kuby/docker/layer.rb

@@ -1,10 +1,10 @@
 module Kuby
   module Docker
     class Layer
-      attr_reader :definition
+      attr_reader :environment
 
-      def initialize(definition)
-        @definition = definition
+      def initialize(environment)
+        @environment = environment
       end
 
       def apply_to(dockerfile)
@@ -15,7 +15,7 @@ module Kuby
       private
 
       def metadata
-        definition.docker.metadata
+        environment.docker.metadata
       end
     end
   end

data/lib/kuby/docker/metadata.rb

@@ -8,10 +8,10 @@ module Kuby
       LATEST_TAG = 'latest'
 
       attr_accessor :image_url
-      attr_reader :definition
+      attr_reader :environment
 
-      def initialize(definition)
-        @definition = definition
+      def initialize(environment)
+        @environment = environment
         @tags = []
       end
 
@@ -46,7 +46,7 @@ module Kuby
 
       def tag
         t = ENV.fetch('KUBY_DOCKER_TAG') do
-          definition.docker.tags.latest_timestamp_tag
+          environment.docker.tags.latest_timestamp_tag
         end
 
         unless t
@@ -57,7 +57,7 @@ module Kuby
       end
 
       def previous_tag(current_tag)
-        t = definition.docker.tags.previous_timestamp_tag(current_tag)
+        t = environment.docker.tags.previous_timestamp_tag(current_tag)
 
         unless t
           raise MissingTagError, 'could not find previous timestamped tag'
@@ -78,7 +78,7 @@ module Kuby
 
       def default_image_url
         # assuming dockerhub by not specifying full url
-        @default_image_url ||= definition.app_name.downcase
+        @default_image_url ||= environment.app_name.downcase
       end
 
       def default_tags

data/lib/kuby/docker/package_phase.rb

@@ -40,7 +40,7 @@ module Kuby
       private
 
       def distro_spec
-        definition.docker.distro_spec
+        environment.docker.distro_spec
       end
 
       def get_package(package_name, version)
@@ -52,7 +52,7 @@ module Kuby
       end
 
       def metadata
-        definition.docker.metadata
+        environment.docker.metadata
       end
     end
   end

data/lib/kuby/docker/spec.rb

@@ -3,10 +3,10 @@ require 'docker/remote'
 module Kuby
   module Docker
     class Spec
-      attr_reader :definition
+      attr_reader :environment
 
-      def initialize(definition)
-        @definition = definition
+      def initialize(environment)
+        @environment = environment
       end
 
       def base_image(image_url)
@@ -75,35 +75,35 @@ module Kuby
       end
 
       def setup_phase
-        @setup_phase ||= SetupPhase.new(definition)
+        @setup_phase ||= SetupPhase.new(environment)
       end
 
       def package_phase
-        @package_phase ||= PackagePhase.new(definition)
+        @package_phase ||= PackagePhase.new(environment)
       end
 
       def bundler_phase
-        @bundler_phase ||= BundlerPhase.new(definition)
+        @bundler_phase ||= BundlerPhase.new(environment)
       end
 
       def yarn_phase
-        @yarn_phase ||= YarnPhase.new(definition)
+        @yarn_phase ||= YarnPhase.new(environment)
       end
 
       def copy_phase
-        @copy_phase ||= CopyPhase.new(definition)
+        @copy_phase ||= CopyPhase.new(environment)
       end
 
       def assets_phase
-        @assets_phase ||= AssetsPhase.new(definition)
+        @assets_phase ||= AssetsPhase.new(environment)
       end
 
       def webserver_phase
-        @webserver_phase ||= WebserverPhase.new(definition)
+        @webserver_phase ||= WebserverPhase.new(environment)
       end
 
       def metadata
-        @metadata ||= Metadata.new(definition)
+        @metadata ||= Metadata.new(environment)
       end
 
       def tags

data/lib/kuby/environment.rb

@@ -8,15 +8,19 @@ module Kuby
     end
 
     def docker(&block)
-      @docker ||= Docker::Spec.new(definition)
+      @docker ||= Docker::Spec.new(self)
       @docker.instance_eval(&block) if block
       @docker
     end
 
     def kubernetes(&block)
-      @kubernetes ||= Kubernetes::Spec.new(definition)
+      @kubernetes ||= Kubernetes::Spec.new(self)
       @kubernetes.instance_eval(&block) if block
       @kubernetes
     end
+
+    def app_name
+      definition.app_name
+    end
   end
 end

data/lib/kuby/kubernetes.rb

@@ -7,8 +7,6 @@ module Kuby
     autoload :DeployTask,       'kuby/kubernetes/deploy_task'
     autoload :DockerConfig,     'kuby/kubernetes/docker_config'
     autoload :Manifest,         'kuby/kubernetes/manifest'
-    autoload :Monitors,         'kuby/kubernetes/monitors'
-    autoload :Plugin,           'kuby/kubernetes/plugin'
     autoload :Plugins,          'kuby/kubernetes/plugins'
     autoload :Provider,         'kuby/kubernetes/provider'
     autoload :RegistrySecret,   'kuby/kubernetes/registry_secret'

data/lib/kuby/kubernetes/deploy_task.rb

@@ -1,5 +1,4 @@
 require 'krane'
-require 'ext/krane/kubernetes_resource'
 require 'kubectl-rb'
 
 module Kuby

data/lib/kuby/kubernetes/deployer.rb

@@ -5,10 +5,10 @@ require 'yaml'
 module Kuby
   module Kubernetes
     class Deployer
-      attr_reader :definition
+      attr_reader :environment
 
-      def initialize(definition)
-        @definition = definition
+      def initialize(environment)
+        @environment = environment
       end
 
       def deploy
@@ -42,7 +42,7 @@ module Kuby
 
           cli.apply(res)
         end
-      rescue InvalidResourceError => e
+      rescue KubernetesCLI::InvalidResourceError => e
         Kuby.logger.fatal(e.message)
         Kuby.logger.fatal(e.resource.to_resource.to_yaml)
       end
@@ -74,15 +74,15 @@ module Kuby
       end
 
       def provider
-        definition.kubernetes.provider
+        environment.kubernetes.provider
       end
 
       def namespace
-        definition.kubernetes.namespace
+        environment.kubernetes.namespace
       end
 
       def all_resources
-        definition.kubernetes.resources
+        environment.kubernetes.resources
       end
 
       def cli

data/lib/kuby/kubernetes/minikube_provider.rb

@@ -26,6 +26,10 @@ module Kuby
           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
 
@@ -66,11 +66,11 @@ module Kuby
       end
 
       def deployer
-        @deployer ||= Kuby::Kubernetes::Deployer.new(definition)
+        @deployer ||= Kuby::Kubernetes::Deployer.new(environment)
       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
@@ -37,7 +37,7 @@ module Kuby
 
       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] ||= plugin_klass.new(environment)
           @plugins[plugin_name].configure(&block) if block
         else
           raise MissingPluginError, "no plugin registered with name #{plugin_name}, "\
@@ -118,7 +118,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
 
@@ -156,11 +156,11 @@ module Kuby
       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