kuby-core 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cbd792443dc33de6a20d02f6969f6d59d535f1b68fb75c9a8945615fd870a28
-  data.tar.gz: 3add1ef85d6758a2590d35d7aa0bfb4fffaeae55ef6567a34cf3b7557a56e55a
+  metadata.gz: 06ed279a1b0ecaac0daed1b868610bac67e6564611360de4cd841a24827438e2
+  data.tar.gz: f8616a5b0ab87c4fb71afa3afba0e001760b3c0855b7670b976013de3c1db5d6
 SHA512:
-  metadata.gz: 7d855f57aae01d93c2fa44e285ee417ebcc00f12de6f9c4b989a39626ec9ec13a4659eafe0b8924592de5d860666158376e5adbf69c70373703eb2a9074ca75d
-  data.tar.gz: dc553aa0b22e5ab262fa18fa1a60bebb421862eab7e747e06c63907fefe8f5371be56415d0bde2e959ffa775140b624aee3aa53006f1dbee272122c87bf53cc6
+  metadata.gz: d75bf991f55a97798152449606740b2d94c9a012ad7c17ea0b9b940c9ca9b3aad0e31baa4635ffeeec584144492d967054cdbfffa386c05c7427f1e90ac58e8f
+  data.tar.gz: 73b7718181d0e43ab1382c70a4a22da1835da30c887c2f42bc67bcce15d811aa0efab93df3a5fd6d28e2b2ce6d6dc3a73154a4cacdadcfeb9641ca0b2ba5604c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.17.1
+* Allow storage class to be customized when using the built-in bare metal provider.
+* Fix a bug where the assets image would be built using the previous app image instead of the current one.
+* Centralize the lookup of the Rails master key (not user-facing).
+* Add descriptions to numerous CLI commands and their arguments.
+* CLI now accepts multiple `--only` flags passed to subcommands like `build`, `push`, etc.
+* Allow running setup steps for individual plugins.
+
 ## 0.16.1
 * Fix a few bugs caused by leaving `continue-on-error: true` in the GitHub actions config 🤦
   - Docker builds would fail if no previous images existed in the registry.

data/lib/kuby/commands.rb

@@ -62,12 +62,22 @@ module Kuby
       true
     end
 
-    desc 'Builds the Docker image.'
+    desc 'Builds Docker images.'
     command :build do |c|
+      c.desc 'Docker build argument.'
       c.flag [:a, :arg], required: false, multiple: true
+
+      c.desc 'When enabled, ignores missing build arguments.'
       c.switch [:'ignore-missing-args'], required: false, default: false
-      c.flag [:only], required: false
+
+      c.desc 'Build only the images associated with the specified identifier(s). '\
+             'Run `kuby images` for a list of all valid identifiers (note that '\
+             'identifiers can be associated with more than one image).'
+      c.flag [:only], required: false, multiple: true
+
+      c.desc 'The directory to use as the Docker build context.'
       c.flag [:c, :context], required: false
+
       c.action do |global_options, options, docker_args|
         build_args = {}.tap do |build_args|
           (options[:arg] || []).each do |a|
@@ -86,9 +96,12 @@ module Kuby
       end
     end
 
-    desc 'Pushes the Docker image to the configured registry.'
+    desc 'Pushes Docker images to their associated registries.'
     command :push do |c|
-      c.flag [:only], required: false
+      c.desc 'Push only the images associated with the specified identifier(s). '\
+             'Run `kuby images` for a list of all valid identifiers (note that '\
+             'identifiers can be associated with more than one image).'
+      c.flag [:only], required: false, multiple: true
       c.action do |global_options, options, args|
         tasks.push(only: options[:only])
       end
@@ -96,14 +109,18 @@ module Kuby
 
     desc 'Gets your Kubernetes cluster ready to run your Rails app.'
     command :setup do |c|
+      c.desc 'Run the setup routines for only the specified plugin identifier(s).'
+      c.flag [:only], required: false, multiple: true
       c.action do |global_options, options, args|
-        tasks.setup
+        tasks.setup(only: options[:only])
       end
     end
 
     desc 'Prints the effective Dockerfiles used to build Docker images.'
     command :dockerfiles do |c|
-      c.flag [:only], required: false
+      c.desc 'Print Dockerfiles for only the images associated with the specified '\
+             'identifier(s).'
+      c.flag [:only], required: false, multiple: true
       c.action do |global_options, options, args|
         tasks.print_dockerfiles(only: options[:only])
       end
@@ -118,7 +135,7 @@ module Kuby
       end
     end
 
-    desc 'Rolls back to the previous Docker tag.'
+    desc 'Rolls back to the previous release.'
     command :rollback do |c|
       c.action do |global_options, options, args|
         tasks.rollback
@@ -127,25 +144,37 @@ module Kuby
 
     desc 'Prints the effective Kubernetes resources that will be applied on deploy.'
     command :resources do |c|
