ev_job_gen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef051014a01fbf1e28657f8816672a3d1f7c8ec85896df9f1055f06637ecb7a7
+  data.tar.gz: 9a820a963bfda3d53cf9db78382609c888c45661ba641b5935a9e24fcd50510d
+SHA512:
+  metadata.gz: 6018b587a63bf310ffdceeb5e026a688c288cf8c9d684e5b0404dcc6b95888b754195edbe7be9b22e8384e8c79afa8fdf8b6a38534d367de124591ef7f19dc4f
+  data.tar.gz: 3ad0324796be638b7c0d33e3db34058d65ee1268c75b22d988aab846285b3860934e1462056b86def1196d349263502c0fb6dcf67eadcefb65ecdd776470e4ce

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,6 @@
+## WHY
+
+
+
+## WHAT
+

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+## WHY
+
+
+
+## WHAT
+

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ev_job_gen.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    ev_job_gen (0.1.0)
+      dotenv (~> 2.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    dotenv (2.5.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-doc (0.13.4)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    yard (0.9.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ev_job_gen!
+  pry
+  pry-doc
+  rake (~> 10.0)
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nao Minami
+
+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,115 @@
+# EvJobGen
+Generator of kubernetes manifest file for evaluation job.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ev_job_gen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ev_job_gen
+
+## Usage
+
+Place a yml file in jobs directory
+
+```yml
+# Ex. ml-project-1.yml
+namespace: ml-project-1
+image: some-docker-registory/ml-project-1:latest
+command: >
+         script/evaluate | tee /tmp/out.txt;
+out: /tmp/out.txt
+metrics: /tmp/metrics.json
+commithash: ${COMMITHASH}
+```
+
+Then execute `ev-job-gen` command.
+
+```console
+$ ev-job-gen --jobfile jobs/ml-project-1.yml
+```
+
+It generates manifest file for cron job which executes evaluation.
+
+```yml
+apiVersion: batch/v1beta1
+kind: CronJob
+metadata:
+  name: ev-job
+  namespace: ml-project-1
+  labels:
+    name: ev-job
+    namespace: ml-project-1
+    app: ev-job
+    role: job
+spec:
+  schedule: "5 17 * * *"
+  concurrencyPolicy: "Replace"
+  suspend: false
+  successfulJobsHistoryLimit: 10
+  failedJobsHistoryLimit: 3
+  jobTemplate:
+    metadata:
+      name: ev-job
+      labels:
+        name: ev-job
+        app: ev-job
+        role: job
+    spec:
+      backoffLimit: 1
+      template:
+        metadata:
+          name: ev-job
+          labels:
+            name: ev-job
+            app: ev-job
+            role: job
+        spec:
+          restartPolicy: Never
+          containers:
+          - name: ev-job
+            image: some-docker-registory/wantedly/ml-project-1:latest
+            imagePullPolicy: Always
+            command:
+              - "/bin/bash"
+              - "-c"
+              - >
+                script/evaluate | tee /tmp/out.txt;
+
+                export AWS_ACCESS_KEY_ID=xxx;
+                export AWS_SECRET_ACCESS_KEY=xxx;
+                export AWS_REGION=xxx;
+
+                wget https://github.com/wantedly/ev-cli/releases/download/v1.2.3/ev-v1.2.3-linux-amd64.tar.gz;
+                tar xvzf ev-v1.2.3-linux-amd64.tar.gz;
+                cp linux-amd64/ev ev;
+
+                ./ev upload --branch master \
+                            --commit ${COMMITHASH} \
+                            --out /tmp/out.txt \
+                            --metrics /tmp/metrics.json \
+                            --namespace ml-project-1;
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake true` 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/south37/ev-job-gen.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ev_job_gen"
+
+# 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(__FILE__)

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/ev_job_gen.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ev_job_gen/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ev_job_gen"
+  spec.version       = EvJobGen::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{Generator of kubernetes manifest file for evaluation job.}
+  spec.description   = %q{Generator of kubernetes manifest file for evaluation job.}
+  spec.homepage      = "https://github.com/south37/ev-job-gen"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "dotenv", "~> 2.5.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+end

data/exe/ev-job-gen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ev_job_gen"
+
+EvJobGen::CLI.run!(ARGV)

data/kubernetes/tmpl/cron_job_template.yml.erb

@@ -0,0 +1,33 @@
+apiVersion: batch/v1beta1
+kind: CronJob
+metadata:
+  name: ev-job
+  namespace: <%= job.namespace %>
+  labels:
+    name: ev-job
+    namespace: <%= job.namespace %>
+    app: ev-job
+    role: job
+spec:
+  schedule: "5 17 * * *"
+  concurrencyPolicy: "Replace"
+  suspend: false
+  successfulJobsHistoryLimit: 10
+  failedJobsHistoryLimit: 3
+  jobTemplate:
+    metadata:
+      name: ev-job
+      labels:
+        name: ev-job
+        app: ev-job
+        role: job
+    spec:
+      backoffLimit: 1
+      template:
+        metadata:
+          name: ev-job
+          labels:
+            name: ev-job
+            app: ev-job
+            role: job
+        spec: <%= spec %>

data/kubernetes/tmpl/oneshot_job_template.yml.erb

@@ -0,0 +1,19 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: ev-job-<%= job.suffix %>
+  namespace: <%= job.namespace %>
+  labels:
+    name: ev-job-<%= job.suffix %>
+    namespace: <%= job.namespace %>
+    app: ev-job
+    role: job
+spec:
+  template:
+    metadata:
+      name: ev-job-<%= job.suffix %>
+      labels:
+        name: ev-job-<%= job.suffix %>
+        app: ev-job
+        role: job
+    spec: <%= spec %>

data/kubernetes/tmpl/spec_template.yml.erb

@@ -0,0 +1,26 @@
+<%= config.imagePullSecrets %>
+restartPolicy: Never
+containers:
+- name: ev-job
+  image: <%= job.image %>
+  imagePullPolicy: Always
+  command:
+    - "/bin/bash"
+    - "-c"
+    - >
+      <%= job.command.strip %>
+
+      export AWS_ACCESS_KEY_ID=<%= ENV['AWS_ACCESS_KEY_ID'] %>;
+      export AWS_SECRET_ACCESS_KEY=<%= ENV['AWS_SECRET_ACCESS_KEY'] %>;
+      export AWS_REGION=<%= ENV['AWS_REGION'] %>;
+
+      wget https://github.com/wantedly/ev-cli/releases/download/v1.2.3/ev-v1.2.3-linux-amd64.tar.gz;
+      tar xvzf ev-v1.2.3-linux-amd64.tar.gz;
+      cp linux-amd64/ev ev;
+
+      ./ev upload --branch master \
+                  --commit <%= job.commithash %> \
+                  --out <%= job.out %> \
+                  --metrics <%= job.metrics %> \
+                  --namespace <%= job.namespace %>;
+<%= config.containers_envFrom(offset: 2) %>

data/lib/ev_job_gen.rb

@@ -0,0 +1,19 @@
+require 'dotenv/load'
+
+require 'ev_job_gen/cli'
+require 'ev_job_gen/config'
+require 'ev_job_gen/job'
+require 'ev_job_gen/yml_renderer'
+require 'ev_job_gen/manifest_gen'
+
+module EvJobGen
+  class << self
+    def root
+      File.expand_path(File.join('..', '..'), __FILE__)
+    end
+
+    def tmpl_dir
+      File.expand_path(File.join('kubernetes', 'tmpl'), self.root)
+    end
+  end
+end

data/lib/ev_job_gen/cli.rb

@@ -0,0 +1,25 @@
+require 'ev_job_gen/cli/option'
+
+module EvJobGen
+  class CLI
+    class << self
+      def run!(argv)
+        CLI.new(argv).run!
+      end
+    end
+
+    def initialize(argv)
+      @option = Option.new
+      @option.parse!(argv)
+    end
+
+    def run!
+      yml = ManifestGen.gen(
+        jobfile:    @option.jobfile,
+        target:     @option.target,
+        configfile: @option.config,
+      )
+      print yml
+    end
+  end
+end

data/lib/ev_job_gen/cli/option.rb

@@ -0,0 +1,36 @@
+require 'optparse'
+
+module EvJobGen
+  class CLI
+    class Option
+      attr_reader :jobfile, :target, :config
+
+      def initialize
+        @jobfile = nil
+        @target  = "cronjob"
+        @config  = nil
+      end
+
+      def parse!(argv)
+        opt = OptionParser.new
+        opt.on('--jobfile jobfile') { |v| @jobfile = v }
+        opt.on('--target [target]') { |v| @target = v }
+        opt.on('--config [config]') { |v| @config = v }
+        opt.parse!(argv)
+        validate!
+      end
+
+    private
+
+      def validate!
+        if !@jobfile
+          raise "<jobfile> is required!"
+        end
+
+        if !["cronjob", "job"].include?(@target)
+          raise '<target> must be "cronjob" or "job"'
+        end
+      end
+    end
+  end
+end

data/lib/ev_job_gen/config.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+
+module EvJobGen
+  class Config
+    def initialize(configfile)
+      if configfile
+        @yml = YAML.load_file(configfile)
+      else
+        @yml = nil
+      end
+    end
+
+    def imagePullSecrets
+      v = fetch("imagePullSecrets")
+      return nil if !v
+      dump({ "imagePullSecrets" => v })
+    end
+
+    def containers_envFrom(offset:)
+      v = fetch("containers.envFrom")
+      return nil if !v
+
+      s = dump({ "envFrom" => v })
+      s.split("\n").map { |l| "#{' ' * offset}#{l}\n" }.join
+    end
+
+  private
+
+    def fetch(key)
+      return nil if !@yml
+      @yml[key]
+    end
+
+    def dump(h)
+      # NOTE: yml has "---" in first line, so trim it.
+      YAML.dump(h).gsub(/^---\n/, '').strip
+    end
+  end
+end

data/lib/ev_job_gen/job.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+
+module EvJobGen
+  class Job
+    CHARS = [*'a'..'z'] + [*'0'..'9']
+
+    def initialize(yml_file)
+      h = YAML.load_file(yml_file)
+      validate!(h)
+      @namespace  = h["namespace"]
+      @image      = h["image"]
+      @command    = h["command"]
+      @out        = h["out"]
+      @metrics    = h["metrics"]
+      @commithash = h["commithash"]
+
+      # NOTE: suffix is used only for oneshot job
+      @suffix    = 5.times.map { CHARS.sample }.join
+    end
+
+    attr_reader :namespace, :image, :command, :out, :metrics, :commithash, :suffix
+
+  private
+
+    def validate!(h)
+      validate_column!(h, "namespace")
+      validate_column!(h, "image")
+      validate_column!(h, "command")
+      validate_column!(h, "out")
+      validate_column!(h, "metrics")
+      validate_column!(h, "commithash")
+    end
+
+    def validate_column!(h, column)
+      if !h[column]
+        raise "#{column} must be specified, but got #{h[column]}"
+      end
+    end
+  end
+end

data/lib/ev_job_gen/manifest_gen.rb

@@ -0,0 +1,35 @@
+module EvJobGen
+  class ManifestGen
+    class << self
+      def gen(jobfile:, target:, configfile:)
+        self.new(jobfile: jobfile, target: target, configfile: configfile).gen
+      end
+    end
+
+    CRONJOB_TEMPLATE_FILE    = "cron_job_template.yml.erb"
+    ONESHOTJOB_TEMPLATE_FILE = "oneshot_job_template.yml.erb"
+
+    def initialize(jobfile:, target:, configfile:)
+      case target
+      when "cronjob"
+        template   = File.join(EvJobGen.tmpl_dir, CRONJOB_TEMPLATE_FILE)
+        specoffset = 8
+      when "job"
+        template   = File.join(EvJobGen.tmpl_dir, ONESHOTJOB_TEMPLATE_FILE)
+        specoffset = 4
+      else
+        raise "invalid target: #{target}"
+      end
+      @renderer = YmlRenderer.new(
+        template:   template,
+        specoffset: specoffset,
+        jobfile:    jobfile,
+        configfile: configfile,
+      )
+    end
+
+    def gen
+      @renderer.render
+    end
+  end
+end

data/lib/ev_job_gen/version.rb

@@ -0,0 +1,3 @@
+module EvJobGen
+  VERSION = "0.1.0"
+end

data/lib/ev_job_gen/yml_renderer.rb

@@ -0,0 +1,38 @@
+require 'erb'
+require 'fileutils'
+
+module EvJobGen
+  class YmlRenderer
+    class << self
+      def spec_template_path
+        File.expand_path(
+          File.join('kubernetes', 'tmpl', 'spec_template.yml.erb'),
+          EvJobGen.root,
+        )
+      end
+    end
+
+    def initialize(template:, specoffset:, jobfile:, configfile:)
+      @spec_renderer = ERB.new(File.read(YmlRenderer.spec_template_path))
+      @specoffset    = specoffset
+      @renderer      = ERB.new(File.read(template))
+      @job           = EvJobGen::Job.new(jobfile)
+      @config        = EvJobGen::Config.new(configfile)
+    end
+
+    attr_reader :job, :config
+
+    def render
+      spec = render_spec
+      @renderer.result(binding)
+    end
+
+  private
+
+    def render_spec
+      r = @spec_renderer.result(binding)
+      offset = @specoffset + 2
+      "\n" + r.split("\n").map { |l| "#{' ' * offset}#{l}\n" }.join
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: ev_job_gen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-doc
+  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'
+description: Generator of kubernetes manifest file for evaluation job.
+email:
+- south37777@gmail.com
+executables:
+- ev-job-gen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ev_job_gen.gemspec
+- exe/ev-job-gen
+- kubernetes/jobs/.gitkeeep
+- kubernetes/tmpl/cron_job_template.yml.erb
+- kubernetes/tmpl/oneshot_job_template.yml.erb
+- kubernetes/tmpl/spec_template.yml.erb
+- lib/ev_job_gen.rb
+- lib/ev_job_gen/cli.rb
+- lib/ev_job_gen/cli/option.rb
+- lib/ev_job_gen/config.rb
+- lib/ev_job_gen/job.rb
+- lib/ev_job_gen/manifest_gen.rb
+- lib/ev_job_gen/version.rb
+- lib/ev_job_gen/yml_renderer.rb
+homepage: https://github.com/south37/ev-job-gen
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Generator of kubernetes manifest file for evaluation job.
+test_files: []