kubes 0.3.2 → 0.4.1

data/docs/_reference/kubes-exec.md

@@ -21,13 +21,20 @@ The exec command finds the latest pod from the deployment and runs `kubectl exec
 
 ## Multiple Deployments
 
-If you have have multiple deployments in your `.kubes/resources` then the command will use the first deployment by default. You can specify the specfic deployment with the `--name` option.  Examples:
+If you have have multiple deployments in your `.kubes/resources` then the command will use the first deployment by default. You can specify the specfic deployment with the `--name` or `-n` option.  Examples:
 
-    kubes exec --name demo-web
-    kubes exec --name demo-clock
-    kubes exec --name demo-worker
-    kubes exec --name demo-web sh
-    kubes exec --name demo-web ls -l
+    kubes exec --name web
+    kubes exec -n web
+    kubes exec -n clock
+    kubes exec -n worker
+    kubes exec -n web sh
+    kubes exec -n web ls -l
+
+## Multiple Pod Containers
+
+If you have have multiple containers in your pod. You can specify the specfic container with the `--container` or `-c` option.  Examples:
+
+    kubes exec --name web
 
 
 ## Options
@@ -36,6 +43,7 @@ If you have have multiple deployments in your `.kubes/resources` then the comman
     [--compile], [--no-compile]  # whether or not to compile the .kube/resources
                                  # Default: true
 n, [--name=NAME]                 # deployment name to use. IE: demo-web
+c, [--container=CONTAINER]       # Container name. If omitted, the first container in the pod will be chosen
     [--verbose], [--no-verbose]  
     [--noop], [--no-noop]        
 ```

data/docs/_reference/kubes-init.md

@@ -20,6 +20,7 @@ a, --app=APP                     # Docker repo name. Example: web. Generates .ku
 t, [--type=TYPE]                 # Type: dsl or yaml
                                  # Default: yaml
     --repo=REPO                  # Docker repo name. Example: user/repo. Configures .kubes/config.rb
