kubes 0.6.5 → 0.7.1

data/docs/_docs/resources/role.md

@@ -8,15 +8,14 @@ Role-based resources are your main project's resources.  Kubes groups resources
 
 Here's an example structure to help explain how role-based resources work.
 
-    .kubes
-    └── resources
-        ├── clock
-        │   └── deployment.yaml
-        ├── web
-        │   ├── deployment.yaml
-        │   └── service.yaml
-        └── worker
-            └── deployment.yaml
+    .kubes/resources
+    ├── clock
+    │   └── deployment.yaml
+    ├── web
+    │   ├── deployment.yaml
+    │   └── service.yaml
+    └── worker
+        └── deployment.yaml
 
 ## Resource Roles
 

data/docs/_docs/yaml.md

@@ -4,11 +4,10 @@ title: Kubes YAML
 
 You can write your Kubernetes resources in YAML format.
 
-    .kubes
-    └── resources
-        └── web
-            ├── deployment.yaml
-            └── service.yaml
+    .kubes/resources
+    └── web
+        ├── deployment.yaml
+        └── service.yaml
 
 ## YAML and Templating
 

data/docs/_docs/yaml/multiple-files.md

@@ -0,0 +1,22 @@
+---
+title: YAML Multiple Resources with Multiple Files
+---
+
+You can also create multiple resources of same kind by appending a dash followed by anything. Example:
+
+    .kubes/resources
+    └── web
+        ├── deployment-1.yaml
+        ├── deployment-2.yaml
+        ├── service-1.yaml
+        └── service-2.yaml
+
+Only words before the dash are used to infer the resource kind.
+
+Filename | Resource Kind
+--- | ---
+deployment-1.yaml | Deployment
+deployment-2.yaml | Deployment
+service-1.yaml | Service
+service-2.yaml | Service
+

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

@@ -0,0 +1,89 @@
+---
+title: YAML Multiple Resources
+---
+
+Kubes encourages a structure with files that matches the resource kind. Example:
+
+    .kubes/resources
+    └── web
+        ├── deployment.yaml
+        └── service.yaml
+
+This structure is nicely organized and covers 80% of use cases. An astute user may point out that this struture assumes one resource of each kind.
+
+Next, we'll cover how to create multiple resource of the same kinds.
+
+## Multiple Resources in Same YAML
+
+You can simply define multiple resources in th same YAML file. Conventionally, you should name the resource files with plural names. An example helps explain:
+
+    .kubes/resources
+    └── web
+        └── deployments.yaml
+
+.kubes/resources/web/deployments.yaml
+
+```yaml
+- apiVersion: apps/v1
+  kind: Deployment
+  metadata:
+    name: web-1
+    labels:
+      role: web
+  spec:
+    selector:
+      matchLabels:
+        role: web
+    template:
+      metadata:
+        labels:
+          role: web
+      spec:
+        containers:
+        - name: web
+          image: <%= docker_image %>
+- apiVersion: apps/v1
+  kind: Deployment
+  metadata:
+    name: web-2
+    labels:
+      role: web
+  spec:
+    selector:
+      matchLabels:
+        role: web
+    template:
+      metadata:
+        labels:
+          role: web
+      spec:
+        containers:
+        - name: web
+          image: <%= docker_image %>
+```
+
+Notice that the YAML contains an Array of definitions now.
+
+## Layering
+
+Layering works just fine with multiple resource definitions. The layering is processed on each item of the Array.
+
+Notes:
+
+* The layering definitions for the pre layers must be in singular form.
+* The layering definitions for the post layers must be in a folder with plural form, but define a singular resource override.
+* Resources in the main "middle" layer is the only one that allows for multiple resource definitions.
+
+Multiple resources layering structure.
+
+    .kubes/resources/
+    ├── base
+    │   ├── all.rb         # SINGULAR
+    │   └── deployment.rb  # SINGULAR
+    └── web
+        ├── deployments    # PLURAL
+        │   ├── dev.rb     # SINGULAR
+        │   └── prod.rb    # SINGULAR
+        └── deployments.rb # PLURAL
+
+The main difference is the pluralized filenames.

data/docs/_includes/commands.html

