kubes 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d2e75bd0d156b889fcbd5a55389d335e4509e2c27bc667940bfd87155b3d9a0
-  data.tar.gz: f13237e1d8fa442d2b1a1ed07d7e209b3054cf3cdfee8f68dab20e3358352add
+  metadata.gz: 658324c3828bd9f6ee60ad1fd925eb47ff9706fe08256b791e180b0daf3cfba0
+  data.tar.gz: 5a2cc328105e6ac7dd7847f4d92697db98827e81b214b7dc3f6b353bf78e224f
 SHA512:
-  metadata.gz: '09576784450fc73c4846f7803c375542de5ed1f37bda86cd8cd8e61cf53dfa774192b8648d9b207180b9681a4e787ea0ade6211d02eedcd63a11051c694bb0a1'
-  data.tar.gz: 13219946a970eb6e476902b09971ae832b47a8cddf0ebc73ab68a079de2d7a67e50a539b8784731d67cf5037c677c811408db6e3cbb8b7eea528bec5588784a4
+  metadata.gz: 307badb633d97365c4072a7e089c5a36b2abb81e761aa3a5abb46e4aaa4e3da2878023edb12cf203b817ee6aa4484b4d2d758e6f4a20b1e571fdaec75bf61ddc
+  data.tar.gz: e5d6f7434c93a73bc996fc661d026f5c601a4bd7c6680c14f0219af4561f1f7ac362370123efe381fac0538021ccb151adc308658b1f3f70c0dbff58334fed9d

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.2.5]
+- #17 cloudbuild build strategy
+
 ## [0.2.4]
 - #16 google cloudbuild support & docs: add Dockerfile for kubes as a docker entrypoint
 

data/docs/_docs/config/build-strategy.md

