kubes 0.5.1 → 0.6.0

data/docs/_reference/kubes-new.md

@@ -11,48 +11,16 @@ reference: true
 
 Generates new resource.
 
-## Examples
-
-    $ kubes new ingress
-          create  .kubes/resources/web/ingress.yaml
-    $ kubes new service_account
-          create  .kubes/resources/shared/service_account.yaml
-    $
-
-## Supported Resources
-
-Here's a list of some of the supported resources.
-
-    backend_config
-    config_map
-    daemon_set
-    deployment
-    ingress
-    job
-    managed_certificate
-    namespace
-    network_policy
-    pod
-    role_binding
-    role
-    secret
-    service_account
-    service
-
-Refer to the source code to all the resources that the generator supports:
-https://github.com/boltops-tools/kubes/blob/master/lib/templates/new/yaml
+## Subcommands
 
+* [kubes new helper]({% link _reference/kubes-new-helper.md %}) - Generates kubes helper file.
+* [kubes new resource]({% link _reference/kubes-new-resource.md %}) - Generates Kubes Kubernetes resource definition.
+* [kubes new variable]({% link _reference/kubes-new-variable.md %}) - Generates kubes variable file.
 
 ## Options
 
 ```
-a, [--app=APP]                   # App name
-                                 # Default: demo
-y, [--force]                     # Bypass overwrite are you sure prompt for existing files
-r, [--role=ROLE]                 # Role. IE: web, clock, worker, migrate, etc. Defaults to convention: web or shared when not set
-t, [--type=TYPE]                 # Type: dsl or yaml
-                                 # Default: yaml
-    [--verbose], [--no-verbose]  
-    [--noop], [--no-noop]        
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
 ```
 

data/kubes.gemspec

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

data/lib/kubes/auth/base.rb

@@ -0,0 +1,21 @@
+require "json"
+
+class Kubes::Auth
+  class Base
+    include Kubes::Logging
+
+    def initialize(image)
+      @image = image
+      @repo_domain = "#{image.split('/').first}"
+    end
+
+    def ensure_dotdocker_exists
+      dirname = File.dirname(docker_config)
+      FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+    end
+
+    def docker_config
+      "#{ENV['HOME']}/.docker/config.json"
+    end
+  end
+end

data/lib/kubes/auth/ecr.rb

@@ -14,14 +14,9 @@
 # If that format changes, the update will need to be updated.
 #
 class Kubes::Auth
-  class Ecr
+  class Ecr < Base
     include Kubes::AwsServices
 
-    def initialize(image)
-      @image = image
-      @repo_domain = "#{image.split('/').first}"
-    end
-
     def run
       auth_token = fetch_auth_token
       if File.exist?(docker_config)
@@ -42,14 +37,5 @@ class Kubes::Auth
     def fetch_auth_token
       ecr.get_authorization_token.authorization_data.first.authorization_token
     end
-
-    def docker_config
-      "#{ENV['HOME']}/.docker/config.json"
-    end
-
-    def ensure_dotdocker_exists
-      dirname = File.dirname(docker_config)
-      FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
-    end
   end
 end

data/lib/kubes/auth/gcr.rb

@@ -0,0 +1,24 @@
+class Kubes::Auth
+  class Gcr < Base
+    def run
+      authorize! unless authorized?
+    end
+
+    def authorize!
+      command = "gcloud auth configure-docker"
+      logger.debug "Authorizing GCR with: #{command}"
+      success = system(command)
+      unless success
+        logger.error "ERROR: running #{command}".color(:red)
+        exit $?.exitstatus if exit_on_fail
+      end
+      success
+    end
+
+    def authorized?
+      return false unless File.exist?(docker_config)
+      data = JSON.load(IO.read(docker_config))
+      !!data.dig('credHelpers', 'gcr.io')
+    end
+  end
+end

data/lib/kubes/auth.rb

