k8s-deploy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cc28d2d236622fd2d05a1c0a540cd11697925d9
+  data.tar.gz: fedeec7ff5b0d64dad150a03110346d277f480d7
+SHA512:
+  metadata.gz: d3b194e0303dd938998a15abb66280d863db5c1835b97c34eb1b58d10c46001b48133567d9f2bde7589909d50ab7e2fbf7cb128e950a65de1e3d7b9fa6618165
+  data.tar.gz: d0b361eb5e000e7f40ede347fd0ba9ab6afc2b504bf6de76be4322bcf653d2127f6992e052004b7bf22c2ed78d7d8296455864bdaf52d04673fcc10586edadc0

data/.gitignore

@@ -0,0 +1,13 @@
+# MacOS files
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+.Spotlight-V100
+.Trashes
+
+# Project
+Gemfile.lock
+.bundle
+doc
+.yardoc

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License
+===============
+
+Copyright © 2016 Oleksii Leonov.
+
+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,122 @@
+K8s deploy
+=============
+
+Introduction
+------------
+
+:bomb: **Important — this gem is not production ready.**
+
+This gem provides bunch of useful **Rake** tasks to automate deploy to Kubernetes cluster in Google Container Engine.
+
+Installation
+------------
+
+### Bundler
+
+Add gem to your Gemfile:
+
+```ruby
+gem 'k8s-deploy'
+```
+
+### Manual
+
+Invoke the following command from your terminal:
+
+```bash
+gem install k8s-deploy
+```
+
+Configuration
+-------------
+
+1. You need to put `k8s-deploy.yml` file into your project root.
+2. Add `require 'k8s-deploy/tasks'` to your Rakefile.
+3. Check available tasks with `rake -T` command.
+
+##### Example of k8s-deploy.yml
+
+```yml
+production: # environment name
+  git_branch: master
+  dockerfile: ./Dockerfile
+  container_registry: gcr.io
+  gcloud_project_name: your-gcloud-project-name
+  kubernetes_context: your-cluster-context
+  kubernetes_deployment_name: your-deployment-name
+  kubernetes_template_name: your-template-name
+  kubernetes_docker_image_name: your-dcoker-image-name
+```
+
+You could add as many environments as you need (production, staging, test, etc.) to `k8s-deploy.yml`.
+
+##### Example of Rakefile
+
+```ruby
+require 'k8s-deploy/tasks'
+```
+
+##### Example of `rake -T` output
+
+```bash
+rake k8s:production:check                         # Check production ready for deploy
+rake k8s:production:check:gcloud                  # Check production GCloud
+rake k8s:production:check:git                     # Check production GIT
+rake k8s:production:configuration                 # Show production configuration
+rake k8s:production:deploy                        # Deploy to production
+rake k8s:production:deploy:build                  # Build container for production
+rake k8s:production:deploy:deployment_patch       # Deployment patch for production
+rake k8s:production:deploy:push                   # Push container for production
+rake k8s:production:deploy:rollback               # Rollback last deployment to production
+rake k8s:production:deploy:scale[replicas_count]  # Scale deployment production
+rake k8s:production:status                        # Show production K8s status
+rake k8s:production:status:deployment             # Show production K8s Deployment status
+rake k8s:production:status:docker_image           # Show production K8s Deployment status
+rake k8s:production:status:pods                   # Show production K8s Pods status
+```
+
+Tasks
+-------------
+
+All tasks have next structure:
+
+```bash
+rake k8s:<environment>:<main-task>:<sub-task>
+```
+
+### Main tasks
+
+Show configuration for environment:
+```bash
+rake k8s:<environment>:configuration
+```
+
+Show status of running Deployment & Pods:
+```bash
+rake k8s:<environment>:status
+```
+
+Check GCloud/K8s configuration and GIT (branch, uncommitted changes, etc.):
+```bash
+rake k8s:<environment>:check
+```
+
+Build new Docker image, push to registry, patch Deployment:
+```bash
+rake k8s:<environment>:deploy
+```
+
+Rollback Deployment to previous state.
+```bash
+rake k8s:<environment>:rollback
+```
+
+Scale Deployment to desired number of replicas.
+```bash
+rake k8s:<environment>:scale[1]
+```
+
+License
+-------
+
+The project uses the MIT License. See LICENSE.md for details.

