kubernetes_template_rendering 0.1.0.pre.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc30ea703d6feacb6fc23a4ad942e1e5118deeecb2eb839f122b781fa9627e22
-  data.tar.gz: 558a7dea6fad9beb97148a57d97d1e99ecee4cadde256b8eac716d32f8453b1b
+  metadata.gz: faeb29036b624168016b45f8b3ec72e0d39328a8a9a82c256125873264a49796
+  data.tar.gz: f5c5269ab942419534e0886cd5a8f015c77b5540b9ba2c8105c4bfa6ff6bb879
 SHA512:
-  metadata.gz: 56f00c1e62e0cac407e4ba3486d240929c4673abe4ab2b955fd2da39789aa54d7eb21a6eab8f8a5b694d85c9273077a29362c8c6b6ce3d8ca9d8efd1d443a502
-  data.tar.gz: 3614ee029ec93b6011066771ae3ffeee13fb033257ccdb3554b51905088b6e4536f39aea6032e18ce131f89f20372aab8da9cb5e1ce645c5956e8de3bcd66c63
+  metadata.gz: 6878a2582ffcf67e8466a260be80a1a6b29a52164bfe42d9737f15da07410245757ca7f232426c13b67bca27b420c26d800018bfe010f34887a76bd12c25a95d
+  data.tar.gz: 8f1c70852a002f85c23636bf25d120e2e7ac4a37c933c620c6c52e2c5ce3b66bd001073c25f95a9a339b67c2d0fd4a4d0f4cd000336b9f90558570122673a16b

data/CHANGELOG.md

@@ -4,6 +4,13 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - Unreleased
+## [0.2.0] - 2024-05-06
+### Added
+- Added support for passing `--source-repo` flag into command line so that the rendered manifest comments can include a link to the source repository.
+
+### Changed
+- Updated the code comment to include the variable overrides used when rendering the current version of the templates
+
+## [0.1.0] - 2024-04-22
 
 - Initial release

data/README.md

@@ -24,7 +24,7 @@ To use this gem you can either install it, and use the `render_kubernetes_templa
 
 ### Example Usage
 ```bash
-gem exec -g kubernetes_template_rendering render_kubernetes_templates \
+gem exec -g kubernetes_template_rendering render_templates \
     --jsonnet-library-path deployment/vendor \
     --rendered_directory path/to/resources \
     deployment/templates
@@ -34,7 +34,7 @@ gem exec -g kubernetes_template_rendering render_kubernetes_templates \
 
 To see a full list of options and how to use them, run the following command:
 ```bash
-gem exec -g kubernetes_template_rendering render_kubernetes_templates --help
+gem exec -g kubernetes_template_rendering render_templates --help
 ```
 
 ## Development

data/catalog-info.yaml

@@ -0,0 +1,19 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: kubernetes_template_rendering
+  title: Kubernetes Template Rendering gem
+  description: |
+    A Ruby gem that provides a way to render Kubernetes templates using ERB and Jsonnet.
+  annotations:
+    github.com/project-slug: invoca/kubernetes_template_rendering
+    backstage.io/adr-location: >-
+      https://github.com/Invoca/kubernetes_template_rendering/tree/main/docs/adrs
+    backstage.io/techdocs-ref: dir:.
+    buildkite.com/project-slug: invoca/kubernetes-template-rendering
+    invoca.com/version-repository-location: rubygems
+    invoca.com/version-repository-name: kubernetes_template_rendering
+spec:
+  type: Library
+  lifecycle: production
+  owner: octothorpe

data/docs/CHANGELOG.md

@@ -0,0 +1 @@
+../CHANGELOG.md

data/docs/README.md

@@ -0,0 +1 @@
+../README.md

data/docs/adrs/0000-template.md

