krane 1.0.0

data/lib/krane/template_sets.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+require 'krane/delayed_exceptions'
+require 'krane/ejson_secret_provisioner'
+
+module Krane
+  class TemplateSets
+    include DelayedExceptions
+    VALID_TEMPLATES = %w(.yml.erb .yml .yaml .yaml.erb)
+    # private inner class
+    class TemplateSet
+      include DelayedExceptions
+      attr_reader :render_erb
+      def initialize(template_dir:, file_whitelist: [], logger:, render_erb: true)
+        @template_dir = template_dir
+        @files = file_whitelist
+        @logger = logger
+        @render_erb = render_erb
+      end
+
+      def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false)
+        if @render_erb
+          @renderer = Renderer.new(
+            template_dir: @template_dir,
+            logger: @logger,
+            current_sha: current_sha,
+            bindings: bindings,
+          )
+        end
+        with_delayed_exceptions(@files, Krane::InvalidTemplateError) do |filename|
+          next if filename.end_with?(EjsonSecretProvisioner::EJSON_SECRETS_FILE)
+          templates(filename: filename, raw: raw) { |r_def| yield r_def, filename }
+        end
+      end
+
+      def ejson_secrets_file
+        @ejson_secrets_file ||= begin
+          secret_file = @files.find { |f| f == EjsonSecretProvisioner::EJSON_SECRETS_FILE }
+          File.join(@template_dir, secret_file) if secret_file
+        end
+      end
+
+      def validate
+        errors = []
+        supported_extensions = if @render_erb
+          TemplateSets::VALID_TEMPLATES
+        else
+          TemplateSets::VALID_TEMPLATES.reject { |extension| extension.include?('erb') }
+        end
+
+        if Dir.entries(@template_dir).none? do |filename|
+             filename.end_with?(*supported_extensions) ||
+             filename.end_with?(EjsonSecretProvisioner::EJSON_SECRETS_FILE)
+           end
+          return errors << "Template directory #{@template_dir} does not contain any valid templates (supported " \
+              "suffixes: #{supported_extensions.join(', ')}, or #{EjsonSecretProvisioner::EJSON_SECRETS_FILE})"
+        end
+
+        @files.each do |filename|
+          filename = File.join(@template_dir, filename)
+          if !File.exist?(filename)
+            errors << "File #{filename} does not exist"
+          elsif !filename.end_with?(*supported_extensions) &&
+                !filename.end_with?(EjsonSecretProvisioner::EJSON_SECRETS_FILE)
+            errors << "File #{filename} does not have valid suffix (supported suffixes: " \
+              "#{supported_extensions.join(', ')}, or #{EjsonSecretProvisioner::EJSON_SECRETS_FILE})"
+          end
+        end
+        errors
+      end
+
+      def deploying_with_erb_files?
+        @files.any? { |file| file.end_with?("erb") }
+      end
+
+      private
+
+      def templates(filename:, raw:)
+        file_content = File.read(File.join(@template_dir, filename))
+        rendered_content = @renderer ? @renderer.render_template(filename, file_content) : file_content
+        YAML.load_stream(rendered_content, "<rendered> #{filename}") do |doc|
+          next if doc.blank?
+          unless doc.is_a?(Hash)
+            raise InvalidTemplateError.new("Template is not a valid Kubernetes manifest",
+              filename: filename, content: doc)
+          end
+          yield doc unless raw
+        end
+        yield rendered_content if raw
+      rescue InvalidTemplateError => err
+        err.filename ||= filename
+        raise err
+      rescue Psych::SyntaxError => err
+        raise InvalidTemplateError.new(err.message, filename: filename, content: rendered_content)
+      end
+    end
+    private_constant :TemplateSet
+
+    class << self
+      def from_dirs_and_files(paths:, logger:, render_erb: true)
+        resource_templates = {}
+        dir_paths, file_paths = paths.partition { |path| File.directory?(path) }
+
+        # Directory paths
+        dir_paths.each do |template_dir|
+          resource_templates[template_dir] = Dir.foreach(template_dir).select do |filename|
+            filename.end_with?(*VALID_TEMPLATES) || filename == EjsonSecretProvisioner::EJSON_SECRETS_FILE
+          end
+        end
+
+        # Filename paths
+        file_paths.each do |filename|
+          dir_name = File.dirname(filename)
+          resource_templates[dir_name] ||= []
+          resource_templates[dir_name] << File.basename(filename) unless resource_templates[dir_name].include?(filename)
+        end
+
+        template_sets = []
+        resource_templates.each do |template_dir, files|
+          template_sets << TemplateSet.new(template_dir: template_dir, file_whitelist: files, logger: logger,
+            render_erb: render_erb)
+        end
+        TemplateSets.new(template_sets: template_sets)
+      end
+    end
+
+    def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false)
+      with_delayed_exceptions(@template_sets, Krane::InvalidTemplateError) do |template_set|
+        template_set.with_resource_definitions_and_filename(
+          current_sha: current_sha,
+          bindings: bindings,
+          raw: raw
+        ) do |r_def, filename|
+          yield r_def, filename
+        end
+      end
+    end
+
+    def with_resource_definitions(current_sha: nil, bindings: nil, raw: false)
+      with_resource_definitions_and_filename(current_sha: current_sha, bindings: bindings, raw: raw) do |r_def, _|
+        yield r_def
+      end
+    end
+
+    def ejson_secrets_files
+      @template_sets.map(&:ejson_secrets_file).compact
+    end
+
+    def validate
+      errors = @template_sets.flat_map(&:validate)
+
+      if rendering_erb_disabled? && deploying_with_erb_files?
+        errors << "ERB template discovered with rendering disabled. If you were trying to render ERB and " \
+          "deploy the result, try piping the output of `krane render` to `krane-deploy` with the --stdin flag"
+      end
+
+      errors
+    end
+
+    private
+
+    def deploying_with_erb_files?
+      @template_sets.any?(&:deploying_with_erb_files?)
+    end
+
+    def rendering_erb_disabled?
+      !@template_sets.any?(&:render_erb)
+    end
+
+    def initialize(template_sets: [])
+      @template_sets = template_sets
+    end
+  end
+end

