kuby-core 0.5.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cec43b807b241115b8aaede84a93510a8fdbc45ebf82a79c334073b9d3cc634
-  data.tar.gz: f0beeedfdd8f48430c9715a4f5c2235037afbd99a7562475d40a7c0ff004e825
+  metadata.gz: a163afc89c23d091afce04277e9308252ae8335f8137f2136b68355dccb74bc2
+  data.tar.gz: 617007a29710ec9359dc4f3d5b31d850e22a0eacdc70175c444cf6d94a53462f
 SHA512:
-  metadata.gz: a9b9d00b93f1734ebdb9459284b7d211bfe4610ac2ad964da9b2e57fd3618de5fce4b698d4b994d00383944a3d798925cf1ee07d884209e192f7146f1d33d369
-  data.tar.gz: 5725aa6ca478958cd94d53fc77a5523b38392447084e642849130fb61375f99b287da7a13989ddb2c5505f6992b83515564e7615017c212971f5306df6557d40
+  metadata.gz: 8fd6302f94ffa2a740928bd324ca5e2bbe251f49356ce582e581c4d91740b66425b6c1a3b392e40fe7c52e649781fe939fa377d6894e435e00386ddaed0f4ee3
+  data.tar.gz: 4ae55a8fc6c4aeceac417b54e41f679a988c34788e5740e268ddeb728223f949915c17e8bc738ffcd744a257a1d5ba74cf431d1df90c8b5b496eaa51861229d6

data/CHANGELOG.md

@@ -1,3 +1,52 @@
+## 0.7.2
+* Fix issue causing `Kuby.environment(...)` to raise an `UndefinedEnvironmentError` for existing environments.
+
+## 0.7.1
+* Fix timestamp tag parsing regression caused by adding anchor tags to the regex.
+  - Instead, let's rely on `strptime` and return `nil` if it throws an `ArgumentError`.
+
+## 0.7.0
+* Automatically perform `docker login` if not already logged into the Docker registry.
+* Fix timestamp tag parsing issue causing deploy to fail with no available tags.
+  - Issue turned out to be ignoring the month of October in the validation regex.
+
+## 0.6.1
+* Fix issue causing database.yml to not be rewritten to point at correct database host.
+
+## 0.6.0
+* Don't load the Rails environment when running Kuby's rake tasks.
+  - Kuby's gems are still part of the bundle, but config has been moved out of the initializer and into kuby.rb in the Rails root directory.
+  - Internal classes no longer retain a reference to `Rails.application`.
+  - Kuby config now requires `environment` blocks:
+      ```ruby
+      Kuby.define('my-app') do
+        environment(:production) do
+          ...
+        end
+
+        environment(:staging) do
+          ...
+        end
+      end
+      ```
+* Fix `MissingDistroError` caused by not setting a default distro.
+* Create a .dockerignore file when running the Rails generator.
+* Add ability to insert inline Docker layers without having to create a separate class, eg:
+    ```ruby
+    insert :hello, before: :bundler_phase do |dockerfile|
+      dockerfile.run('echo "hello, world"')
+    end
+    ```
+* Add Postgres database support.
+* Don't install sqlite libs by default.
+* Modify Rails generator
+  - Require kuby and load config safely.
+  - Provide manual access to credentials via `ActiveSupport::EncryptedConfiguration`, which is necessary now that our rake tasks don't load the Rails environment.
+* Add a convenience method for requesting the amount of block storage for the database.
+* Add the ability to entirely disable database management via `manage_database false`.
+* Avoid deploying nginx-ingress if it's already deployed.
+* Add rake task for running arbitrary `kubectl` commands.
+
 ## 0.5.0
 * Fix Rails generators issue causing crash at startup.
 * Add rake task to run arbitrary kubectl commands.

data/kuby-core.gemspec

@@ -15,13 +15,16 @@ 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.1'
+  s.add_dependency 'kuby-cert-manager', '~> 0.2'
   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'
 
+  s.add_development_dependency 'rspec'
+
   s.require_path = 'lib'
+
   s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'LICENSE', 'CHANGELOG.md', 'README.md', 'Rakefile', 'kuby-core.gemspec']
 end

data/lib/kuby.rb

@@ -10,6 +10,7 @@ module Kuby
   autoload :CLIBase,      'kuby/cli_base'
   autoload :Definition,   'kuby/definition'
   autoload :Docker,       'kuby/docker'
+  autoload :Environment,  'kuby/environment'
   autoload :Kubernetes,   'kuby/kubernetes'
   autoload :Middleware,   'kuby/middleware'
   autoload :Tasks,        'kuby/tasks'
@@ -19,24 +20,30 @@ module Kuby
 
   class << self
     attr_reader :definition
-    attr_accessor :logger
+    attr_writer :logger
 
-    def define(environment, app = Rails.application, &block)
-      environment = environment.to_s
-      definitions[environment] ||= Definition.new(environment, app, &block)
+    def load!
+      require ENV['KUBY_CONFIG'] || File.join('.', 'kuby.rb')
     end
 