@@ -0,0 +1,72 @@
+# [short title of solved problem and solution]
+
+* Status: [proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)] <!-- optional -->
+* Deciders: [list everyone involved in the decision] <!-- optional -->
+* Date: [YYYY-MM-DD when the decision was last updated] <!-- optional -->
+
+Technical Story: [description | ticket/issue URL] <!-- optional -->
+
+## Context and Problem Statement
+
+[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.]
+
+## Decision Drivers <!-- optional -->
+
+* [driver 1, e.g., a force, facing concern, …]
+* [driver 2, e.g., a force, facing concern, …]
+* … <!-- numbers of drivers can vary -->
+
+## Considered Options
+
+* [option 1]
+* [option 2]
+* [option 3]
+* … <!-- numbers of options can vary -->
+
+## Decision Outcome
+
+Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)].
+
+### Positive Consequences <!-- optional -->
+
+* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
+* …
+
+### Negative Consequences <!-- optional -->
+
+* [e.g., compromising quality attribute, follow-up decisions required, …]
+* …
+
+## Pros and Cons of the Options <!-- optional -->
+
+### [option 1]
+
+[example | description | pointer to more information | …] <!-- optional -->
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
+* … <!-- numbers of pros and cons can vary -->
+
+### [option 2]
+
+[example | description | pointer to more information | …] <!-- optional -->
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
+* … <!-- numbers of pros and cons can vary -->
+
+### [option 3]
+
+[example | description | pointer to more information | …] <!-- optional -->
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
+* … <!-- numbers of pros and cons can vary -->
+
+## Links <!-- optional -->
+
+* [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) -->
+* … <!-- numbers of links can vary -->

data/lib/kubernetes_template_rendering/cli.rb

@@ -32,6 +32,7 @@ module KubernetesTemplateRendering
           op.on("--region=REGION",                             "set the specific region to render")                                   { args.region = _1 }
           op.on("--color=COLOR",                               "set the specific color to render")                                    { args.color = _1 }
           op.on("--[no-]prune",                                "enable/disable pruning of untouched resources")                       { args.prune = _1 }
+          op.on("--source-repo=SOURCE_REPO",                   "set the source repo for the rendered templates")                      { args.source_repo = _1 }
 
           op.on("--variable-override=KEY:VALUE", "override a variable value set within definitions.yaml") do |override|
             args.variable_overrides ||= {}
@@ -64,7 +65,8 @@ module KubernetesTemplateRendering
           cluster_type: args.cluster_type,
           region: args.region,
           color: args.color,
-          variable_overrides: args.variable_overrides
+          variable_overrides: args.variable_overrides,
+          source_repo: args.source_repo
         )
       end
 

data/lib/kubernetes_template_rendering/cli_arguments.rb

@@ -12,7 +12,8 @@ module KubernetesTemplateRendering
       :region,
       :color,
       :variable_overrides,
-      :prune
+      :prune,
+      :source_repo
     ) do
       def valid?
         rendered_directory && template_directory

data/lib/kubernetes_template_rendering/resource.rb

@@ -9,14 +9,16 @@ module KubernetesTemplateRendering
   class Resource
     class UnexpectedFileTypeError < StandardError; end
 
-    attr_reader :variables, :template_path, :output_directory
-
-    def initialize(template_path:, definitions_path:, variables:, output_directory:, output_filename: nil)
-      @template_path    = template_path
-      @definitions_path = definitions_path
-      @variables        = variables
-      @output_directory = output_directory
-      @output_filename  = output_filename || template_filename(template_path)
+    attr_reader :variables, :variable_overrides, :template_path, :output_directory, :source_repo
+
+    def initialize(template_path:, definitions_path:, variables:, output_directory:, output_filename: nil, variable_overrides: {}, source_repo: nil)
+      @template_path      = template_path
+      @definitions_path   = definitions_path
+      @variables          = variables
+      @variable_overrides = variable_overrides
+      @output_directory   = output_directory
+      @source_repo        = source_repo
+      @output_filename    = output_filename || template_filename(template_path)
     end
 
     def render(args)
@@ -26,7 +28,7 @@ module KubernetesTemplateRendering
     private
 
     def rendered_template(args)
-      @rendered_template ||= template_klass.render(@template_path, variables, jsonnet_library_path: args.jsonnet_library_path)
+      @rendered_template ||= template_klass.render(@template_path, variables, variable_overrides:, source_repo:, jsonnet_library_path: args.jsonnet_library_path)
     end
 
     def write_template(args)

data/lib/kubernetes_template_rendering/resource_set.rb

