kubes 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68eb4fe2f49953dd133ed6d5baece88f47ff0078162576a0cc41238bf571b6fc
-  data.tar.gz: 29821780f33d80b168f20d2f42e38074776230ed7cde8fc474d947c70bc6f099
+  metadata.gz: 4068263aefa8212b17485e3a257813b806e0efc0617c01e7210db576759c2f27
+  data.tar.gz: e649b39644516f59a09c08ec33d05c9ceb9adde006c6bda386f370bec8e205d8
 SHA512:
-  metadata.gz: 0c6de28da8411c1a62cc6fb310e0057aaae12d4e219c14399002b81731f5ecc3f20b596247a367068a5c83695f7d25ffdb0583004e8e7b3812eaf57646b86709
-  data.tar.gz: 828253eb8e9943dd39218de79a73cb6ae2c6652b4f6e88e4aebe1b1ab5b6be44ff9aee199cee9208a8abc5f038608c5ad1ead7836799c57813df37f49ed5e0db
+  metadata.gz: 0f65b2736c9967eee1a24b65513bed5bb79177c54f8870871e1428e4ba6ff4b2e2501e5d6a1a78ada9f2db971763a6b1f6d35b4818fcfaf76df95baa37aba049
+  data.tar.gz: cfb8c9a0371d7efd6e9a4d8deeb1c503a18c63fd291a0a89275b9bf84996fa7a6ce7f3dfc7c83e8ff98546fc94c80a65bf41f953121833b0f3614c5a635098de

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.6.2]
+- [#36](https://github.com/boltops-tools/kubes/pull/36) add plugin hooks support
+
 ## [0.6.1]
 - update gemspec dependency to plugins that provide the secrets helpers
 

data/README.md

@@ -18,13 +18,6 @@ Kubes will:
 2. Compile Kubernetes YAML files from YAML/ERB or a DSL and adjusts the Docker build image
 3. Deploy via kubectl apply on the compiled Kubernetes YAML files
 
-Features:
-
-* Automation: [Builds the Docker image](docs/docker.md) and updates the compiled YAML files
-* Syntactic Sugar: Use an optional [ERB/YAML](docs/yaml.md) or [DSL](docs/dsl.md) to write your Kubernetes YAML files. You can use a mix of DSL and YAML definitions in the `.kubes/resources` folder.
-* Layering: Use the same Kubernetes YAML to build multiple environments like dev and prod with [layering](docs/layering.md).
-* CLI Customizations: You can customize the [cli args](docs/kubectl.md). You can also run hooks before and after kubectl commands.
-
 ## Usage
 
     kubes init # creates .kubes structure

data/docs/_docs/config/hooks/kubes.md

@@ -13,6 +13,7 @@ Hook | Description
 compile | When kubes compiles the `.kubes/resources` to `.kubes/output`.
 apply | When kubes runs all the `kubectl apply` commands.
 delete | When kubes runs all the `kubectl delete` commands.
+prune | When kubes prunes. IE: To clean old secrets.
 
 ## Lifecycle At Kubes Level
 

data/docs/_docs/dsl/multiple-resources.md

@@ -39,7 +39,9 @@ Using multiple files is the general recommended approach.
 
 ## Multiple Resources: Block Form
 
-You can also use a block form to create multiple resources.  You name the resource files with plural names. An example helps explain:
+You can also use a block form to create multiple resources.  The multiple resources block form is an experimental feature.
+
+You name the resource files with plural names. An example helps explain:
 
     .kubes
     └── resources

data/docs/_docs/helpers/google/gke.md

@@ -0,0 +1,33 @@
+---
+title: GKE Whitelisting
+nav_text: GKE
+categories: helpers-google
+---
+
+This page covers how to enable GKE IP Whitelisting. This feature is useful for deploying from a CloudBuild with GKE Private Clusters.
+
+GKE Private Clusters whitelist and only allow authorized IPs to communicate with the Kubernetes control plane.  An issue with CloudBuild is that the IP address is not well-known.  Google creates a VM to run the CI scripts and throws it away when finished.  Kubes can detect the IP of the CloudBuild machine, add it to the cluster, deploy, and remove the IP afterward.
+
+## Setup
+
+To enable the GKE IP whitelisting feature, it's a single line:
+
+.kubes/config/env/dev.rb
+
+```ruby
+KubesGoogle.configure do |config|
+  config.gke.cluster_name = "projects/#{ENV['GOOGLE_PROJECT']}/locations/us-central1/clusters/dev-cluster"
+end
+```
+
+This enables `kubes apply` before and after hooks to add and remove the current machine IP.
+
+## Options
+
+Here are the `config.gke` settings:
+
+Name | Description | Default
+---|---|---
+cluster_name | GKE cluster name. This is required. | nil
+enable_hooks | This will be true when the cluster_name is set. So there's no need to set it. The option provides a quick way to override and disable running the hooks. | true
+whitelist_ip | Explicit IP to whitelist. By default the IP address of the current machine is automatically detected and used. | nil

data/docs/_docs/layering/mix.md

@@ -70,7 +70,7 @@ spec:
 
 ## Output
 
-The result is the merge layered files.
+The result is the merged layered files.
 
 ```yaml
 metadata:

data/kubes.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   # core helper libs
   spec.add_dependency "kubes_aws", "~> 0.2.0"
-  spec.add_dependency "kubes_google", "~> 0.2.0"
+  spec.add_dependency "kubes_google", "~> 0.3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/kubes/cli/apply.rb

@@ -4,7 +4,6 @@ class Kubes::CLI
       compile
       logger.info "Deploying kubes resources"
       Kubes::Kubectl::Dispatcher.new(:apply, @options).run
-      Prune.new(@options.merge(yes: true, quiet: true)).run if Kubes.config.auto_prune # prune old secrets and config maps
     end
   end
 end

data/lib/kubes/cli/prune.rb

@@ -2,15 +2,17 @@ class Kubes::CLI
   class Prune < Base
     KINDS = %w[ConfigMap Secret]
     extend Memoist
+    include Kubes::Hooks::Concern
     include Kubes::Util::Sure
 
     def run
       return unless anything_to_prune?
       logger.info "Pruning old resources: #{KINDS.join(', ')}"
-
       perform(preview: true) unless @options[:yes]
       sure?("This will prune/delete resources. Are you sure?")
-      perform(preview: false)
+      run_hooks("kubes.rb", name: "prune") do
+        perform(preview: false)
+      end
     end
 
     def fetcher

data/lib/kubes/compiler/shared/plugin_helpers.rb

@@ -5,7 +5,7 @@ module Kubes::Compiler::Shared
     def load_plugin_helpers
       return if @@plugin_helpers_loaded
       Kubes::Plugin.plugins.each do |klass|
-        helpers_class = "#{klass}::Helpers".constantize
+        helpers_class = "#{klass}::Helpers".constantize # IE: KubesAws::Helpers
         self.class.send :include, helpers_class
       end
       @@plugin_helpers_loaded = true

data/lib/kubes/config.rb

@@ -81,9 +81,22 @@ module Kubes
       yield(@config)
     end
 
+    # Load configs example:
+    #
+    # .kubes/config.rb
+    # .kubes/config/env/dev.rb
+    # .kubes/config/plugins/google.rb
+    # .kubes/config/plugins/google/dev.rb
+    #
     def load_configs
       evaluate_file(".kubes/config.rb")
       evaluate_file(".kubes/config/env/#{Kubes.env}.rb")
+      Kubes::Plugin.plugins.each do |klass|
+        # klass: IE: KubesAws, KubesGoogle
+        name = klass.to_s.underscore.sub('kubes_','') # kubes_google => google
+        evaluate_file(".kubes/config/plugins/#{name}.rb")
+        evaluate_file(".kubes/config/plugins/#{name}/#{Kubes.env}.rb")
+      end
     end
   end
 end

data/lib/kubes/hooks/builder.rb

@@ -6,8 +6,9 @@ module Kubes::Hooks
     include Kubes::Logging
 
     attr_accessor :name
-    def initialize(dsl_file, options={})
-      @dsl_file, @options = dsl_file, options # IE: .kubes/config/hooks/kubectl.rb
+    def initialize(file, options={})
+      @file, @options = file, options # IE: .kubes/config/hooks/kubectl.rb
+      @dsl_file = "#{Kubes.root}/.kubes/config/hooks/#{@file}"
       @output_file = options[:file] # IE: .kubes/output/web/service.yaml
       @name = options[:name].to_s
       @hooks = {before: {}, after: {}}
@@ -16,10 +17,26 @@ module Kubes::Hooks
     def build
       return @hooks unless File.exist?(@dsl_file)
       evaluate_file(@dsl_file)
+      evaluate_plugin_hooks
       @hooks.deep_stringify_keys!
     end
     memoize :build
 
+    def evaluate_plugin_hooks
+      Kubes::Plugin.plugins.each do |klass|
+        hooks_class = hooks_class(klass)
+        next unless hooks_class
+        plugin_hooks = hooks_class.new
+        path = "#{plugin_hooks.path}/#{@file}"
+        evaluate_file(path)
+      end
+    end
+
+    def hooks_class(klass)
+      "#{klass}::Hooks".constantize # IE: KubesGoogle::Hooks
+    rescue NameError
+    end
+
     def run_hooks
       build
       run_each_hook("before")
@@ -42,8 +59,7 @@ module Kubes::Hooks
       id = "#{command} #{type} #{@name}"
       on = " on: #{hook["on"]}" if hook["on"]
       label = " label: #{hook["label"]}" if hook["label"]
-      logger.info  "Running #{id} hook.#{on}#{label}"
-      logger.debug "Hook options: #{hook}"
+      logger.info  "Hook: Running #{id} hook.#{on}#{label}"
       Runner.new(hook).run
     end
 

data/lib/kubes/hooks/concern.rb

@@ -2,7 +2,7 @@ module Kubes::Hooks
   module Concern
     # options example: {:name=>"apply", :file=>".kubes/output/web/service.yaml"}
     def run_hooks(file, options={}, &block)
-      hooks = Kubes::Hooks::Builder.new("#{Kubes.root}/.kubes/config/hooks/#{file}", options)
+      hooks = Kubes::Hooks::Builder.new(file, options)
       hooks.build # build hooks
       hooks.run_hooks(&block)
     end

data/lib/kubes/kubectl/batch.rb

@@ -22,10 +22,17 @@ class Kubes::Kubectl
               Kubes::Kubectl.run(@name, @options.merge(file: file))
             end
           end
+          prune # important to call within run_hooks for case of GKE IP whitelisting
         end
       end
     end
 
+    def prune
+      return unless @name == "apply" # only run for apply
+      return unless Kubes.config.auto_prune # prune old secrets and config maps
+      Kubes::CLI::Prune.new(@options.merge(yes: true, quiet: true)).run
+    end
+
     def switch_context(&block)
       kubectl = Kubes.config.kubectl
       context = kubectl.context

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -312,6 +312,7 @@ files:
 - docs/_docs/helpers/google.md
 - docs/_docs/helpers/google/advanced.md
 - docs/_docs/helpers/google/advanced/secrets.md
+- docs/_docs/helpers/google/gke.md
 - docs/_docs/helpers/google/secrets.md
 - docs/_docs/helpers/google/service-account.md
 - docs/_docs/intro.md