kuby-core 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce4674de91f39049845cbcfd48b38c1b0555c888e31a3014d54de151445a0097
-  data.tar.gz: b16c0f671056c928698db27a58635fd2aa2449bd52f333f5a2eaadcbaf4504c4
+  metadata.gz: 42f6ba3c11212d10aeb9d878af3f91e4712f88498ddf1f6d94a29d26dfbd27d4
+  data.tar.gz: 624f45761eed5d05d45e115697a6f43e4fa4516fed17f1158a05af01266ef0e4
 SHA512:
-  metadata.gz: 648c72c35ca24938fedc50e5287a0dff2ace8ca067e1650626cce8e470ba6289152a43739384e837a23840b66fb155ac0255d307ee47ab4cdca83422ef83b962
-  data.tar.gz: 6a1bf52a1984c135e2171ce7e10eb7ecd70b5e42ffa688234c4f7a10741d84a541755bf36e39b77fa8c46dcbd3ed31b0c01f3288ac339a2213391a69e1be789b
+  metadata.gz: 46fda51d238e517907361f4da89ef9615383e55d3daad4c58eb8a0d947ccae27398ca340b9d2590274ff02ef312e9f8384fa7965a5470b4b3b0d8b0eb63527bb
+  data.tar.gz: b7589f6ad84cbd44276893466a15350ba24db01dc5183db3554dc8f5cff77b6834ec964c0591de4c3ad1293713e62f6f28766775b6c88074d3f36d6749afe522

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.3.0
+* Fix Krane issue causing incorrect constant lookup and therefore deploy failures.
+  - See: https://github.com/Shopify/krane/pull/720
+  - Fixed via monkeypatch in lib/ext/krane/kubernetes_resource.rb
+* Move Docker timestamp tag logic into the `Tags` class.
+* Refactor Docker timestamp tag logic.
+* Change deployment names so they're more descriptive of the role (i.e. web, worker, etc)
+  - Rails app deployment changes from [app_name]-deployment to [app_name]-web.
+  - Database deployment changes from [app_name]-[environment]-[adapter] to [app-name]-web-[adapter].
+* Add shortcut for specifying number of Rails app replicas.
+* Move registry secret from the `rails_app` plugin to the Kubernetes spec.
+* Fix rollback functionality.
+
 ## 0.2.0
 * Move Kubernetes CLI error classes into kubernetes-cli gem.
 * Update README to indicate Kuby supports Rails 5.1 and up.

data/Gemfile

@@ -2,10 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'kube-dsl', path: '../kube-dsl'
-gem 'kuby-kube-db', path: '../kuby-kube-db'
-gem 'kuby-cert-manager', path: '../kuby-cert-manager'
-
 group :development, :test do
   gem 'pry-byebug'
   gem 'rake'

data/kuby-core.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'docker-remote', '~> 0.1'
   s.add_dependency 'krane', '~> 1.0'
   s.add_dependency 'kuby-cert-manager', '~> 0.1'
-  s.add_dependency 'kube-dsl', '~> 0.1'
-  s.add_dependency 'kuby-kube-db', '~> 0.1'
-  s.add_dependency 'kubernetes-cli', '~> 0.1'
+  s.add_dependency 'kube-dsl', '~> 0.3'
+  s.add_dependency 'kuby-kube-db', '~> 0.4'
+  s.add_dependency 'kubernetes-cli', '~> 0.2'
   s.add_dependency 'railties', '>= 5.1'
   s.add_dependency 'rouge', '~> 3.0'
 

data/lib/ext/krane/kubernetes_resource.rb

@@ -0,0 +1,16 @@
+require 'krane/kubernetes_resource'
+
+# See: https://github.com/Shopify/krane/pull/720
+module Krane
+  class KubernetesResource
+    class << self
+      def class_for_kind(kind)
+        if Krane.const_defined?(kind, false)
+          Krane.const_get(kind, false)
+        end
+      rescue NameError
+        nil
+      end
+    end
+  end
+end

data/lib/kuby/docker/metadata.rb

@@ -40,6 +40,28 @@ module Kuby
         @tags.empty? ? default_tags : @tags
       end
 
+      def tag
+        t = ENV.fetch('KUBY_DOCKER_TAG') do
+          definition.docker.tags.latest_timestamp_tag
+        end
+
+        unless t
+          raise MissingTagError, 'could not find latest timestamped tag'
+        end
+
+        t.to_s
+      end
+
+      def previous_tag(current_tag)
+        t = definition.docker.tags.previous_timestamp_tag(current_tag)
+
+        unless t
+          raise MissingTagError, 'could not find previous timestamped tag'
+        end
+
+        t.to_s
+      end
+
       def distro=(distro_name)
         @distro = distro_name
       end