@@ -12,9 +12,10 @@ module KubernetesTemplateRendering
   class ResourceSet
     attr_reader :variables, :output_directory, :deploy_group_config, :omitted_resources,
                 :template_directory, :target_output_directory, :regions, :colors,
-                :definitions_path, :kubernetes_cluster_type
+                :definitions_path, :kubernetes_cluster_type, :variable_overrides,
+                :source_repo
 
-    def initialize(config:, template_directory:, rendered_directory:, definitions_path:, kubernetes_cluster_type:)
+    def initialize(config:, template_directory:, rendered_directory:, definitions_path:, kubernetes_cluster_type:, variable_overrides: {}, source_repo: nil)
       @variables               = config["variables"] || {}
       @deploy_group_config     = config["deploy_groups"]
       @omitted_resources       = config["omitted_resources"]
@@ -25,6 +26,8 @@ module KubernetesTemplateRendering
       @rendered_directory      = rendered_directory
       @definitions_path        = definitions_path
       @kubernetes_cluster_type = kubernetes_cluster_type
+      @variable_overrides      = variable_overrides
+      @source_repo             = source_repo
       @resources               = {}
 
       if @kubernetes_cluster_type != "kube-platform"
@@ -185,7 +188,7 @@ module KubernetesTemplateRendering
 
     def standard_resources(output_directory)
       standard_template_paths.map do |path|
-        Resource.new(template_path: path, definitions_path: @definitions_path, variables: variables, output_directory: output_directory)
+        Resource.new(template_path: path, definitions_path:, variables:, output_directory:, variable_overrides:, source_repo:)
       end
     end
 

data/lib/kubernetes_template_rendering/template.rb

@@ -8,10 +8,13 @@ require "yaml"
 # This is a base class for all Templates. Derived classes must implement the render method.
 module KubernetesTemplateRendering
   class Template < OpenStruct
-    attr_reader :template_path, :variables
-    def initialize(template_path, variables)
-      @template_path = template_path
-      @variables = variables
+    attr_reader :template_path, :variables, :source_repo, :variable_overrides
+
+    def initialize(template_path, variables, source_repo: nil, variable_overrides: {})
+      @template_path      = template_path
+      @variables          = variables.merge(variable_overrides)
+      @source_repo        = source_repo
+      @variable_overrides = variable_overrides
     end
 
     def render(args)
@@ -24,9 +27,25 @@ module KubernetesTemplateRendering
       comment = <<~EOS
       # WARNING: DO NO EDIT THIS FILE!
       # Any changes made here will be lost.
-      # This file is autogenerated from #{template_path}
+      # This file is autogenerated from #{full_template_path}
       EOS
-      comment + yaml_string
+      comment + variable_override_comment + yaml_string
+    end
+
+    def full_template_path
+      if source_repo
+        "https://github.com/#{source_repo}/blob/-/#{template_path.start_with?("/") ? template_path[1..-1] : template_path}"
+      else
+        template_path
+      end
+    end
+
+    def variable_override_comment
+      if variable_overrides&.any?
+        <<~EOS
+        # Variable overrides used: #{variable_overrides.to_json}
+        EOS
+      end || ""
     end
 
     class << self
@@ -43,8 +62,8 @@ module KubernetesTemplateRendering
       # The ErbTemplate and JsonnetTemplate classes both inherit from the Template class and implement a render method.
       # However, the erb_binding parameter is used just in ErbTemplate, while the jsonnet_library_path parameter is used just in JsonnetTemplate.
       # This is a little awkward. Potentially this could be refactored.
-      def render(template_path, variables, erb_binding: nil, jsonnet_library_path: nil)
-        new(template_path, variables).render(erb_binding: erb_binding, jsonnet_library_path: jsonnet_library_path)
+      def render(template_path, variables, erb_binding: nil, jsonnet_library_path: nil, source_repo: nil, variable_overrides: {})
+        new(template_path, variables, source_repo:, variable_overrides:).render(erb_binding: erb_binding, jsonnet_library_path: jsonnet_library_path)
       end
     end
   end

data/lib/kubernetes_template_rendering/template_directory_renderer.rb

