keel 0.1.0

data/lib/keel/gcloud/config.rb

@@ -0,0 +1,109 @@
+require 'yaml'
+
+module Keel::GCloud
+  #
+  # Config file parser.
+  # Takes the YAML file and creates an object with attributes matching
+  # the supplied configurations.
+  #
+  # Also serves as a wrapper for the GCloud configurations API.
+  #
+  class Config
+    attr_accessor :cli,
+                  :config,
+                  :app_name,
+                  :compute_region,
+                  :compute_zone,
+                  :container_app_image_path,
+                  :container_cloud_sql_image_path,
+                  :container_cluster,
+                  :cloud_sql_instance,
+                  :env_variables,
+                  :project_id
+
+    GCLOUD_OPTIONS_LIST = [:compute_zone, :container_cluster, :project_id]
+
+    def initialize
+      @cli    = Cli.new
+      @config = YAML.load_file(Rails.root.join('config', 'gcloud.yml'))
+
+      @app_name                       = @config[:app][:name]
+      @compute_region                 = @config[:compute][:region]
+      @compute_zone                   = @config[:compute][:zone]
+      @container_app_image_path       = @config[:container][:app_image_path]
+      @container_cloud_sql_image_path = @config[:container][:cloud_sql_image_path]
+      @container_cluster              = @config[:container][:cluster]
+      @cloud_sql_instance             = @config[:cloud_sql_instance]
+      @env_variables                  = @config[:env_variables]
+      @project_id                     = @config[:project_id]
+    end
+
+    #
+    # Lists the GCloud configurations.
+    #
+    # @return [Array] of configurations
+    #
+    def self.list
+      Cli.new.execute 'gcloud config list'
+    end
+
+    #
+    # Checks if the gcloud excutable is installed.
+    #
+    # @return [Boolean]
+    #
+    def executable_installed?
+      @cli.system 'which gcloud'
+      $?.success?
+    end
+
+    #
+    # (see #executable_installed?)
+    #
+    def executable_missing?
+      !executable_installed?
+    end
+
+    #
+    # Gets the application specific configurations for GCloud by checking
+    # if any ENV variables are set first, otherwise returning the ones
+    # from the config file.
+    # This allows the developer to override a config param locally without
+    # changing the YAML file.
+    #
+    # @return [Hash] of config name/value
+    #
+    def app_config
+      values = {}
+
+      GCLOUD_OPTIONS_LIST.each do |option|
+        values[option] = ENV[option.to_s.upcase] || self.send(option)
+      end
+
+      return values
+    end
+
+    #
+    # Checks if the user's system is configured properly or if it's missing
+    # any configurations.
+    #
+    # @return [Boolean]
+    #
+    def system_configured?
+      system_configs  = self.class.list
+      desired_configs = self.app_config
+
+      desired_configs.values.all? { |config| system_configs.include? config }
+    end
+
+    #
+    # Sets the appropriate GCloud configurations properties for the system
+    # if they are not already set.
+    #
+    def set_properties
+      @cli.system "gcloud config set compute/zone #{self.compute_zone}"
+      @cli.system "gcloud config set container/cluster #{self.container_cluster}"
+      @cli.system "gcloud config set project #{self.project_id}"
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'yaml'
+
+module Keel::GCloud
+  module Kubernetes
+    #
+    # A class to represent a Kubernetes Namespace.
+    # It is a simplified view of what Kubernetes returns with only
+    # the necessary information required to perform the operations needed.
+    #
+    class Namespace
+      attr_accessor :cli, :name, :status, :uid
+
+      def initialize **params
+        @name   = params[:name]
+        @status = params[:status]
+        @uid    = params[:uid]
+
+        @cli    = Cli.new
+      end
+
+      #
+      # Parses the returned YAML into objects of the Namespace class.
+      #
+      # @param yaml [Hash] the parsed result of the API call
+      # @return [Array<Namespace>] an array of Namespace objects
+      #
+      def self.from_yaml yaml
+        yaml['items'].map do |item|
+          params = {
+            name:   item['metadata']['name'],
+            status: item['status']['phase'],
+            uid:    item['metadata']['uid'],
+          }
+
+          self.new params
+        end
+      end
+
+      #
+      # Fetches all the namespaces from Kubernetes.
+      #
+      # @return [Hash] the parsed result of the API call
+      #
+      def self.fetch_all
+        command         = 'kubectl get namespaces -o yaml'
+        namespaces_yaml = YAML.load Cli.new.execute(command)
+        return false unless namespaces_yaml
+
+        self.from_yaml namespaces_yaml
+      end
+
+      #
+      # Checks if the namespace is active by comparing the status attribute.
+      #
+      # @return [Boolean]
+      #
+      def active?
+        'Active' == self.status
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require 'yaml'
+
+module Keel::GCloud
+  module Kubernetes
+    #
+    # A class to represent a Kubernetes Pod.
+    # It is a simplified view of what Kubernetes returns with only
+    # the necessary information required to perform the operations needed.
+    #
+    class Pod
+      attr_accessor :cli, :app, :name, :namespace, :status, :uid
+
+      def initialize **params
+        @app        = params[:app]
+        @name       = params[:name]
+        @namespace  = params[:namespace]
+        @status     = params[:status]
+        @uid        = params[:uid]
+
+        @cli        = Cli.new
+        @prompter   = Prompter.new
+      end
+
+      #
+      # Parses the returned YAML into objects of the Pod class.
+      #
+      # @param yaml [Hash] the parsed result of the API call
+      # @return [Array<Pod>] an array of Pod objects
+      #
+      def self.from_yaml yaml
+        yaml['items'].map do |item|
+          params = {
+            app:        item['metadata']['labels']['app'],
+            name:       item['metadata']['name'],
+            namespace:  item['metadata']['namespace'],
+            status:     item['status']['phase'],
+            uid:        item['metadata']['uid'],
+          }
+
+          self.new params
+        end
+      end
+
+      #
+      # Fetches all the pods from Kubernetes.
+      #
+      # @param env [String] the namespace/environment for which to fetch the pods
+      # @param app [String] the app for which to fetch the pods
+      # @return [Hash] the parsed result of the API call
+      #
+      def self.fetch_all env, app
+        command   = "kubectl get po --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
+      end
+
+      #
+      # Checks if the namespace is running by comparing the status attribute.
+      #
+      # @return [Boolean]
+      #
+      def running?
+        'Running' == self.status
+      end
+
+      #
+      # Deletes the pod.
+      #
+      # @return [Boolean] whether the call succeeded or not
+      #
+      def delete
+        @cli.system "kubectl delete po #{self.name} --namespace=#{self.namespace}"
+      end
+
+      #
+      # Fetches the logs for the pod.
+      # If the param +tail+ is set to true, it tails the logs.
+      #
+      # @param tail [Boolean, nil] flag whether to tail the logs or not
+      # @return [Boolean] whether the call succeeded or not
+      #
+      def logs tail=nil
+        f = tail ? '-f ' : ''
+
+        if tail
+          @prompter.print 'Fetching logs...'
+          @prompter.print 'Use Ctrl-C to stop'
+        end
+
+        @cli.system "kubectl logs #{f}#{self.name} --namespace=#{self.namespace} -c=#{self.app}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+require 'yaml'
+
+module Keel::GCloud
+  module Kubernetes
+    #
+    # A class to represent a Kubernetes ReplicationController.
+    # It is a simplified view of what Kubernetes returns with only
+    # the necessary information required to perform the operations needed.
+    #
+    class ReplicationController
+      attr_accessor :containers, :name, :namespace, :original, :uid
+
+      def initialize **params
+        @containers = params[:containers]
+        @name       = params[:name]
+        @namespace  = params[:namespace]
+        @uid        = params[:uid]
+
+        @original   = params[:original]
+        @original['metadata'].delete 'creationTimestamp'
+      end
+
+      #
+      # Parses the returned YAML into objects of the ReplicationController class.
+      #
+      # @param yaml [Hash] the parsed result of the API call
+      # @return [Array<ReplicationController>] an array of ReplicationController objects
+      #
+      def self.from_yaml yaml
+        yaml['items'].map do |item|
+          params = {
+            containers: item['spec']['template']['spec']['containers'],
+            name:       item['metadata']['name'],
+            namespace:  item['metadata']['namespace'],
+            original:   item,
+            uid:        item['metadata']['uid'],
+          }
+
+          self.new params
+        end
+      end
+
+      #
+      # Fetches all the controllers 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
+      end
+
+      #
+      # Replaces the controller's specifications with a new one.
+      #
+      # @param file [File] the new specifications file
+      # @return [Boolean] whether the call succeeded or not
+      #
+      def self.replace file
+        Cli.new.system "kubectl replace -f #{file}"
+      end
+
+      #
+      # Get the YAML representation of the controller.
+      #
+      # @return [String] the YAML format
+      #
+      def to_yaml
+        self.original.to_yaml
+      end
+
+      #
+      # Writes the current specifications to a file.
+      #
+      # @param filename [String] the name of the file to write to
+      # @return [Boolean] result of the operation
+      #
+      def to_file filename
+        File.open(filename, 'w') do |io|
+          io.write self.to_yaml
+        end
+      end
+
+      #
+      # Increments the number of replicas.
+      #
+      def increment_replica_count
+        self.original['spec']['replicas'] += 1
+      end
+
+      #
+      # Decrements the number of replicas.
+      #
+      def decrement_replica_count
+        self.original['spec']['replicas'] -= 1
+      end
+
+      #
+      # Updates the specifications of a controller on Kubernetes
+      # with the latest specs.
+      #
+      # (see #to_file)
+      # (see #replace)
+      #
+      def update
+        tmp_file = Rails.root.join('tmp', 'deployment-rc.yml')
+        self.to_file tmp_file
+        self.class.replace tmp_file
+      end
+    end
+  end
+end