+      c.desc 'Only print resources of the given kind.'
       c.flag [:K, :kind], required: false
+
+      c.desc 'Only print resources that match the given name.'
       c.flag [:N, :name], required: false
+
       c.action do |global_options, options, args|
         tasks.print_resources(options[:kind], options[:name])
       end
     end
 
-    desc 'Prints out the contents of the kubeconfig Kuby is using to communicate with your cluster.'
+    desc 'Prints out the contents of the kubeconfig file Kuby is using to communicate '\
+         'with your cluster.'
     command :kubeconfig do |c|
       c.action do |global_options, options, args|
         tasks.print_kubeconfig
       end
     end
 
+    desc 'Prints out the URLs to the latest Docker images in the Docker registry.'
+    command :images do |c|
+      c.action do |global_options, options, args|
+        tasks.print_images
+      end
+    end
+
     desc 'Runs an arbitrary kubectl command.'
     command :kubectl do |c|
       c.desc 'Prefixes the kubectl command with the namespace associated with '\
-        'the current environment. For example, if the Kuby env is "production", '\
-        'this option will prefix the kubectl command with "-n myapp-production".'
+             'the current environment. For example, if the Kuby env is "production", '\
+             'this option will prefix the kubectl command with "-n myapp-production".'
       c.switch [:N, :namespaced], default: false
       c.action do |global_options, options, args|
         if options[:namespaced]

data/lib/kuby/docker/timestamped_image.rb

@@ -79,8 +79,6 @@ module Kuby
       sig { params(build_args: T::Hash[String, String], docker_args: T::Array[String], context: T.nilable(String)).void }
       def build(build_args = {}, docker_args = [], context: nil)
         docker_cli.build(new_version, build_args: build_args, docker_args: docker_args, context: context)
-        @current_version = new_version
-        @new_version = nil
       end
 
       sig { params(tag: String).void }

data/lib/kuby/kubernetes/bare_metal_provider.rb

@@ -7,12 +7,13 @@ module Kuby
     class BareMetalProvider < Provider
       extend T::Sig
 
-      STORAGE_CLASS_NAME = T.let('hostpath'.freeze, String)
+      DEFAULT_STORAGE_CLASS = T.let('hostpath'.freeze, String)
 
       class Config
         extend ::KubeDSL::ValueFields
 
         value_fields :kubeconfig
+        value_fields :storage_class
       end
 
       sig { returns(Config) }
@@ -36,7 +37,7 @@ module Kuby
 
       sig { returns(String) }
       def storage_class_name
-        STORAGE_CLASS_NAME
+        config.storage_class
       end
 
       private
@@ -46,6 +47,7 @@ module Kuby
         configure do
           # default kubeconfig path
           kubeconfig File.join(ENV['HOME'], '.kube', 'config')
+          storage_class DEFAULT_STORAGE_CLASS
         end
       end
     end

data/lib/kuby/kubernetes/spec.rb

@@ -89,13 +89,23 @@ module Kuby
         @tag = nil
       end
 
-      def setup
-        provider.before_setup
-        provider.setup
+      def setup(only: [])
+        plugins = if only.empty?
+          @plugins
+        else
+          @plugins.each_with_object({}) do |(name, plg), memo|
+            memo[name] = plg if only.include?(name)
+          end
+        end
+
+        if only.empty?
+          provider.before_setup
+          provider.setup
+        end
 
-        @plugins.each { |_, plg| plg.before_setup }
-        @plugins.each { |_, plg| plg.setup }
-        @plugins.each { |_, plg| plg.after_setup }
+        plugins.each { |_, plg| plg.before_setup }
+        plugins.each { |_, plg| plg.setup }
+        plugins.each { |_, plg| plg.after_setup }
 
         provider.after_setup
       end

data/lib/kuby/plugin.rb

@@ -12,6 +12,7 @@ module Kuby
       # do nothing by default
     end
 
+    # install any global resources like operators, etc
     def setup
       # do nothing by default
     end

data/lib/kuby/plugin_registry.rb

@@ -1,6 +1,8 @@
 # typed: false
 module Kuby
   class PluginRegistry
+    include Enumerable
+
     ANY = 'any'.freeze
 
     def register(plugin_name, plugin_klass, environment: ANY)
@@ -19,6 +21,19 @@ module Kuby
       plugins_by_env[environment] || plugins_by_env[ANY]
     end
 
+    def each(&block)
+      return to_enum(__method__) unless block
+
+      @plugins.each_pair do |plugin_name, plugins_by_env|
+        plugins_by_env.each_pair do |env, plugin_klass|
+          case env
+            when ANY, Kuby.env
+              yield plugin_name, plugin_klass
+          end
+        end
+      end
+    end
+
     private
 
     def plugins

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

@@ -11,9 +11,11 @@ module Kuby
         end
 
         def new_version
-          # Asset images track the base image, so return the current version
+          # Asset images track the base image, so return the new version
           # here. There can be no asset image without a base image.
