inst-jobs-autoscaling 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3f9fbfdd0d13f234e05ebc243dbe26ae16673e4
+  data.tar.gz: 88e985211fecb32e66ac8d1c3c4c11bff309e207
+SHA512:
+  metadata.gz: 11543a9b36146b72fe984410c9decb325baddf58e5eacc70447f774da575298adf5abe36034cc016e9966864e091bce15c26e25460555bd120b0db9d9e0c0ec9
+  data.tar.gz: 18a70e446be14da423e0ecba10d6a8880ba814b485c8d6b1d86d93030c0a4c72690bf773dc9a503ccdd8bc47996ec545afcadacbab83e8806eeb16951ac335a2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM instructure/ruby:2.1
+
+ADD Gemfile* *.gemspec /usr/src/app/
+ADD lib/jobs_autoscaling/version.rb /usr/src/app/lib/jobs_autoscaling/
+USER root
+RUN bundle install
+ADD . /usr/src/app/
+RUN chown -R docker:docker /usr/src/app
+USER docker
+
+CMD ["rake"]

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Instructure Inc.
+
+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,43 @@
+# Jobs Autoscaling
+
+This [inst-jobs](https://github.com/instructure/inst-jobs) plugin enables
+autoscaling of job worker pools using AWS Autoscaling Groups.
+
+Using this plugin requires configuring inst-jobs to use the ParentProcess
+WorkQueue implementation, which is not currently the default.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inst-jobs-autoscaling'
+```
+
+## Usage
+
+Before using the plugin you'll need to configure your jobs workers to run as an
+AWS ASG. This typically means creating an AMI containing your application's
+code, and then setting scaleup/scaledown actions based on either CPU or job
+queue length.
+
+To enable the plugin you'll need to provide the ASG name to the app via an ENV
+var or other means, and add a line in an application initializer:
+
+```ruby
+require 'jobs_autoscaling'
+action = JobsAutoscaling::AwsAction.new(asg_name: "my_asg_name")
+autoscaler = JobsAutoscaling::Monitor.new(action: action)
+autoscaler.activate!
+```
+
+To just log what actions would be taken, rather than make actual ASG API calls,
+use the `LoggerAction`:
+
+```ruby
+action = JobsAutoscaling::LoggerAction.new
+```
+
+## 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,8 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jobs_autoscaling"
+
+# 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

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/build.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+
+docker-compose build
+docker-compose run --rm ci

data/docker-compose.yml

@@ -0,0 +1,2 @@
+ci:
+  build: .

data/inst-jobs-autoscaling.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jobs_autoscaling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inst-jobs-autoscaling"
+  spec.version       = JobsAutoscaling::VERSION
+  spec.authors       = ["Brian Palmer"]
+  spec.email         = ["brianp@instructure.com"]
+
+  spec.summary       = %q{AWS ASG autoscaling for inst-jobs}
+  spec.homepage      = "https://github.com/instructure/inst-jobs-autoscaling"
+  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_dependency "inst-jobs", ">= 0.11.0"
+  spec.add_dependency "aws-sdk", ">= 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.4.0"
+end

data/lib/jobs_autoscaling.rb

@@ -0,0 +1,9 @@
+require 'aws-sdk'
+
+require "jobs_autoscaling/version"
+require "jobs_autoscaling/monitor"
+require "jobs_autoscaling/aws_action"
+require "jobs_autoscaling/logger_action"
+
+module JobsAutoscaling
+end

data/lib/jobs_autoscaling/aws_action.rb

@@ -0,0 +1,41 @@
+require 'net/http'
+require 'uri'
+
+module JobsAutoscaling
+  class AwsAction
+    attr_reader :asg_name, :client
+
+    def initialize(asg_name:)
+      @asg_name = asg_name
+      @client = Aws::AutoScaling::Client.new(retry_limit: 10)
+    end
+
+    def idle
+      @client.set_instance_protection(
+        protected_from_scale_in: false,
+        auto_scaling_group_name: asg_name,
+        instance_ids: [instance_id],
+      )
+    end
+
+    # it's intentional that if this call fails, the error bubbles up to
+    # inst-jobs and errors the WorkQueue. We don't want to start running the
+    # job if we weren't able to block scaledowns.
+    def busy
+      @client.set_instance_protection(
+        protected_from_scale_in: true,
+        auto_scaling_group_name: asg_name,
+        instance_ids: [instance_id],
+      )
+    end
+
+    # This is the hard-coded EC2 endpoint for getting instance metadata.
+    # Oddly the ruby SDK doesn't include a method to get this information,
+    # you are expected to just hit the endpoint yourself.
+    INSTANCE_ID_ENDPOINT = 'http://169.254.169.254/latest/meta-data/instance-id'
+
+    def instance_id
+      @instance_id ||= Net::HTTP.get(URI.parse(INSTANCE_ID_ENDPOINT))
+    end
+  end
+end

data/lib/jobs_autoscaling/logger_action.rb

@@ -0,0 +1,17 @@
+module JobsAutoscaling
+  class LoggerAction
+    def idle
+      log_change("idle")
+    end
+
+    def busy
+      log_change("busy")
+    end
+
+    protected
+
+    def log_change(new_state)
+      Rails.logger.info("Worker state is now: #{new_state}")
+    end
+  end
+end

data/lib/jobs_autoscaling/monitor.rb

@@ -0,0 +1,35 @@
+require 'delayed_job'
+
+module JobsAutoscaling
+  class Monitor
+    IDLE = :idle
+    BUSY = :busy
+
+    def initialize(action: action)
+      @action = action
+    end
+
+    def activate!
+      Delayed::Worker.lifecycle.after(:work_queue_pop, &method(:work_queue_pop))
+      change_state(IDLE)
+    end
+
+    protected
+
+    def work_queue_pop(work_queue)
+      unless work_queue.respond_to?(:all_workers_idle?)
+        raise("JobsAutoscaling requires a ParentProcess work queue")
+      end
+
+      new_state = work_queue.all_workers_idle? ? IDLE : BUSY
+      if new_state != @worker_state
+        change_state(new_state)
+      end
+    end
+
+    def change_state(new_state)
+      @worker_state = new_state
+      @action.public_send(new_state)
+    end
+  end
+end

data/lib/jobs_autoscaling/version.rb

@@ -0,0 +1,3 @@
+module JobsAutoscaling
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: inst-jobs-autoscaling
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Palmer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inst-jobs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: 
+email:
+- brianp@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- build.sh
+- docker-compose.yml
+- inst-jobs-autoscaling.gemspec
+- lib/jobs_autoscaling.rb
+- lib/jobs_autoscaling/aws_action.rb
+- lib/jobs_autoscaling/logger_action.rb
+- lib/jobs_autoscaling/monitor.rb
+- lib/jobs_autoscaling/version.rb
+homepage: https://github.com/instructure/inst-jobs-autoscaling
+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: AWS ASG autoscaling for inst-jobs
+test_files: []