awsadm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1c945a82af301d859b2e606b39443e56140faab44616d3c60eea69de9723f9d
+  data.tar.gz: ff6770b94e06fcd44be5bdd785c3ddcd903c130b25ddaa17acbb9d12780cb057
+SHA512:
+  metadata.gz: 536c6fa9a349f7fbefcad3943c7aeeea2b3f784ad91617c8880cb7bed09b4f1ba88263e1753361e71194f595f836b447289d3d426413939e7c4dbc44cbe4bccc
+  data.tar.gz: 13501ae9f0106aab6b628aaed767ffefb8dec84d061e54b983a1758b3545199199c0b9006afa7cc9d4a5706b7f12df7efb33469fb04b01040234151d034cb37f

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016–2017 Jimmy Thelander
+
+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,45 @@
+# awsadm
+
+A command-line tool to manage Amazon Web Services (AWS) Elastic Compute Cloud (EC2) spot instance requests, instances and images.
+
+*Note: This tools is highly experimental. Use at your own risk!*
+
+# Installation
+
+```
+$ gem install awsadm
+```
+
+# Environment variables
+
+* AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY: [Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) for using AWS
+* AWS_DEFAULT_REGION: Default AWS [region](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions)
+* AWSADM_SECURITY_GROUP: Name of [security group](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) to use
+
+# Usage
+
+```
+awsadm commands:
+  awsadm cancel REQUEST             # Cancel spot instance REQUEST
+  awsadm help [COMMAND]             # Describe available commands or one specific command
+  awsadm list OWNER                 # List available images by OWNER
+  awsadm price INSTANCE_TYPE        # Show price history for INSTANCE_TYPE
+  awsadm save INSTANCE              # Save an image from INSTANCE
+  awsadm start IMAGE INSTANCE_TYPE  # Start INSTANCE_TYPE from IMAGE
+  awsadm status                     # Return status on spot instance requests and instances
+  awsadm stop INSTANCE              # Stop INSTANCE
+
+Options:
+  v, [--verbose], [--no-verbose]
+```
+
+# To do
+
+* Tests, tests, tests
+* More and better environment variable and input checks
+* Sort image list by creation date
+* Implement support for other parts of the Amazon Web Services
+
+# License
+
+[MIT License](http://opensource.org/licenses/MIT)

data/Rakefile

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

data/awsadm.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awsadm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "awsadm"
+  spec.version       = Awsadm::VERSION
+  spec.authors       = ["Jimmy Thelander"]
+  spec.email         = ["jimmy.thelander@gmail.com"]
+  spec.summary       = %q{EXPERIMENTAL: Command-line tool for AWS resources.}
+  spec.description   = %q{Manage your AWS resources from the command-line.}
+  spec.homepage      = "https://github.com/thelander/awsadm"
+  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 "thor"
+  spec.add_dependency "aws-sdk"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

data/bin/awsadm

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby -U
+
+require "awsadm"
+
+begin
+  Awsadm::Cli.start(ARGV)
+rescue Interrupt
+  exit 1
+end

data/lib/awsadm/cli.rb

@@ -0,0 +1,361 @@
+module Awsadm
+  class Cli < Thor
+    include Awsadm::Helpers
+
+    package_name "awsadm"
+    class_option :verbose, type: :boolean, aliases: :v
+
+    def initialize(*args)
+      super
+
+      @config = {
+        security_name: ENV["AWSADM_SECURITY_GROUP"] || "awsadm",
+        security_desc: "Allow port 22 on TCP (ssh)"
+      }
+
+      if ENV["AWS_ACCESS_KEY_ID"].nil? or ENV["AWS_SECRET_ACCESS_KEY"].nil?
+        abort "ERROR: Amazon Web Services credentials not set"
+      end
+
+      if ENV["AWS_DEFAULT_REGION"].nil?
+        abort "ERROR: Amazon Web Services default region not set"
+      end
+
+      Aws.config.update({
+        credentials: Aws::Credentials.new(
+          ENV["AWS_ACCESS_KEY_ID"],
+          ENV["AWS_SECRET_ACCESS_KEY"]
+        ),
+        region: ENV["AWS_DEFAULT_REGION"]
+      })
+
+      @client = Aws::EC2::Client.new
+    end
+
+    desc "list OWNER", "List available images by OWNER"
+    def list owner=""
+      print "Finding images... " if options[:verbose]
+
+      if owner.empty?
+        images = @client.describe_images[0]
+      else
+        images = @client.describe_images({
+          owners: [owner]
+        })[0]
+      end
+
+      puts "#{images.count} image(s) found." if options[:verbose]
+
+      image_table_header = ["IMAGE", "NAME", "PLATFORM", "STATE", "CREATED"]
+      image_table_items  = []
+
+      images.each do |image|
+        image_table_items << [
+          image.image_id,
+          image.name.nil? ? "-" : truncate(image.name),
+          image.platform,
+          image.state,
+          empty?(image.creation_date) ? "-" : time_string_format(image.creation_date)
+        ]
+      end
+
+      if image_table_items.size > 0
+        puts_table image_table_header, image_table_items
+      end
+    end
+
+    desc "start IMAGE INSTANCE_TYPE", "Start INSTANCE_TYPE from IMAGE"
+    def start image_id, instance_type
+      print "Finding image... " if options[:verbose]
+
+      begin
+        image = @client.describe_images({
+          image_ids: [image_id]
+        })[0][0]
+      rescue Aws::EC2::Errors::InvalidAMIIDMalformed
+        abort "ERROR: Invalid image ID"
+      rescue Aws::EC2::Errors::InvalidAMIIDNotFound
+        abort "ERROR: Image not found"
+      end
+
+      puts "Found." if options[:verbose]
+
+      image_table_header = ["IMAGE", "NAME", "PLATFORM", "STATE", "CREATED"]
+      image_table_items  = []
+
+      image_table_items = [[
+        image.image_id,
+        image.name.nil? ? "-" : truncate(image.name),
+        image.platform,
+        image.state,
+        empty?(image.creation_date) ? "-" : time_string_format(image.creation_date)
+      ]]
+
+      if image_table_items.size > 0
+        puts_table image_table_header, image_table_items
+      end
+
+      puts
+      print "Finding security group \"#{@config[:security_name]}\"... " if options[:verbose]
+
+      begin
+        security_group = @client.describe_security_groups({
+          group_names: [@config[:security_name]]
+        })[0][0]
+      rescue Aws::EC2::Errors::InvalidGroupNotFound
+        puts "Not found." if options[:verbose]
+        print "Creating one with defaults... " if options[:verbose]
+
+        @client.create_security_group({
+          group_name: @config[:security_name],
+          description: @config[:security_desc]
+        })
+
+        default_security.each do |rule|
+          @client.authorize_security_group_ingress(rule.merge({
+            group_name: @config[:security_name]
+            }))
+        end
+
+        security_group = @client.describe_security_groups({
+          group_names: [@config[:security_name]]
+        })[0][0]
+      end
+
+      puts "Done." if options[:verbose]
+
+      rule_table_header = ["PROTOCOL", "PORT RANGE", "IP RANGES"]
+      rule_table_items  = []
+
+      security_group.ip_permissions.each do |p|
+        ip_ranges = []
+        p.ip_ranges.each do |ip|
+          ip_ranges << ip.cidr_ip
+        end
+
+        rule_table_items << [
+          p.ip_protocol,
+          "#{p.from_port} to #{p.to_port}",
+          "#{ip_ranges.join(", ")}"
+        ]
+      end
+
+      puts_table rule_table_header, rule_table_items, false
+      puts
+      print "Retrieving price history... " if options[:verbose]
+
+      if image.platform.nil? or image.platform.empty?
+        price_history = @client.describe_spot_price_history({
+          instance_types: [instance_type],
+          start_time: Time.now
+        })[0]
+      else
+        price_history = @client.describe_spot_price_history({
+          instance_types: [instance_type],
+          start_time: Time.now,
+          product_descriptions: [image.platform.capitalize]
+        })[0]
+      end
+
+      puts "Retrieved." if options[:verbose]
+
+      price_table_header = ["ZONE", "INSTANCE TYPE", "PLATFORM", "PRICE"]
+      price_table_items  = []
+      prices = []
+
+      price_history.each do |p|
+        price = p.spot_price.to_f.round(3)
+        prices << price
+        price_table_items << [
+          p.availability_zone,
+          instance_type,
+          p.product_description.downcase,
+          price
+        ]
+      end
+
+      puts_table price_table_header, price_table_items
+      puts
+
+      suggested_bid = bid_formula prices
+      bid = ask "How much are you willing to bid for the instance (#{suggested_bid} usd/hour)?"
+      bid = suggested_bid if bid.nil? or bid.empty?
+      exit unless valid_float? bid
+      bid.to_f.round(3)
+
+      print "Creating instance request... " if options[:verbose]
+
+      request = @client.request_spot_instances({
+        spot_price: bid.to_s,
+        launch_specification: {
+          image_id: image_id,
+          security_groups: [@config[:security_name]],
+          instance_type: instance_type
+        }
+      })
+
+      puts "Created." if options[:verbose]
+      puts "Run \"awsadm status\" to see status." if options[:verbose]
+    end
+
+    desc "status", "Return status on spot instance requests and instances"
+    def status
+      requests = @client.describe_spot_instance_requests()[0]
+
+      request_table_header = ["REQUEST", "INSTANCE", "STATE", "PRICE", "AGE"]
+      request_table_items  = []
+
+      requests.each do |r|
+        request_table_items << [
+          r.spot_instance_request_id,
+          r.instance_id.nil? ? "-" : r.instance_id,
+          r.status.code,
+          r.spot_price.to_f.round(3).to_s,
+          r.create_time.nil? ? "-" : "#{minutes_since(r.create_time)}m"
+        ]
+      end
+
+      if request_table_items.size > 0
+        puts_table request_table_header, request_table_items
+      end
+
+      instances = @client.describe_instances()[0]
+
+      instance_table_header = [
+        "INSTANCE", "IMAGE", "STATE", "IP", "ZONE", "AGE"
+      ]
+      instance_table_items  = []
+
+      instances.each do |i|
+        i = i.instances.first
+        ni = i.network_interfaces.first
+
+        instance_table_items << [
+          i.instance_id,
+          i.image_id,
+          i.state.name,
+          i.state.name == "running" ? ni.association.public_ip : "-",
+          i.placement.availability_zone,
+          i.state.name == "running" ? "#{minutes_since(i.launch_time)}m" : "-"
+        ]
+      end
+
+      if instance_table_items.size > 0
+        puts
+        puts_table instance_table_header, instance_table_items
+      end
+    end
+
+    desc "stop INSTANCE", "Stop INSTANCE"
+    def stop instance_id
+      if instance_id == "all"
+        instances = @client.describe_instances()[0]
+      else
+        begin
+          instances = @client.describe_instances({
+            instance_ids: [instance_id]
+          })[0]
+        rescue Aws::EC2::Errors::InvalidInstanceIDMalformed
+          abort "ERROR: Invalid instance ID"
+        rescue Aws::EC2::Errors::InvalidInstanceIDNotFound
+          abort "ERROR: Instance not found"
+        end
+      end
+
+      instance_ids = []
+      instances.each do |i|
+        i = i.instances.first
+        instance_ids << i.instance_id
+      end
+
+      @client.terminate_instances({
+        instance_ids: instance_ids
+      })
+
+      print "Instance(s) have been stopped. " if options[:verbose]
+      puts "Run \"awsadm status\" to see status." if options[:verbose]
+    end
+
+    desc "cancel REQUEST", "Cancel spot instance REQUEST"
+    def cancel request_id
+      if request_id == "all"
+        requests = @client.describe_spot_instance_requests()[0]
+      else
+        begin
+          requests = @client.describe_spot_instance_requests({
+            spot_instance_request_ids: [request_id]
+          })[0]
+        rescue Aws::EC2::Errors::InvalidSpotInstanceRequestIDMalformed
+          abort "ERROR: Invalid request ID"
+        rescue Aws::EC2::Errors::InvalidSpotInstanceRequestIDNotFound
+          abort "ERROR: Request not found"
+        end
+      end
+
+      request_ids = []
+
+      requests.each do |r|
+        request_ids << r.spot_instance_request_id
+      end
+
+      if request_ids.size > 0
+        @client.cancel_spot_instance_requests({
+          spot_instance_request_ids: request_ids
+        })
+      end
+
+      print "Instance request(s) cancelled. " if options[:verbose]
+      puts "Run \"awsadm status\" to see status." if options[:verbose]
+    end
+
+    desc "save INSTANCE", "Save an image from INSTANCE"
+    def save instance_id
+      begin
+        instance = @client.describe_instances({
+          instance_ids: [instance_id]
+        })[0][0]
+      rescue Aws::EC2::Errors::InvalidInstanceIDMalformed
+        abort "ERROR: Invalid instance ID"
+      rescue Aws::EC2::Errors::InvalidInstanceIDNotFound
+        abort "ERROR: Instance not found"
+      end
+
+      image = @client.create_image({
+        instance_id: instance_id,
+        name: "awsadm-#{instance_id}-#{Time.now.strftime('%Y%m%d-%H%M%S%L')}"
+      })
+
+      print "Instance saved. " if options[:verbose]
+      puts "Run \"awsadm list\" to see images." if options[:verbose]
+    end
+
+    desc "price INSTANCE_TYPE", "Show price history for INSTANCE_TYPE"
+    def price instance_type
+      print "Retrieving price history... " if options[:verbose]
+
+      price_history = @client.describe_spot_price_history({
+        instance_types: [instance_type],
+        start_time: Time.now
+      })[0]
+
+      puts "Retrieved." if options[:verbose]
+
+      price_table_header = ["ZONE", "INSTANCE TYPE", "PLATFORM", "PRICE"]
+      price_table_items  = []
+      prices = []
+
+      price_history.each do |p|
+        price = p.spot_price.to_f.round(3)
+        prices << price
+        price_table_items << [
+          p.availability_zone,
+          p.instance_type,
+          p.product_description.downcase,
+          price
+        ]
+      end
+
+      puts_table price_table_header, price_table_items
+    end
+  end
+end

data/lib/awsadm/helpers.rb

@@ -0,0 +1,49 @@
+module Awsadm::Helpers
+  def bid_formula x
+    y = 0.02
+    (x.max + y).round(3)
+  end
+
+  def minutes_since time
+    (time - Time.now).to_i.abs / 60
+  end
+
+  def time_format time
+    time.strftime("%Y-%m-%d")
+  end
+
+  def time_string_format time
+    time_format(Time.parse(time))
+  end
+
+  def truncate string, max=24
+    string.length > max ? "#{string[0..max]}..." : string
+  end
+
+  def valid_float? string
+    !!Float(string) rescue false
+  end
+
+  def puts_table header, items, sort=true
+    full_table = []
+    full_table = items
+    full_table.sort! if sort
+    full_table.unshift header
+    print_table full_table, colwidth: 14
+  end
+
+  def empty? string
+    (string.nil? or string.empty?)
+  end
+
+  def default_security
+    [
+      {
+        ip_protocol: "tcp",
+        cidr_ip:     "0.0.0.0/0",
+        from_port:   22,
+        to_port:     22
+      }
+    ]
+  end
+end

data/lib/awsadm/version.rb

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

data/lib/awsadm.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "thor"
+require "aws-sdk"
+
+module Awsadm
+  autoload :Cli,     "awsadm/cli"
+  autoload :Helpers, "awsadm/helpers"
+  autoload :Version, "awsadm/version"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: awsadm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmy Thelander
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Manage your AWS resources from the command-line.
+email:
+- jimmy.thelander@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- awsadm.gemspec
+- bin/awsadm
+- lib/awsadm.rb
+- lib/awsadm/cli.rb
+- lib/awsadm/helpers.rb
+- lib/awsadm/version.rb
+homepage: https://github.com/thelander/awsadm
+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.3
+signing_key: 
+specification_version: 4
+summary: 'EXPERIMENTAL: Command-line tool for AWS resources.'
+test_files: []