data/lib/kuby/docker/tags.rb

@@ -19,10 +19,28 @@ module Kuby
         (local.latest_tags + remote.latest_tags).uniq
       end
 
+      def previous_timestamp_tag(current_tag)
+        current_tag = ::Kuby::Docker::TimestampTag.try_parse(current_tag)
+        all_tags = timestamp_tags.sort
+
+        idx = all_tags.index do |tag|
+          tag.time == current_tag.time
+        end
+
+        idx ||= 0
+        return nil unless idx > 0
+
+        all_tags[idx - 1]
+      end
+
       def timestamp_tags
         (local.timestamp_tags + remote.timestamp_tags).uniq
       end
 
+      def latest_timestamp_tag
+        @latest_timestamp_tag ||= timestamp_tags.sort.last
+      end
+
       def all
         self
       end

data/lib/kuby/kubernetes/deployer.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'krane'
+require 'ext/krane/kubernetes_resource'
 require 'securerandom'
 require 'yaml'
 

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

@@ -6,6 +6,8 @@ module Kuby
     module Plugins
       module RailsApp
         class MySQL < Kuby::Kubernetes::Plugin
+          ROLE = 'web'.freeze
+
           attr_reader :definition, :environment, :configs
 
           def initialize(definition, environment, configs)
@@ -109,7 +111,7 @@ module Kuby
           end
 
           def base_name
-            @base_name ||= "#{kubernetes.selector_app}-#{environment}"
+            @base_name ||= "#{kubernetes.selector_app}-#{ROLE}"
           end
 
           def kubernetes

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

@@ -13,11 +13,12 @@ module Kuby
           ENV_SECRETS = [MASTER_KEY_VAR].freeze
           ENV_EXCLUDE = ['RAILS_ENV'].freeze
 
-          value_fields :hostname, :tls_enabled, :database
+          value_fields :hostname, :tls_enabled, :database, :replicas
 
           def initialize(definition)
             @definition = definition
             @tls_enabled = true
+            @replicas = 1
           end
 
           def configure(&block)
@@ -53,14 +54,9 @@ module Kuby
                 cert_manager.annotate_ingress(ing)
               end
             end
-          end
 
-          def database(&block)
-            @database.instance_eval(&block) if block
-            @database
-          end
+            image_with_tag = "#{docker.metadata.image_url}:#{kubernetes.tag}"
 
-          def set_image(image_with_tag)
             deployment do
               spec do
                 template do
@@ -82,6 +78,11 @@ module Kuby
             end
           end
 
+          def database(&block)
+            @database.instance_eval(&block) if block
+            @database
+          end
+
           def service(&block)
             spec = self
 
@@ -190,33 +191,12 @@ module Kuby
             @app_secrets
           end
 
-          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
-
-              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
-
-            @registry_secret.instance_eval(&block) if block
-            @registry_secret
-          end
-
           def deployment(&block)
             kube_spec = self
 
             @deployment ||= KubeDSL.deployment do
               metadata do
-                name "#{kube_spec.selector_app}-deployment"
+                name "#{kube_spec.selector_app}-#{kube_spec.role}"
                 namespace kube_spec.namespace.metadata.name
 
                 labels do
@@ -226,6 +206,8 @@ module Kuby
               end
 
               spec do
+                replicas kube_spec.replicas
+
                 selector do
                   match_labels do
                     add :app, kube_spec.selector_app
@@ -299,7 +281,7 @@ module Kuby
                     end
 
                     image_pull_secret do
-                      name kube_spec.registry_secret.metadata.name
+                      name kube_spec.definition.kubernetes.registry_secret.metadata.name
                     end
 
                     restart_policy 'Always'
@@ -360,7 +342,6 @@ module Kuby
               service_account,
               config_map,
               app_secrets,
-              registry_secret,
               deployment,
               ingress,
               *database.resources
@@ -379,6 +360,10 @@ module Kuby
             definition.docker
           end
 
+          def kubernetes
+            definition.kubernetes
+          end
+
           def app
             definition.app
           end

data/lib/kuby/kubernetes/spec.rb

@@ -5,7 +5,7 @@ module Kuby
     class Spec
       extend ::KubeDSL::ValueFields
 