@@ -30,15 +30,14 @@ kubes delete -y
               <h3>Structure</h3>
               <div class="commands">
 {% highlight sh %}
-.kubes
-└── resources
-    ├── clock
-    │   └── deployment.yaml
-    ├── worker
-    │   └── deployment.yaml
-    └── web
-        ├── deployment.yaml
-        └── service.yaml
+.kubes/resources
+├── clock
+│   └── deployment.yaml
+├── worker
+│   └── deployment.yaml
+└── web
+    ├── deployment.yaml
+    └── service.yaml
 {% endhighlight %}
               </div>
             </div>

data/docs/_includes/config/hooks/options.md

@@ -18,3 +18,4 @@ exit_on_fail | Whether or not to continue process if the script returns an faile
 ## Ruby Hooks
 
 Instead of using a script for the hook `execute` option, you can also use a Ruby object. This provides some more control over the current process. See: [Ruby Hooks]({% link _docs/config/hooks/ruby.md %})
+

data/docs/_includes/layering/layers.md

@@ -21,11 +21,14 @@ Here's an example structure, so we can understand how layering works.
 
 To explain the layering, here's the general processing order that Kubes takes.
 
-1. The `.kubes/resources/base` folder is treated as a base layer.  It gets processed as pre-layers by Kubes.
-2. Then Kubes will process your `.kubes/resources/ROLE` definitions.
-3. Lastly, Kubes processes any post-layers in the `.kubes/resources/ROLE/KIND` folders.
+1. **Pre Layers**: The `.kubes/resources/base` folder is treated as a base layer.  It gets processed as pre-layers by Kubes.
+2. **Main Layer**: Then Kubes will process your `.kubes/resources/ROLE` definitions.
+3. **Post Layers**: Lastly, Kubes processes any post-layers in the `.kubes/resources/ROLE/KIND` folders.
 
-Note, both YAML and DSL forms support layering. They can be mixed together.
+Notes
+
+* Both YAML and DSL forms support layering. They can be mixed together.
+* In the Main Layer you can define single or multiple resource definitions.
 
 ## Full Layering
 

data/docs/_includes/sidebar.html

@@ -86,7 +86,12 @@
         </ul>
       </li>
       <li><a href="{% link _docs/generators.md %}">Generators</a></li>
-      <li><a href="{% link _docs/yaml.md %}">YAML</a></li>
+      <li><a href="{% link _docs/yaml.md %}">YAML</a>
+        <ul>
+          <li><a href="{% link _docs/yaml/multiple-resources.md %}">Multiple Resources</a></li>
+          <li><a href="{% link _docs/yaml/multiple-files.md %}">Multiple Files</a></li>
+        </ul>
+      </li>
       <li><a href="{% link _docs/layering.md %}">Layering</a>
         <ul>
           <li><a href="{% link _docs/layering/yaml.md %}">YAML</a></li>

data/docs/_includes/vs/kubes/structure.md

@@ -2,19 +2,18 @@
 
 On the other hand, Kubes defines a conventional project structure. Here's a project directory example:
 
-    .kubes
-    └── resources
-        ├── base
-        │   ├── all.yaml
-        │   └── deployment.yaml
-        ├── shared
-        │   └── namespace.yaml
-        └── web
-            ├── deployment
-            │   ├── dev.yaml
-            │   └── prod.yaml
-            ├── deployment.yaml
-            └── service.yaml
+    .kubes/resources
+    ├── base
+    │   ├── all.yaml
+    │   └── deployment.yaml
+    ├── shared
+    │   └── namespace.yaml
+    └── web
+        ├── deployment
+        │   ├── dev.yaml
+        │   └── prod.yaml
+        ├── deployment.yaml
+        └── service.yaml
 
 A Kubes project structure also supports introduces a role concept or folder. The folder structure only shows a web role for simplicity. You can always add more roles.  For example:
 

data/kubes.gemspec

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

data/lib/kubes/command.rb

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

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

@@ -3,22 +3,18 @@ module Kubes::Compiler::Dsl::Core
     extend Fields
     include DslEvaluator
     include Helpers