data/k8s-deploy.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/k8s-deploy/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'k8s-deploy'
+  s.version     = K8sDeploy::VERSION.dup
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.platform    = Gem::Platform::RUBY
+  s.author      = 'Oleksii Leonov'
+  s.email       = 'mail@aleksejleonov.com'
+  s.homepage    = 'https://github.com/cropio/k8s-deploy'
+  s.summary     = 'automate deploy to Kubernetes.'
+  s.description = 'automate deploy to Kubernetes.'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 1.9.1'
+  s.add_dependency 'rake', '>= 0.8.2'
+
+  s.files       = `git ls-files`.split("\n")
+end

data/lib/k8s-deploy/tasks.rb

@@ -0,0 +1,12 @@
+require 'rake'
+
+module K8sDeploy
+  class Tasks
+    include Rake::DSL if defined? Rake::DSL
+    def install_tasks
+      load 'k8s-deploy/tasks/k8s-deploy.rake'
+    end
+  end
+end
+
+K8sDeploy::Tasks.new.install_tasks

data/lib/k8s-deploy/tasks/check.rb

@@ -0,0 +1,47 @@
+def print_git_check_branch(configuration)
+  conf_branch = configuration['git_branch']
+  local_branch = `git rev-parse --abbrev-ref HEAD`
+  check_result = local_branch == conf_branch
+
+  puts 'Your local branch must be ' \
+       "#{color_output(:green) { conf_branch }}:\t\t" \
+       "#{check_result_output(check_result)}"
+end
+
+def print_git_check_uncommitted
+  check_result = `git status --porcelain`.empty?
+
+  puts "Your local branch must be clear:\t\t" \
+       "#{check_result_output(check_result)}"
+end
+
+def print_git_check_remote_branch(configuration)
+  conf_branch = configuration['git_branch']
+
+  local_git_hash = `git rev-parse #{conf_branch}`
+  remote_git_hash = `git rev-parse origin/#{conf_branch}`
+  check_result = local_git_hash == remote_git_hash
+
+  puts "Your local version must be same as GitHub:\t" \
+       "#{check_result_output(check_result)}"
+end
+
+def print_gcloud_check_project(configuration)
+  conf_gcloud_project = configuration['gcloud_project_name']
+  current_gcloud_project = `gcloud config get-value project`
+  check_result = current_gcloud_project.include?(conf_gcloud_project)
+
+  puts 'Your GCloud project should be ' \
+       "#{color_output(:green) { conf_gcloud_project }}:\t" \
+       "#{check_result_output(check_result)}"
+end
+
+def print_gcloud_check_kubectl_context(configuration)
+  conf_k8s_context = configuration['kubernetes_context']
+  current_k8s_context = `kubectl config view -o jsonpath='{.current-context}'`
+  check_result = current_k8s_context == conf_k8s_context
+
+  puts 'Your K8s context should be ' \
+       "#{color_output(:green) { conf_k8s_context }}:\t" \
+       "#{check_result_output(check_result)}"
+end

data/lib/k8s-deploy/tasks/configuration.rb

@@ -0,0 +1,27 @@
+CONFIGURATION_OPTIONS = {
+  'git_branch' => 'GIT branch',
+  'dockerfile' => 'Path to Dockerfile',
+  'container_registry' => 'Docker container registry',
+  'gcloud_project_name' => 'GCloud project name',
+  'kubernetes_context' => 'K8s context',
+  'kubernetes_deployment_name' => 'K8s deployment name',
+  'kubernetes_template_name' => 'K8s deployment -> template name',
+  'kubernetes_docker_image_name' => 'K8s deployment -> template -> docker image'
+}.freeze
+
+def validate_configuration(configuration)
+  missed_parameters = CONFIGURATION_OPTIONS.keys - configuration.keys
+
+  unless missed_parameters.empty?
+    params_string = missed_parameters.join(', ')
+    raise "Missed parameters in configuration: #{params_string}."
+  end
+end
+
+def print_configuration(configuration)
+  max_name_length = CONFIGURATION_OPTIONS.values.map(&:length).max
+  CONFIGURATION_OPTIONS.each do |key, name|
+    value = configuration.fetch(key, '—')
+    puts "#{name.rjust(max_name_length)}: #{color_output(:green) { value }}"
+  end
+end