data/lib/keel/gcloud/kubernetes.rb

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

data/lib/keel/gcloud/notifier/base.rb

@@ -0,0 +1,39 @@
+class NotImplemented < StandardError; end
+
+module Keel::GCloud
+  module Notifier
+    #
+    # Base class to be inherited for notifiers that are used to send any
+    # notifications when a deployment is complete.
+    #
+    class Base
+      attr_accessor :cli, :env, :sha, :user
+
+      def initialize env:, sha:
+        @env = env
+        @sha = sha
+
+        @cli = Cli.new
+
+        set_user
+      end
+
+      #
+      # Determines the user id to be sent with the nofications
+      # based on the ENV variable if set, otherwise on the system user.
+      #
+      def set_user
+        unless ENV['DEPLOY_USERNAME'].nil? || ENV['DEPLOY_USERNAME'] == ''
+          return @user = ENV['DEPLOY_USERNAME']
+        end
+
+        whoami  = @cli.execute 'whoami'
+        @user   = whoami.chomp
+      end
+
+      def notify # :nodoc:
+        raise NotImplemented
+      end
+    end
+  end
+end

data/lib/keel/gcloud/notifier/new_relic.rb

@@ -0,0 +1,17 @@
+module Keel::GCloud
+  module Notifier
+    #
+    # Notifier for NewRelic that send a deployment notification.
+    #
+    class NewRelic < Base
+      #
+      # Sends a notification to NewRelic of a new deployment with the
+      # appropriate attributes.
+      #
+      def notify
+        env = @env == 'production' ? 'production' : 'staging'
+        @cli.system "newrelic deployments -e #{env} -r #{@sha} -u #{@user}"
+      end
+    end
+  end
+end

