kuby-core 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b6d5377f043be7d0aa02cddf817a9dd7fdbaa500c2ed94a2fdb92fa7ef0c1cc
-  data.tar.gz: 57c6cb1a15c4385a7675a05637dbfd085e2b2f438f5429104ec66203e854dd68
+  metadata.gz: 0a5f265cee423b7487de7e4c209b26cc9fef63cf584455bc4164ecd7e6384377
+  data.tar.gz: e48304bf9397b30ceed7025039d074e55423ced190f734a416a311e412bd609d
 SHA512:
-  metadata.gz: 9c903b0768473d63df1a3ddb9ee3146193abad9c809614f7ccd2e7b7c711a2a3effd3810a3b67780ee68ea3198b8770099fcb3fd4d2a334b39b664f59b8e9e8f
-  data.tar.gz: 69fc8934c14181930c03d3d3ffe050e2da0a85edbbd2f5bba38bf0509131149c643ea42577afcec3a4625057eab52f57bab1e00c3271bedcf491d2e11f1ae696
+  metadata.gz: d4cbd6c2fbf6de8f621d4b2412bb4c1921eff7e5ba3c90b5afefac3c0d216aff676772b0582dab70a688c3c1dc7ce55a48f9c42f3b178ad25f31d489a3f33421
+  data.tar.gz: b9b3f808ed6184c73edb8652a958cd53b12337c8a48bf2f19d188b07c1c4d56283f7bfbfffd2a9338dc522a2376f8665e9c792571b4fdb609bf14b0181efcc16

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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)

data/lib/kuby/commands.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: false
 
 require 'kuby/version'
 require 'gli'
@@ -170,7 +170,7 @@ 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|
-          tasks.remote_exec([*args, *@rails_options])
+          tasks.remote_exec([*args, *T.unsafe(@rails_options)])
         end
       end
 

data/lib/kuby/docker/app_image.rb

@@ -11,11 +11,12 @@ module Kuby
           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, main_tag = nil, alias_tags = [])
+      def initialize(dockerfile, image_url, credentials, registry_index_url = nil, main_tag = nil, alias_tags = [])
         super
         @identifier = "app"
       end

data/lib/kuby/docker/docker_uri.rb

@@ -5,11 +5,36 @@ module Kuby
     class DockerURI
       extend T::Sig
 
-      DEFAULT_REGISTRY_HOST = T.let('index.docker.io'.freeze, String)
-      DEFAULT_REGISTRY_PORT = T.let(443, Integer)
+      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(url)
+      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
@@ -17,9 +42,9 @@ module Kuby
         host_port, *path = url.split('/')
         host, port, *path = if host_port =~ /[.:]/
           hst, prt = T.must(host_port).split(':')
-          [T.must(hst), prt || DEFAULT_REGISTRY_PORT, *path]
+          [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.to_s, port.to_i, (path || []).join('/'))
@@ -40,6 +65,11 @@ module Kuby
         @port = port
         @path = path
       end
+
+      sig { returns(T::Boolean) }
+      def has_default_port?
+        port == DEFAULT_PORT
+      end
     end
   end
 end

data/lib/kuby/docker/image.rb

@@ -11,6 +11,9 @@ module Kuby
       sig { returns(String) }
       attr_reader :image_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :registry_index_url
+
       sig { returns(Credentials) }
       attr_reader :credentials
 
@@ -25,13 +28,15 @@ module Kuby
           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, main_tag = nil, alias_tags = [])
+      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])
@@ -39,6 +44,9 @@ module Kuby
 
         @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))
@@ -73,6 +81,16 @@ module Kuby
         @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
@@ -85,7 +103,12 @@ module Kuby
 
       sig { returns(DockerURI) }
       def image_uri
-        @full_image_uri ||= DockerURI.parse(image_url)
+        @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]) }
@@ -112,7 +135,7 @@ module Kuby
 
       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, main_tag, alias_tags)
+        self.class.new(dockerfile, image_url, credentials, registry_index_url, main_tag, alias_tags)
       end
     end
   end

data/lib/kuby/docker/spec.rb

@@ -13,6 +13,9 @@ module Kuby
       sig { returns(T.nilable(String)) }
       attr_reader :image_url_str
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :registry_index_url_str
+
       sig { params(environment: Environment).void }
       def initialize(environment)
         @environment = environment