data/lib/k8s-deploy/tasks/console_formatters.rb

@@ -0,0 +1,38 @@
+DELIMITER_WIDTH = 80
+
+CONSOLE_COLORS = {
+  red: "\x1b[31;01m",
+  yellow: "\x1b[33;01m",
+  green: "\x1b[32;01m",
+  no_color: "\x1b[0m"
+}.freeze
+
+# colorizing output
+def color_output(color)
+  raise 'Wrong color name' unless CONSOLE_COLORS.key?(color)
+  CONSOLE_COLORS[color] + yield.to_s + CONSOLE_COLORS[:no_color]
+end
+
+def command_output(text)
+  puts "#> #{text}"
+end
+
+def block_output(header)
+  prepared_header = color_output(:yellow) { " #{header} " }
+
+  # adding 12 to fix size of non-visible color symbols
+  puts
+  puts prepared_header.center(DELIMITER_WIDTH + 12, '=')
+
+  puts
+  yield
+  puts
+end
+
+def check_result_output(result)
+  if result
+    color_output(:green) { 'Ok' }
+  else
+    color_output(:red) { 'Fail' }
+  end
+end

data/lib/k8s-deploy/tasks/deploy.rb

@@ -0,0 +1,125 @@
+def build_timestamp
+  CURRENT_TIME.strftime('%Y%m%d%H%M%S')
+end
+
+def build_tag_name(git_hash)
+  build_timestamp + '-' + git_hash
+end
+
+def get_git_hash(configuration)
+  conf_branch = configuration['git_branch']
+  `git rev-parse #{conf_branch}`
+end
+
+def build_full_image_name(configuration)
+  registry = configuration['container_registry']
+  gcloud_project_name = configuration['gcloud_project_name']
+  docker_image_name = configuration['kubernetes_docker_image_name']
+  local_git_hash = get_git_hash(configuration)[0..6]
+  tag = build_tag_name(local_git_hash)
+
+  "#{registry}/#{gcloud_project_name}/#{docker_image_name}:#{tag}"
+end
+
+def print_deploy_build(configuration)
+  conf_branch = configuration['git_branch']
+  new_image_name = build_full_image_name(configuration)
+
+  puts "New name:\t#{color_output(:green) { new_image_name }}"
+  puts
+  new_git_hash = get_git_hash(configuration)[0..6]
+  puts "New GIT hash:\t#{color_output(:green) { new_git_hash }}"
+
+  git_hash = `git rev-parse #{conf_branch}`
+  git_info = `git log -1 --format=full #{git_hash}`
+
+  puts
+  puts "\t\t--- GIT commit info ---"
+  git_info.each_line do |line|
+    puts "\t\t#{line}"
+  end
+  puts "\t\t-----------------------"
+  puts
+  puts "New Timestamp:\t#{color_output(:green) { build_timestamp }}"
+  puts
+
+  dockerfile_path = configuration['dockerfile']
+  command = "docker build -t #{new_image_name} -f #{dockerfile_path} ."
+  command_output(command)
+  puts
+
+  system command
+end
+
+def print_deploy_push(configuration)
+  new_image_name = build_full_image_name(configuration)
+  command = "gcloud docker push #{new_image_name}"
+  command_output(command)
+  puts
+  system command
+  puts
+  puts 'Sleeping for 5 seconds...'
+  sleep 5
+end
+
+def print_deploy_deployment_patch(configuration)
+  deployment_name = configuration['kubernetes_deployment_name']
+  template_name = configuration['kubernetes_template_name']
+  new_image_name = build_full_image_name(configuration)
+
+  json_template = {
+    spec: {
+      template: {
+        spec: {
+          containers: [{
+            name: template_name,
+            image: new_image_name
+          }]
+        }
+      }
+    }
+  }
+
+  template_string = JSON.dump(json_template)
+
+  command = "kubectl patch deployment #{deployment_name} -p " \
+            "'#{template_string}' --record"
+
+  command_output(command)
+  puts
+
+  print color_output(:yellow) { 'Confirm deploy (y/N): ' }
+
+  case STDIN.gets.strip
+  when 'Y', 'y', 'Yes', 'yes'
+    puts
+    puts color_output(:green) { 'Starting deploy...' }
+    system command
+    puts
+    puts 'Now you can check deploy status with ' \
+         "#{color_output(:yellow) { 'status' }} command."
+  else
+    puts
+    puts color_output(:red) { 'Deploy terminated.' }
+    exit 1
+  end
+end
+
+def print_deploy_rollback(configuration)
+  deployment_name = configuration['kubernetes_deployment_name']
+  command = "kubectl rollout undo deployment #{deployment_name}"
+
+  command_output(command)
+  puts
+  system command
+end
+
+def print_deploy_scale(configuration, replicas_count)
+  deployment_name = configuration['kubernetes_deployment_name']
+  command = "kubectl scale deployment #{deployment_name} " \
+            "--replicas=#{replicas_count}"
+
+  command_output(command)
+  puts
+  system command
+end