-      attr_reader :definition, :plugins
+      attr_reader :definition, :plugins, :tag
 
       def initialize(definition)
         @definition = definition
@@ -56,6 +56,24 @@ module Kuby
         provider.after_configuration
       end
 
+      def before_deploy
+        @tag ||= docker.metadata.tag
+
+        provider.before_deploy(resources)
+        @plugins.each { |_, plg| plg.before_deploy(resources) }
+      ensure
+        @tag = nil
+      end
+
+      def after_deploy
+        @tag ||= docker.metadata.tag
+
+        @plugins.each { |_, plg| plg.after_deploy(resources) }
+        provider.after_deploy(resources)
+      ensure
+        @tag = nil
+      end
+
       def setup
         provider.before_setup
         provider.setup
@@ -68,26 +86,19 @@ module Kuby
       end
 
       def deploy(tag = nil)
-        tag ||= latest_tag
-
-        unless tag
-          raise Kuby::Docker::MissingTagError, 'could not find latest timestamped tag'
-        end
-
-        set_tag(tag)
-
-        provider.before_deploy(resources)
-        @plugins.each { |_, plg| plg.before_deploy(resources) }
+        @tag = tag
 
+        before_deploy
         provider.deploy
-
-        @plugins.each { |_, plg| plg.after_deploy(resources) }
-        provider.after_deploy(resources)
+        after_deploy
       end
 
       def rollback
+        # it sucks that we have to reach into the rails app for this...
         depl = provider.kubernetes_cli.get_object(
-          'deployment', namespace.metadata.name, deployment.metadata.name
+          'deployment',
+          namespace.metadata.name,
+          plugin(:rails_app).deployment.metadata.name
         )
 
         image_url = depl.dig('spec', 'template', 'spec', 'containers', 0, 'image')
@@ -96,16 +107,10 @@ module Kuby
           raise MissingDeploymentError, "couldn't find an existing deployment"
         end
 
-        deployed_tag = ::Kuby::Docker::TimestampTag.try_parse(image_url.split(':').last)
-        all_tags = docker.tags.all.timestamp_tags.sort
-        tag_idx = all_tags.index { |tag| tag.time == deployed_tag.time } || 0
+        deployed_tag = image_url.split(':').last
+        previous_tag = docker.metadata.previous_tag(deployed_tag)
 
-        if tag_idx == 0
-          raise Kuby::Docker::MissingTagError, 'could not find previous tag'
-        end
-
-        previous_tag = all_tags[tag_idx - 1]
-        deploy(previous_tag.to_s)
+        deploy(previous_tag)
       end
 
       def namespace(&block)
@@ -121,17 +126,35 @@ module Kuby
         @namespace
       end
 
+      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
+
+          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
+
+        @registry_secret.instance_eval(&block) if block
+        @registry_secret
+      end
+
       def resources
         @resources ||= Manifest.new([
           namespace,
+          registry_secret,
           *@plugins.flat_map { |_, plugin| plugin.resources }
         ])
       end
 
-      def set_tag(tag)
-        plugin(:rails_app).set_image("#{docker.metadata.image_url}:#{tag}")
-      end
-
       def selector_app
         @selector_app ||= definition.app_name.downcase
       end
@@ -139,14 +162,6 @@ module Kuby
       def docker
         definition.docker
       end
-
-      private
-
-      def latest_tag
-        @latest_tag ||= docker.tags.local.latest_tags.find do |tag|
-          tag != ::Kuby::Docker::Tags::LATEST
-        end
-      end
     end
   end
 end

data/lib/kuby/tasks.rb

@@ -50,6 +50,8 @@ module Kuby
     end
 
     def print_resources
+      kubernetes.before_deploy
+
       kubernetes.resources.each do |res|
         puts res.to_resource.serialize.to_yaml
       end

data/lib/kuby/version.rb

@@ -1,3 +1,3 @@
 module Kuby
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuby-core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Cameron Dutro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: kuby-kube-db
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: kubernetes-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +149,7 @@ files:
 - README.md
 - Rakefile
 - kuby-core.gemspec
+- lib/ext/krane/kubernetes_resource.rb
 - lib/kuby.rb
 - lib/kuby/basic_logger.rb
 - lib/kuby/cli_base.rb
@@ -211,7 +212,7 @@ files:
 homepage: http://github.com/getkuby/kuby-core
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -226,8 +227,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Deploy your Rails app onto Kubernetes the easy way.
 test_files: []