kube-templates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0414a2f5df5fc9f4f45536cd46731f74e62482bd
+  data.tar.gz: 317e628839d7664bc34b5800d7caaa60e3ee2439
+SHA512:
+  metadata.gz: 8e39d263917b785ec37b589811735477d409245a7582d1e169a733b2da87369d71800351f2f6c222f37fd6cb36d886ee35a41086f1a550c502fdab711e44350f
+  data.tar.gz: 290430c9754af9fc61211c3a2b541f32cda9d7a7e388bf56742794065a7e1743466396134d407ca64eccf95da3d2beab03b843398f21e41ec210745e9c7a758c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+

data/.ruby-gemset

@@ -0,0 +1 @@
+kube-templates

data/.ruby-version

@@ -0,0 +1 @@
+ruby 2.3.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kube-templates.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Keylime Toolbox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Kube::Templates
+
+Simple template system for Kubernetes deployments.
+
+We built this to handle deploying resque workers as containers. For each of our Rails
+apps we may have 50 or more resque workers running that code base, listening to different
+queues. This simplified the deployment by allowing us to provide a single Deployment template
+and then generate lots of deployment configurations with the right settings for the queues
+for the workers to listen to and the number of replicas.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "kube-templates"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kube-templates
+
+## Usage
+
+`Kube::Templates::Builder` takes a template file and a configuration file, assigning values from the
+configuration file and emitting a collection of deployments for kubernetes to run.
+
+### Example
+
+Create a deployment template. In this file you can have template variables (e.g. `${QUEUES}`) that 
+will be replaced with values from your configuration. In the following we use three variables,
+`${NAME}`, `${REPLICAS}`, and `${QUEUES}`.
+
+    # resque-template.yaml
+    apiVersion: extensions/v1beta1
+    kind: Deployment
+    metadata:
+      name: resque-${NAME}
+    spec:
+      replicas: ${REPLICAS}
+      template:
+        metadata:
+          labels:
+            service: rails
+            app: my-app
+            purpose: worker
+            queues: ${QUEUES}
+        spec:
+          containers:
+          - name: my-app
+            image: us.gcr.io/project-id-1138/my-app-resque:latest
+            env:
+            - name: QUEUE
+              value: ${QUEUES}
+
+Create a configuration file that defines your workers. In the following file we define two types 
+of workers. One, with four replicas, listens onthe "reports" queue. A second listens on the 
+"process_priority" and "process" queues. This second worker will have two replicas set as that
+values it defined in the "defaults" section and it doesn't change it.
+
+    # resque-workers.yml
+    defaults:
+      replicas: 2
+    workers:
+      - queues: reports
+        replicas: 4
+        name: builder
+      - queues: process_priority,process
+     
+Note that while we can define the `NAME` variable, as we did for the first worker, we don't 
+need to and the `Builder` will automatically generate a name from the values provided for 
+the worker. So the second worker would have a name "process-priority-process"
+
+Use the `resque-k8s` command to create a series of YAML deployments
+for kubernetes to consume. You can pipe the output to less to see what it produces.
+
+    $ resque-k8s | less
+
+To apply this run the `kubectl apply` command with the value from the configuration.
+
+    $ resque-k8s | kubectl apply -f -
+
+
+## Other options
+
+This is a very simple implementation. There are a number of solutions out there that propose to 
+do something similar in the scope of larger efforts.
+
+- There is currently a proposal to 
+  [support this in Kubernetes](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/templates.md).
+
+- [kb8or](https://github.com/UKHomeOffice/kb8or) includes something like this with many more continuous deployment
+  features
+
+- Kubernetes [Helm](https://helm.sh/) does this with its [charts](https://github.com/kubernetes/helm/tree/master/docs/examples/alpine).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can 
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to 
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/keylimetoolbox/kube-templates.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kube/templates"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kube-templates.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kube/templates/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kube-templates"
+  spec.version       = Kube::Templates::VERSION
+  spec.authors       = ["Jeremy Wadsack"]
+  spec.email         = ["jeremy.wadsack@gmail.com"]
+
+  spec.summary       = %q{Simple template system for Kubernetes deployments.}
+  spec.description   = %q{Rapidly generate many Kubernetes deployments from a template and a simple YAML configuration file.}
+  spec.homepage      = "https://github.com/keylimetoolbox/kube-templates"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kube/templates/builder.rb

@@ -0,0 +1,152 @@
+require "yaml"
+
+module Kube
+  module Templates
+    # Applies a template of a kubernetes configuration with options for resque
+    # workers and builds out deployments for all workers
+    #
+    # Example
+    #
+    # Given a kubernetes deployment configuration template:
+    #
+    #    # resque-template.yaml
+    #    apiVersion: extensions/v1beta1
+    #    kind: Deployment
+    #    metadata:
+    #      name: resque-${NAME}
+    #    spec:
+    #      replicas: ${REPLICAS}
+    #      template:
+    #        metadata:
+    #          labels:
+    #            service: rails
+    #            app: my-app
+    #            purpose: worker
+    #            queues: ${QUEUES}
+    #        spec:
+    #          containers:
+    #          - name: my-app
+    #            image: us.gcr.io/project-id-1138/my-app-resque:latest
+    #            env:
+    #            - name: QUEUE
+    #              value: ${QUEUES}
+    #
+    # And the following worker configuration
+    #
+    #    # resque-workers.yml
+    #    defaults:
+    #      replicas: 2
+    #    workers:
+    #      - queues: reports
+    #        replicas: 4
+    #        name: builder
+    #      - queues: process_priority,process
+    #
+    # Use the `resque-k8s` command to create a series of YAML deployments
+    # for kubernetes to consume. Then use `kubectl apply` command to configure
+    # the cluster.
+    #
+    #    $ resque-k8s | kubectl apply -f -
+    class Builder
+
+      # Create a template handler for the template and configuration.
+      #
+      # template_file  The name or IO of the file that has the kubernetes deployment template.
+      # config_file    The name or IO of the file that has the resque configuration.
+      #
+      # For either argument you can provide the path to the template file or
+      # you can provide an `IO` object for the `Builder` to read. With an `IO`
+      # object you are responsible for closing the stream.
+      #
+      # Examples:
+      #     Kube::Templates::Builder.new("resque-template.yml", "resque-workers.yml")
+      #
+      #     File.open("resque-template.yml") do |template|
+      #       File.open("resque-workers.yml") do |config|
+      #         Kube::Templates::Builder.new(template, config))
+      #       end
+      #     end
+      #
+      # Note that if you want to provide a string value to the `Builder` you can
+      # just use a `StringIO` instance.
+      #
+      #     Kube::Templates::Builder.new(StringIO.new(template), StringIO.new(config))
+      def initialize(template_file, config_file)
+        @template = readfile(template_file)
+        @config   = YAML.load(readfile(config_file))
+      end
+
+      # Returns a string of YAML configurations, concatenated with "---" line,
+      # for each configuration defined.
+      #
+      # The `config_file` must have a "workers" property which is a collection
+      # of properties that are applied to the template. Template variables are
+      # case insensitive, but configuration keys must all be lower case.
+      #
+      # You can also provide a "defaults" section that applies default values
+      # for any worker that does not have a specific value defined.
+      #
+      # There is a special ${NAME} property that you can use in your template. If
+      # not provided as a value, it will default to, roughly, the values for
+      # the worker concatenated with "-".
+      #
+      # Example:
+      #    # resque-workers.yml
+      #    defaults:
+      #      replicas: 2
+      #    workers:
+      #      - queues: reports
+      #        replicas: 4
+      #        name: builder
+      #      - queues: process_priority,process
+      #
+      # For this configuration, `#build` would create two YAML configurations.
+      # The first assigns these values in the template:
+      #    ${QUEUES}   = "reports"
+      #    ${REPLICAS} = 4
+      #    ${NAME}     = "builder"
+      # The second assigns these values in the template:
+      #    ${QUEUES}   = "process_priority,process"
+      #    ${REPLICAS} = 2
+      #    ${NAME}     = "process-priority-process"
+      #
+      # Configurations are returned in the order defined in the `config_file`.
+      def build
+        defaults = @config["defaults"] || {}
+        configs = @config["workers"].map do |worker|
+          # TODO: We should #downcase the keys for the variables as well
+          variables = defaults.merge(worker)
+          @template.gsub(/\$\{([^}]+)\}/) do |match|
+            key = Regexp.last_match[1].downcase
+            if variables.key? key
+              variables[key]
+            elsif key == "name"
+              # NB This doesn't handle utf-8 characters at all
+              name_from_values(worker.values)
+            else
+              match
+            end
+          end
+        end
+
+        configs.join("---\n")
+      end
+
+      private
+
+      def readfile(file)
+        if file.is_a? String
+          File.read(file)
+        elsif file.respond_to?(:read)
+          file.read
+        else
+          raise ArgumentError.new("Don't know how to read #{file.class}")
+        end
+      end
+
+      def name_from_values(values)
+        values.join("-").gsub(/[^-a-zA-Z0-9]/, "-").gsub(/--+/, "-").gsub(/\A-|-\Z/, "")
+      end
+    end
+  end
+end

data/lib/kube/templates/version.rb

@@ -0,0 +1,5 @@
+module Kube
+  module Templates
+    VERSION = "0.1.0"
+  end
+end

data/lib/kube/templates.rb

@@ -0,0 +1,7 @@
+require "kube/templates/version"
+require "kube/templates/builder"
+
+module Kube
+  module Templates
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: kube-templates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Wadsack
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rapidly generate many Kubernetes deployments from a template and a simple
+  YAML configuration file.
+email:
+- jeremy.wadsack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kube-templates.gemspec
+- lib/kube/templates.rb
+- lib/kube/templates/builder.rb
+- lib/kube/templates/version.rb
+homepage: https://github.com/keylimetoolbox/kube-templates
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple template system for Kubernetes deployments.
+test_files: []