-          current_version
+          @new_version ||= duplicate_with_annotated_tags(
+            base_image.new_version
+          )
         end
 
         def current_version
@@ -29,7 +31,7 @@ module Kuby
         end
 
         def build(build_args = {}, docker_args = [], context: nil)
-          docker_cli.build(current_version, build_args: build_args, docker_args: docker_args, context: context)
+          docker_cli.build(new_version, build_args: build_args, docker_args: docker_args, context: context)
         end
 
         def push(tag)

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

@@ -209,15 +209,7 @@ module Kuby
             type 'Opaque'
 
             data do
-              if master_key = ENV[MASTER_KEY_VAR]
-                add MASTER_KEY_VAR.to_sym, master_key
-              else
-                master_key_path = File.join(spec.root, 'config', 'master.key')
-
-                if File.exist?(master_key_path)
-                  add MASTER_KEY_VAR.to_sym, File.read(master_key_path).strip
-                end
-              end
+              add MASTER_KEY_VAR.to_sym, spec.master_key
             end
           end
 
@@ -434,6 +426,13 @@ module Kuby
         def namespace
           environment.kubernetes.namespace
         end
+
+        def master_key
+          @master_key ||= ENV[MASTER_KEY_VAR] || begin
+            master_key_path = File.join(root, 'config', 'master.key')
+            File.read(master_key_path).strip if File.exist?(master_key_path)
+          end
+        end
       end
     end
   end

data/lib/kuby/tasks.rb

@@ -24,23 +24,19 @@ module Kuby
       end
     end
 
-    def setup
-      environment.kubernetes.setup
+    def setup(only: [])
+      environment.kubernetes.setup(only: only.map(&:to_sym))
     end
 
-    def build(build_args = {}, docker_args = [], only: nil, ignore_missing_args: false, context: nil)
+    def build(build_args = {}, docker_args = [], only: [], ignore_missing_args: false, context: nil)
       check_platform(docker_args)
 
-      build_args['RAILS_MASTER_KEY'] ||= ENV['RAILS_MASTER_KEY'] || begin
-        master_key_file = File.join('config', 'master.key')
-        File.exist?(master_key_file) ? File.read(master_key_file).strip : nil
-      end
+      build_args['RAILS_MASTER_KEY'] ||= rails_app.master_key
 
       check_build_args(build_args) unless ignore_missing_args
 
       kubernetes.docker_images.each do |image|
-        next if only && image.identifier != only
-
+        next unless only.empty? || only.include?(image.identifier)
         return unless perform_docker_login_if_necessary(image)
 
         image = image.new_version
@@ -49,9 +45,9 @@ module Kuby
       end
     end
 
-    def push(only: nil)
+    def push(only: [])
       kubernetes.docker_images.each do |image|
-        next if only && image.identifier != only
+        next unless only.empty? || only.include?(image.identifier)
 
         image = image.current_version
         Kuby.logger.info("Pushing image #{image.image_url} with tags #{image.tags.join(', ')}")
@@ -101,6 +97,18 @@ module Kuby
       puts File.read(path)
     end
 
+    def print_images
+      rows = kubernetes.docker_images.flat_map do |image|
+        image = image.current_version
+
+        image.tags.map do |tag|
+          [image.identifier, "#{image.image_url}:#{tag}"]
+        end
+      end
+
+      puts Kuby::Utils::Table.new(%w(IDENTIFIER URL), rows).to_s
+    end
+
     def kubectl(*cmd)
       kubernetes_cli.run_cmd(cmd)
     end

data/lib/kuby/utils/table.rb

@@ -0,0 +1,35 @@
+module Kuby
+  module Utils
+    class Table
+      attr_reader :headers, :rows
+
+      def initialize(headers, rows)
+        @headers = headers
+        @rows = rows
+      end
+
+      def to_s
+        [headers, *rows].map { |vals| make_row(vals) }.join("\n")
+      end
+
+      private
+
+      def make_row(values)
+        columns = values.each_with_index.map do |value, idx|
+          col_width = col_width_at(idx) + 2
+          value.ljust(col_width, ' ')
+        end
+
+        columns.join
+      end
+
+      def col_width_at(idx)
+        col_widths[idx] ||= [headers[idx].size, *rows.map { |r| r[idx].size }].max
+      end
+
+      def col_widths
+        @col_widths ||= {}
+      end
+    end
+  end
+end

data/lib/kuby/utils.rb

@@ -0,0 +1,5 @@
+module Kuby
+  module Utils
+    autoload :Table, 'kuby/utils/table'
+  end
+end

data/lib/kuby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuby-core
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -285,6 +285,8 @@ files:
 - lib/kuby/railtie.rb
 - lib/kuby/tasks.rb
 - lib/kuby/trailing_hash.rb
+- lib/kuby/utils.rb
+- lib/kuby/utils/table.rb
 - lib/kuby/version.rb
 - spec/docker/spec_spec.rb
 - spec/docker/timestamp_tag_spec.rb