+n, [--namespace=NAMESPACE]       # Namespace to use, defaults to the app option
     [--verbose], [--no-verbose]  
     [--noop], [--no-noop]        
 ```

data/docs/_reference/kubes-logs.md

@@ -18,6 +18,7 @@ logs from all deployment pods
     [--compile], [--no-compile]  # whether or not to compile the .kube/resources
                                  # Default: true
 n, [--name=NAME]                 # deployment name to use. IE: demo-web
+c, [--container=CONTAINER]       # Container name. If omitted, the first container in the pod will be chosen
 f, [--follow], [--no-follow]     # Follow logs
                                  # Default: true
     [--verbose], [--no-verbose]  

data/docs/_sass/theme.scss

@@ -290,4 +290,28 @@ ul.toc {
     text-align: center;
     padding: 20px;
   }
-}
+}
+
+// https://coolestguidesontheplanet.com/videodrome/youtube/
+// I added another box wrapper to control the width
+.video-box {
+  max-width: 600px;
+  text-align: left;
+  margin: 0 auto 0 0;
+  padding-bottom: 20px;
+  .video-container {
+    position:relative;
+    padding-bottom:56.25%;
+    padding-top:30px;
+    height:0;
+    overflow:hidden;
+  }
+
+  .video-container iframe, .video-container object, .video-container embed {
+    position:absolute;
+    top:0;
+    left:0;
+    width:100%;
+    height:100%;
+  }
+}

data/kubes.gemspec

@@ -28,6 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "zeitwerk"
 
+  # core helper libs
+  spec.add_dependency "kubes_google"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "cli_markdown"

data/lib/kubes.rb

@@ -14,6 +14,9 @@ require "memoist"
 require "rainbow/ext/string"
 require "yaml"
 
+# core helper libraries
+require "kubes_google"
+
 DslEvaluator.backtrace_reject = ".kubes"
 
 require "kubes/autoloader"

data/lib/kubes/cli.rb

@@ -9,8 +9,17 @@ module Kubes
     compile_option = Proc.new {
       option :compile, type: :boolean, default: true, desc: "whether or not to compile the .kube/resources"
     }
-    name_option = Proc.new {
-      option :name, aliases: %w[n], desc: "deployment name to use. IE: demo-web"
+    pod_option = Proc.new {
+      option :pod, aliases: %w[p], desc: "pod to use. IE: web"
+    }
+    deployment_option = Proc.new {
+      option :deployment, aliases: %w[d], desc: "deployment name to use. IE: demo-web"
+    }
+    container_option = Proc.new {
+      option :container, aliases: %w[c], desc: "Container name. If omitted, the first container in the pod will be chosen"
+    }
+    yes_option = Proc.new {
+      option :yes, aliases: %w[y], type: :boolean, desc: "Skip are you sure prompt"
     }
 
     desc "docker SUBCOMMAND", "Docker subcommands"
@@ -42,7 +51,7 @@ module Kubes
     desc "delete [ROLE] [RESOURCE]", "Delete Kubernetes resources within the app folder"
     long_desc Help.text(:delete)
     image_option.call
-    option :yes, aliases: %w[y], type: :boolean, desc: "Skip are you sure prompt"
+    yes_option.call
     def delete(role=nil, resource=nil)
       Delete.new(options.merge(role: role, resource: resource)).run
     end
@@ -66,8 +75,9 @@ module Kubes
     desc "exec", "Exec into the latest container from the deployment"
     long_desc Help.text(:exec)
     compile_option.call
-    name_option.call
-    option :container, aliases: %w[c], desc: "Container name. If omitted, the first container in the pod will be chosen"
+    pod_option.call
+    deployment_option.call
+    container_option.call
     def exec(*cmd)
       Exec.new(options.merge(cmd: cmd)).run
     end
@@ -85,12 +95,21 @@ module Kubes
     desc "logs", "logs from all deployment pods"
     long_desc Help.text(:logs)
     compile_option.call
-    name_option.call
+    pod_option.call
+    deployment_option.call
+    container_option.call
     option :follow, aliases: %w[f], type: :boolean, default: true, desc: "Follow logs"
     def logs(*cmd)
       Logs.new(options.merge(cmd: cmd)).run
     end
 
+    desc "prune", "Prune old resources like secret and config maps"
+    long_desc Help.text(:prune)
+    yes_option.call
+    def prune
+      Prune.new(options).run
+    end
+
     long_desc Help.text(:init)
     Init.options.each { |args| option(*args) }
     register(Init, "init", "init", "Init project")

data/lib/kubes/cli/apply.rb

@@ -3,7 +3,8 @@ class Kubes::CLI
     def run
       compile
       logger.info "Deploying kubes resources"
-      Kubes::Kubectl::Decider.new(:apply, @options).run
+      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/base.rb

@@ -9,5 +9,16 @@ class Kubes::CLI
     def compile
       Compile.new(@options).run unless @options[:compile] == false
     end
+
+    def pod_name
+      return unless @options[:pod]
+
+      pods = Kubes::Kubectl::Fetch::Pods.new(@options)
+      items = pods.fetch(:pod)
+      metas = items.map { |i| i['metadata'] }
+      metas.select! { |i| i['name'].include?(@options[:pod]) }
+      meta = metas.sort { i['creationTimestamp'] }.last
+      meta['name'] if meta
+    end
   end
 end

data/lib/kubes/cli/compile.rb

@@ -1,8 +1,16 @@
 class Kubes::CLI
   class Compile < Base
+    # Separate command like prune can call compile. Apply also calls Prune.
+    # Instead of moving Compile out of Prune, will use this class variable.
+    # In case we have other cases where compile is called in another area.
+    # We only want compiled to be called once so hooks only fire once.
+    # Done here so we don't clean and remove the .kubes/output folder.
+    @@compiled = false
     def run
+      return if @@compiled
       Clean.new(@options.merge(mute: true)).run
       Kubes::Compiler.new(@options).run
+      @@compiled = true
     end
   end
 end

data/lib/kubes/cli/delete.rb

@@ -10,7 +10,7 @@ class Kubes::CLI
     end
 
     def perform(preview: false)
-      Kubes::Kubectl::Decider.new(:delete, @options.merge(preview: preview)).run
+      Kubes::Kubectl::Dispatcher.new(:delete, @options.merge(preview: preview)).run
     end
   end
 end

data/lib/kubes/cli/exec.rb

@@ -1,15 +1,49 @@
 class Kubes::CLI
   class Exec < Base
+    extend Memoist
+    include Kubes::Logging
     include Kubes::Util::Sh
 
     def run
       compile
-      metadata = Kubes::Kubectl::Fetch::Deployment.new(@options).metadata
+      pod = find_pod
 
+      unless pod
+        logger.info <<~EOL
+          Unable to find a pod to exec into. This means there was no deployment found.
+          You can also try using the -p option and specifying enough of the pod name. Example:
+
+              kubes exec -p web
+
+        EOL
+        exit 1
+      end
+
+      container = " -c #{@options[:container]}" unless @options[:container].nil?
+      cmd = @options[:cmd].empty? ? "bash" : @options[:cmd].join(' ')
+      sh("kubectl exec #{ns} -ti #{pod}#{container} -- #{cmd}")
+    end
+
+    def find_pod
+      pod_name || deployment_pod
+    end
+
+    def ns
+      "-n #{metadata['namespace']}" if metadata
+    end
+
+    def metadata
+      deployment = Kubes::Kubectl::Fetch::Deployment.new(@options)
+      deployment.metadata if deployment.found
+    end
+    memoize :metadata
+
+    def deployment_pod
+      return unless metadata
       labels = metadata['labels'].map { |k,v| "#{k}=#{v}" }.join(',')
       ns = metadata['namespace']
 
-      resp = capture("kubectl get pod -l #{labels} -n #{ns} -o json")
+      resp = sh_capture("kubectl get pod -l #{labels} -n #{ns} -o json")
       data = JSON.load(resp)
       pod = latest_pod(data['items'])
 
@@ -18,10 +52,7 @@ class Kubes::CLI
         exit 1
       end
 
-      name = pod['metadata']['name']
-      container = " -c #{@options[:container]}" unless @options[:container].nil?
-      cmd = @options[:cmd].empty? ? "bash" : @options[:cmd].join(' ')
-      sh("kubectl exec -n #{ns} -ti #{name}#{container} -- #{cmd}")
+      pod['metadata']['name']
     end
 
     # get latest running pod

data/lib/kubes/cli/get.rb

@@ -2,9 +2,10 @@ class Kubes::CLI
   class Get < Base
     def run
       compile
-      Kubes::Kubectl.run(:get, @options)
+      Kubes::Kubectl.run(:get, @options.merge(exit_on_fail: false))
+      return unless @options[:show_pods]
       pods = Kubes::Kubectl::Fetch::Pods.new(@options)
-      pods.show if @options[:show_pods]
+      pods.show
     end
   end
 end

data/lib/kubes/cli/init.rb

@@ -6,6 +6,7 @@ class Kubes::CLI
         [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
         [:type, aliases: ["t"], default: "yaml", desc: "Type: dsl or yaml"],
         [:repo, required: true, desc: "Docker repo name. Example: user/repo. Configures .kubes/config.rb"],
+        [:namespace, aliases: ["n"], desc: "Namespace to use, defaults to APP-ENV. IE: demo-dev"],
       ]
     end
 
@@ -17,6 +18,42 @@ class Kubes::CLI
       @options[:app]
     end
 
+    def namespace
+      @options[:namespace] || default_namespace
+    end
+
+    def default_namespace
+      env = @options[:type] == "yaml" ? '<%= Kubes.env %>' : '#{Kubes.env}'
+      "#{app}-#{env}"
+    end
+
+    def excludes
+      if namespace == "default"
+        case options[:type]
+        when "dsl"
+          %w[
+            namespace.rb.tt
+          ]
+        else
+          %w[
+            all.yaml.tt
+            namespace.yaml.tt
+          ]
+        end
+      else
+        []
+      end
+    end
+
+    def directory_options
+      if excludes.empty?
+        {}
+      else
+        pattern = Regexp.new(excludes.join('|'))
+        {exclude_pattern: pattern }
+      end
+    end
+
   public
     def create_dockefile
       return if File.exist?("Dockerfile")
@@ -32,13 +69,13 @@ class Kubes::CLI
     def create_dsl_files
       return unless @options[:type] == "dsl"
       set_source("dsl")
-      directory ".", "."
+      directory ".", ".", directory_options
     end
 
     def create_yaml_files
       return if @options[:type] == "dsl"
       set_source("yaml")
-      directory ".", "."
+      directory ".", ".", directory_options
     end
 
     def message

data/lib/kubes/cli/logs.rb

@@ -1,15 +1,62 @@
 class Kubes::CLI
   class Logs < Base
+    include Kubes::Logging
     include Kubes::Util::Sh
 
     def run
       compile
-      metadata = Kubes::Kubectl::Fetch::Deployment.new(@options).metadata
+      sh("kubectl logs #{args}")
+    end
+
+  private
+    def args
+      args = pod_name || deployment_args
+
+      unless args
+        logger.info <<~EOL
+          Unable to find a pod to show logs for. This means there was no deployment found.
+          You can also try using the -p option and specifying enough of the pod name. Example:
+
+              kubes logs -p web
+
+        EOL
+        exit 1
+      end
+
+      follow = " -f" if @options[:follow]
+      "#{args}#{follow}"
+    end
+
+    def deployment_args
+      deployment = Kubes::Kubectl::Fetch::Deployment.new(@options)
+      metadata = deployment.metadata
+      return unless metadata
+
       name = metadata['name']
       ns = metadata['namespace']
 
-      follow = " -f" if @options[:follow]
-      sh("kubectl logs deployment/#{name}#{follow} -n #{ns}")
+      container = container(deployment)
+      c = " -c #{container}" if container
+      "deployment/#{name} -n #{ns}#{c}"
+    end
+
+    def container(deployment)
+      container = @options[:container]
+      return container if container
+
+      spec = deployment.spec
+      containers = spec['template']['spec']['containers']
+      names = containers.map { |c| c['name'] }
+      if containers.size > 1
+        logger.info <<~EOL
+          INFO: More than one container found.
+          Container names: #{names.join(', ')}
+          Using #{names.first}
+          Note: You can specify the container to use with --container or -c
+        EOL
+
+        names.first
+      end
     end
   end
 end

data/lib/kubes/cli/prune.rb

@@ -0,0 +1,95 @@
+class Kubes::CLI
+  class Prune < Base
+    KINDS = %w[ConfigMap Secret]
+    extend Memoist
+    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)
+    end
+
+    def fetcher
+      Kubes::Kubectl::Fetch::Base.new(@options)
+    end
+    memoize :fetcher
+
+    def namespace
+      fetcher.namespace
+    end
+
+    def anything_to_prune?
+      items = []
+      return unless namespace
+
+      with_old_items { |i| items << i }
+      if items.empty?
+        logger.info("There are no old resources that need pruning.") unless @options[:quiet]
+      end
+      !items.empty?
+    end
+
+    def perform(preview:)
+      with_old_items do |item|
+        prune(item, preview)
+      end
+    end
+
+    def with_old_items
+      items = get_all_items
+      items.each do |i|
+        next unless old?(i)
+        yield(i)
+      end
+    end
+
+    def old?(item)
+      name = item['metadata']['name']
+      kind = item['kind']
+      built = built_kinds[kind] || [] # IE: {"demo-secret"=>"ebd93b58dd"}
+      built.each do |original_name,hash|
+        return false unless name.include?(original_name)
+        current = "#{original_name}-#{hash}"
+        return false if name == current
+        # Spec cover the tricky regexp logic
+        regexp = Regexp.new("#{original_name}-\\w{10}$") # IE: # demo-secret-\w{10}$
+        return true if name.match(regexp)
+      end
+
+      false
+    end
+
+    def get_all_items
+      secrets = capture_items('secret')
+      config_maps = capture_items('configmap')
+      secrets + config_maps
+    end
+
+    def capture_items(kind)
+      data = Kubes::Kubectl.capture("get #{kind} -o json -n #{namespace}")
+      data['items'] || []
+    end
+
+    # IE: {"Secret"=>{"demo-secret"=>"ebd93b58dd"}}
+    def built_kinds
+      compile # compile so built kinds are in memory
+      Kubes::Compiler::Decorator::Hashable::Storage.md5s
+    end
+    memoize :built_kinds
+
+    def prune(item, preview=false)
+      kind = item['kind']
+      name = item['metadata']['name']
+      args = "delete #{kind} #{name} -n #{namespace}"
+      if preview
+        logger.info "    kubectl #{args}"
+      else
+        Kubes::Kubectl.execute(args)
+      end
+    end
+  end
+end