@@ -31,6 +34,7 @@ module Kuby
         @layer_stack = T.let(@layer_stack, T.nilable(Kuby::Docker::LayerStack))
 
         @image_url_str = T.let(@image_url_str, T.nilable(String))
+        @registry_index_url_str = T.let(@registry_index_url_str, T.nilable(String))
         @image = T.let(@image, T.nilable(Docker::AppImage))
       end
 
@@ -96,6 +100,11 @@ module Kuby
         @image_url_str = url
       end
 
+      sig { params(url: String).void }
+      def registry_index_url(url)
+        @registry_index_url_str = url
+      end
+
       sig {
         params(
           name: Symbol,
@@ -148,7 +157,7 @@ module Kuby
           end
 
           Docker::AppImage.new(
-            dockerfile, T.must(image_url_str), credentials
+            dockerfile, T.must(image_url_str), credentials, registry_index_url_str
           )
         end
       end

data/lib/kuby/docker/timestamped_image.rb

@@ -12,11 +12,12 @@ module Kuby
           dockerfile: T.any(Dockerfile, T.proc.returns(Dockerfile)),
           image_url: String,
           credentials: Credentials,
+          registry_index_url_str: T.nilable(String),
           main_tag: T.nilable(String),
           alias_tags: T::Array[String]
         ).void
       }
-      def initialize(dockerfile, image_url, credentials, main_tag = nil, alias_tags = [])
+      def initialize(dockerfile, image_url, credentials, registry_index_url_str = nil, main_tag = nil, alias_tags = [])
         @new_version = T.let(@new_version, T.nilable(Image))
         @current_version = T.let(@current_version, T.nilable(Image))
         @previous_version = T.let(@previous_version, T.nilable(Image))
@@ -90,7 +91,7 @@ module Kuby
       sig { returns(::Docker::Remote::Client) }
       def remote_client
         @remote_client ||= ::Docker::Remote::Client.new(
-          image_host, image_repo, credentials.username, credentials.password,
+          registry_index_host, image_repo, credentials.username, credentials.password,
         )
       end
 
@@ -106,7 +107,7 @@ module Kuby
 
       sig { returns(RemoteTags) }
       def remote
-        @remote ||= RemoteTags.new(remote_client, image_url)
+        @remote ||= RemoteTags.new(remote_client, registry_index_host)
       end
     end
   end

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

@@ -296,7 +296,7 @@ module Kuby
         end
 
         def image
-          @image ||= RailsApp::AssetsImage.new(docker.image, -> { dockerfile })
+          @image ||= RailsApp::AssetsImage.new(docker.image, -> { dockerfile }, docker.image.registry_index_url)
         end
 
         private
@@ -324,6 +324,7 @@ module Kuby
               if tag
                 image_name = "#{app_name}-#{tag}"
                 df.from("#{base_image.image_url}:#{tag}", as: image_name)
+                df.arg('RAILS_MASTER_KEY')
                 df.copy("--from=#{prev_image_name} #{RAILS_MOUNT_PATH}", RAILS_MOUNT_PATH)
                 df.run("env RAILS_MASTER_KEY=$RAILS_MASTER_KEY bundle exec rake kuby:rails_app:assets:copy")
               end

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

@@ -4,8 +4,8 @@ module Kuby
       class AssetsImage < ::Kuby::Docker::Image
         attr_reader :base_image
 
-        def initialize(base_image, dockerfile, main_tag = nil, alias_tags = [])
-          super(dockerfile, base_image.image_url, base_image.credentials, main_tag, alias_tags)
+        def initialize(base_image, dockerfile, registry_index_url = nil, main_tag = nil, alias_tags = [])
+          super(dockerfile, base_image.image_url, base_image.credentials, registry_index_url, main_tag, alias_tags)
           @base_image = base_image
           @identifier = "assets"
         end
@@ -42,6 +42,7 @@ module Kuby
           self.class.new(
             base_image,
             dockerfile,
+            registry_index_url,
             annotate_tag(image.main_tag),
             image.alias_tags.map { |at| annotate_tag(at) }
           )

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