data/lib/keel/gcloud/notifier.rb

@@ -0,0 +1,2 @@
+require_relative 'notifier/base'
+require_relative 'notifier/new_relic'

data/lib/keel/gcloud/prompter.rb

@@ -0,0 +1,88 @@
+require 'inquirer'
+require 'colorize'
+
+module Keel::GCloud
+  #
+  # A helper to output to the command line and prompt the user for input.
+  #
+  class Prompter
+    #
+    # Prints the message with coloring based on the level param.
+    #
+    # @param message [String] the message to print
+    # @param level [String, nil] the level that determines the color
+    #
+    def print message, level=nil
+      case level
+      when :success
+        puts message.green
+      when :error
+        puts message.red
+      when :info
+        puts message.blue
+      else
+        puts message
+      end
+    end
+
+    #
+    # Prompts the user to select the namespace from a list.
+    # If a default is provided it returns that instead.
+    #
+    # @param namespaces [Array<Namespace>] the array of namespaces to choose from
+    # @param default [String, nil] the default choice
+    #
+    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]
+    end
+
+    #
+    # Prompts the user to provide a SHA.
+    # If a default is provided it returns that instead.
+    #
+    # @param default [String, nil] the default choice
+    #
+    def prompt_for_sha 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
+    end
+
+    #
+    # Prompts the user to provide a datbase URL.
+    # If a default is provided it returns that instead.
+    #
+    # @param default [String, nil] the default choice
+    #
+    def prompt_for_database_url default=nil
+      return default unless default.blank?
+
+      Ask.input 'Database URL'
+    end
+
+    #
+    # Prompts the user to provide a secret key.
+    # If a default is provided it returns that instead.
+    #
+    # @param default [String, nil] the default choice
+    #
+    def prompt_for_secret_key default=nil
+      return default unless default.blank?
+
+      Ask.input 'Secret key'
+    end
+
+    #
+    # Prompts the user to choose if they want to tail the logs or not.
+    #
+    def prompt_for_tailing_logs
+      Ask.confirm "To tail or not to tail? (ie: -f, --follow[=false]: Specify if the logs should be streamed.)", default: true
+    end
+  end
+end

data/lib/keel/gcloud.rb

@@ -0,0 +1,7 @@
+require_relative 'gcloud/auth'
+require_relative 'gcloud/cli'
+require_relative 'gcloud/component'
+require_relative 'gcloud/config'
+require_relative 'gcloud/kubernetes'
+require_relative 'gcloud/notifier'
+require_relative 'gcloud/prompter'

data/lib/keel/railtie.rb

@@ -0,0 +1,7 @@
+module Keel
+  class Railtie < Rails::Railtie # :nodoc: all
+    rake_tasks do
+      load 'tasks/keel.rake'
+    end
+  end
+end

data/lib/keel/version.rb

@@ -0,0 +1,3 @@
+module Keel
+  VERSION = "0.1.0" # :nodoc:
+end

data/lib/keel.rb

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