data/lib/k8s-deploy/tasks/k8s-deploy.rake

@@ -0,0 +1,128 @@
+require 'yaml'
+require 'json'
+require 'time'
+
+require_relative 'console_formatters.rb'
+require_relative 'configuration.rb'
+require_relative 'status.rb'
+require_relative 'check.rb'
+require_relative 'deploy.rb'
+
+# Configuration file path
+CONFIGURATION_FILE = 'k8s-deploy.yml'.freeze
+
+# Get start time
+CURRENT_TIME = Time.now.utc
+
+# Read configuration file
+begin
+  CONFIGURATION = YAML.load_file(CONFIGURATION_FILE)
+rescue Errno::ENOENT
+  CONFIGURATION = [].freeze
+end
+
+namespace :k8s do
+  CONFIGURATION.each do |environment, configuration|
+    validate_configuration(configuration)
+
+    namespace environment do
+      desc "Show #{environment} configuration"
+      task :configuration do
+        block_output("Configuration for #{environment}") do
+          print_configuration(configuration)
+        end
+      end
+
+      desc "Show #{environment} K8s status"
+      task status: ['status:deployment', 'status:pods', 'status:docker_image']
+
+      namespace :status do
+        desc "Show #{environment} K8s Pods status"
+        task :pods do
+          block_output("K8s Pods status for #{environment}") do
+            print_pods_status(configuration)
+          end
+        end
+
+        desc "Show #{environment} K8s Deployment status"
+        task :deployment do
+          block_output("K8s Deployment status for #{environment}") do
+            print_deployment_status(configuration)
+          end
+        end
+
+        desc "Show #{environment} K8s Deployment status"
+        task :docker_image do
+          block_output("K8s Docker image status for #{environment}") do
+            print_docker_image_status(configuration)
+          end
+        end
+      end
+
+      desc "Check #{environment} ready for deploy"
+      task check: ['check:git', 'check:gcloud']
+
+      namespace :check do
+        desc "Check #{environment} GIT"
+        task :git do
+          block_output("Check GIT for #{environment}") do
+            print_git_check_branch(configuration)
+            print_git_check_uncommitted
+            print_git_check_remote_branch(configuration)
+          end
+        end
+
+        desc "Check #{environment} GCloud"
+        task :gcloud do
+          block_output("Check GCloud for #{environment}") do
+            print_gcloud_check_project(configuration)
+            print_gcloud_check_kubectl_context(configuration)
+          end
+        end
+      end
+
+      desc "Deploy to #{environment}"
+      task deploy: [:configuration, :check, :status,
+                    'deploy:build',
+                    'deploy:push',
+                    'deploy:deployment_patch']
+
+      namespace :deploy do
+        desc "Build container for #{environment}"
+        task :build do
+          block_output("Build container for #{environment}") do
+            print_deploy_build(configuration)
+          end
+        end
+
+        desc "Push container for #{environment}"
+        task :push do
+          block_output("Push container for #{environment}") do
+            print_deploy_push(configuration)
+          end
+        end
+
+        desc "Deployment patch for #{environment}"
+        task :deployment_patch do
+          block_output("Deployment patch for #{environment}") do
+            print_deploy_deployment_patch(configuration)
+          end
+        end
+
+        desc "Rollback last deployment to #{environment}"
+        task :rollback do
+          block_output("Rollback for #{environment}") do
+            print_deploy_rollback(configuration)
+          end
+        end
+
+        desc "Scale deployment #{environment}"
+        task :scale, [:replicas_count] do |_task, args|
+          block_output("Scale for #{environment}") do
+            print_deploy_scale(configuration, args[:replicas_count])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k8s-deploy/tasks/status.rb