@@ -86,16 +86,38 @@ class KubyGenerator < Rails::Generators::Base
     create_file(
       '.dockerignore',
       <<~END
-        .bundle/
-        vendor/bundle
-        node_modules/
-        .node_modules/
-        **/.git*
-        tmp/
-        log/
-        engines/**/log/
-        engines/**/tmp/
+        .git/
+
+        # Ignore bundler config.
+        .bundle
+
+        # Ignore all logfiles and tempfiles.
+        log/*
+        tmp/*
+        !log/.keep
+        !tmp/.keep
+
+        # Ignore pidfiles, but keep the directory.
+        tmp/pids/*
+        !tmp/pids/
+        !tmp/pids/.keep
+
+        # Ignore uploaded files in development.
+        storage/*
+        !storage/.keep
+
         public/assets
+        **/.byebug_history
+
+        # Ignore master key for decrypting credentials and more.
+        config/master.key
+
+        public/packs
+        public/packs-test
+        node_modules
+        yarn-error.log
+        **/yarn-debug.log*
+        **/.yarn-integrity
       END
     )
   end

data/lib/kuby/tasks.rb

@@ -29,9 +29,13 @@ module Kuby
     end
 
     def build(build_args = {}, docker_args = [], only = nil)
+      check_platform(docker_args)
+
       kubernetes.docker_images.each do |image|
         next if only && image.identifier != only
 
+        return unless perform_docker_login_if_necessary(image)
+
         image = image.new_version
         Kuby.logger.info("Building image #{image.image_url} with tags #{image.tags.join(', ')}")
         image.build(build_args, docker_args)
@@ -49,21 +53,7 @@ module Kuby
     end
 
     def push_image(image)
-      if image.credentials.username && !image.docker_cli.auths.include?(image.image_host)
-        Kuby.logger.info("Attempting to log in to registry at #{image.image_host}")
-
-        begin
-          image.docker_cli.login(
-            url: image.image_host,
-            username: image.credentials.username,
-            password: image.credentials.password
-          )
-        rescue Kuby::Docker::LoginError => e
-          Kuby.logger.fatal("Couldn't log in to the registry at #{image.image_host}")
-          Kuby.logger.fatal(e.message)
-          return
-        end
-      end
+      return unless perform_docker_login_if_necessary(image)
 
       begin
         image.tags.each { |tag| image.push(tag) }
@@ -145,6 +135,71 @@ module Kuby
 
     private
 
+    def check_platform(docker_args)
+      arch, * = RUBY_PLATFORM.split('-')
+
+      if arch != 'x86_64' && !docker_args.include?('--platform')
+        Kuby.logger.fatal(<<~END)
+          Hey there! It looks like your processor isn't x86-compatible.
+          By default, Docker will try to build images that match the
+          current architecture, in this case #{arch}. Most hosting
+          providers run x86 hardware, meaning Docker images built using
+          this computer's architecture might fail to run when deployed
+          to production. You can fix this by running the build command
+          with a special --platform flag, eg:
+
+          bundle exec kuby -e production build -- --platform linux/amd64
+
+          If you meant to build for the current architecture, you can
+          prevent this error by passing the --platform argument for the
+          current architecture, eg. --platform linux/arm64 for ARM, etc.
+        END
+
+        exit 1
+      end
+    end
+
+    def perform_docker_login_if_necessary(image)
+      auth_uris = image.docker_cli.auths.map do |url|
+        Kuby::Docker::DockerURI.parse_uri(url)
+      end
+
+      logged_in = image.credentials.username && (
+        auth_uris.any? do |uri|
+          image.image_hostname == uri.host ||
+            image.registry_index_hostname == uri.host
+        end
+      )
+
+      if !logged_in
+        Kuby.logger.info("Attempting to log in to registry at #{image.image_host}")
+
+        begin
+          # For some reason, Docker login with a port doesn't work for some
+          # registries (most notably Docker Hub). Since the default is 443 anyway,
+          # it should be fine to omit it.
+          url = if image.image_uri.has_default_port?
+            image.image_hostname  # host without port
+          else
+            image.image_host      # host with port
+          end
+
+          image.docker_cli.login(
+            url: url,
+            username: image.credentials.username,
+            password: image.credentials.password
+          )
+        rescue Kuby::Docker::LoginError => e
+          Kuby.logger.fatal("Couldn't log in to the registry at #{image.image_host}")
+          Kuby.logger.fatal(e.message)
+
+          return false
+        end
+      end
+
+      true
+    end
+
     def get_first_pod
       pods = kubernetes_cli.get_objects(
         'pods', namespace, match_labels.serialize

data/lib/kuby/version.rb

@@ -1,5 +1,5 @@
 # typed: true
 
 module Kuby
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.15.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuby-core
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-28 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize