mina-kubernetes 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f1fd603c840045e6402d4eee5e82b997a3e31459b2e33f904bff8541cf4ce42
-  data.tar.gz: b31401cfce0e729fabbc51e0aa37841a7b6e907639fc5fa572046ac4e3916924
+  metadata.gz: f69cc691a91d27b5cefa7d4a79056184cfad126ffd833ce2c11c8c85438516ef
+  data.tar.gz: 15e3ee21f521d47f1cc4d22ab70edeb7ace125244b301a571fcb88a3ea01537d
 SHA512:
-  metadata.gz: 83b16882b97e8b5a1e2bfd13a2143955443c39d9fb3166c457457510cffd375e32b468a1d4fba608e0822425ebd61d9abd40a12a38fbcc037ea6d6707ad0abd4
-  data.tar.gz: 8cfc7cc45cb7dbf508a97ad3c3c6ecff2d094530672a3fb38676426d25448a2d676a0e362d45507cbf89066caa06db971864cfbf26878f360446f5c117f54ca3
+  metadata.gz: 4e3d514d8ee7e171f28d646f2142dc1fad2acca1416ecb30baa77742c1f046e19cd92990d88e34016d196f62fbaf7492f99778158a69504365af7c3844096a70
+  data.tar.gz: '01066097331bdac2aeba3b2228fc4d78f68511accef2ea59d111478d379bf37551b55673842dbf77b9cc1d0012222d6378328bb7538dde1c9ea46335c3121be9'

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 2.0.0
+
+*Breaking*
+
+- Using `namespace` config variable instead of `app_name`
+- Using `kubernetes_context` config variable linking directly to a context set in $KUBE_CONFIG instead of creating a new context from separate `kubernetes_cluster` and `kubernetes_user` config variables
+
+*Fixes*
+
+- Not overriding $KUBE_CONFIG environment variable anymore

data/README.md

@@ -3,6 +3,9 @@ Plugin for the [mina](https://github.com/mina-deploy/mina) deployment tool to st
 
 Requires local Docker and [kubectl](https://cloud.google.com/kubernetes-engine/docs/quickstart) with authentication set up to connect to the destination Kubernetes cluster.
 
+NB: `docker manifest inspect` is used to check the image is available. This requires experimental features to be enabled in your local Docker config by adding `"experimental": "enabled"` to `~/.docker/config.json`.
+If the image repository is not public authentication will need to be set up for your local Docker, for instance see https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper for images hosted on the Google Cloud Registry
+
 ## Usage
 
 Add `mina-kubernetes` to your local Gemfile. 
@@ -10,6 +13,7 @@ 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/multistage"
 require "mina/kubernetes"
 
 task :deploy do
@@ -19,20 +23,14 @@ 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"
+set :namespace, "my_app"
+set :image_repo, "gcr.io/project-id/myapp"
+set :kubernetes_context, "kubernetes_context_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.
+Then add `*.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.
 
@@ -52,4 +50,4 @@ Prompts for branch unless image tag is set, then spins up a temporary pod with t
 
 #### `kubernetes:delete`
 
-Confirms and delete all resources on cluster under namespace `app_name-stage`.
+Confirms and delete all resources on cluster under namespace. 

data/lib/mina/kubernetes.rb

@@ -7,20 +7,13 @@ 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
 
@@ -35,17 +28,15 @@ namespace :kubernetes 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))
+    run_terminal_command(fetch(:command), env_hash_arg)
   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?")
+    if TTY::Prompt.new.yes?("This will delete all resources in namespace #{fetch(:namespace)} on context #{fetch(:kubernetes_context)}, 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)}"
+        command "kubectl delete namespace #{fetch(:namespace)} --context=#{fetch(:kubernetes_context)}"
       end
     end
   end
@@ -54,6 +45,10 @@ end
 
 private
 
+def env_hash_arg
+  @env_hash_arg ||= (fetch(:env_hash).is_a?(String) ? JSON.parse(fetch(:env_hash)) : fetch(:env_hash)) || {}
+end
+
 def set_tag_from_branch_commit
   run :local do
     comment "Updating Git branches..."
@@ -66,14 +61,7 @@ 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)}"
+    command "kubectl create namespace #{fetch(:namespace)} --dry-run -o yaml | kubectl apply -f - --context=#{fetch(:kubernetes_context)}"
   end
 end
 
@@ -97,12 +85,12 @@ 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}"
+  system "kubectl run #{label}-#{SecureRandom.hex(4)} --rm -i --tty --restart=Never --context=#{fetch(:kubernetes_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)}"
+    command "REVISION=#{fetch(:image_tag)} kubernetes-deploy --template-dir=config/deploy/#{fetch(:stage)} --bindings=image_repo=#{fetch(:image_repo)},image_tag=#{fetch(:image_tag)},namespace=#{fetch(:namespace)} #{fetch(:namespace)} #{fetch(:kubernetes_context)}"
   end
 end

data/lib/mina/kubernetes/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mina-kubernetes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Antoine Sabourin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - README.md
 - Rakefile
 - lib/mina/kubernetes.rb