@@ -0,0 +1,46 @@
+---
+title: Build Strategy
+---
+
+Kubes uses the `docker` to build the docker image by default. Kubes can also support an additional build strategy: gcloud.
+
+## Gcloud Build Strategy
+
+With the gcloud build strategy, you do not need docker installed locally. Google CloudBuild is used to build and push the image to a GCR registry.
+
+You must set up the [gcloud cli](https://cloud.google.com/sdk/gcloud/reference/builds/submit).  Please refer to the [gcloud sdk install docs](https://cloud.google.com/sdk/install). Kubes will call out to `gcloud builds submit` to create the Docker image.
+
+## Configure
+
+You configure gcloud as the build strategy like so:
+
+```ruby
+Kubes.configure do |config|
+  config.repo = "gcr.io/#{ENV['GOOGLE_PROJECT']}/demo"
+  config.logger.level = "info"
+  config.build_strategy = "gcloud" # <= changed to gcloud
+end
+```
+
+## Commands
+
+The kubes builds command will remain the same.
+
+    kubes docker build
+
+There is no need to run the push command, as the build command with the gcloud strategy will always push.
+
+## Deploy
+
+The deploy commands remain the same. Example:
+
+    kubes deploy web
+
+If you want to skip the `docker build` phase of the deploy, you can run:
+
+    kubes deploy web --no-build
+
+Also, kubes apply another way to skip the docker build:
+
+    kubes apply web
+

data/docs/_includes/sidebar.html

@@ -56,6 +56,7 @@
           <li><a href="{% link _docs/config/docker.md %}">Docker</a></li>
           <li><a href="{% link _docs/config/env.md %}">Env</a></li>
           <li><a href="{% link _docs/config/kubectl.md %}">Kubectl</a></li>
+          <li><a href="{% link _docs/config/build-strategy.md %}">Build Strategy</a></li>
         </ul>
       </li>
       <li><a href="{% link _docs/yaml.md %}">YAML</a></li>

data/lib/kubes/cli/build.rb

@@ -1,8 +1,8 @@
 class Kubes::CLI
   class Build < Base
     def run
-      Kubes::Docker::Build.new(@options).run
-      Kubes::Docker::Push.new(@options).run
+      Kubes::Docker.new(@options, "build").run
+      Kubes::Docker.new(@options, "push").run
     end
   end
 end

data/lib/kubes/cli/docker.rb

@@ -4,7 +4,7 @@ class Kubes::CLI
     long_desc Help.text("docker:build")
     option :push, type: :boolean, default: false
     def build
-      builder = Kubes::Docker::Build.new(options)
+      builder = Kubes::Docker.new(options, "build")
       builder.run
       push if options[:push]
     end
@@ -13,7 +13,7 @@ class Kubes::CLI
     long_desc Help.text("docker:push")
     option :push, type: :boolean, default: false
     def push
-      pusher = Kubes::Docker::Push.new(options)
+      pusher = Kubes::Docker.new(options, "push")
       pusher.run
     end
   end

data/lib/kubes/config.rb

@@ -35,6 +35,8 @@ module Kubes
 
       config.repo = nil # expected to be set by .kubes/config.rb
 
+      config.build_strategy = "docker" # IE: docker or gcloud
+
       config
     end
 

data/lib/kubes/docker.rb

@@ -0,0 +1,19 @@
+module Kubes
+  class Docker
+    def initialize(options, name)
+      @options = options
+      @name = name
+    end
+
+    def run
+      strategy = strategy_class.new(@options, @name) # @name: docker or push
+      strategy.run
+    end
+
+    def strategy_class
+      strategy = Kubes.config.build_strategy.to_s.camelize # IE: Docker or Gcloud
+      klass_name = "Kubes::Docker::Strategy::#{@name.camelize}::#{strategy}"
+      klass_name.constantize
+    end
+  end
+end

data/lib/kubes/docker/strategy/build/base.rb

@@ -0,0 +1,24 @@
+module Kubes::Docker::Strategy::Build
+  class Base
+    extend Memoist
+    include Kubes::Docker::Strategy::Utils
+
+    def initialize(options, name)
+      @options, @name = options, name
+    end
+
+    def run
+      reserve_image_name
+      check_dockerfile!
+      perform
+      store_image_name
+    end
+
+    def check_dockerfile!
+      # Dockerfile is also used in args/default.rb, will have to combine if Dockerfile is made configurable
+      return if File.exist?("Dockerfile")
+      logger.error "ERROR: The Dockerfile does not exist. Cannot build the docker image without a Dockerfile".color(:red)
+      exit 1
+    end
+  end
+end

data/lib/kubes/docker/strategy/build/docker.rb

@@ -0,0 +1,11 @@
+module Kubes::Docker::Strategy::Build
+  class Docker < Base
+    def perform
+      params = args.flatten.join(' ')
+      command = "docker build #{params}"
+      run_hooks "build" do
+        sh(command)
+      end
+    end
+  end
+end

data/lib/kubes/docker/strategy/build/gcloud.rb

@@ -0,0 +1,10 @@
+module Kubes::Docker::Strategy::Build
+  class Gcloud < Base
+    def perform
+      command = "gcloud builds submit --tag #{@@image_name}"
+      run_hooks "build" do
+        sh(command)
+      end
+    end
+  end
+end

data/lib/kubes/docker/strategy/hooks.rb

@@ -0,0 +1,9 @@
+module Kubes::Docker::Strategy
+  module Hooks
+    def run_hooks(name, &block)
+      hooks = Kubes::Hooks::Builder.new(name, "#{Kubes.root}/.kubes/config/docker/hooks.rb")
+      hooks.build # build hooks
+      hooks.run_hooks(&block)
+    end
+  end
+end

data/lib/kubes/docker/{base.rb → strategy/image_name.rb}

@@ -1,36 +1,6 @@
-module Kubes::Docker
-  class Base
+module Kubes::Docker::Strategy
+  module ImageName
     extend Memoist
-    include Kubes::Logging
-    include Kubes::Util::Sh
-
-    def initialize(options={})
-      @options = options
-      @name = self.class.name.split('::').last.underscore
-    end
-
-    def run_hooks(name, &block)
-      hooks = Kubes::Hooks::Builder.new(name, "#{Kubes.root}/.kubes/config/docker/hooks.rb")
-      hooks.build # build hooks
-      hooks.run_hooks(&block)
-    end
-
-    def args
-      # base at end in case of redirection. IE: command > /path
-      custom.args + default.args
-    end
-
-    def custom
-      custom = Kubes::Args::Custom.new(@name, "#{Kubes.root}/.kubes/config/docker/args.rb")
-      custom.build
-      custom
-    end
-    memoize :custom
-
-    def default
-      Args::Default.new(@name, image_name, @options)
-    end
-    memoize :default
 
     @@image_name = nil
     def reserve_image_name
@@ -84,5 +54,22 @@ module Kubes::Docker
       @git_sha = `cd #{Kubes.root} && git rev-parse --short HEAD`
       @git_sha.strip!
     end
+
+    def args
+      # base at end in case of redirection. IE: command > /path
+      custom.args + default.args
+    end
+
+    def custom
+      custom = Kubes::Args::Custom.new(@name, "#{Kubes.root}/.kubes/config/docker/args.rb")
+      custom.build
+      custom
+    end
+    memoize :custom
+
+    def default
+      Kubes::Docker::Args::Default.new(@name, image_name, @options)
+    end
+    memoize :default
   end
 end

data/lib/kubes/docker/strategy/push/base.rb

@@ -0,0 +1,9 @@
+module Kubes::Docker::Strategy::Push
+  class Base
+    include Kubes::Docker::Strategy::Utils
+
+    def initialize(options, name)
+      @options, @name = options, name
+    end
+  end
+end

data/lib/kubes/docker/{push.rb → strategy/push/docker.rb}

@@ -1,8 +1,5 @@
-module Kubes::Docker
-  class Push < Base
-    include Kubes::Logging
-    include Kubes::Util::Time
-
+module Kubes::Docker::Strategy::Push
+  class Docker < Base
     def run
       update_auth_token
       start_time = Time.now

data/lib/kubes/docker/strategy/push/gcloud.rb

@@ -0,0 +1,9 @@
+module Kubes::Docker::Strategy::Push
+  class Gcloud < Base
+    def run
+      run_hooks "push" do
+        # noop, gcloud builds submit already pushes the image
+      end
+    end
+  end
+end

data/lib/kubes/docker/strategy/utils.rb

@@ -0,0 +1,9 @@
+module Kubes::Docker::Strategy
+  module Utils
+    include Kubes::Logging
+    include Kubes::Util::Sh
+    include Kubes::Util::Time
+    include Kubes::Docker::Strategy::ImageName
+    include Kubes::Docker::Strategy::Hooks
+  end
+end

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -235,6 +235,7 @@ files:
 - docs/_docs/auto-context.md
 - docs/_docs/ci/cloudbuild.md
 - docs/_docs/config.md
+- docs/_docs/config/build-strategy.md
 - docs/_docs/config/docker.md
 - docs/_docs/config/env.md
 - docs/_docs/config/kubectl.md
@@ -513,10 +514,17 @@ files:
 - lib/kubes/completer/script.sh
 - lib/kubes/config.rb
 - lib/kubes/core.rb
+- lib/kubes/docker.rb
 - lib/kubes/docker/args/default.rb
-- lib/kubes/docker/base.rb
-- lib/kubes/docker/build.rb
-- lib/kubes/docker/push.rb
+- lib/kubes/docker/strategy/build/base.rb
+- lib/kubes/docker/strategy/build/docker.rb
+- lib/kubes/docker/strategy/build/gcloud.rb
+- lib/kubes/docker/strategy/hooks.rb
+- lib/kubes/docker/strategy/image_name.rb
+- lib/kubes/docker/strategy/push/base.rb
+- lib/kubes/docker/strategy/push/docker.rb
+- lib/kubes/docker/strategy/push/gcloud.rb
+- lib/kubes/docker/strategy/utils.rb
 - lib/kubes/hooks/builder.rb
 - lib/kubes/hooks/dsl.rb
 - lib/kubes/kubectl.rb

data/lib/kubes/docker/build.rb

@@ -1,22 +0,0 @@
-module Kubes::Docker
-  class Build < Base
-    def run
-      reserve_image_name
-      build
-      store_image_name
-    end
-
-    def build
-      # Dockerfile is also used in args/default.rb, will have to combine if Dockerfile is made configurable
-      unless File.exist?("Dockerfile")
-        logger.error "ERROR: The Dockerfile does not exist. Cannot build the docker image without a Dockerfile".color(:red)
-        exit 1
-      end
-      params = args.flatten.join(' ')
-      command = "docker build #{params}"
-      run_hooks "build" do
-        sh(command)
-      end
-    end
-  end
-end