whenever-eb-shipoffers 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 391a39f62b49a6e75cf82937fd402d956e536ca8
+  data.tar.gz: 81a687b539838ba6d9a20b518d6331c774fbf8b1
+SHA512:
+  metadata.gz: 079e8f42b72422c5319667f8832aaf80354b426083ac52356b4a6134725bb7182fbc31187893dc67decf75c39ecf5a505a54621f6b70f851aa0312d58a26e0e0
+  data.tar.gz: ce3c643622b2ca6e5a0b7c688f04d5537f4de52449a55dde8eba81780fd8d1b781001686a93649941b6d2a8b386670e627d89de7a995cda9a53bba23900e25fe

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Zachary Green
+
+MIT License
+
+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,102 @@
+# Whenever::Elasticbeanstalk for ShipOffers
+
+Whenever-elasticbeanstalk is an extension gem to [Whenever](https://github.com/javan/whenever) that automatically ensures that one instance in an AWS Elastic Beanstalk environment is set as leader. This allows you to run cron jobs on all instances, or just on the leader. This is required since Elastic Beanstalk may start or stop any instance as it scales up or down.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'whenever-elasticbeanstalk'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install whenever-elasticbeanstalk
+```
+
+## Getting started
+```bash
+$ cd /apps/my-great-project
+$ wheneverize-eb .
+```
+
+This will create an initial `config/schedule.rb` file for you with the `ensure_leader` job set to run every minute. It will also create a `.ebextensions/cron.config` file that will automatically choose a leader on environment initialization, and start up Whenever with the correct `leader` role. Lastly, it creates the `config/whenever-elasticbeanstalk.yml` file that will contain your AWS credentials for retrieving your environment information.
+
+### Manually updating schedule
+
+If you are already using Whenever, running `wheneverize-eb .` won't overwrite your `config/schedule.rb` file. You'll need to add the following lines in order for your environment to always have one leader.
+
+```ruby
+every 1.minute do
+  command "cd /var/app/current && bundle exec ensure_one_cron_leader"
+end
+```
+
+### EC2 Instance IAM Role Permissions
+
+In order for the scripts to work, you need to ensure that the EC2 Instance Role has access to EC2 instances and tags (further reading at [AWS Documentation](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.roles.aeb.html) ). Ensure that your EC2 instance has at a minimum the following permissions:
+
+Example policy:
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Action": [
+        "ec2:DescribeInstanceAttribute",
+        "ec2:DescribeInstanceStatus",
+        "ec2:DescribeInstances",
+        "ec2:DescribeTags",
+        "ec2:CreateTags"
+      ],
+      "Resource": [
+        "*"
+      ],
+      "Effect": "Allow"
+    }
+  ]
+}
+```
+
+Make sure to add the `RACK_ENV` environment variable to your environment if you haven't already done so. This variable is not created automatically by AWS. You can add the following line to your `.elasticbeanstalk/optionsettings.appname-env` file:
+```yaml
+RACK_ENV=staging
+```
+
+## Usage
+
+For `config/schedule.rb` usage, please see the documentation for the [Whenever gem](https://github.com/javan/whenever).
+
+### Run a task on only one instance
+
+To run a task only on one instance, assign the task to the `leader` role.
+```ruby
+every :day, :at => "12:30am", :roles => [:leader] do
+	runner "MyModel.task_to_run_nightly_only_on_one_instance"
+end
+```
+
+### Run a task on all instances
+
+To run a task on all instance, omit the `roles` option.
+```ruby
+every 1.minute do
+	command "touch $EB_CONFIG_APP_SUPPORT/.cron_check"
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/change_remove_cron_leader

@@ -0,0 +1,61 @@
+#!/usr/bin/ruby
+
+require           'optparse'
+require           'rubygems'
+gem               'aws-sdk', '~> 2'
+require           'aws-sdk'
+require           'erb'
+
+EB_CONFIG_APP_SUPPORT = "/opt/elasticbeanstalk/support"
+ENVIRONMENT_NAME_FILE = File.join(EB_CONFIG_APP_SUPPORT,'env_name')
+
+# Options Parsing
+options = {}
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options]"
+
+	# Define the options, and what they do
+	options[:no_update] = false
+	opts.on( '--no-update', 'Do not update crontab after making leader' ) do
+	 options[:no_update] = true
+	end
+
+	options[:instance] = ''
+	opts.on( '-i', '--instance', 'Instance to make leader' ) do |i|
+	 options[:instance] = i
+	end
+
+
+	# This displays the help screen, all programs are
+	# assumed to have this option.
+	opts.on( '-h', '--help', 'Display this screen' ) do
+	 puts opts
+	 exit
+	end
+end
+optparse.parse!
+
+instance_id       = `/opt/aws/bin/ec2-metadata -i | awk '{print $2}'`.strip
+availability_zone = `/opt/aws/bin/ec2-metadata -z | awk '{print $2}'`.strip
+region            =   availability_zone.slice(0..availability_zone.length-2)
+
+Aws.config.update({
+  region: region,
+  credentials: Aws::Credentials.new(ENV['ACCCESS_KEY_ID'], ENV['SECRET_ACCESS_TOKEN'])
+})
+ec2 = ec2 = Aws::EC2::Client.new
+
+
+tags = ec2.describe_tags({filters: [{name: "key", values: ["leader"]}]})
+ids = tags.tags.each {|t| m = []; m << t[:resource_id]; m}
+if options[:instance].empty?
+	puts "Changing all set leader tags to false"
+	ec2.create_tags({dry_run: false, resources: ids, tags: [{key: "leader", value: "false"}]})
+else
+	ec2.create_tags({dry_run: false, resources: [instance_id], tags: [{key: "leader", value: "true"}]})
+end
+
+
+unless options[:no_update]
+	`setup_cron`
+end

data/bin/create_ensure_one_cron_leader

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby
+
+require           'optparse'
+require           'rubygems'
+gem               'aws-sdk', '~> 2'
+require           'aws-sdk'
+require           'erb'
+
+EB_CONFIG_APP_SUPPORT = "/opt/elasticbeanstalk/support"
+ENVIRONMENT_NAME_FILE = File.join(EB_CONFIG_APP_SUPPORT,'env_name')
+
+# Options Parsing
+options = {}
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options]"
+
+	# Define the options, and what they do
+	options[:no_update] = false
+	opts.on( '--no-update', 'Do not update crontab after making leader' ) do
+	 options[:no_update] = true
+	end
+
+	# This displays the help screen, all programs are
+	# assumed to have this option.
+	opts.on( '-h', '--help', 'Display this screen' ) do
+	 puts opts
+	 exit
+	end
+end
+optparse.parse!
+
+instance_id       = `/opt/aws/bin/ec2-metadata -i | awk '{print $2}'`.strip
+availability_zone = `/opt/aws/bin/ec2-metadata -z | awk '{print $2}'`.strip
+region            =   availability_zone.slice(0..availability_zone.length-2)
+
+Aws.config.update({
+  region: region,
+  credentials: Aws::Credentials.new(ENV['ACCCESS_KEY_ID'], ENV['SECRET_ACCESS_TOKEN'])
+})
+ec2 = ec2 = Aws::EC2::Client.new
+tags = ec2.describe_tags({filters: [{name: "key", values: ["leader"]}]})
+ids = tags.tags.each {|t| m = []; m << t[:resource_id]; m}
+
+if !tags.tags.empty?
+  ids = tags.tags.each {|t| m = []; m << t[:resource_id]; m.delete_if {|f| f == instance_id}}
+  if tags.tags.count > 1
+    tags.tags.each do |t|
+      ec2.create_tags({dry_run: false, resources: m, tags: [{key: "leader", value: "false"}]})
+    end
+  else
+    ec2.create_tags({dry_run: false, resources: [instance_id], tags: [{key: "leader", value: "true"}]})
+  end
+else
+  ec2.create_tags({dry_run: false, resources: [instance_id], tags: [{key: "leader", value: "true"}]})
+end
+
+unless options[:no_update]
+	`setup_cron`
+end

data/bin/setup_cron

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby
+
+require           'rubygems'
+gem               'aws-sdk', '~> 2'
+require           'aws-sdk'
+require           'erb'
+
+ENVIRONMENT = ENV["RACK_ENV"]
+
+instance_id       = `/opt/aws/bin/ec2-metadata -i | awk '{print $2}'`.strip
+availability_zone = `/opt/aws/bin/ec2-metadata -z | awk '{print $2}'`.strip
+region            =   availability_zone.slice(0..availability_zone.length-2)
+
+Aws.config.update({
+  region: region,
+  credentials: Aws::Credentials.new(ENV['ACCCESS_KEY_ID'], ENV['SECRET_ACCESS_TOKEN'])
+})
+ec2 = ec2 = Aws::EC2::Client.new
+
+unless (`echo $PATH`).match("/usr/local/bin")
+  `export PATH=/usr/local/bin:$PATH`
+end
+
+tags = ec2.describe_tags({filters: [{name: "key", values: ["leader"]}]})
+leader = tags.tags.each {|t| t.resource_id == instance_id ? t[:value] : "false"}
+
+roles = leader.eql?("true") ? ["leader", ENVIRONMENT] : ["non-leader"]
+`bundle exec whenever --roles #{roles.join(',')} --set 'environment=#{ENVIRONMENT}&path=/var/app/current' --update-crontab --user root`

data/bin/wheneverize-eb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+# This file is based heavily on Whenever's 'wheneverize' command
+
+require 'optparse'
+require 'fileutils'
+require 'erb'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+unless ARGV.empty?
+  if !File.exists?(ARGV.first)
+    abort "`#{ARGV.first}' does not exist."
+  elsif !File.directory?(ARGV.first)
+    abort "`#{ARGV.first}' is not a directory."
+  elsif ARGV.length > 1
+    abort "Too many arguments; please specify only the directory to wheneverize."
+  end
+end
+
+base = ARGV.empty? ? '.' : ARGV.shift
+
+schedule_content = <<-FILE
+# Use this file to easily define all of your cron jobs.
+#
+# It's helpful, but not entirely necessary to understand cron before proceeding.
+# http://en.wikipedia.org/wiki/Cron
+
+# Example:
+#
+# set :output, "/path/to/my/cron_log.log"
+#
+# every 2.hours do
+#   command "/usr/bin/some_great_command"
+#   runner "MyModel.some_method"
+#   rake "some:great:rake:task"
+# end
+#
+# every 4.days do
+#   runner "AnotherModel.prune_old_records"
+# end
+
+# Learn more: http://github.com/javan/whenever
+
+every 1.minute do
+  command "cd /var/app/current && bundle exec ensure_one_cron_leader"
+end
+FILE
+
+file = 'config/schedule.rb'
+file = File.join(base, file)
+if File.exists?(file)
+  warn "[skip] `#{file}' already exists"
+elsif File.exists?(file.downcase)
+  warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+elsif !File.exists?(File.dirname(file))
+  warn "[skip] directory `#{File.dirname(file)}' does not exist"
+else
+  puts "[add] writing `#{file}'"
+  File.open(file, "w") { |f| f.write(schedule_content) }
+end
+
+
+eb_config_content = <<-FILE
+files:
+  # Reload the on deployment
+  /opt/elasticbeanstalk/hooks/appdeploy/post/10_reload_cron.sh:
+    mode: "00700"
+    owner: root
+    group: root
+    content: |
+      #!/usr/bin/env bash
+      # Loading environment data
+      EB_SCRIPT_DIR=$(/opt/elasticbeanstalk/bin/get-config container -k script_dir)
+      EB_SUPPORT_DIR=$(/opt/elasticbeanstalk/bin/get-config container -k support_dir)
+      EB_APP_CURRENT_DIR=$(/opt/elasticbeanstalk/bin/get-config container -k app_deploy_dir)
+
+      # Setting up correct environment and ruby version so that bundle can load all gems
+      . $EB_SUPPORT_DIR/envvars
+      . $EB_SCRIPT_DIR/use-app-ruby.sh
+
+      cd $EB_APP_CURRENT_DIR
+      /usr/local/bin/bundle exec setup_cron
+commands:
+  create_bundle_symlink_patch:
+    test: test ! -f /usr/local/bin/bundle
+    command: ln -s `su -l -s /bin/bash -c "which bundle" $(/opt/elasticbeanstalk/bin/get-config container -k app_user)` /usr/local/bin/bundle
+    ignoreErrors: true
+container_commands:
+  cron_01_set_leader:
+    test: test ! -f /opt/elasticbeanstalk/containerfiles/.cron-setup-complete || test ! -f /opt/elasticbeanstalk/support/.cron-setup-complete
+    leader_only: true
+    cwd: /var/app/ondeck
+    command: su -l -s /bin/bash -c "/usr/local/bin/bundle exec create_cron_leader --no-update" $(/opt/elasticbeanstalk/bin/get-config container -k app_user)
+  cron_02_write_cron_setup_complete_file_containerfiles:
+    test: test -d /opt/elasticbeanstalk/containerfiles
+    command: touch /opt/elasticbeanstalk/containerfiles/.cron-setup-complete
+    ignoreErrors: true
+  cron_02_write_cron_setup_complete_file_support:
+    test: test -d /opt/elasticbeanstalk/support
+    command: touch /opt/elasticbeanstalk/support/.cron-setup-complete
+    ignoreErrors: true
+FILE
+
+file = '.ebextensions/cron.config'
+file = File.join(base, file)
+if File.exists?(file)
+  warn "[skip] `#{file}' already exists"
+elsif File.exists?(file.downcase)
+  warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+elsif !File.exists?(File.dirname(file))
+  warn "[skip] directory `#{File.dirname(file)}' does not exist"
+else
+  puts "[add] writing `#{file}'"
+  File.open(file, "w") { |f| f.write(eb_config_content) }
+end
+
+puts "[done] wheneverized for Elastic Beanstalk!"

data/lib/whenever-elasticbeanstalk.rb

@@ -0,0 +1,7 @@
+require "whenever-elasticbeanstalk/version"
+
+module Whenever
+  module Elasticbeanstalk
+    # Your code goes here...
+  end
+end

data/lib/whenever-elasticbeanstalk/version.rb

@@ -0,0 +1,5 @@
+module Whenever
+  module Elasticbeanstalk
+    VERSION = "1.0.3"
+  end
+end

data/whenever-elasticbeanstalk.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whenever-elasticbeanstalk/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "whenever-eb-shipoffers"
+  gem.version       = Whenever::Elasticbeanstalk::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Zachary Green"]
+  gem.email         = ["zach@shipoffers.com"]
+  gem.description   = %q{Use Whenever on AWS Elastic Beanstalk}
+  gem.summary       = %q{Allows you to run cron jobs easily on one or all AWS Elastic Beanstalk instances.}
+  gem.homepage      = "https://github.com/ShipOffers/whenever-elasticbeanstalk"
+  # gem.license       = 'MIT'
+
+  gem.add_dependency('whenever','~> 0.9.4')
+  gem.add_dependency('aws-sdk', '~> 2.2.12')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: whenever-eb-shipoffers
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Zachary Green
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: whenever
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.12
+description: Use Whenever on AWS Elastic Beanstalk
+email:
+- zach@shipoffers.com
+executables:
+- change_remove_cron_leader
+- create_ensure_one_cron_leader
+- setup_cron
+- wheneverize-eb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/change_remove_cron_leader
+- bin/create_ensure_one_cron_leader
+- bin/setup_cron
+- bin/wheneverize-eb
+- lib/whenever-elasticbeanstalk.rb
+- lib/whenever-elasticbeanstalk/version.rb
+- whenever-elasticbeanstalk.gemspec
+homepage: https://github.com/ShipOffers/whenever-elasticbeanstalk
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Allows you to run cron jobs easily on one or all AWS Elastic Beanstalk instances.
+test_files: []