keel 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae5771e28c49313b1b90d71a280c481c0268de00
-  data.tar.gz: 85969874e3bd3d217946c1a62058b91ffb2b09ff
+  metadata.gz: 3837deed0bba2d9618d452af738a4dca69c109e5
+  data.tar.gz: a069e3ba4d3bf4035b49d98ec60369f54b5a2669
 SHA512:
-  metadata.gz: a580124ef47f0ddc0f9cc723dcea47f273020d606d60a60402fa6488ce062ba8a1c264c710f801f5a51d300fe56119b8214dfadae01a4aeb50680f81705220c0
-  data.tar.gz: dca6f0cfc23daf0c9dc4aa56d62189647b4bd66ad7f9b7cac798ea136a47533bd8b6858da180854a2a4e0b88c8a330054da61a143795a410cb2b1360a2e67165
+  metadata.gz: 55344a32cc6baf594e379ce440e00317435fb0e0e53d54276a1030604c2b3145c6ddb63863c012b5bdd648161dc5586a8d85728975a7fad9a818f28d846df064
+  data.tar.gz: 73c7f65984d998f7b177263321c6504e22c9b4b3afd5ca2f67d45393ea89bea8f517ce883d95778f3619fcb2d5fa11c24ad738fc75088ccc3cc126dfee81552b

data/.ruby-version

@@ -0,0 +1 @@
+2.2.5

data/README.md

