kuby-core 0.11.16 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01cc5428a8bc4bfc44143f4aa2c2e949405d3c7231831da50f33efa5a314fc29
-  data.tar.gz: c4e440506c9ad072449f3382bcfa7dd1f80c757e64426b5c49f1e20540c57ae8
+  metadata.gz: 0a5f265cee423b7487de7e4c209b26cc9fef63cf584455bc4164ecd7e6384377
+  data.tar.gz: e48304bf9397b30ceed7025039d074e55423ced190f734a416a311e412bd609d
 SHA512:
-  metadata.gz: 5db95c1958618d58354ba4c87411a0cd52894ede6ba0fbd622479e66e327397967314979c7496806577115d6b22571582e17f76c720a8472c9568cb009682555
-  data.tar.gz: 2c1c1bd58fcbc7d29380e5e2ef2cf71b68f7073dbff26ca5d73333734b326dccc42243a559b3272502b4a6628db0c7513ea9b6586b5475e44108ba4a490734f5
+  metadata.gz: d4cbd6c2fbf6de8f621d4b2412bb4c1921eff7e5ba3c90b5afefac3c0d216aff676772b0582dab70a688c3c1dc7ce55a48f9c42f3b178ad25f31d489a3f33421
+  data.tar.gz: b9b3f808ed6184c73edb8652a958cd53b12337c8a48bf2f19d188b07c1c4d56283f7bfbfffd2a9338dc522a2376f8665e9c792571b4fdb609bf14b0181efcc16

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## 0.15.0
+* Add an extra parameter to the Docker spec for specifying the URL of the Docker registry index.
+  - In most cases, the registry and registry index URLs will be the same. However Docker Hub, the default registry, uses index.docker.io for API requests (catalog, tags, etc) but only allows pushes to docker.io.
+* Add config/master.key to the .dockerignore created by the Rails generator.
+  - This was an unfortunate oversight, but such are the perils of using pre-1.0 software.
+* Print an error message if building images on non-x86 hardware.
+  - People with M1 Macs are running into mismatches between their laptop's arch and the arch of their hosting provider's hardware. The error message asks you to explicitly pass the `--platform` flag to Docker.
+  - We may need to revisit this in the future if ARM processors become more popular.
+
+## 0.14.0
+* Make RAILS_MASTER_KEY available in the assets image (@palkan, #63)
+* Allow specifying custom docker build options via CLI (@palkan, #65)
+
+## 0.13.0
+* Fix handling rails/rake options in remote exec (@palkan, #60)
+* Add `bundler_phase.gemfiles(*paths)` to allow adding additional gemfiles (@palkan, #61)
+
+## 0.12.0
+* Fix issue causing volume mount errors when k8s tries to schedule asset pods on multiple nodes (fixes #42).
+  - Persistent volumes can only be mounted on a single physical node.
+  - Kuby now creates a separate assets image powered by nginx.
+  - Ingress routes requests to either the Rails service or assets service depending on the URL (i.e. /assets).
+  - Since the ingress layer is now essential, the Docker Desktop provider no longer deletes ingresses or monkeys with service objects. You'll have to either 1) add an entry for your hostname to your hosts file, or 2) set the `Host` header when making requests to your app.
+* Plugins can now specify additional Dockerfiles to build during `kuby build`.
+* Switch from TravisCI to Github Actions.
+* Remove support for development environments.
+  - Proved to be too difficult to maintain.
+  - Kuby is a _deployment_ tool anyway, not a dev tool.
+  - Maybe we can turn the dev stuff into a gem at some point.
+* Refactor Docker image logic.
+  - Introduced the `Image` class and friends.
+  - Deleted the `Kuby::Docker::Metadata` class.
+* Add missing git dependency to Alpine distro.
+* Add a bare metal provider (fixes #10).
+
 ## 0.11.16
 * Fix yarn phase
   - Apparently you have to copy at least one file, TIL.

data/Gemfile

@@ -6,10 +6,9 @@ group :development, :test do
   gem 'pry-byebug'
   gem 'rake'
   # lock to a specific version to prevent breaking CI when new versions come out
-  gem 'sorbet', '= 0.5.6397'
+  gem 'sorbet', '= 0.5.6433'
 end
 
 group :test do
   gem 'rspec', '~> 3.0'
-  gem 'timecop', '~> 0.9'
 end

data/README.md

@@ -1,6 +1,7 @@
 ## Kuby
 
-[![Build Status](https://travis-ci.com/getkuby/kuby-core.svg?branch=master)](https://travis-ci.com/getkuby/kuby-core)
+![Unit Tests](https://github.com/getkuby/kuby-core/actions/workflows/unit_tests.yml/badge.svg?branch=master)
+![Integration Tests](https://github.com/getkuby/kuby-core/actions/workflows/integration_tests.yml/badge.svg?branch=master)
 
 Deploy your Rails app the easy way.
 

data/kuby-core.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.add_dependency 'colorize', '~> 0.8'
-  s.add_dependency 'docker-remote', '~> 0.5'
+  s.add_dependency 'docker-remote', '~> 0.6'
   s.add_dependency 'gli', '~> 2.0'
   s.add_dependency 'helm-cli', '~> 0.3'
   # See: https://github.com/Shopify/krane/pull/720

data/lib/kuby/commands.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: false
 
 require 'kuby/version'
 require 'gli'
@@ -25,9 +25,10 @@ module Kuby
       def run(args)
         if idx = args.index('rails') || idx = args.index('rake')
           @rails_options = T.let(@rails_options, T.nilable(T::Array[String]))
-          @rails_options = args[idx..-1]
+          @rails_options = args[(idx + 1)..-1]
           super(args[0..idx])
         else
+          @rails_options = []
           super
         end
       end
@@ -38,13 +39,6 @@ module Kuby
       Kuby::Tasks.new(Kuby.environment)
     end
 
-    sig { void }
-    def self.must_be_dev_env!
-      unless Kuby.environment.development?
-        fail "Command not supported in the '#{Kuby.environment.name}' environment"
-      end
-    end
-
     program_desc 'Kuby command-line interface. Kuby is a convention '\
       'over configuration approach for running Rails apps in Kubernetes.'
 
@@ -68,66 +62,28 @@ module Kuby
       true
     end
 
-    # These are only stubs included to fill out the help screens. Rails
-    # commands are handled by the RailsCommands class.
-    desc 'Runs a Rails command.'
-    command :rails do |rc|
-      rc.action do |global_options, options, args|
-        must_be_dev_env!
-        exit 1 unless tasks.dev_deployment_ok
-        @rails_options = T.let(@rails_options, T.nilable(T::Array[String]))
-        Kuby::RailsCommands.run(@rails_options)
-      end
-
-      rc.desc 'Runs the rails server (run `rails server --help` for options)'
-      rc.command [:server, :s] do |c|
-        c.action do |global_options, options, args|
-          must_be_dev_env!
-          exit 1 unless tasks.dev_deployment_ok
-          Kuby::RailsCommands.run(@rails_options)
-        end
-      end
-
-      rc.desc 'Runs a script in the Rails environment (run `rails runner --help` for options)'
-      rc.command [:runner, :r] do |c|
-        c.action do |global_options, options, args|
-          must_be_dev_env!
-          exit 1 unless tasks.dev_deployment_ok
-          Kuby::RailsCommands.run(@rails_options)
-        end
-      end
-
-      rc.desc 'Starts an interactive Ruby console with the Rails environment loaded '\
-        '(run `rails console --help` for options)'
-      rc.command [:console, :c] do |c|
-        c.action do |global_options, options, args|
-          must_be_dev_env!
-          exit 1 unless tasks.dev_deployment_ok
-          Kuby::RailsCommands.run(@rails_options)
-        end
-      end
-    end
-
-    desc 'Runs a rake task.'
-    command :rake do |rc|
-      rc.action do |global_options, options, args|
-        must_be_dev_env!
-        exit 1 unless tasks.dev_deployment_ok
-        Kuby::RailsCommands.run(@rails_options)
-      end
-    end
-
     desc 'Builds the Docker image.'
     command :build do |c|
-      c.action do |global_options, options, args|
-        tasks.build
+      c.flag [:a, :arg], required: false, multiple: true
+      c.flag [:only], required: false
+      c.action do |global_options, options, docker_args|
+        build_args = {}.tap do |build_args|
+          (options[:arg] || []).each do |a|
+            key, value = a.split('=', 2)
+            value = value[1..-2] if value.start_with?('"') || value.start_with?("'")
+            build_args[key] = value
+          end
+        end
+
+        tasks.build(build_args, docker_args, options[:only])
       end
     end
 
     desc 'Pushes the Docker image to the configured registry.'
     command :push do |c|
+      c.flag [:only], required: false
       c.action do |global_options, options, args|
-        tasks.push
+        tasks.push(options[:only])
       end
     end
 
@@ -138,10 +94,11 @@ module Kuby
       end
     end
 
-    desc 'Prints the effective Dockerfile used to build the Docker image.'
-    command :dockerfile do |c|
+    desc 'Prints the effective Dockerfiles used to build Docker images.'
+    command :dockerfiles do |c|
+      c.flag [:only], required: false
       c.action do |global_options, options, args|
-        tasks.print_dockerfile
+        tasks.print_dockerfiles(options[:only])
       end
     end
 
@@ -163,8 +120,10 @@ module Kuby
 
     desc 'Prints the effective Kubernetes resources that will be applied on deploy.'
     command :resources do |c|
+      c.flag [:K, :kind], required: false
+      c.flag [:N, :name], required: false
       c.action do |global_options, options, args|
-        tasks.print_resources
+        tasks.print_resources(options[:kind], options[:name])
       end
     end
 
@@ -197,7 +156,6 @@ module Kuby
       rc.desc 'Tails (i.e. continuously streams) the Rails log from your running application.'
       rc.command :logs do |c|
         c.action do |global_options, options, args|
-          exit 1 unless tasks.dev_deployment_ok
           tasks.remote_logs
         end
       end
@@ -205,7 +163,6 @@ module Kuby
       rc.desc 'Lists running Kubernetes pods.'
       rc.command :status do |c|
         c.action do |global_options, options, args|
-          exit 1 unless tasks.dev_deployment_ok
           tasks.remote_status
         end
       end
@@ -213,15 +170,13 @@ module Kuby
       rc.desc 'Runs an arbitrary command inside a running Rails pod.'
       rc.command :exec do |c|
         c.action do |global_options, options, args|
-          exit 1 unless tasks.dev_deployment_ok
-          tasks.remote_exec(args)
+          tasks.remote_exec([*args, *T.unsafe(@rails_options)])
         end
       end
 
       rc.desc 'Establishes a shell inside a running Rails pod.'
       rc.command :shell do |c|
         c.action do |global_options, options, args|
-          exit 1 unless tasks.dev_deployment_ok
           tasks.remote_shell
         end
       end
@@ -229,7 +184,6 @@ module Kuby
       rc.desc 'Establishes a Rails console inside a running Rails pod.'
       rc.command :console do |c|
         c.action do |global_options, options, args|
-          exit 1 unless tasks.dev_deployment_ok
           tasks.remote_console
         end
       end
@@ -237,7 +191,6 @@ module Kuby
       rc.desc 'Establishes a database console inside a running Rails pod.'
       rc.command :dbconsole do |c|
         c.action do |global_options, options, args|
-          exit 1 unless tasks.dev_deployment_ok
           tasks.remote_dbconsole
         end
       end
@@ -245,7 +198,6 @@ module Kuby
       rc.desc "Restarts the Rails app's web pods."
       rc.command :restart do |c|
         c.action do |global_options, options, args|
-          exit 1 unless tasks.dev_deployment_ok
           tasks.remote_restart
         end
       end

data/lib/kuby/docker/alpine.rb

@@ -10,7 +10,8 @@ module Kuby
         [:nodejs, '12.14.1'],
         [:yarn, '1.21.1'],
         [:c_toolchain, nil],
-        [:tzdata, nil]
+        [:tzdata, nil],
+        [:git, nil]
       ].freeze, T::Array[[Symbol, T.nilable(String)]])
 
       sig { returns(Layer) }

data/lib/kuby/docker/app_image.rb

@@ -0,0 +1,34 @@
+
+# typed: strict
+
+module Kuby
+  module Docker
+    class AppImage < ::Kuby::Docker::TimestampedImage
+      extend T::Sig
+
+      sig {
+        params(
+          dockerfile: T.any(Dockerfile, T.proc.returns(Dockerfile)),
+          image_url: String,
+          credentials: Credentials,
+          registry_index_url: T.nilable(String),
+          main_tag: T.nilable(String),
+          alias_tags: T::Array[String]
+        ).void
+      }
+      def initialize(dockerfile, image_url, credentials, registry_index_url = nil, main_tag = nil, alias_tags = [])
+        super
+        @identifier = "app"
+      end
+
+      sig { params(build_args: T::Hash[String, String], docker_args: T::Array[String]).returns(AppImage) }
+      def build(build_args = {}, docker_args = [])
+        unless ENV.fetch('RAILS_MASTER_KEY', '').empty?
+          build_args['RAILS_MASTER_KEY'] = T.must(ENV['RAILS_MASTER_KEY'])
+        end
+
+        super(build_args, docker_args)
+      end
+    end
+  end
+end

data/lib/kuby/docker/bundler_phase.rb

@@ -35,6 +35,7 @@ module Kuby
 
         @version = T.let(@version, T.nilable(String))
         @gemfile = T.let(@gemfile, T.nilable(String))
+        @gemfiles = T.let([], T::Array[String])
         @without = T.let(@without, T.nilable(T::Array[String]))
       end
 
@@ -51,6 +52,10 @@ module Kuby
         dockerfile.copy(gf, '.')
         dockerfile.copy(lf, '.')
 
+        @gemfiles.each do |file|
+          dockerfile.copy(file, file)
+        end
+
         unless wo.empty?
           dockerfile.env("BUNDLE_WITHOUT='#{wo.join(' ')}'")
         end
@@ -67,6 +72,11 @@ module Kuby
         dockerfile.env("PATH=./bin:$PATH")
       end
 
+      sig { params(paths: String).void }
+      def gemfiles(*paths)
+        @gemfiles.concat(paths)
+      end
+
       private
 
       sig { returns(String) }

data/lib/kuby/docker/cli.rb

@@ -53,27 +53,21 @@ module Kuby
         config.fetch('auths', {}).keys
       end
 
-      sig {
-        params(
-          dockerfile: Dockerfile,
-          image_url: String,
-          tags: T::Array[String],
-          build_args: T::Hash[T.any(Symbol, String), String]
-        )
-        .void
-      }
-      def build(dockerfile:, image_url:, tags:, build_args: {})
+      sig { params(image: Image, build_args: T::Hash[T.any(Symbol, String), String], docker_args: T::Array[String]).void }
+      def build(image, build_args: {}, docker_args: [])
         cmd = [
           executable, 'build',
-          *tags.flat_map { |tag| ['-t', "#{image_url}:#{tag}"] },
+          *image.tags.flat_map { |tag| ['-t', "#{image.image_url}:#{tag}"] },
           *build_args.flat_map do |arg, val|
             ['--build-arg', Shellwords.shellescape("#{arg}=#{val}")]
           end,
-          '-f-', '.'
+          '-f-',
+          *docker_args,
+          '.'
         ]
 
         open3_w(cmd) do |stdin, _wait_threads|
-          stdin.puts(dockerfile.to_s)
+          stdin.puts(image.dockerfile.to_s)
         end
 
         unless T.must(last_status).success?

data/lib/kuby/docker/docker_uri.rb

@@ -1,34 +1,75 @@
-# typed: false
+# typed: strict
 
 module Kuby
   module Docker
     class DockerURI
-      DEFAULT_REGISTRY_HOST = 'index.docker.io'.freeze
-      DEFAULT_REGISTRY_PORT = 443
+      extend T::Sig
 
-      def self.parse(url)
+      DEFAULT_REGISTRY_HOST = T.let('docker.io'.freeze, String)
+      DEFAULT_REGISTRY_INDEX_HOST = T.let('index.docker.io'.freeze, String)
+      DEFAULT_PORT = T.let(443, Integer)
+
+      sig { params(url: String).returns(DockerURI) }
+      def self.parse_uri(url)
+        parse(
+          url,
+          default_host: DEFAULT_REGISTRY_HOST,
+          default_port: DEFAULT_PORT
+        )
+      end
+
+      sig { params(url: String).returns(DockerURI) }
+      def self.parse_index_uri(url)
+        parse(
+          url,
+          default_host: DEFAULT_REGISTRY_INDEX_HOST,
+          default_port: DEFAULT_PORT
+        )
+      end
+
+      sig {
+        params(
+          url: String,
+          default_host: T.nilable(String),
+          default_port: T.nilable(Integer)
+        ).returns(DockerURI)
+      }
+      def self.parse(url, default_host:, default_port:)
         if idx = url.index('://')
           url = url[(idx + 3)..-1] || ''
         end
 
         host_port, *path = url.split('/')
         host, port, *path = if host_port =~ /[.:]/
-          hst, prt = host_port.split(':')
-          [hst, prt || DEFAULT_REGISTRY_PORT, *path]
+          hst, prt = T.must(host_port).split(':')
+          [T.must(hst), prt || default_port, *path]
         else
-          [DEFAULT_REGISTRY_HOST, DEFAULT_REGISTRY_PORT, host_port, *path]
+          [default_host, default_port, host_port, *path]
         end
 
-        new(host, port.to_i, path.join('/'))
+        new(host.to_s, port.to_i, (path || []).join('/'))
       end
 
-      attr_reader :host, :port, :path
+      sig { returns(String) }
+      attr_reader :host
 
+      sig { returns(Integer) }
+      attr_reader :port
+
+      sig { returns(String) }
+      attr_reader :path
+
+      sig { params(host: String, port: Integer, path: String).void }
       def initialize(host, port, path)
         @host = host
         @port = port
         @path = path
       end
+
+      sig { returns(T::Boolean) }
+      def has_default_port?
+        port == DEFAULT_PORT
+      end
     end
   end
 end

data/lib/kuby/docker/errors.rb

@@ -6,25 +6,7 @@ module Kuby
     class PushError < StandardError; end
     class PullError < StandardError; end
     class LoginError < StandardError; end
-
-    class MissingTagError < StandardError
-      extend T::Sig
-
-      sig { returns(String) }
-      attr_reader :tag
-
-      sig { params(tag: String).void }
-      def initialize(tag)
-        @tag = tag
-        @message = T.let(@message, T.nilable(String))
-      end
-
-      sig { returns(String) }
-      def message
-        @message ||= "Could not find tag '#{tag}'."
-      end
-    end
-
+    class MissingTagError < StandardError; end
     class UnsupportedDistroError < StandardError; end
     class MissingPackageError < StandardError; end
     class MissingDistroError < StandardError; end

data/lib/kuby/docker/image.rb

@@ -0,0 +1,142 @@
+# typed: strict
+
+module Kuby
+  module Docker
+    class Image
+      extend T::Sig
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :identifier
+
+      sig { returns(String) }
+      attr_reader :image_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :registry_index_url
+
+      sig { returns(Credentials) }
+      attr_reader :credentials
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :main_tag
+
+      sig { returns T::Array[String] }
+      attr_reader :alias_tags
+
+      sig {
+        params(
+          dockerfile: T.any(Dockerfile, T.proc.returns(Dockerfile)),
+          image_url: String,
+          credentials: Credentials,
+          registry_index_url: T.nilable(String),
+          main_tag: T.nilable(String),
+          alias_tags: T::Array[String]
+        ).void
+      }
+      def initialize(dockerfile, image_url, credentials, registry_index_url = nil, main_tag = nil, alias_tags = [])
+        @dockerfile = T.let(dockerfile, T.any(Dockerfile, T.proc.returns(Dockerfile)))
+        @image_url = T.let(image_url, String)
+        @registry_index_url = T.let(registry_index_url, T.nilable(String))
+        @credentials = T.let(credentials, Credentials)
+        @main_tag = T.let(main_tag, T.nilable(String))
+        @alias_tags = T.let(alias_tags, T::Array[String])
+        @identifier = T.let(@identifier, T.nilable(String))
+
+        @image_host = T.let(@image_host, T.nilable(String))
+        @image_hostname = T.let(@image_hostname, T.nilable(String))
+        @registry_index_host = T.let(@registry_index_host, T.nilable(String))
+        @registry_index_hostname = T.let(@registry_index_hostname, T.nilable(String))
+        @registry_index_uri = T.let(@registry_index_uri, T.nilable(DockerURI))
+        @image_repo = T.let(@image_repo, T.nilable(String))
+        @full_image_uri = T.let(@full_image_uri, T.nilable(DockerURI))
+        @docker_cli = T.let(@docker_cli, T.nilable(Docker::CLI))
+      end
+
+      sig { returns(Image) }
+      def new_version
+        raise NotImplementedError, 'please use a Docker::Image subclass'
+      end
+
+      sig { returns(Image) }
+      def current_version
+        raise NotImplementedError, 'please use a Docker::Image subclass'
+      end
+
+      sig { params(current_tag: T.nilable(String)).returns(Image) }
+      def previous_version(current_tag = nil)
+        raise NotImplementedError, 'please use a Docker::Image subclass'
+      end
+
+      sig { returns(Dockerfile) }
+      def dockerfile
+        if @dockerfile.respond_to?(:call)
+          T.cast(@dockerfile, T.proc.returns(Dockerfile)).call
+        else
+          T.cast(@dockerfile, Dockerfile)
+        end
+      end
+
+      sig { returns(String) }
+      def image_host
+        @image_host ||= "#{image_uri.host}:#{image_uri.port}"
+      end
+
+      sig { returns(String) }
+      def registry_index_host
+        @registry_index_host ||= "#{registry_index_uri.host}:#{registry_index_uri.port}"
+      end
+
+      sig { returns(String) }
+      def registry_index_hostname
+        @registry_index_hostname ||= registry_index_uri.host
+      end
+
+      sig { returns(String) }
+      def image_hostname
+        @image_hostname ||= image_uri.host
+      end
+
+      sig { returns(String) }
+      def image_repo
+        @image_repo ||= image_uri.path
+      end
+
+      sig { returns(DockerURI) }
+      def image_uri
+        @full_image_uri ||= DockerURI.parse_uri(image_url)
+      end
+
+      sig { returns(DockerURI) }
+      def registry_index_uri
+        @registry_index_uri ||= DockerURI.parse_index_uri(registry_index_url || image_url)
+      end
+
+      sig { returns(T::Array[String]) }
+      def tags
+        [main_tag, *alias_tags].compact
+      end
+
+      sig { params(build_args: T::Hash[String, String], docker_args: T::Array[String]).void }
+      def build(build_args = {}, docker_args = [])
+        raise NotImplementedError, 'please use a Docker::Image subclass'
+      end
+
+      sig { params(tag: String).void }
+      def push(tag)
+        raise NotImplementedError, 'please use a Docker::Image subclass'
+      end
+
+      sig { returns(Docker::CLI) }
+      def docker_cli
+        @docker_cli ||= Docker::CLI.new
+      end
+
+      private
+
+      sig { params(main_tag: String, alias_tags: T::Array[String]).returns(Image) }
+      def duplicate_with_tags(main_tag, alias_tags)
+        self.class.new(dockerfile, image_url, credentials, registry_index_url, main_tag, alias_tags)
+      end
+    end
+  end
+end

data/lib/kuby/docker/layer.rb

@@ -21,13 +21,6 @@ module Kuby
         raise NotImplementedError,
           "#{__method__} must be defined in derived classes"
       end
-
-      private
-
-      sig { returns(Metadata) }
-      def metadata
-        environment.docker.metadata
-      end
     end
   end
 end