ky 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80b326de6d0dd57558007807fe7441ea72f75c2e
-  data.tar.gz: 7788d551ece1c5bdafd05c99ea05a4a16a5d4b88
+  metadata.gz: 88f4ea27998f9a2958de3c9e2bdf989de7d99110
+  data.tar.gz: 2fd156270734c5064cd94d47e4f79d8a734e8658
 SHA512:
-  metadata.gz: 3ff01e43e12fa0db1a2649c5f9b410572012f512c59a41445cb106be7b0902c406a3e3a26146fdc2b539ff465f6e2104576ab96ccf27a04d73a1efb2c4ed4384
-  data.tar.gz: 8614bfdae5d0aab41b98c4eedfb3668f54106dde827429f0397fc894042616e3ea3bb81305d317612aa8a09464b911b55aa34b551c6403ea97c95b4f1ab71ef5
+  metadata.gz: fb7b698da20ddb79a6aba30ee1e4fdba2983cd319bd08dae0325cbacabf4c60c50cfed7aafe5f074a80f3bd1af3d880755d6851eb30821c89adaa6bbaf9abf0e
+  data.tar.gz: 5da3f95409421d0f5b3974283a8cb6187b9174cf043e35268ce979878b942dd2565218fea461d8f43855c982fae8af7bd3f4a3316c69515f644b2a4932588c21

data/README.md

@@ -4,8 +4,10 @@
 
 The primary purpose is to automate/DRY up duplication and agreement between multiple deployment YAML files and config/secret yaml files that we saw emerging as we built our kubernetes configuration.
 