@@ -106,6 +106,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/o19s/keel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Contributors
+
+* [Chris Bradford](https://github.com/bradfordcp) did the original work
+* [Youssef Chaker](https://github.com/ychaker) extracted out the gem
+* [Matt Overstreet](https://github.com/omnifroodle) added support for kubernetes deployments
 
 ## License
 

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: 2.2.3
+dependencies:
+  pre:
+    - echo Y | rvm @global do gem uninstall bundler
+    - gem install bundler -v '1.11'

data/lib/generators/keel/config_generator.rb

@@ -7,6 +7,7 @@ module Keel
 
       def copy_config
         copy_file "gcloud.yml", "config/gcloud.yml"
+        copy_file "Dockerfile", "Dockerfile"
       end
     end
   end

data/lib/generators/keel/controller_generator.rb

@@ -1,3 +1,4 @@
+# TODO, kill these and their templates
 module Keel
   module Generators
     class ControllerGenerator < ::Rails::Generators::Base

data/lib/generators/keel/service_generator.rb

@@ -1,3 +1,4 @@
+# TODO, kill these and their templates
 module Keel
   module Generators
     class ServiceGenerator < ::Rails::Generators::Base

data/lib/generators/keel/templates/Dockerfile

@@ -0,0 +1 @@
+FROM rails:onbuild

data/lib/keel/docker/image.rb

@@ -0,0 +1,13 @@
+module Keel::Docker
+  class Image
+    def self.create(label, project_id, app_name)
+      command = "docker build -t gcr.io/#{project_id}/#{app_name}:#{label} ." 
+      Keel::GCloud::Cli.new.execute(command)
+    end
+
+    def self.push(label, project_id, app_name)
+      command = "gcloud docker push gcr.io/#{project_id}/#{app_name}:#{label}"
+      Keel::GCloud::Cli.new.execute(command)
+    end
+  end
+end

data/lib/keel/docker.rb

@@ -0,0 +1 @@
+require_relative 'docker/image'

data/lib/keel/gcloud/cli.rb

@@ -1,3 +1,4 @@
+require 'open3'
 module Keel::GCloud
   #
   # A helper class to run system commands and handle interrupts.
@@ -5,7 +6,17 @@ module Keel::GCloud
   class Cli
     def execute command
       begin
-        `#{command}`
+        out = ""
+        Open3.popen3(command) do |stdout, stderr, stdin, thread|
+          # TODO do smarter things with status and stdout
+          while line=stderr.gets do
+            out += line
+            print '.'
+          end
+          print "\n"
+          raise "error while processing. " + out unless thread.value.success?
+          return out
+        end
       rescue Interrupt
         puts 'Task interrupted.'
       end

data/lib/keel/gcloud/interactions.rb

@@ -0,0 +1,41 @@
+module Keel::GCloud
+  #
+  # A helper for prompts that integrate other services
+  #
+  class Interactions
+    @@namespace = nil
+    @@label     = nil
+
+    #
+    # Prompts for the deployment namespace if there are multiple available and one has
+    # not been already chosen
+    #
+    # @param namespace [String] the default option to present for the namespace
+    #
+    def self.pick_namespace(namespace)
+      unless @@namespace
+        prompter    = Keel::GCloud::Prompter.new
+        namespaces 	= Keel::GCloud::Kubernetes::Namespace.fetch_all
+        unless namespaces
+          message = 'Unable to connect to Kubernetes, please try again later...'
+          prompter.print message, :error
+          abort
+        end
+        @@namespace = prompter.prompt_for_namespace namespaces, namespace
+      end
+      @@namespace
+    end
+
+    #
+    # Prompts for a Docker image label if one has not already been selected
+    #
+    # @params label [String] the default value to present to the user
+    def self.pick_image_label(label)
+      unless @@label
+        prompter = Keel::GCloud::Prompter.new
+        @@label = prompter.prompt_for_label label
+      end
+      @@label
+    end
+  end
+end

data/lib/keel/gcloud/kubernetes/deployment.rb

@@ -0,0 +1,34 @@
+module Keel::GCloud
+    module Kubernetes
+        #
+        # A class to represent a Kubernetes Deployment
+        class Deployment < ReplicationController
+
+            #
+            # Fetches the correct deployment or replication controller from Kubernetes.
+            #
+            # @param env [String] the namespace/environment for which to fetch the controllers
+            # @param app [String] the app for which to fetch the controllers
+            # @return [Hash] the parsed result of the API call
+            #
+            def self.fetch_all env, app
+                command = "kubectl get deployment --namespace=#{env} -l app=#{app} -o yaml"
+                rcs_yaml = YAML.load Cli.new.execute(command)
+                return false unless rcs_yaml["items"].count > 0
+                self.from_yaml rcs_yaml 
+            end
+
+            # 
+            # Create a Deployment and expose it on kubernetes
+            #
+            def self.create app_name, image_path, port, sha, namespace
+                cli            = Cli.new
+                deploy_command = "kubectl run #{app_name} --image=#{image_path}:#{sha} --namespace=#{namespace}"
+                expose_command = "kubectl expose deployment #{app_name} --port=80 --target-port=#{port} --type=LoadBalancer --namespace=#{namespace}"
+                cli.execute(deploy_command)
+                cli.execute(expose_command)
+            end
+      
+        end
+    end
+end

data/lib/keel/gcloud/kubernetes/replication_controller.rb

@@ -35,24 +35,22 @@ module Keel::GCloud
             original:   item,
             uid:        item['metadata']['uid'],
           }
-
           self.new params
         end
       end
 
       #
-      # Fetches all the controllers from Kubernetes.
+      # Fetches the correct deployment or replication controller from Kubernetes.
       #
       # @param env [String] the namespace/environment for which to fetch the controllers
       # @param app [String] the app for which to fetch the controllers
       # @return [Hash] the parsed result of the API call
       #
       def self.fetch_all env, app
-        command   = "kubectl get rc --namespace=#{env} -l app=#{app} -o yaml"
-        rcs_yaml  = YAML.load Cli.new.execute(command)
-        return false unless rcs_yaml
-
-        self.from_yaml rcs_yaml
+        command = "kubectl get rc --namespace=#{env} -l app=#{app} -o yaml"
+        rcs_yaml = YAML.load Cli.new.execute(command)
+        return false unless rcs_yaml["items"].count > 0
+        self.from_yaml rcs_yaml 
       end
 
       #

data/lib/keel/gcloud/kubernetes.rb

@@ -1,3 +1,4 @@
 require_relative 'kubernetes/namespace'
 require_relative 'kubernetes/replication_controller'
+require_relative 'kubernetes/deployment'
 require_relative 'kubernetes/pod'

data/lib/keel/gcloud/prompter.rb

@@ -35,23 +35,27 @@ module Keel::GCloud
     def prompt_for_namespace namespaces, default=nil
       return default unless default.blank?
 
-      options = namespaces.map { |namespace| namespace.name }
-      index = Ask.list 'Please choose an environment (destination)', options
-      options[index]
+      options = namespaces.map { |namespace| namespace.name } - ['kube-system']
+      if options.count > 1
+        index = Ask.list 'Please choose an environment (destination)', options
+        options[index]
+      else
+        options[0]
+      end
     end
 
     #
-    # Prompts the user to provide a SHA.
+    # Prompts the user to provide a label.  Defaults to the current git branch shortened SHA.
     # If a default is provided it returns that instead.
     #
     # @param default [String, nil] the default choice
     #
-    def prompt_for_sha default=nil
+    def prompt_for_label default=nil
       return default unless default.blank?
 
       # Get current git SHA
       current_sha = `git rev-parse --short HEAD`.lines.first.split(' ')[0]
-      Ask.input 'Git SHA', default: current_sha
+      Ask.input 'Image Label (defaults to Git SHA)', default: current_sha
     end
 
     #

data/lib/keel/gcloud.rb

@@ -4,3 +4,4 @@ require_relative 'gcloud/component'
 require_relative 'gcloud/config'
 require_relative 'gcloud/kubernetes'
 require_relative 'gcloud/prompter'
+require_relative 'gcloud/interactions'

data/lib/keel/version.rb

@@ -1,3 +1,3 @@
 module Keel
-  VERSION = "0.1.2" # :nodoc:
+  VERSION = "0.1.5" # :nodoc:
 end

data/lib/keel.rb

@@ -1,6 +1,7 @@
 require 'keel/version'
 require 'keel/railtie' if defined?(Rails)
 require 'keel/gcloud'
+require 'keel/docker'
 require 'keel/notifier'
 
 # {file:README.md Usage#usage}

data/lib/tasks/keel.rake

@@ -1,24 +1,57 @@
 namespace :keel do
-  desc 'Deploy the specified SHA to a given environment'
-  task :deploy, [:environment, :deploy_sha] do |_, args|
-    prompter  = Keel::GCloud::Prompter.new
-    config    = Keel::GCloud::Config.new
-    app       = config.app_name
+  config    = Keel::GCloud::Config.new
+  prompter  = Keel::GCloud::Prompter.new
+
+  desc "build a docker image suitable for pushing"
+  task :pack, [:deploy_sha] do |_, args|
+    prompter.print 'Building Docker image', :info
+    image_label  = Keel::GCloud::Interactions.pick_image_label args[:deploy_sha]
+    Keel::Docker::Image.create image_label, config.project_id, config.app_name
+    prompter.print 'finished build', :info 
+  end
 
-    # Fetch namespaces from k8s
-    namespaces = Keel::GCloud::Kubernetes::Namespace.fetch_all
-    unless namespaces
-      message = 'Unable to connect to Kubernetes, please try again later...'
-      prompter.print message, :error
-      abort
+  desc "ship the image to gcloud"
+  task :push, [:deploy_sha] do |_, args|
+    prompter.print 'Pushing image to Docker repository, this may take some time', :info
+    image_label  = Keel::GCloud::Interactions.pick_image_label args[:deploy_sha]
+    Keel::Docker::Image.push image_label, config.project_id, config.app_name
+    prompter.print 'finished push', :info
+  end
+
+  desc "provision a deployment and service on kubernetes"
+  task :provision, [:deploy_sha] do |_, args|
+    image_label = Keel::GCloud::Interactions.pick_image_label args[:deploy_sha]    
+    deploy_env  = Keel::GCloud::Interactions.pick_namespace args[:environment]
+
+    # Retrieve a replication controller configuration from the cluster
+    rcs = Keel::GCloud::Kubernetes::ReplicationController.fetch_all deploy_env, config.app_name
+    if rcs
+      message = "Found an existing deployment or replication controller for #{config.app_name}"
+      prompter.print message, :success
+    else
+      message = Keel::GCloud::Kubernetes::ReplicationController.create config.app_name, config.container_app_image_path, "3000", image_label, deploy_env
+      prompter.print message, :success
     end
+  end
 
-    # Prompt the user for the env and git commit to deploy
-    deploy_env  = prompter.prompt_for_namespace namespaces, args[:environment]
-    deploy_sha  = prompter.prompt_for_sha args[:deploy_sha]
+  task :shipit, [:deploy_sha] => [:set_gcloud_properties,
+                                  :pack,
+                                  :push,
+                                  :provision,
+                                  :deploy] do |_, args|
+    prompter.print "packed, pushed, provisioned and deployed #{config.app_name}!", :success
+  end
+
+  desc 'Deploy the specified SHA to a given environment'
+  task :deploy, [:environment, :deploy_sha] do |_, args|
+    app         = config.app_name
+    deploy_sha  = Keel::GCloud::Interactions.pick_image_label args[:deploy_sha]
+    deploy_env  = Keel::GCloud::Interactions.pick_namespace args[:environment]
+    #rc_type     = :replication_controller
 
     # Retrieve a replication controller configuration from the cluster
-    rcs = Keel::GCloud::Kubernetes::ReplicationController.fetch_all deploy_env, app
+    rcs = Keel::GCloud::Kubernetes::ReplicationController.fetch_all(deploy_env, app) || Keel::GCloud::Kubernetes::Deployment.fetch_all(deploy_env, app)
+
     unless rcs
       message = 'Unable to connect to Kubernetes, please try again later...'
       prompter.print message, :error
@@ -34,54 +67,60 @@ namespace :keel do
 
     # Prep deployment:
     # 1. Update image
-    # 2. Update replica count
-    # 3. Write out to a tmp file
-    # 4. Replace the running controller
-    #     - this will create 1 new pod with the updated code
-
-    # We can get away with first since it is a single container pod
     container = rc.containers.first
     container['image'] = "#{config.container_app_image_path}:#{deploy_sha}"
-    rc.increment_replica_count
-    rc.update
 
-    # Get a list of pods for the RC, this must be done pre-change
-    pods = Keel::GCloud::Kubernetes::Pod.fetch_all deploy_env, app
-    unless pods
-      message = 'Unable to connect to Kubernetes, please try again later...'
-      prompter.print message, :error
-      abort
-    end
+    if rc.is_a? Keel::GCloud::Kubernetes::Deployment
+      rc.update
+    else
+      # Additionally for replication controllers
+      # 2. Update replica count
+      # 3. Write out to a tmp file
+      # 4. Replace the running controller
+      #     - this will create 1 new pod with the updated code
+
+      # We can get away with first since it is a single container pod
+
+      rc.increment_replica_count
+      rc.update
+
+      # Get a list of pods for the RC, this must be done pre-change
+      pods = Keel::GCloud::Kubernetes::Pod.fetch_all deploy_env, app
+      unless pods
+        message = 'Unable to connect to Kubernetes, please try again later...'
+        prompter.print message, :error
+        abort
+      end
 
-    # Iterate over all pods, checking to see if they are running
-    all_pods_running = false
-    while !all_pods_running do
-      prompter.print 'Waiting for new pods to start', :info
-      sleep 5
-      new_pods = Keel::GCloud::Kubernetes::Pod.fetch_all deploy_env, app
-
-      all_pods_running = true
-      new_pods.each do |pod|
-        if !pod.running?
-          prompter.print "Pod \"#{pod.name}\" is not running", :info
-          all_pods_running = false
+      # Iterate over all pods, checking to see if they are running
+      all_pods_running = false
+      while !all_pods_running do
+        prompter.print 'Waiting for new pods to start', :info
+        sleep 5
+        new_pods = Keel::GCloud::Kubernetes::Pod.fetch_all deploy_env, app
+
+        all_pods_running = true
+        new_pods.each do |pod|
+          if !pod.running?
+            prompter.print "Pod \"#{pod.name}\" is not running", :info
+            all_pods_running = false
+          end
         end
       end
-    end
-
-    # Nuke old pods
-    pods.each do |pod|
-      pod.delete
-      sleep 3
-    end
 
-    # Bring the replica count down and resubmit to the cluster,
-    # this kills the 1 extra pod
-    rcs = Keel::GCloud::Kubernetes::ReplicationController.fetch_all deploy_env, app
-    rc = rcs.first
-    rc.decrement_replica_count
-    rc.update
+      # Nuke old pods
+      pods.each do |pod|
+        pod.delete
+        sleep 3
+      end
 
+      # Bring the replica count down and resubmit to the cluster,
+      # this kills the 1 extra pod
+      rcs = Keel::GCloud::Kubernetes::ReplicationController.fetch_all deploy_env, app
+      rc = rcs.first
+      rc.decrement_replica_count
+      rc.update
+    end
     prompter.print 'Notifying NewRelic of deployment', :info
     notifier = Keel::Notifier::NewRelic.new env: deploy_env, sha: deploy_sha
     notifier.notify
@@ -90,9 +129,15 @@ namespace :keel do
   end
 
   desc 'Configures the local machine for communication with gcloud and k8s'
-  task :setup do |_|
-    prompter  = Keel::GCloud::Prompter.new
-    config    = Keel::GCloud::Config.new
+  task :setup => [:check_gcloud_executables, 
+                  :check_configuration,
+                  :update_tools,
+                  :gcloud_auth,
+                  :set_gcloud_properties,
+                  :install_k8s,
+                  :authenticate_k8s] 
+
+  task :check_gcloud_executables do
 
     if config.executable_missing?
       message = 'Install Google Cloud command line tools'
@@ -101,44 +146,46 @@ namespace :keel do
 
       abort message.red
     end
+  end
+
+  task :check_configuration do
 
     if config.system_configured?
       abort 'App appears to already be configured on your system.'.green
     end
+  end
 
-    prompter.print 'Updating tools', :info
-    Keel::GCloud::Component.update
+  task :install_k8s do
+    prompter.print 'Install Kubernetes', :info
+    Keel::GCloud::Component.install_k8s
+  end
 
+  task :authenticate_k8s do
+    prompter.print 'Pulling Kubernetes auth configuration', :info
+    auth = Keel::GCloud::Auth.new config: config
+    auth.authenticate_k8s
+  end
+
+  task :gcloud_auth do
     prompter.print 'Authenticating with Google Cloud', :info
     Keel::GCloud::Auth.authenticate
+  end
 
-    prompter.print 'Install Kubernetes', :info
-    Keel::GCloud::Component.install_k8s
+  task :update_tools do
+    prompter.print 'Updating tools', :info
+    Keel::GCloud::Component.update
+  end
 
+  task :set_gcloud_properties do 
     prompter.print 'Setting gcloud properties', :info
     config.set_properties
-
-    prompter.print 'Pulling Kubernetes auth configuration', :info
-    auth = Keel::GCloud::Auth.new config: config
-    auth.authenticate_k8s
   end
 
   desc 'Pulls logs for a given environment'
   task :logs, [:environment] do |_, args|
-    prompter  = Keel::GCloud::Prompter.new
-    config    = Keel::GCloud::Config.new
-    app       = config.app_name
-
-    # Fetch namespaces from k8s
-    namespaces = Keel::GCloud::Kubernetes::Namespace.fetch_all
-    unless namespaces
-      message = 'Unable to connect to Kubernetes, please try again later...'
-      prompter.print message, :error
-      abort
-    end
-
+    app           = config.app_name
     # Prompt the user for the env and to log and whether to tail the logs
-    deploy_env    = prompter.prompt_for_namespace namespaces, args[:environment]
+    deploy_env    = Keel::GCloud::Interactions.pick_namespace args[:environment]
     tail          = prompter.prompt_for_tailing_logs
 
     prompter.print "Getting pod information for #{deploy_env}", :info

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keel
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Youssef Chaker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -96,20 +97,26 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - keel.gemspec
 - lib/generators/keel/config_generator.rb
 - lib/generators/keel/controller_generator.rb
 - lib/generators/keel/service_generator.rb
+- lib/generators/keel/templates/Dockerfile
 - lib/generators/keel/templates/gc-controller.yml.erb
 - lib/generators/keel/templates/gc-service.yml.erb
 - lib/generators/keel/templates/gcloud.yml
 - lib/keel.rb
+- lib/keel/docker.rb
+- lib/keel/docker/image.rb
 - lib/keel/gcloud.rb
 - lib/keel/gcloud/auth.rb
 - lib/keel/gcloud/cli.rb
 - lib/keel/gcloud/component.rb
 - lib/keel/gcloud/config.rb
+- lib/keel/gcloud/interactions.rb
 - lib/keel/gcloud/kubernetes.rb
+- lib/keel/gcloud/kubernetes/deployment.rb
 - lib/keel/gcloud/kubernetes/namespace.rb
 - lib/keel/gcloud/kubernetes/pod.rb
 - lib/keel/gcloud/kubernetes/replication_controller.rb
@@ -140,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Deploy your Rails app to Kubernetes.