data/lib/krane/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Krane
+  VERSION = "1.0.0"
+end

data/pull_request_template.md

@@ -0,0 +1,8 @@
+**What are you trying to accomplish with this PR?**
+...
+
+**How is this accomplished?**
+...
+
+**What could go wrong?**
+...

data/shipit.yml

@@ -0,0 +1,4 @@
+ci:
+  hide:
+    -  buildkite/kubernetes-deploy-gem-nightly
+

metadata

@@ -0,0 +1,376 @@
+--- !ruby/object:Gem::Specification
+name: krane
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Katrina Verey
+- Daniel Turner
+- Kir Shatrov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: kubeclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: ejson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: A command line tool that helps you ship changes to a Kubernetes namespace
+  and understand the result
+email:
+- ops-accounts+shipit@shopify.com
+executables:
+- krane
+extensions: []
+extra_rdoc_files: []
+files:
+- ".buildkite/pipeline.nightly.yml"
+- ".github/probots.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".shopify-build/VERSION"
+- ".shopify-build/kubernetes-deploy.yml"
+- 1.0-Upgrade.md
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- ISSUE_TEMPLATE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ci
+- bin/setup
+- bin/test
+- dev.yml
+- dev/flamegraph-from-tests
+- exe/krane
+- krane.gemspec
+- lib/krane.rb
+- lib/krane/bindings_parser.rb
+- lib/krane/cli/deploy_command.rb
+- lib/krane/cli/global_deploy_command.rb
+- lib/krane/cli/krane.rb
+- lib/krane/cli/render_command.rb
+- lib/krane/cli/restart_command.rb
+- lib/krane/cli/run_command.rb
+- lib/krane/cli/version_command.rb
+- lib/krane/cluster_resource_discovery.rb
+- lib/krane/common.rb
+- lib/krane/concerns/template_reporting.rb
+- lib/krane/concurrency.rb
+- lib/krane/container_logs.rb
+- lib/krane/deferred_summary_logging.rb
+- lib/krane/delayed_exceptions.rb
+- lib/krane/deploy_task.rb
+- lib/krane/deploy_task_config_validator.rb
+- lib/krane/duration_parser.rb
+- lib/krane/ejson_secret_provisioner.rb
+- lib/krane/errors.rb
+- lib/krane/formatted_logger.rb
+- lib/krane/global_deploy_task.rb
+- lib/krane/global_deploy_task_config_validator.rb
+- lib/krane/kubeclient_builder.rb
+- lib/krane/kubectl.rb
+- lib/krane/kubernetes_resource.rb
+- lib/krane/kubernetes_resource/cloudsql.rb
+- lib/krane/kubernetes_resource/config_map.rb
+- lib/krane/kubernetes_resource/cron_job.rb
+- lib/krane/kubernetes_resource/custom_resource.rb
+- lib/krane/kubernetes_resource/custom_resource_definition.rb
+- lib/krane/kubernetes_resource/daemon_set.rb
+- lib/krane/kubernetes_resource/deployment.rb
+- lib/krane/kubernetes_resource/horizontal_pod_autoscaler.rb
+- lib/krane/kubernetes_resource/ingress.rb
+- lib/krane/kubernetes_resource/job.rb
+- lib/krane/kubernetes_resource/network_policy.rb
+- lib/krane/kubernetes_resource/persistent_volume_claim.rb
+- lib/krane/kubernetes_resource/pod.rb
+- lib/krane/kubernetes_resource/pod_disruption_budget.rb
+- lib/krane/kubernetes_resource/pod_set_base.rb
+- lib/krane/kubernetes_resource/pod_template.rb
+- lib/krane/kubernetes_resource/replica_set.rb
+- lib/krane/kubernetes_resource/resource_quota.rb
+- lib/krane/kubernetes_resource/role.rb
+- lib/krane/kubernetes_resource/role_binding.rb
+- lib/krane/kubernetes_resource/secret.rb
+- lib/krane/kubernetes_resource/service.rb
+- lib/krane/kubernetes_resource/service_account.rb
+- lib/krane/kubernetes_resource/stateful_set.rb
+- lib/krane/label_selector.rb
+- lib/krane/oj.rb
+- lib/krane/options_helper.rb
+- lib/krane/remote_logs.rb
+- lib/krane/render_task.rb
+- lib/krane/renderer.rb
+- lib/krane/resource_cache.rb
+- lib/krane/resource_deployer.rb
+- lib/krane/resource_watcher.rb
+- lib/krane/restart_task.rb
+- lib/krane/rollout_conditions.rb
+- lib/krane/runner_task.rb
+- lib/krane/runner_task_config_validator.rb
+- lib/krane/statsd.rb
+- lib/krane/task_config.rb
+- lib/krane/task_config_validator.rb
+- lib/krane/template_sets.rb
+- lib/krane/version.rb
+- pull_request_template.md
+- screenshots/deploy-demo.gif
+- screenshots/migrate-logs.png
+- screenshots/missing-secret-fail.png
+- screenshots/success.png
+- screenshots/test-output.png
+- shipit.yml
+homepage: https://github.com/Shopify/krane
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A command line tool that helps you ship changes to a Kubernetes namespace
+  and understand the result
+test_files: []