kubernetes_template_rendering 0.1.0.pre.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6a61ce9b0278d451c6e402ffab894a703846d04704061be05b1bdd30ddfef1
-  data.tar.gz: '079c1784c5357f79fa1e6d6e5a15ef00ea6f2bdf72f37b1ff3949283d3d328ef'
+  metadata.gz: 5b05563ef123216e666bf9be24a72f445455386367b500a64d202468e5ab3292
+  data.tar.gz: e923ed36b4fdf9267ddb45860425895186c1289582cfb179bc136fb98758432d
 SHA512:
-  metadata.gz: 2eee87d74893f113a7b999c312457001cc5a8df0fed38b3827b7e773b5f243f2f73625b69ceb7e330576a4438671aa7f7c6491bf80b1b3e82b2167ab31d272ed
-  data.tar.gz: 17698c156cc055c8d0e42c1194f88d1ba99b1152712c2ee212393222ac5a93c75ca1029f424cf01f86993f95113fec39183546f4aef04a3d46f3f02de8e6190c
+  metadata.gz: 5ffe4df38a962360ca6f1d84ee122182e0abd3c3d220b6577e576fe3237e0cf12736b7fbb03a814e7d10870af3df36761913074b2cb428ebdf940eac64f4eaa1
+  data.tar.gz: 6e6d5b003e44d68c59834bf25f2d0a67be7041f964030b221d2845f3bd7a50c2ef8b0fccc7b3e99f5ea63420572970f0a7679d6c99d3b28141417bad3e81de4f

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

@@ -25,12 +25,13 @@ module KubernetesTemplateRendering
           op.banner = "Usage: #{$PROGRAM_NAME} --rendered-directory=<directory> <template directory>"
 
           op.on("--rendered-directory=RENDERED_DIRECTORY",     "set the directory where rendered output is written")                  { args.rendered_directory = _1 }
-          op.on("--[no-]fork",                                 "disable/enable fork")                                                 { |fork| args.fork = fork }
+          op.on("--[no-]fork",                                 "disable/enable fork")                                                 { args.fork = _1 }
           op.on("--makeflags=MAKEFLAGS",                       "pass through makeflags so that we can infer fork preference from -j") { args.makeflags = _1 }
           op.on("--jsonnet_library_path=JSONNET_LIBRARY_PATH", "set the jsonnet library path")                                        { args.jsonnet_library_path = _1 }
           op.on("--cluster_type=CLUSTER_TYPE",                 "set the specific cluster type to render")                             { args.cluster_type = _1 }
           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("--variable-override=KEY:VALUE", "override a variable value set within definitions.yaml") do |override|
             args.variable_overrides ||= {}

data/lib/kubernetes_template_rendering/cli_arguments.rb

@@ -11,7 +11,8 @@ module KubernetesTemplateRendering
       :cluster_type,
       :region,
       :color,
-      :variable_overrides
+      :variable_overrides,
+      :prune
     ) do
       def valid?
         rendered_directory && template_directory
@@ -25,6 +26,10 @@ module KubernetesTemplateRendering
         end
       end
 
+      def prune?
+        !!prune
+      end
+
       def render_files?
         true
       end

data/lib/kubernetes_template_rendering/resource_set.rb

@@ -63,6 +63,7 @@ module KubernetesTemplateRendering
     end
 
     def render_create_directory(args, output_directory)
+      prune_directory(output_directory) if args.prune?
       create_directory(output_directory)
       puts "Rendering templates to: #{Color.magenta(output_directory)}"
       puts "Variable assignments:"
@@ -167,6 +168,17 @@ module KubernetesTemplateRendering
       end
     end
 
+    def prune_directory(directory)
+      if File.exist?(directory)
+        puts <<~MESSAGE
+
+          The `prune` flag is set to true, #{Color.green('pruning')} directory #{Color.magenta(directory)} before rendering
+
+        MESSAGE
+        FileUtils.rm_rf("#{directory}/*")
+      end
+    end
+
     def resources(output_directory)
       @resources[output_directory] ||= standard_resources(output_directory) + grouped_resources(output_directory)
     end

data/lib/kubernetes_template_rendering/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KubernetesTemplateRendering
-  VERSION = "0.1.0.pre.1"
+  VERSION = "0.1.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_template_rendering
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Octothorpe
@@ -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