-    def definitions
-      @definitions ||= {}
-    end
+    def define(name, &block)
+      raise 'Kuby is already configured' if @definition
+
+      @definition = Definition.new(name.to_s)
+      @definition.instance_eval(&block)
 
-    def definition(environment = env)
-      definitions.fetch(environment.to_s) do
-        raise UndefinedEnvironmentError, "couldn't find a Kuby environment named "\
-          "'#{environment}'"
+      @definition.environments.each do |_, env|
+        env.kubernetes.after_configuration
       end
     end
 
+    def environment(name = env)
+      definition.environment(name.to_s) || raise(
+        UndefinedEnvironmentError, "couldn't find a Kuby environment named "\
+        "'#{name}'"
+      )
+    end
+
     def register_provider(provider_name, provider_klass)
       providers[provider_name] = provider_klass
     end
@@ -61,6 +68,10 @@ module Kuby
       @plugins ||= {}
     end
 
+    def logger
+      @logger ||= BasicLogger.new(STDERR)
+    end
+
     def register_package(package_name, package_def = nil)
       packages[package_name] = case package_def
         when NilClass
@@ -86,7 +97,7 @@ module Kuby
 
     def env
       ENV.fetch('KUBY_ENV') do
-        (definitions.keys.first || Rails.env).to_s
+        (definition.environments.keys.first || Rails.env).to_s
       end
     end
   end
@@ -114,8 +125,3 @@ Kuby.register_package(:c_toolchain,
   debian: 'build-essential',
   alpine: 'build-base'
 )
-
-Kuby.register_package(:sqlite_dev,
-  debian: 'libsqlite3-dev',
-  alpine: 'sqlite-dev'
-)

data/lib/kuby/definition.rb

@@ -1,29 +1,35 @@
 module Kuby
   class Definition
-    attr_reader :environment, :app
+    attr_reader :app_name
 
-    def initialize(environment, app, &block)
-      @environment = environment
-      @app = app
+    def initialize(app_name, &block)
+      @app_name = app_name
+    end
+
+    def environment(name = Kuby.env, &block)
+      name = name.to_s
+
+      if name
+        environments[name] ||= Environment.new(name, self)
+      end
+
+      if block_given?
+        environments[name].instance_eval(&block)
+      end
 
-      instance_eval(&block) if block
-      kubernetes.after_configuration
+      environments[name]
     end
 
     def docker(&block)
-      @docker ||= Docker::Spec.new(self)
-      @docker.instance_eval(&block) if block
-      @docker
+      environment.docker(&block)
     end
 
     def kubernetes(&block)
-      @kubernetes ||= Kubernetes::Spec.new(self)
-      @kubernetes.instance_eval(&block) if block
-      @kubernetes
+      environment.kubernetes(&block)
     end
 
-    def app_name
-      @app_name ||= app.class.module_parent.name
+    def environments
+      @environments ||= {}
     end
   end
 end

data/lib/kuby/docker.rb

@@ -10,12 +10,13 @@ module Kuby
     autoload :Credentials,    'kuby/docker/credentials'
     autoload :Debian,         'kuby/docker/debian'
     autoload :Dockerfile,     'kuby/docker/dockerfile'
+    autoload :InlineLayer,    'kuby/docker/inline_layer'
+    autoload :Layer,          'kuby/docker/layer'
     autoload :LayerStack,     'kuby/docker/layer_stack'
     autoload :LocalTags,      'kuby/docker/local_tags'
     autoload :Metadata,       'kuby/docker/metadata'
     autoload :Packages,       'kuby/docker/packages'
     autoload :PackagePhase,   'kuby/docker/package_phase'
-    autoload :Phase,          'kuby/docker/phase'
     autoload :RemoteTags,     'kuby/docker/remote_tags'
     autoload :SetupPhase,     'kuby/docker/setup_phase'
     autoload :Spec,           'kuby/docker/spec'

data/lib/kuby/docker/alpine.rb

@@ -8,7 +8,6 @@ module Kuby
         [:nodejs, '12.14.1'],
         [:yarn, '1.21.1'],
         [:c_toolchain],
-        [:sqlite_dev],
         [:tzdata]
       ].freeze
 

data/lib/kuby/docker/assets_phase.rb

@@ -1,6 +1,6 @@
 module Kuby
   module Docker