@@ -10,11 +10,14 @@ module Kubes
       klass.new(@image).run
     end
 
-    # Currently only support ECR
+    # Currently only support ECR and GCR
+    # TODO: consider moving this to plugin gems
     def strategy_class
       case @image
       when /\.amazonaws\.com/ # IE: 112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra
         Ecr
+      when /gcr\.io/
+        Gcr
       end
     end
   end

data/lib/kubes/cli/help/new/helper.md

@@ -0,0 +1,4 @@
+## Examples
+
+    $ kubes new helper custom
+          create  .kubes/helpers/custom_helper.rb

data/lib/kubes/cli/help/{new.md → new/resource.md}

@@ -1,8 +1,8 @@
 ## Examples
 
-    $ kubes new ingress
+    $ kubes new resource ingress
           create  .kubes/resources/web/ingress.yaml
-    $ kubes new service_account
+    $ kubes new resource service_account
           create  .kubes/resources/shared/service_account.yaml
     $
 
@@ -27,4 +27,4 @@ Here's a list of some of the supported resources.
     service
 
 Refer to the source code to all the resources that the generator supports:
-https://github.com/boltops-tools/kubes/blob/master/lib/templates/new/yaml
+https://github.com/boltops-tools/kubes/blob/master/lib/templates/new/resource/yaml

data/lib/kubes/cli/new/helper.rb

