keel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9990776275902868c2a1b8a6d21d0fd22513062d
+  data.tar.gz: f85d922dbfb13ffe9bff782ff8e0e4f98cd85435
+SHA512:
+  metadata.gz: 3009f39f0f6d91b7e2f6fe3d86d18d8fabfe166dd65426efeeb17c8d4a660cd6cd4a2c997574f483ade191124d21f3dbff978c5eafb75587089c19ced0933835
+  data.tar.gz: 014e2faea3583f3bb45a62b2b9dce4010a34bd78a5431978c05172ba7e0683c2bfac8fd445a4029d66f2b62dffeedba0aa0e4f210069ede90e236011c906ca1a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ychaker@o19s.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 OpenSource Connections
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# Keel
+
+This gem provides a few easy to run rake tasks to deploy your [Rails](http://rubyonrails.org/) application to a [Kubernetes](http://kubernetes.io/) cluster.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keel'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install keel
+```
+
+## Usage
+
+First, run:
+
+```
+bin/rails g keel:config
+```
+
+to generate the config file and update the attributes with the appropriate values.
+
+### Rake Tasks
+
+This gem mostly provides a set of rake tasks that you can see if you execute `bin/rake -T keel`:
+
+```
+rake keel:deploy[environment,deploy_sha]                            # Deploy the specified SHA to a given environment
+rake keel:logs[environment]                                         # Pulls logs for a given environment
+rake keel:setup                                                     # Configures the local machine for communication with gcloud and k8s
+```
+
+The first thing you'd want to do after you've setup the configs is to run `bin/rake keel:setup` to make sure your local environment is setup with the right tools to communicate with GCloud and Kubernetes. Just follow the instructions in the command prompt.
+
+Once you have that setup, you can run `bin/rake keel:deploy` to deploy your code to one of your environments on the Kubernetes cluster. You can provide all the necessary information by following the instructions in the command prompt.
+
+### Generators
+
+Other than the config generator that was mentioned above, this gem provides a couple of handy generators to help you work with Kubernetes:
+
+```
+keel:controller
+keel:service
+```
+
+These generators use standard templates to generate a `yml` file that you can use to configure your Kubernetes setup.
+
+You can find the generated files under the `ops/` directory of your application.
+
+## LOLz
+
+Naming is hard, so why not have fun with it?
+
+```
+Daniel
+Before you commit to that name it, I would like to point out that it is ripe for pun disruption.
+Daniel
+"You're really keeling it @Youssef"
+Matt
+crap, our deployment just keeled over
+Daniel
+"That's a good boy. Down. Sit. Keel."
+Doug
+We've finally found kubernetes keeler app
+Matt
+whoa there doug, lets keep this keel
+Doug
+I know how you keel
+Matt
+I wonder if we can get an endorsement from my favorite comedy duo?
+Matt
+Pey and Keele
+Daniel
+Pen and Keeler
+Matt
+we should probably keel this before it gets out of hand
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/keel.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keel"
+  spec.version       = Keel::VERSION
+  spec.authors       = ["Youssef Chaker"]
+  spec.email         = ["ychaker@o19s.com"]
+
+  spec.summary       = %q{Deploy your Rails app to Kubernetes.}
+  spec.description   = %q{This gem lets you deploy your Rails application to your Kubernetes cluster.}
+  spec.homepage      = "https://github.com/o19s/keel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler",  "~> 1.11"
+  spec.add_development_dependency "rake",     "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "inquirer",     "~> 0.2"
+  spec.add_runtime_dependency "colorize",     "~> 0.7"
+end

data/lib/generators/keel/config_generator.rb

@@ -0,0 +1,13 @@
+module Keel
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      desc "Generates a the config file for GCloud/Kubernetes."
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_settings
+        copy "gcloud.yml", "config/gcloud.yml"
+      end
+    end
+  end
+end

data/lib/generators/keel/controller_generator.rb

@@ -0,0 +1,59 @@
+module Keel
+  module Generators
+    class ControllerGenerator < ::Rails::Generators::Base
+      desc "Generates a Kubernetes replication controller configuration file."
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_template
+        config    = Keel::GCloud::Config.new
+        prompter  = Keel::GCloud::Prompter.new
+
+        # 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
+          return
+        end
+
+        # Prompt the user for the env, database url, and secret key to be used
+        deploy_env    = prompter.prompt_for_namespace namespaces
+        database_url  = prompter.prompt_for_database_url
+        secret_key    = prompter.prompt_for_secret_key
+
+        if deploy_env.blank? || database_url.blank? || secret_key.blank?
+          message = 'Missing required parameters'
+          prompter.print message, :error
+          return
+        end
+
+        set_params(
+          config:       config,
+          env:          deploy_env,
+          database_url: database_url,
+          secret_key:   secret_key
+        )
+
+        template "gc-controller.yml.erb", "ops/#{@params[:app]}-controller.yml"
+      end
+
+      private
+
+      def set_params config:, env:, **rest
+        # Setup variables to fill the template
+        @params = {
+          app:                            config.app_name,
+          cloud_sql_instance:             config.cloud_sql_instance[env.to_sym],
+          compute_region:                 config.compute_region,
+          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,
+          deploy_env:                     env,
+          env_variables:                  config.env_variables[env.to_sym],
+          rails_env:                      env == 'production' ? 'production' : 'staging',
+        }.merge(rest)
+      end
+    end
+  end
+end

data/lib/generators/keel/service_generator.rb

@@ -0,0 +1,55 @@
+module Keel
+  module Generators
+    class ServiceGenerator < ::Rails::Generators::Base
+      desc "Generates a Kubernetes service configuration file."
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_template
+        config    = Keel::GCloud::Config.new
+        prompter  = Keel::GCloud::Prompter.new
+
+        # 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
+          return
+        end
+
+        # Prompt the user for the env, database url, and secret key to be used
+        deploy_env    = prompter.prompt_for_namespace namespaces
+
+        unless deploy_env
+          message = 'Missing required parameters: deploy_env'
+          prompter.print message, :error
+          return
+        end
+
+        set_params(
+          config:       config,
+          env:          deploy_env,
+        )
+
+        template "gc-service.yml.erb", "ops/#{@params[:app]}-service.yml"
+      end
+
+      private
+
+      def set_params config:, env:, **rest
+        # Setup variables to fill the template
+        @params = {
+          app:                            config.app_name,
+          cloud_sql_instance:             config.cloud_sql_instance[env.to_sym],
+          compute_region:                 config.compute_region,
+          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,
+          deploy_env:                     env,
+          env_variables:                  config.env_variables[env.to_sym],
+          rails_env:                      env == 'production' ? 'production' : 'staging',
+        }.merge(rest)
+      end
+    end
+  end
+end

data/lib/generators/keel/templates/gc-controller.yml.erb

@@ -0,0 +1,58 @@
+apiVersion: v1
+kind: ReplicationController
+metadata:
+  name: <%= @params[:deploy_env] %>-<%= @params[:app] %>-ctl
+  labels:
+    app: <%= @params[:app] %>
+  namespace: <%= @params[:deploy_env] %>
+spec:
+  replicas: 1
+  selector:
+    app: <%= @params[:app] %>
+  template:
+    metadata:
+      name: <%= @params[:app] %>
+      labels:
+        app: <%= @params[:app] %>
+    spec:
+      volumes:
+      - name: secret-volume
+        secret:
+          secretName: cloud-sql-creds
+      - name: ssl-certs
+        hostPath:
+          path: /etc/ssl/certs
+      - name: cloudsql
+        emptyDir:
+      containers:
+      - name: <%= @params[:app] %>
+        image: <%= @params[:container_app_image_path] %>
+        ports:
+        - containerPort: 3000
+        resources:
+          limits:
+            cpu: 100m
+        env:
+        - name: DATABASE_URL
+          value: <%= @params[:database_url] %>
+        - name: SECRET_KEY_BASE
+          value: <%= @params[:secret_key] %>
+        - name: RAILS_ENV
+          value: <%= @params[:rails_env] %>
+        <%- @params[:env_variables].each do |name, value| -%>
+        - name: <%= name.to_s.upcase %>
+          value: <%= value %>
+        <%- end unless @params[:env_variables].blank? -%>
+        volumeMounts:
+        - name: cloudsql
+          mountPath: /cloudsql
+      - name: cloud-sql-proxy
+        image: <%= @params[:container_cloud_sql_image_path] %>
+        volumeMounts:
+        - name: cloudsql
+          mountPath: /cloudsql
+        - name: secret-volume
+          mountPath: /secret/
+        - name: ssl-certs
+          mountPath: /etc/ssl/certs
+        command: ["/cloud_sql_proxy", "-dir=/cloudsql", "-credential_file=/secret/creds.json", "-instances=<%= @params[:container_cluster] %>:<%= @params[:compute_region] %>:<%= @params[:cloud_sql_instance] %>"]

data/lib/generators/keel/templates/gc-service.yml.erb

@@ -0,0 +1,15 @@
+kind: Service
+apiVersion: v1
+metadata:
+  name: <%= @params[:deploy_env] %>-<%= @params[:app] %>-app
+  labels:
+    app: <%= @params[:app] %>
+  namespace: <%= @params[:deploy_env] %>
+spec:
+  ports:
+  - name: web-http
+    port: 80
+    targetPort: 3000
+  selector:
+    app: <%= @params[:app] %>
+  type: NodePort

data/lib/generators/keel/templates/gcloud.yml

@@ -0,0 +1,19 @@
+:app:
+  :name:        YOUR-APP-NAME
+:compute:
+  :zone:        YOUR-ZONE
+  :region:      YOUR-REGION
+:container:
+  :app_image_path:        YOUR-APP-IMAGE-PATH
+  :cloud_sql_image_path:  YOUR-CLOUD-SQL-IMAGE-PATH
+  :cluster:               YOUR-CLUSTER-NAME
+:project_id:    YOUR-PROJECT-ID
+:cloud_sql_instance:
+  # Add your own, eg.
+  # :production:  production
+:env_variables:
+  # Add your own, eg.
+  # :production:
+  #   :force_ssl:       true
+  #   :quepid_ga:       UA-XXXXXXXX-X
+  #   :ga_domain:       example.com

data/lib/keel/gcloud/auth.rb

@@ -0,0 +1,32 @@
+module Keel::GCloud
+  #
+  # This is a wrapper to call authentication related APIs with GCloud.
+  #
+  class Auth
+    attr_accessor :cli, :config
+
+    def initialize config:
+      @config = config
+      @cli    = Cli.new
+    end
+
+    #
+    # Calls the `login` API for GCLoud.
+    #
+    # @return [Boolean] whether the call succeeded or not
+    #
+    def self.authenticate
+      Cli.new.system 'gcloud auth login'
+    end
+
+    #
+    # Calls the `get-credentials` API for GCLoud for a specific
+    # container/cluster.
+    #
+    # @return [Boolean] whether the call succeeded or not
+    #
+    def authenticate_k8s
+      @cli.system "gcloud container clusters get-credentials #{self.config.container_cluster}"
+    end
+  end
+end

data/lib/keel/gcloud/cli.rb

@@ -0,0 +1,22 @@
+module Keel::GCloud
+  #
+  # A helper class to run system commands and handle interrupts.
+  # 
+  class Cli
+    def execute command
+      begin
+        `#{command}`
+      rescue Interrupt
+        puts 'Task interrupted.'
+      end
+    end
+
+    def system command
+      begin
+        system command
+      rescue Interrupt
+        puts 'Task interrupted.'
+      end
+    end
+  end
+end

data/lib/keel/gcloud/component.rb

@@ -0,0 +1,24 @@
+module Keel::GCloud
+  #
+  # Class to help manage GCloud components.
+  #
+  class Component
+    #
+    # Updates the installed GCloud components.
+    #
+    # @return [Boolean] whether the call succeeded or not
+    #
+    def self.update
+      Cli.new.system 'gcloud components update'
+    end
+
+    #
+    # Installs the Kubernetes controller component.
+    #
+    # @return [Boolean] whether the call succeeded or not
+    #
+    def self.install_k8s
+      Cli.new.system 'gcloud components install kubectl'
+    end
+  end
+end