-    class AssetsPhase < Phase
+    class AssetsPhase < Layer
       def apply_to(dockerfile)
         dockerfile.run(
           'bundle', 'exec', 'rake', 'assets:precompile'

data/lib/kuby/docker/bundler_phase.rb

@@ -1,6 +1,8 @@
+require 'pathname'
+
 module Kuby
   module Docker
-    class BundlerPhase < Phase
+    class BundlerPhase < Layer
       DEFAULT_WITHOUT = ['development', 'test', 'deploy'].freeze
 
       attr_accessor :version, :gemfile, :without
@@ -48,7 +50,7 @@ module Kuby
           .definition
           .gemfiles
           .first
-          .relative_path_from(app.root)
+          .relative_path_from(Pathname(Dir.getwd))
           .to_s
       end
     end

data/lib/kuby/docker/cli.rb

@@ -10,6 +10,38 @@ module Kuby
         @executable = executable || `which docker`.strip
       end
 
+      def config_file
+        if File.exist?(default_config_file)
+          default_config_file
+        end
+      end
+
+      def default_config_file
+        File.join(Dir.home, '.docker', 'config.json')
+      end
+
+      def login(url:, username:, password:)
+        cmd = [
+          executable, 'login', url, '--username', username, '--password-stdin'
+        ]
+
+        open3_w({}, cmd) do |stdin, _wait_threads|
+          stdin.puts(password)
+        end
+
+        unless last_status.success?
+          raise LoginError, 'build failed: docker command exited with '\
+            "status code #{last_status.exitstatus}"
+        end
+      end
+
+      def auths
+        return [] unless config_file
+
+        config = JSON.parse(File.read(config_file))
+        config.fetch('auths', {}).keys
+      end
+
       def build(dockerfile:, image_url:, tags:)
         cmd = [
           executable, 'build',

data/lib/kuby/docker/copy_phase.rb

@@ -1,6 +1,6 @@
 module Kuby
   module Docker
-    class CopyPhase < Phase
+    class CopyPhase < Layer
       DEFAULT_PATHS = ['./'].freeze
 
       attr_reader :paths

data/lib/kuby/docker/errors.rb

@@ -2,6 +2,7 @@ module Kuby
   module Docker
     class BuildError < StandardError; end
     class PushError < StandardError; end
+    class LoginError < StandardError; end
 
     class MissingTagError < StandardError
       attr_reader :tag

data/lib/kuby/docker/inline_layer.rb

@@ -0,0 +1,15 @@
+module Kuby
+  module Docker
+    class InlineLayer < Layer
+      attr_reader :block
+
+      def initialize(block)
+        @block = block
+      end
+
+      def apply_to(dockerfile)
+        block.call(dockerfile)
+      end
+    end
+  end
+end

data/lib/kuby/docker/{phase.rb → layer.rb}

@@ -1,18 +1,19 @@
 module Kuby
   module Docker
-    class Phase
+    class Layer
       attr_reader :definition
 
       def initialize(definition)
         @definition = definition
       end
 
-      private
-
-      def app
-        definition.app
+      def apply_to(dockerfile)
+        raise NotImplementedError,
+          "#{__method__} must be defined in derived classes"
       end
 
+      private
+
       def metadata
         definition.docker.metadata
       end

data/lib/kuby/docker/layer_stack.rb

@@ -15,12 +15,31 @@ module Kuby
         @stack.each { |name| yield layers[name] }
       end
 
-      def use(name, layer)
+      def use(name, layer = nil, &block)
         stack << name
-        layers[name] = layer
+
+        if layer
+          layers[name] = layer
+        elsif block_given?
+          layers[name] = InlineLayer.new(block)
+        else
+          raise "Must either pass a layer object or a block to `#{__method__}'"
+        end
       end
 
-      def insert(name, layer, options = {})
+      def insert(name, layer = nil, options = {}, &block)
+        # this is truly gross but it's the only way I can think of to be able
+        # to call insert these two ways:
+        #
+        # insert :foo, FooLayer.new, before: :bundler_phase
+        # insert :foo, before: :bundler_phase do
+        #   ...
+        # end
+        if layer.is_a?(Hash)
+          insert(name, nil, options.merge(layer), &block)
+          return
+        end
+
         existing_name = options[:before] || options[:after]
         idx = stack.index(existing_name)
 
@@ -30,7 +49,14 @@ module Kuby
 
         idx += 1 if options[:after]
         stack.insert(idx, name)
-        layers[name] = layer
+
+        if layer
+          layers[name] = layer
+        elsif block_given?
+          layers[name] = InlineLayer.new(block)
+        else
+          raise "Must either pass a layer object or a block to `#{__method__}'"
+        end
       end
 
       def delete(name)

data/lib/kuby/docker/metadata.rb

@@ -4,11 +4,11 @@ module Kuby
   module Docker
     class Metadata
       DEFAULT_DISTRO = :debian
-      DEFAULT_REGISTRY_HOST = 'https://docker.io'.freeze
+      DEFAULT_REGISTRY_HOST = 'https://www.docker.com'.freeze
       LATEST_TAG = 'latest'
 
       attr_accessor :image_url
-      attr_reader :definition, :distro
+      attr_reader :definition
 
       def initialize(definition)
         @definition = definition
@@ -28,6 +28,10 @@ module Kuby
         end
       end
 
+      def image_hostname
+        @image_hostname ||= URI(image_host).host
+      end
+
       def image_repo
         @image_repo ||= if image_url.include?('/')
           parse_url(image_url).path.sub(/\A\//, '')
@@ -62,6 +66,10 @@ module Kuby
         t.to_s
       end
 
+      def distro
+        @distro || DEFAULT_DISTRO
+      end
+
       def distro=(distro_name)
         @distro = distro_name
       end