+The full/hopeful use of the tool may be enabled with the new `compile` command which is very much a rough draft at present, but which takes a crack at generating a complete deployment yaml file for every line of a Procfile such as used for Heroku, and a pair of config and secrets files.  The secret file can be non-base64 encoded, and compile will generate deployments and a base64 encoded secrets file to a target directory specified.  This command uses all the below commands in combination, plus the undocumented `from_proc` command.  The command is invoked as:
+`ky compile Procfile.file config.yml secrets.yml output_dir` and the output directory will be created if necessary.  You may pass a namespace to compile which will be reflected in the deployments (and should agree with the config and secrets, though it's not checking they agree at present).
 
-The typical workflow for the tool might start with generating a yaml file of env mappings from a secrets.yml file and a config.yml file, like so:
+The less automated workflow for the tool might start with generating a yaml file of env mappings from a secrets.yml file and a config.yml file, like so:
 ###Example usage
 Assuming config.yml such as:
 ```

data/lib/ky.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'base64'
 require 'open-uri'
+require 'fileutils'
 require_relative 'ky/manipulation'
 require_relative 'ky/env_generation'
 require_relative 'ky/deploy_generation'
@@ -22,15 +23,26 @@ module KY
   end
 
   def env(output, input1, input2)
-    output << EnvGeneration.generate_env(input1, input2)
+    output << EnvGeneration.generate_env(input1, input2).to_yaml
   rescue KY::EnvGeneration::ConflictingProjectError => e
     $stderr << "Error processing yml files, please provide a config and a secrets file from the same kubernetes project/name"
     exit(1)
   end
 
   def from_proc(proc_path, output_dir)
+    FileUtils.mkdir_p(output_dir)
     DeployGeneration.new(proc_path, output_dir).call
   end
 
+  def compile(proc_path, env1path, env2path, output_dir, namespace=DeployGeneration::DEFAULT_NAMESPACE)
+    FileUtils.mkdir_p(output_dir)
+    env_obj = EnvGeneration.new(env1path, env2path)
+    deploys_hash = DeployGeneration.new(proc_path, output_dir, env_obj.project, namespace).to_h
+    deploys_hash.each do |file_path, deploy_hash|
+      File.write(file_path, deploy_hash.merge(env_obj.to_h).to_yaml)
+    end
+    Manipulation.write_configs_encode_if_needed(env_obj.config_hsh, env_obj.secret_hsh, output_dir)
+  end
+
 
 end

data/lib/ky/cli.rb

@@ -30,17 +30,29 @@ module KY
       end
     end
 
-    desc "from_proc path/to/Procfile output_dir", "generate kubernetes deployment base configs from Procfile"
+    desc "from_proc Procfile.file output_dir", "generate kubernetes deployment base configs from Procfile to output_dir"
     def from_proc(procfile_path, output_dir)
       KY.from_proc(procfile_path, output_dir)
     end
 
+    desc "compile Procfile.file config.yml secrets.yml output_dir", "generate kubernetes deployment configs from Procfile and env files to output_dir, encode secrets if unencoded"
+    method_option :namespace, type: :string, aliases: "-n"
+    def compile(procfile_path, config_or_secrets_path, secrets_or_config_path, output_dir)
+      input_input(config_or_secrets_path, secrets_or_config_path) do |input1, input2|
+        KY.compile(procfile_path, input1, input2, output_dir, options[:namespace])
+      end
+    end
+
     private
 
     def input_output(input1, output1)
       with(input1, 'r') {|input_object| with(output1, 'w+') { |output_object| yield(input_object, output_object)  } }
     end
 
+    def input_input(input1, input2)
+      with(input1, 'r') {|input_object1| with(input2, 'r') { |input_object2| yield(input_object1, input_object2)  } }
+    end
+
     def with(output, mode)
       if output.kind_of?(IO)
         yield output

data/lib/ky/deploy_generation.rb

@@ -0,0 +1,78 @@
+module KY
+  class DeployGeneration
+    API_VERSION = "extensions/v1beta1"
+    IMAGE_TYPE  = "docker/image"
+    DEFAULT_PULL_POLICY = "Always"
+    DEFAULT_PROJECT_NAME = "global"
+    DEFAULT_NAMESPACE = "default"
+    DEFAULT_REPLICA_COUNT = 1
+
+    #string array meta-trick to avoid naked strings everywhere below, yaml doesn't to_s symbols as desired
+    %w(apiVersion Deployment imagePullPolicy namespace command
+       replicas template labels app kind containers image
+       data metadata name key valueFrom spec template containers env).each do |raw_string|
+      define_method(raw_string.underscore) { raw_string }
+    end
+
+    def initialize(proc_path, output_dir, project_name=DEFAULT_PROJECT_NAME, current_namespace=DEFAULT_NAMESPACE)
+      @proc_commands = File.read(proc_path).split("\n")
+                            .map {|line| line.split(':', 2) }
+                            .map {|k, v| [k, ["/bin/bash","-c", v]] }
+                            .to_h
+      @output_dir = output_dir
+      @project = project_name
+      @current_namespace = current_namespace
+    end
+
+    def call
+      to_h.each do |file_path, deploy_hash|
+        File.write(file_path, deploy_hash.to_yaml)
+      end
+    end
+
+    def to_h
+      proc_commands.map do |id, command_array|
+        ["#{output_dir}/#{id}.yml", template_hash(id, command_array)]
+      end.to_h
+    end
+
+    private
+    attr_reader :proc_commands, :output_dir, :project, :current_namespace
+
+    def template_hash(id, command_array)
+      {api_version => API_VERSION,
+       kind => deployment,
+       metadata =>{ name => id, namespace => current_namespace},
+       spec =>
+        {replicas => replica_count,
+         template =>
+          {
+            metadata => {
+              labels =>{ app =>"#{project}-#{id}"}
+             },
+           spec => {
+            containers =>
+              [
+                {
+                 name => id,
+                 image => IMAGE_TYPE,
+                 image_pull_policy => pull_policy,
+                 command => command_array
+                }
+              ]
+            }
+          }
+        }
+      }
+    end
+
+    def replica_count
+      ENV['REPLICA_COUNT'] || DEFAULT_REPLICA_COUNT
+    end
+
+    def pull_policy
+      ENV['PULL_POLICY'] || DEFAULT_PULL_POLICY
+    end
+
+  end
+end

data/lib/ky/env_generation.rb

@@ -10,7 +10,7 @@ module KY
     end
 
     def self.generate_env(input1, input2)
-      new(input1, input2).to_yaml
+      new(input1, input2).to_h
     end
 
     attr_reader :config_hsh, :secret_hsh
@@ -21,16 +21,17 @@ module KY
       raise ConflictingProjectError.new("Config and Secret metadata names do not agree") unless secret_hsh[metadata][name] == project
     end
 
-    def to_yaml
-      output_hash(config_hsh[data].map {|key, _| config_env(project, key) } + secret_hsh[data].map {|key, _| secret_env(project, key) }).to_yaml
+    def to_h
+      output_hash(config_hsh[data].map {|key, _| config_env(project, key) } + secret_hsh[data].map {|key, _| secret_env(project, key) })
     end
 
-    private
-
     def project
        config_hsh[metadata][name]
     end
 
+    private
+
+
     def config_env(project, kebab_version)
       env_map(config_map_key_ref, project, kebab_version)
     end

data/lib/ky/manipulation.rb

@@ -3,7 +3,7 @@ module KY
   module Manipulation
     DEFAULT_DATA_KEY = 'data'
     MAGIC_DELIMITER = '@'
-
+    BASE_64_DETECTION_REGEX = /^([A-Za-z0-9+]{4})*([A-Za-z0-9+]{4}|[A-Za-z0-9+]{3}=|[A-Za-z0-9+]{2}==)$/
     class << self
       def merge_yaml(input1, input2)
         combined = {}
@@ -41,6 +41,16 @@ module KY
       def obscured_data_key
         ENV['DATA_KEY'] || DEFAULT_DATA_KEY
       end
+
+      def write_configs_encode_if_needed(config_hsh, secret_hsh, output_path)
+        if secret_hsh[obscured_data_key].values.detect {|value| BASE_64_DETECTION_REGEX =~ value }
+          File.write("#{output_path}/secret.yml", secret_hsh.to_yaml)
+        else
+          File.write("#{output_path}/secret.yml", code_yaml(StringIO.new(secret_hsh.to_yaml), :encode))
+        end
+        File.write("#{output_path}/config.yml", config_hsh.to_yaml)
+      end
+
     end
   end
 end

data/lib/ky/version.rb

@@ -1,3 +1,3 @@
 module KY
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/ky_bin_spec.rb

@@ -65,6 +65,18 @@ describe "cli commands" do
       expect(File.exists?("#{tmpdir}/web.yml")).to be true
       expect(File.exists?("#{tmpdir}/worker.yml")).to be true
       expect(File.exists?("#{tmpdir}/jobs.yml")).to be true
+      `rm -r #{tmpdir}`
+    end
+  end
+
+  describe "compiles Procfile and env secrets/configs into entire deployments" do
+    let(:tmpdir) { 'spec/support/tmpdir' }
+    it "to directory" do
+      KY::Cli.new.compile('spec/support/Procfile', 'spec/support/config.yml', 'spec/support/decoded.yml', tmpdir)
+      expect(File.exists?("#{tmpdir}/web.yml")).to be true
+      expect(File.exists?("#{tmpdir}/worker.yml")).to be true
+      expect(File.exists?("#{tmpdir}/jobs.yml")).to be true
+      `rm -r #{tmpdir}`
     end
   end
 

data/spec/support/Procfile

@@ -0,0 +1,3 @@
+web: bundle exec puma -C ./config/puma.rb
+jobs: bundle exec rake jobs:work
+worker: bundle exec toiler --rails -C config/toiler.yml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ky
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Brian Glusman
@@ -104,11 +104,13 @@ files:
 - ky.gemspec
 - lib/ky.rb
 - lib/ky/cli.rb
+- lib/ky/deploy_generation.rb
 - lib/ky/env_generation.rb
 - lib/ky/manipulation.rb
 - lib/ky/version.rb
 - spec/ky_bin_spec.rb
 - spec/spec_helper.rb
+- spec/support/Procfile
 - spec/support/config.yml
 - spec/support/decoded.yml
 - spec/support/encoded.yml