@@ -13,9 +13,9 @@ module KubernetesTemplateRendering
   class TemplateDirectoryRenderer
     DEFINITIONS_FILENAME = "definitions.yaml"
 
-    attr_reader :directories, :omitted_names, :rendered_directory, :cluster_type, :region, :color, :variable_overrides
+    attr_reader :directories, :omitted_names, :rendered_directory, :cluster_type, :region, :color, :variable_overrides, :source_repo
 
-    def initialize(directories:, rendered_directory:, omitted_names: [], cluster_type: nil, region: nil, color: nil, variable_overrides: nil)
+    def initialize(directories:, rendered_directory:, omitted_names: [], cluster_type: nil, region: nil, color: nil, variable_overrides: nil, source_repo: nil)
       @directories        = directories_with_definitions(Array(directories))
       @omitted_names      = Array(omitted_names)
       @rendered_directory = rendered_directory
@@ -23,6 +23,7 @@ module KubernetesTemplateRendering
       @region             = region
       @color              = color
       @variable_overrides = variable_overrides || {}
+      @source_repo        = source_repo
     end
 
     def render(args)
@@ -102,7 +103,15 @@ module KubernetesTemplateRendering
           kubernetes_cluster_type = name.sub('SPP-PLACEHOLDER', 'staging').sub(/\..*/, '') # prod.gcp => prod
 
           hash[name] ||= []
-          hash[name] << ResourceSet.new(config: config, template_directory: dir, rendered_directory: @rendered_directory, kubernetes_cluster_type: kubernetes_cluster_type, definitions_path: definitions_path)
+          hash[name] << ResourceSet.new(
+            config: config,
+            template_directory: dir,
+            rendered_directory: @rendered_directory,
+            kubernetes_cluster_type: kubernetes_cluster_type,
+            definitions_path: definitions_path,
+            variable_overrides: @variable_overrides,
+            source_repo: @source_repo
+          )
         end
       end
     end
@@ -156,7 +165,6 @@ module KubernetesTemplateRendering
 
           cluster_type_config.regions   = cluster_type_config.regions & [region] if region
           cluster_type_config.colors    = cluster_type_config.colors & [color]   if color
-          cluster_type_config.variables = (cluster_type_config.variables || {}).merge(variable_overrides)
 
           hash[name] = cluster_type_config if (region.nil? && color.nil?) || (cluster_type_config.regions.any? && cluster_type_config.colors.any?)
         end

data/lib/kubernetes_template_rendering/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KubernetesTemplateRendering
-  VERSION = "0.1.0.pre.2"
+  VERSION = "0.2.0"
 end

data/mkdocs.yml

@@ -0,0 +1,9 @@
+site_name: "Kubernetes Template Rendering Gem"
+site_description: "A light weight gem used to render Kubernetes manifest templates written in Jsonnet and ERB"
+
+nav:
+- Introduction: README.md
+- Change Log: CHANGELOG.md
+
+plugins:
+  - techdocs-core

data/sig/kubernetes_template_rendering.rbs

@@ -0,0 +1,4 @@
+module KubernetesTemplateRendering
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_template_rendering
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Octothorpe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,6 +67,10 @@ files:
 - CHANGELOG.md
 - README.md
 - Rakefile
+- catalog-info.yaml
+- docs/CHANGELOG.md
+- docs/README.md
+- docs/adrs/0000-template.md
 - exe/render_templates
 - lib/kubernetes_template_rendering.rb
 - lib/kubernetes_template_rendering/cli.rb
@@ -80,7 +84,8 @@ files:
 - lib/kubernetes_template_rendering/template.rb
 - lib/kubernetes_template_rendering/template_directory_renderer.rb
 - lib/kubernetes_template_rendering/version.rb
-- sig/invoca/kubernetes_templates.rbs
+- mkdocs.yml
+- sig/kubernetes_template_rendering.rbs
 homepage: https://github.com/Invoca/kubernetes_template_rendering
 licenses: []
 metadata:
@@ -99,9 +104,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.21
 signing_key:

data/sig/invoca/kubernetes_templates.rbs

@@ -1,6 +0,0 @@
-module Invoca
-  module KubernetesTemplateRendering
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end