mina-kubernetes 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f1fd603c840045e6402d4eee5e82b997a3e31459b2e33f904bff8541cf4ce42
+  data.tar.gz: b31401cfce0e729fabbc51e0aa37841a7b6e907639fc5fa572046ac4e3916924
+SHA512:
+  metadata.gz: 83b16882b97e8b5a1e2bfd13a2143955443c39d9fb3166c457457510cffd375e32b468a1d4fba608e0822425ebd61d9abd40a12a38fbcc037ea6d6707ad0abd4
+  data.tar.gz: 8cfc7cc45cb7dbf508a97ad3c3c6ecff2d094530672a3fb38676426d25448a2d676a0e362d45507cbf89066caa06db971864cfbf26878f360446f5c117f54ca3

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/README.md

@@ -0,0 +1,55 @@
+# mina-kubernetes
+Plugin for the [mina](https://github.com/mina-deploy/mina) deployment tool to streamline deployment of resources to Kubernetes cluster, using the [kubernetes-deploy](https://github.com/Shopify/kubernetes-deploy) gem and [mina-multistage](https://github.com/endoze/mina-multistage) plugin.
+
+Requires local Docker and [kubectl](https://cloud.google.com/kubernetes-engine/docs/quickstart) with authentication set up to connect to the destination Kubernetes cluster.
+
+## Usage
+
+Add `mina-kubernetes` to your local Gemfile. 
+
+Create a configuration file for mina in `config/deploy.rb` like the one below:
+```ruby
+require "mina/default"
+require "mina/kubernetes"
+
+task :deploy do
+  invoke :"kubernetes:deploy"
+end
+```
+
+Add the following variables to your stage configuration i.e. `config/deploy/production.rb`:
+```ruby
+set :app_name, "my_app"
+set :image_repository, "gcr.io/project-id/myapp"
+set :kubernetes_cluster, "kubernetes_cluster_name"
+set :kubernetes_user, "kubernetes_user_name"
+```
+
+If `set :image_tag, "my_image_tag"` is also defined, it'll be used to deploy the image tagged with this tag on the repository. Otherwise you'll be prompted to pick a branch from current working Git repository and the image to deploy will be assumed to be tagged with the Git commit hash, i.e. `gcr.io/project-123456/my_app:abcd1234`.
+
+Optional configuration (showing default values):
+```ruby
+set :kube_config, "~/.kube/config"
+```
+
+Then create `*.yml.erb` Kubernetes resource definition files in the stage folder, i.e. `config/deploy/production/app.yml.erb`. Occurences of `<%= image_repo %>` and `<%= current_sha %>` in these files will be dynamically replaced on deploy by the image repository URL and the latest commit hash of the selected branch on its git origin.
+
+When you run `mina production deploy`, a namespace labelled `my_app-production` will be created on the Kubernetes cluster and set as a local kubectl context. Then the resources are applied to the cluster after checking/waiting for the image to be available on the repository.
+
+### Tasks available
+
+#### `kubernetes:deploy`
+
+Creates namespace on cluster and assigns it to a local kubectl context, prompts for git branch if no image tag specified, applies all resources to cluster after checking tagged image is available.
+
+#### `kubernetes:bash`
+
+Prompts for branch unless image tag is set, then spins up a temporary pod with the image and opens up a remote bash terminal.
+
+#### `kubernetes:command`
+
+Prompts for branch unless image tag is set, then spins up a temporary pod with the image and run command given by task variable `command`, for instance with `set :command, "rails console"`. Environment variables can also be given by defining`env_hash`, i.e. `set :env_hash, {"RAILS_ENV" => "production", "MY_VAR" => "abcd123"}`
+
+#### `kubernetes:delete`
+
+Confirms and delete all resources on cluster under namespace `app_name-stage`.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mina/kubernetes.rb

@@ -0,0 +1,108 @@
+require "tty-prompt"
+require "tty-spinner"
+require "securerandom"
+require "json"
+require "base64"
+
+# required by mina
+set :execution_mode, :pretty
+
+# default for kubernetes-deploy
+set :kube_config, "~/.kube/config"
+
+namespace :kubernetes do
+
+  set :namespace, fetch(:app_name)
+  set :context, "#{fetch(:namespace)}-#{fetch(:stage)}"
+
+  task :deploy do
+    desc "Set image tag to be latest commit of prompted branch (unless provided) then applies resources to cluster"
+    set_tag_from_branch_commit unless fetch(:image_tag)
+    wait_until_image_ready(fetch(:image_tag))
+    create_namespace_on_cluster
+    set_local_config_context
+    apply_kubernetes_resources
+  end
+
+  task :bash do
+    desc "Spins up temporary pod with image and opens remote interactive bash"
+    set_tag_from_branch_commit unless fetch(:image_tag)
+    wait_until_image_ready(fetch(:image_tag))
+    run_terminal_command("bash")
+  end
+
+  task :command do
+    desc "Spins up temporary pod with image and runs given command in interactive shell, passing given environment variable"
+    set_tag_from_branch_commit unless fetch(:image_tag)
+    wait_until_image_ready(fetch(:image_tag))
+    run_terminal_command(fetch(:command), fetch(:env_hash))
+  end
+
+  task :delete do
+    desc "Delete all resources in namespace on cluster"
+    if TTY::Prompt.new.yes?("This will delete all resources in namespace #{fetch(:namespace)} on cluster #{fetch(:kubernetes_cluster)}, are you sure?")
+      run :local do
+        comment "Deleting all resources in #{fetch(:namespace)}..."
+        command "kubectl delete namespace #{fetch(:namespace)} --cluster=#{fetch(:kubernetes_cluster)}"
+        comment "Removing local config context..."
+        command "kubectl config unset contexts.#{fetch(:context)}"
+      end
+    end
+  end
+
+end
+
+private
+
+def set_tag_from_branch_commit
+  run :local do
+    comment "Updating Git branches..."
+  end
+  remote_branches = `git fetch --prune && git branch -r --no-merged master --sort=-committerdate | grep origin`.split("\n").collect { |b| b.strip.gsub("origin/", "") }.reject { |b| b == "master" }
+  set :branch, TTY::Prompt.new.select("Which branch?", ["master"].concat(remote_branches))
+  set :image_tag, `git rev-parse origin/#{fetch(:branch)}`.split("\n")[0]
+end
+
+def create_namespace_on_cluster
+  run :local do
+    comment "Create/update namespace on Kubernetes cluster..."
+    command "kubectl create namespace #{fetch(:namespace)} --dry-run -o yaml | kubectl apply -f - --cluster=#{fetch(:kubernetes_cluster)}"
+  end
+end
+
+def set_local_config_context
+  run :local do
+    comment "Set up local Kubernetes config context..."
+    command "kubectl config set-context #{fetch(:context)} --namespace=#{fetch(:namespace)} --cluster=#{fetch(:kubernetes_cluster)} --user=#{fetch(:kubernetes_user)}"
+  end
+end
+
+def wait_until_image_ready(commit)
+  run :local do
+    comment "Check image #{fetch(:image_repo)}:#{commit} is available..."
+  end
+  spinner = TTY::Spinner.new
+  spinner.auto_spin
+  while !image_available?(commit)
+    sleep 5
+  end
+  spinner.stop
+end
+
+def image_available?(commit)
+  system("docker manifest inspect #{fetch(:image_repo)}:#{commit} > /dev/null") == true
+end
+
+def run_terminal_command(command, env_hash = {})
+  env = env_hash.collect{|k,v| "--env #{k}=#{v}" }.join(" ")
+  label = command.downcase.gsub(" ", "-").gsub(":", "-")
+  # using system instead of mina's command so tty opens successfully
+  system "kubectl run #{label}-#{SecureRandom.hex(4)} --rm -i --tty --restart=Never --context=#{fetch(:context)} --image #{fetch(:image_repo)}:#{fetch(:image_tag)} #{env} -- #{command}"
+end
+
+def apply_kubernetes_resources
+  run :local do
+    comment "Apply all Kubernetes resources..."
+    command "REVISION=#{fetch(:image_tag)} KUBECONFIG=#{fetch(:kube_config)} ENVIRONMENT=#{fetch(:stage)} kubernetes-deploy --bindings=image_repo=#{fetch(:image_repo)},image_tag=#{fetch(:image_tag)},namespace=#{fetch(:namespace)} #{fetch(:namespace)} #{fetch(:context)}"
+  end
+end

data/lib/mina/kubernetes/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  module Kubernetes
+    VERSION = "1.0.1"
+  end
+end

data/mina-kubernetes.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina/kubernetes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mina-kubernetes'
+  spec.version       = Mina::Kubernetes::VERSION
+  spec.authors       = ['Antoine Sabourin']
+  spec.email         = ['antoine@streem.com.au']
+
+  spec.summary       = %q{Mina plugin to streamline deployment of resources to Kubernetes cluster}
+  spec.description   = %q{Mina plugin to streamline deployment of resources to Kubernetes cluster}
+  spec.homepage      = 'https://github.com/streemau/mina-kubernetes'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  
+  spec.add_runtime_dependency 'mina', '~> 1.0'
+  spec.add_runtime_dependency 'mina-multistage', '~> 1.0'
+  spec.add_runtime_dependency 'kubernetes-deploy'
+  spec.add_runtime_dependency 'tty-prompt'
+  spec.add_runtime_dependency 'tty-spinner'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: mina-kubernetes
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Antoine Sabourin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mina-multistage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: kubernetes-deploy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mina plugin to streamline deployment of resources to Kubernetes cluster
+email:
+- antoine@streem.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- lib/mina/kubernetes.rb
+- lib/mina/kubernetes/version.rb
+- mina-kubernetes.gemspec
+homepage: https://github.com/streemau/mina-kubernetes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Mina plugin to streamline deployment of resources to Kubernetes cluster
+test_files: []