-    include Kubes::Compiler::Shared::CustomHelpers
-    include Kubes::Compiler::Shared::CustomVariables
-    include Kubes::Compiler::Shared::PluginHelpers
+    include Kubes::Compiler::Shared::RuntimeHelpers
 
     def initialize(options={})
       @options = options
       @name = options[:name]
       @path = options[:path]
-      load_plugin_helpers
-      load_custom_variables
-      load_custom_helpers
+      load_runtime_helpers
     end
 
     def run
       evaluate_file(@path) # main resource definition
-      result if respond_to?(:result) # block form doesnt have result
+      result
     end
   end
 end

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

@@ -5,7 +5,11 @@ module Kubes::Compiler::Dsl::Core
       @results = {} # Hash key is the name of resource, using it so we can keep a map to handle layering
       @block_form = true # pluralizes the layer names
       super # handles layering and evaluating the main DSL file
-      self
+      result # Array
+    end
+
+    def result
+      @results.values # Array
     end
 
     def syntax_instance(meth, name)

data/lib/kubes/compiler/dsl/syntax/endpoint.rb

@@ -0,0 +1,34 @@
+module Kubes::Compiler::Dsl::Syntax
+  class Endpoint < Resource
+    fields :subsets
+
+    # kubectl explain endpoints.subsets
+    fields :addresses,         # <[]Object>
+           :notReadyAddresses, # <[]Object>
+           :ports              # <[]Object>
+
+    def default_kind
+      return @kind_from_block if @kind_from_block
+      "Endpoints" # always plural
+    end
+
+    def default_apiVersion
+      "v1"
+    end
+
+    def default_top
+      top = super
+      top.merge(
+        subsets: subsets
+      )
+    end
+
+    def default_subsets
+      [{
+        addresses: addresses,
+        notReadyAddresses: notReadyAddresses,
+        ports: ports,
+      }]
+    end
+  end
+end

data/lib/kubes/compiler/dsl/syntax/resource.rb

@@ -1,7 +1,6 @@
 module Kubes::Compiler::Dsl::Syntax
   class Resource < Kubes::Compiler::Dsl::Core::Base
     include Kubes::Compiler::Util::Normalize
-    include Kubes::Compiler::Shared::Helpers
 
     fields :apiVersion,  # <string>
            :kind,        # <string>

data/lib/kubes/compiler/layering.rb

@@ -5,14 +5,10 @@ class Kubes::Compiler
 
       ext = File.extname(@path)
       kind = File.basename(@path).sub(ext,'') # IE: deployment
-      all = "all"
-      if @block_form
-        kind = kind.pluralize
-        all = all.pluralize
-      end
+      kind = kind.pluralize if @block_form
       layers = [
-        "#{all}",
-        "#{all}/#{Kubes.env}",
+        "all",
+        "all/#{Kubes.env}",
         "#{kind}",
         "#{kind}/#{Kubes.env}",
       ]

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

@@ -0,0 +1,78 @@
+module Kubes::Compiler::Shared
+  module RuntimeHelpers
+    include Kubes::Compiler::Shared::Helpers
+
+    def load_runtime_helpers
+      load_custom_variables # also load custom variables
+      load_plugin_helpers
+      load_custom_helpers
+    end
+
+    @@custom_helpers_loaded = false
+    def load_custom_helpers
+      return if @@custom_helpers_loaded
+      paths = Dir.glob("#{Kubes.root}/.kubes/helpers/**/*.rb")
+      paths.sort_by! { |p| p.size } # so namespaces are loaded first
+
+      paths.each do |path|
+        filename = path.sub(%r{.*.kubes/helpers/},'').sub('.rb','')
+        module_name = filename.camelize
+        base_class_for_helper.send :include, module_name.constantize
+      end
+      @@custom_helpers_loaded = true
+    end
+
+    # 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 # IE: KubesAws::Helpers
+        base_class_for_helper.send :include, helpers_class
+      end
+      @@plugin_helpers_loaded = true
+    end
+
+    def base_class_for_helper
+      if self.is_a?(Kubes::Compiler::Strategy::Erb)
+        Kubes::Compiler::Strategy::Erb
+      else
+        Kubes::Compiler::Dsl::Core::Base
+      end
+    end
+
+    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