kubernetes-deploy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3658ae1e0a4c2163f17843504df7fe4252f7f0ea
-  data.tar.gz: 78b8016923a5cbccda633cb9651e12fe678f2cc6
+  metadata.gz: 821c10919c954524f0e04068a6335ca187e83282
+  data.tar.gz: 0e63e63103fd2a0c5e8725553649b710670401bc
 SHA512:
-  metadata.gz: 88e9824411a939c1d5c864602a512d4ec420f18984e54138c0cf8bc9edbbc0e82190499b74900bcc624dfd190b6b766e83c78d491f5ca5c9c128c03284cb63bb
-  data.tar.gz: 5d663ab66c6d2fdeb41dbafa4289c129bc43bd8eb68b84d4feba3062bde215133c80f8521dc58b8f43032ac3616dfc13b69edea9f3992a77c7fe3dbd1ded78dc
+  metadata.gz: 0981745c90e24271e2c95ee825a62c57bb86823d3de470109151187f0adc085f6812402a1cbf50df751e43083cce5f5de9883f1147f2aab53296e93647ce5da0
+  data.tar.gz: d608ff476b6e72ec54b5501ef3ff31a3f20218295623a72b3dde8ae2a15f81a1ccd073e6026de120ab84e8a28663039033494f78f1e40d53dde9963eea70d732

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'pry'
+gem 'kubeclient'

data/README.md