@@ -0,0 +1,67 @@
+def print_deployment_status(configuration)
+  deployment_name = configuration['kubernetes_deployment_name']
+
+  basic_info_command = "kubectl get deployment #{deployment_name} --show-labels"
+  command_output(basic_info_command)
+  puts
+  system basic_info_command
+  puts
+
+  describe_command = "kubectl describe deployment #{deployment_name}"
+  command_output(describe_command)
+  puts
+  system describe_command
+end
+
+def print_pods_status(configuration)
+  template_name = configuration['kubernetes_template_name']
+
+  command = "kubectl get pods --show-labels -l name=#{template_name}"
+  command_output(command)
+  puts
+  system command
+end
+
+def print_docker_image_status(configuration)
+  deployment_name = configuration['kubernetes_deployment_name']
+
+  command = "kubectl get deployment #{deployment_name} -o template " \
+            "'--template={{(index .spec.template.spec.containers 0).image}}'"
+
+  command_output(command)
+  puts
+
+  docker_image = `#{command}`
+  puts "Full name:\t#{color_output(:green) { docker_image }}"
+
+  time_hash = docker_image.split(':').last
+  git_hash = time_hash.split('-').last
+  timestamp = time_hash.split('-').first
+
+  puts
+
+  # check git_hash is valid
+  if git_hash && /^[a-f0-9]+$/.match(git_hash)
+    puts "GIT hash:\t#{color_output(:green) { git_hash }}"
+    git_info = `git log -1 --format=full #{git_hash}`
+
+    puts
+    puts "\t\t--- GIT commit info ---"
+    git_info.each_line do |line|
+      puts "\t\t#{line}"
+    end
+    puts "\t\t-----------------------"
+  else
+    puts color_output(:red) { "ERROR! Can't parse GIT hash from tag!" }
+  end
+
+  puts
+  begin
+    time_utc = Time.strptime(timestamp + ' UTC', '%Y%m%d%H%M%S %Z')
+    puts "Timestamp:\t#{color_output(:green) { timestamp }}"
+    puts "Time (UTC):\t#{time_utc}"
+    puts "Time (local):\t#{time_utc.getlocal}"
+  rescue ArgumentError
+    puts color_output(:red) { "ERROR! Can't parse timestamp from tag!" }
+  end
+end

data/lib/k8s-deploy/version.rb

@@ -0,0 +1,7 @@
+##
+# Defines version.
+class K8sDeploy
+  ##
+  # @return [String] the library version
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: k8s-deploy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oleksii Leonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: automate deploy to Kubernetes.
+email: mail@aleksejleonov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.md
+- README.md
+- k8s-deploy.gemspec
+- lib/k8s-deploy/tasks.rb
+- lib/k8s-deploy/tasks/check.rb
+- lib/k8s-deploy/tasks/configuration.rb
+- lib/k8s-deploy/tasks/console_formatters.rb
+- lib/k8s-deploy/tasks/deploy.rb
+- lib/k8s-deploy/tasks/k8s-deploy.rake
+- lib/k8s-deploy/tasks/status.rb
+- lib/k8s-deploy/version.rb
+homepage: https://github.com/cropio/k8s-deploy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: automate deploy to Kubernetes.
+test_files: []