@@ -0,0 +1,24 @@
+class Kubes::CLI::New
+  class Helper < Kubes::CLI::Sequence
+    argument :name, default: "custom"
+
+    def self.options
+      [
+        [:force, aliases: ["y"], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+  private
+    def underscored_name
+      name.include?("_helper") ? name : "#{name}_helper"
+    end
+
+  public
+    def create_helper
+      set_source("new/helper")
+      file = "#{underscored_name}.rb"
+      template "file.rb", ".kubes/helpers/#{file}"
+    end
+  end
+end

data/lib/kubes/cli/new/resource.rb

@@ -0,0 +1,97 @@
+class Kubes::CLI::New
+  class Resource < Kubes::CLI::Sequence
+    argument :kind
+
+    def self.options
+      [
+        [:app, aliases: ["a"], default: "demo", desc: "App name"],
+        [:force, aliases: ["y"], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:role, aliases: ["r"], desc: "Role. IE: web, clock, worker, migrate, etc. Defaults to convention: web or shared when not set"],
+        [:type, aliases: ["t"], default: "yaml", desc: "Type: dsl or yaml"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+  private
+    def app
+      options[:app]
+    end
+
+    def role
+      role = options[:role]
+      return role if role
+      shared = %w[
+        config_map
+        namespace
+        network_policy
+        persistent_volume
+        persistent_volume_claim
+        secret
+        service_account
+      ]
+      if shared.include?(full_kind)
+        "shared"
+      elsif full_kind == "job"
+        "migrate"
+      else
+        "web"
+      end
+    end
+
+    def full_kind
+      # shorthands
+      map = {
+        cj:     "cron_job",
+        cm:     "config_map",
+        crd:    "custom_resource_definition",
+        crds:   "custom_resource_definition",
+        cs:     "component_statuses",
+        csr:    "certificate_signing_request",
+        deploy: "deployment",
+        ds:     "daemonset",
+        ep:     "endpoints",
+        ev:     "event",
+        hpa:    "horizontal_pod_autoscaler",
+        ing:    "ingress",
+        limits: "limit_range",
+        netpol: "network_policy",
+        no:     "node",
+        ns:     "namespace",
+        pc:     "priority_class",
+        pdb:    "pod_disruption_budget",
+        po:     "pod",
+        psp:    "pods_ecurity_policy",
+        pv:     "persistent_volume",
+        pvc:    "persistent_volume_claim",
+        quota:  "resource_quota",
+        rc:     "replication_controller",
+        rs:     "replica_set",
+        sa:     "service_account",
+        sc:     "storage_classes",
+        sgp:    "security_group_policy",
+        sts:    "stateful_set",
+        svc:    "service",
+      }.stringify_keys!
+      map[kind] || kind
+    end
+
+    def file
+      ext = options[:type] == "yaml" ? "yaml" : "rb"
+      "#{full_kind}.#{ext}"
+    end
+
+  public
+    def set_template_source
+      path = File.expand_path("../../../templates/new/resource/#{options[:type]}/#{file}", __dir__)
+      unless File.exist?(path)
+        logger.info "ERROR: Generator for #{file} not supported".color(:red)
+        exit 1
+      end
+      set_source("new/resource/#{options[:type]}")
+    end
+
+    def create_resource
+      template file, ".kubes/resources/#{role}/#{file}"
+    end
+  end
+end

data/lib/kubes/cli/new/variable.rb

@@ -0,0 +1,16 @@
+class Kubes::CLI::New
+  class Variable < Kubes::CLI::Sequence
+    def self.options
+      [
+        [:force, aliases: ["y"], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    def create_helper
+      set_source("new/variable")
+      file = "#{Kubes.env}.rb"
+      template "file.rb", ".kubes/variables/#{file}"
+    end
+  end
+end

data/lib/kubes/cli/new.rb

@@ -1,97 +1,15 @@
 class Kubes::CLI
-  class New < Sequence
-    argument :kind
-
-    def self.options
-      [
-        [:app, aliases: ["a"], default: "demo", desc: "App name"],
-        [:force, aliases: ["y"], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
-        [:role, aliases: ["r"], desc: "Role. IE: web, clock, worker, migrate, etc. Defaults to convention: web or shared when not set"],
-        [:type, aliases: ["t"], default: "yaml", desc: "Type: dsl or yaml"],
-      ]
-    end
-    options.each { |args| class_option(*args) }
-
-  private
-    def app
-      options[:app]
-    end
-
-    def role
-      role = options[:role]
-      return role if role
-      shared = %w[
-        config_map
-        namespace
-        network_policy
-        persistent_volume
-        persistent_volume_claim
-        secret
-        service_account
-      ]
-      if shared.include?(full_kind)
-        "shared"
-      elsif full_kind == "job"
-        "migrate"
-      else
-        "web"
-      end
-    end
-
-    def full_kind
-      # shorthands
-      map = {
-        cj:     "cron_job",
-        cm:     "config_map",
-        crd:    "custom_resource_definition",
-        crds:   "custom_resource_definition",
-        cs:     "component_statuses",
-        csr:    "certificate_signing_request",
-        deploy: "deployment",
-        ds:     "daemonset",
-        ep:     "endpoints",
-        ev:     "event",
-        hpa:    "horizontal_pod_autoscaler",
-        ing:    "ingress",
-        limits: "limit_range",
-        netpol: "network_policy",
-        no:     "node",
-        ns:     "namespace",
-        pc:     "priority_class",
-        pdb:    "pod_disruption_budget",
-        po:     "pod",
-        psp:    "pods_ecurity_policy",
-        pv:     "persistent_volume",
-        pvc:    "persistent_volume_claim",
-        quota:  "resource_quota",
-        rc:     "replication_controller",
-        rs:     "replica_set",
-        sa:     "service_account",
-        sc:     "storage_classes",
-        sgp:    "security_group_policy",
-        sts:    "stateful_set",
-        svc:    "service",
-      }.stringify_keys!
-      map[kind] || kind
-    end
-
-    def file
-      ext = options[:type] == "yaml" ? "yaml" : "rb"
-      "#{full_kind}.#{ext}"
-    end
-
-  public
-    def set_template_source
-      path = File.expand_path("../../templates/new/#{options[:type]}/#{file}", __dir__)
-      unless File.exist?(path)
-        logger.info "ERROR: Generator for #{file} not supported".color(:red)
-        exit 1
-      end
-      set_source("new/#{options[:type]}")
-    end
-
-    def create_resource
-      template file, ".kubes/resources/#{role}/#{file}"
-    end
+  class New < Kubes::Command
+    long_desc Help.text("new/resource")
+    Resource.options.each { |args| option(*args) }
+    register(Resource, "resource", "resource", "Generates Kubes Kubernetes resource definition.")
+
+    long_desc Help.text("new/helper")
+    Helper.options.each { |args| option(*args) }
+    register(Helper, "helper", "helper", "Generates kubes helper file.")
+
+    long_desc Help.text("new/variable")
+    Variable.options.each { |args| option(*args) }
+    register(Variable, "variable", "variable", "Generates kubes variable file.")
   end
 end

data/lib/kubes/command.rb

@@ -57,7 +57,7 @@ module Kubes
       end
 
       def check_project!(command_name)
-        return if %w[init new].include?(command_name)
+        return if %w[-h help init new].include?(command_name)
         Kubes.check_project!
       end
 

data/lib/kubes/compiler/decorator/base.rb

@@ -11,7 +11,7 @@ module Kubes::Compiler::Decorator
     end
 
     def result
-      if @data.is_a?(Kubes::Compiler::Dsl::Core::Blocks)
+      if @data.key?(Kubes::Compiler::Dsl::Core::Blocks)
         @data.results.each { |k,v| process(v) } # returns nil
       else
         process # processes and returns @data

data/lib/kubes/compiler/dsl/core/base.rb

@@ -3,25 +3,22 @@ module Kubes::Compiler::Dsl::Core
     extend Fields
     include DslEvaluator
     include Helpers
-    include Kubes::Compiler::Layering
+    include Kubes::Compiler::Shared::CustomHelpers
+    include Kubes::Compiler::Shared::CustomVariables
+    include Kubes::Compiler::Shared::PluginHelpers
 
     def initialize(options={})
       @options = options
       @name = options[:name]
       @path = options[:path]
+      load_plugin_helpers
+      load_custom_variables
+      load_custom_helpers
     end
 
     def run
-      evaluate_files(pre_layers)
       evaluate_file(@path) # main resource definition
-      evaluate_files(post_layers)
       result if respond_to?(:result) # block form doesnt have result
     end
-
-    def evaluate_files(paths)
-      paths.each do |path|
-        evaluate_file(path)
-      end
-    end
   end
 end

data/lib/kubes/compiler/layering.rb

@@ -11,14 +11,26 @@ class Kubes::Compiler
         all = all.pluralize
       end
       layers = [
-        "#{all}#{ext}",
-        "#{all}/#{Kubes.env}#{ext}",
-        "#{kind}#{ext}",
-        "#{kind}/#{Kubes.env}#{ext}",
+        "#{all}",
+        "#{all}/#{Kubes.env}",
+        "#{kind}",
+        "#{kind}/#{Kubes.env}",
       ]
-      layers.map do |layer|
+      layers = add_exts(layers)
+      layers.map! do |layer|
         "#{Kubes.root}/.kubes/resources/base/#{layer}"
       end
+      layers.select { |layer| File.exist?(layer) }
+    end
+
+    def add_exts(layers)
+      layers.map do |layer|
+        [
+          "#{layer}.rb",
+          "#{layer}.yaml",
+          "#{layer}.yml",
+        ]
+      end.flatten
     end
 
     def post_layers
@@ -31,9 +43,11 @@ class Kubes::Compiler
         "base",
         Kubes.env.to_s
       ]
-      layers.map do |layer|
-        "#{kind_path}/#{layer}#{ext}"
+      layers = add_exts(layers)
+      layers.map! do |layer|
+        "#{kind_path}/#{layer}"
       end
+      layers.select { |layer| File.exist?(layer) }
     end
   end
 end

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

@@ -0,0 +1,38 @@
+module Kubes::Compiler::Shared
+  module CustomVariables
+    include DslEvaluator
+
+    # Load custom variables from project
+    @@custom_variables_loaded = false
+    def load_custom_variables
+      return if Kubes.kustomize?
+
+      ext = File.extname(@path)
+      role = @path.sub(%r{.*\.kubes/resources/},'').sub(ext,'').split('/').first # IE: web
+      kind = File.basename(@path).sub(ext,'') # IE: deployment
+      all = "all"
+      if @block_form
+        kind = kind.pluralize
+        all = all.pluralize
+      end
+
+      layers = [
+        "base.rb",
+        "#{Kubes.env}.rb",
+        "base/all.rb",
+        "base/all/#{Kubes.env}.rb",
+        "base/#{kind}.rb",
+        "base/#{kind}/base.rb",
+        "base/#{kind}/#{Kubes.env}.rb",
+        "#{role}/#{kind}.rb",
+        "#{role}/#{kind}/base.rb",
+        "#{role}/#{kind}/#{Kubes.env}.rb",
+      ]
+
+      layers.each do |layer|
+        path = "#{Kubes.root}/.kubes/variables/#{layer}"
+        evaluate_file(path)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Kubes::Compiler::Shared
+  module PluginHelpers
+    # Load plugin helper methods from project
+    @@plugin_helpers_loaded = false
+    def load_plugin_helpers
+      return if @@plugin_helpers_loaded
+      Kubes::Plugin.plugins.each do |klass|
+        helpers_class = "#{klass}::Helpers".constantize
+        self.class.send :include, helpers_class
+      end
+      @@plugin_helpers_loaded = true
+    end
+  end
+end

data/lib/kubes/compiler/strategy/base.rb

@@ -1,13 +1,70 @@
 class Kubes::Compiler::Strategy
   class Base
-    include Kubes::Logging
+    include Kubes::Compiler::Layering
+    include Kubes::Compiler::Util::Normalize
     include Kubes::Compiler::Util::SaveFile
-    include Kubes::Compiler::Shared::CustomHelpers
+    include Kubes::Logging
 
     def initialize(options={})
       @options = options
       @path = options[:path]
       @save_file = save_file(@path)
+      @data = @options[:data] || {}
+    end
+
+    def run
+      render_files(pre_layers)
+      render(@path) # main resource definition
+      render_files(post_layers)
+
+      Result.new(@save_file, @data)
+    end
+
+    def render_files(paths)
+      paths.each do |path|
+        next unless File.exist?(path) # layers may not exist
+        render(path)
+      end
+    end
+
+    # render and merge
+    def render(path)
+      result = render_strategy(path)
+      if result.is_a?(Kubes::Compiler::Dsl::Core::Blocks)
+        result = result.results
+      end
+      @data.deeper_merge!(result)
+    end
+
+    # Delegate to Dsl or Erb strategy again and pass @data down to allow rendering of a mix of yaml and rb files.
+    def render_strategy(path)
+      if path.include?('.rb')
+        dsl_class.new(@options.merge(path: path, data: @data)).run
+      else
+        Erb.new(@options.merge(data: @data)).render_result(path)
+      end
+    end
+
+    # Must be defined here in case coming from Kubes::Compiler::Strategy::Erb#render_strategy
+    def dsl_class
+      if block_form?
+        Kubes::Compiler::Dsl::Core::Blocks
+      else
+        syntax_class
+      end
+    end
+
+    def syntax_class
+      klass_name = normalize_kind(@save_file) # IE: @save_file: web/service.yaml
+      "Kubes::Compiler::Dsl::Syntax::#{klass_name}".constantize
+    rescue NameError
+      logger.debug "Using default resource for: #{klass_name}"
+      Kubes::Compiler::Dsl::Syntax::Resource # default
+    end
+
+    def block_form?
+      type = extract_type(@save_file)
+      type.pluralize == type
     end
   end
 end