@@ -1,8 +1,8 @@
 # Kubernetes::Deploy
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kubernetes/deploy`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build status](https://badge.buildkite.com/0f2d4956d49fbc795f9c17b0a741a6aa9ea532738e5f872ac8.svg)](https://buildkite.com/shopify/kubernetes-deploy-gem)
 
-TODO: Delete this and the text above, and describe your gem
+Deploy script used to manage a Kubernetes application's namespace with [Shipit](https://github.com/Shopify/shipit-engine).
 
 ## Installation
 
@@ -22,14 +22,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`kubernetes-deploy <app's namespace> <kube context> --template-dir=DIR`
+
+Requirements:
+
+ - kubectl 1.5.1+ binary must be available in your path
+ - `ENV['KUBECONFIG']` must point to a valid kubeconfig file that includes the context you want to deploy to
+ - The target namespace must already exist in the target context
+ - `ENV['GOOGLE_APPLICATION_CREDENTIALS']` must point to the credentials for an authenticated service account if your user's auth provider is gcp
+ - `ENV['ENVIRONMENT']` must be set to use the default template path (`config/deploy/$ENVIRONMENT`) in the absence of the `--template-dir=DIR` option
+
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. You currently need to [manually install kubectl version 1.5.1 or higher](https://kubernetes.io/docs/user-guide/prereqs/) as well if you don't already have it.
+
+To run the tests:
+
+* [Install minikube](https://kubernetes.io/docs/getting-started-guides/minikube/#installation)
+* Start minikube (`minikube start [options]`)
+* Make sure you have a context named "minikube" in your kubeconfig. Minikube adds this context for you when you run `minikube start`; please do not rename it. You can check for it using `kubectl config get-contexts`.
+* Run `bundle exec rake test`
 
 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).
 
+## CI
+
+Buildkite will build branches as you're working on them, but as soon as you create a PR it will stop building new commits from that branch because we disabled PR builds for security reasons.
+As a Shopify employee, you can manually trigger the PR build from the Buildkite UI (just specify the branch, SHA is not required):
+
+<img width="464" alt="screen shot 2017-02-21 at 10 55 33" src="https://cloud.githubusercontent.com/assets/522155/23172610/52771a3a-f824-11e6-8c8e-3d59c45e7ff8.png">
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kubernetes-deploy.
@@ -38,4 +62,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/ci

@@ -0,0 +1,32 @@
+#!/bin/bash
+set -eox pipefail
+
+MINIKUBE_VER=0.16.0
+KUBERNETES_VER=1.5.2
+DOCKER_MACHINE_KVM_VER=0.7.0
+
+echo "--- Installing dependencies"
+curl -Lo minikube https://storage.googleapis.com/minikube/releases/v$MINIKUBE_VER/minikube-linux-amd64
+chmod +x minikube
+sudo mv minikube /usr/local/bin/
+
+# minikube requires kubectl
+curl -Lo kubectl https://storage.googleapis.com/kubernetes-release/release/v$KUBERNETES_VER/bin/linux/amd64/kubectl
+chmod +x kubectl
+sudo mv kubectl /usr/local/bin/
+
+# KVM support for minikube
+curl -Lo docker-machine-driver-kvm https://github.com/dhiltgen/docker-machine-kvm/releases/download/v$DOCKER_MACHINE_KVM_VER/docker-machine-driver-kvm
+chmod +x docker-machine-driver-kvm
+sudo mv docker-machine-driver-kvm /usr/local/bin/
+
+minikube config set vm-driver kvm
+
+gem install bundler --no-ri --no-rdoc
+bundle install --jobs 4
+
+echo "--- Starting minikube"
+minikube start --cpus 2 --memory 2048 --disk-size=2gb --kubernetes-version=$KUBERNETES_VER
+
+echo "--- Running tests"
+bundle exec rake test

data/bin/setup

@@ -1,8 +1,16 @@
 #!/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
+if [ ! -x "$(which minikube)" ]; then
+  echo -e "\n\033[0;33mIf you're going to run the tests, please follow the minikube setup instructions for your operating system:\nhttps://kubernetes.io/docs/getting-started-guides/minikube/#installation\033[0m"
+fi
+
+if [ ! -x "$(which kubectl)" ]; then
+  echo -e "\n\033[0;33mPlease install kubectl version 1.5.1 or higher:\nhttps://kubernetes.io/docs/user-guide/prereqs/\033[0m"
+else
+  KUBECTL_VERSION=$(kubectl version --short --client | grep -oe "v[[:digit:]\.]\+")
+  echo -e "\n\033[0;32mKubectl version $KUBECTL_VERSION is already installed. This gem requires version v1.5.1 or greater.\033[0m"
+fi

data/exe/kubernetes-deploy

@@ -1,15 +1,5 @@
 #!/usr/bin/env ruby
 
-# Usage: kubernetes-deploy <app's namespace> <kube context>
-
-# Prerequisites:
-#  - kubectl 1.5.1+ binary must be available in the shipit machine's path
-#  - ENV['KUBECONFIG'] must point to a valid kubeconfig file that includes all the contexts you want to deploy to
-#  - ENV['GOOGLE_APPLICATION_CREDENTIALS'] must point to the credentials for an authenticated service account if your user's auth provider is gcp
-
-# Optionally, the following variables can be used to override script defaults:
-#  - ENV['K8S_TEMPLATE_FOLDER']: Location of Kubernetes files to deploy. Default is config/deploy/#{environment}.
-
 require 'kubernetes-deploy'
 
 require 'optparse'
@@ -31,11 +21,16 @@ if !template_dir || template_dir.empty?
   exit 1
 end
 
+revision = ENV.fetch('REVISION') do
+  puts "ENV['REVISION'] is missing. Please specify the commit SHA"
+  exit 1
+end
+
 KubernetesDeploy::Runner.with_friendly_errors do
   runner = KubernetesDeploy::Runner.new(
     namespace: ARGV[0],
     context: ARGV[1],
-    current_sha: ENV['REVISION'],
+    current_sha: revision,
     template_dir: template_dir,
     wait_for_completion: !skip_wait,
   )

data/lib/kubernetes-deploy/kubernetes_resource.rb

@@ -24,6 +24,14 @@ module KubernetesDeploy
       end
     end
 
+    def self.timeout
+      self::TIMEOUT
+    end
+
+    def timeout
+      self.class.timeout
+    end
+
     def initialize(name, namespace, context, file)
       # subclasses must also set these
       @name, @namespace, @context, @file = name, namespace, context, file
@@ -68,7 +76,7 @@ module KubernetesDeploy
 
     def deploy_timed_out?
       return false unless @deploy_started
-      !deploy_succeeded? && !deploy_failed? && (Time.now.utc - @deploy_started > self.class::TIMEOUT)
+      !deploy_succeeded? && !deploy_failed? && (Time.now.utc - @deploy_started > timeout)
     end
 
     def tpr?

data/lib/kubernetes-deploy/kubernetes_resource/deployment.rb

@@ -37,8 +37,8 @@ module KubernetesDeploy
     def deploy_succeeded?
       return false unless @rollout_data.key?("availableReplicas")
       # TODO: this should look at the current replica set's pods too
-      @rollout_data["availableReplicas"].to_i == @pods.length &&
-      @rollout_data.values.uniq.length == 1 # num desired, current, up-to-date and available are equal
+      @rollout_data["updatedReplicas"].to_i == @rollout_data["replicas"].to_i &&
+      @rollout_data["updatedReplicas"].to_i == @rollout_data["availableReplicas"].to_i
     end
 
     def deploy_failed?

data/lib/kubernetes-deploy/runner.rb

@@ -174,7 +174,8 @@ MSG
       delay_sync_until = Time.now.utc
       started_at = delay_sync_until
       human_resources = watched_resources.map(&:id).join(", ")
-      KubernetesDeploy.logger.info("Waiting for #{human_resources}")
+      max_wait_time = watched_resources.map(&:timeout).max
+      KubernetesDeploy.logger.info("Waiting for #{human_resources} with #{max_wait_time}s timeout")
       while watched_resources.present?
         if Time.now.utc < delay_sync_until
           sleep (delay_sync_until - Time.now.utc)

data/lib/kubernetes-deploy/version.rb

@@ -1,3 +1,3 @@
 module KubernetesDeploy
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kir Shatrov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,7 +81,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
+- bin/ci
 - bin/setup
 - exe/kubernetes-deploy
 - kubernetes-deploy.gemspec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "kubernetes/deploy"
-
-# 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