consolr 1.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# look at the .gemspec file for deps
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,103 @@
+```
+
+ ▄████████  ▄██████▄  ███▄▄▄▄      ▄████████  ▄██████▄   ▄█          ▄████████ 
+███    ███ ███    ███ ███▀▀▀██▄   ███    ███ ███    ███ ███         ███    ███ 
+███    █▀  ███    ███ ███   ███   ███    █▀  ███    ███ ███         ███    ███ 
+███        ███    ███ ███   ███   ███        ███    ███ ███        ▄███▄▄▄▄██▀ 
+███        ███    ███ ███   ███ ▀███████████ ███    ███ ███       ▀▀███▀▀▀▀▀   
+███    █▄  ███    ███ ███   ███          ███ ███    ███ ███       ▀███████████ 
+███    ███ ███    ███ ███   ███    ▄█    ███ ███    ███ ███▌    ▄   ███    ███ 
+████████▀   ▀██████▀   ▀█   █▀   ▄████████▀   ▀██████▀  █████▄▄██   ███    ███ 
+                                                        ▀           ███    ███ 
+                                                        
+```
+
+Consolr is a utility to communicate with Collins assets through ipmitool. Doing a
+collins lookup, it retrieves the attributes necessary to invoke an ipmitool
+command to the asset.
+ 
+Consolr supports a subset of commonly used ipmitool actions making the life of 
+system administrators a little easier.
+
+## Setup 
+
+**Consolr is only useful when you have [collins setup](http://tumblr.github.io/collins/) and a hosts fleet managed by collins with IPMI information populated for each host.**
+
+- Make sure you have ipmitool installed.
+
+Ubuntu
+
+```
+# apt-get install openipmi
+```
+
+Redhat Flavors
+
+```
+# yum install ipmitool
+```
+
+- Install the Consolr gem
+
+```
+# gem install consolr
+```
+
+- Setting up a configuration file
+
+Configuration file is where consolr looks for the location of ipmitool.
+If you have assets where you don't want users changing things, just add the 
+asset in the dangerous assets list. Consolr will safeguard it.
+
+Consolr authenticates with Collins through [collins-auth](https://github.com/tumblr/collins/tree/master/support/ruby/collins-auth). So 
+one would want collins.yml file to be set up as well.
+
+Configuration params are searched in these locations -- 
+
+-- ENV['CONSOLR_CONFIG']
+-- $HOME/.consolr.yml
+-- /etc/consolr.yml
+-- /var/db/consolr.yml
+
+An example consolr.yml file
+
+```    
+ipmitool:  /usr/bin/ipmitool
+dangerous_assets:
+  - "007117"
+dangerous_status:
+  - "Allocated"
+```
+
+## Running the tool
+
+```
+$ consolr -a 006123 -c
+```
+
+For a full list of actions, look up the help page
+
+```
+$ consolr --help
+```
+
+## Mailing list
+http://groups.google.com/group/collins-sm
+
+## Bugs
+
+Please report any bugs or submit a request for a patch here : <https://github.com/tumblr/collins/issues/>
+
+## License
+Copyright 2015 Tumblr Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

data/bin/consolr

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'consolr'
+
+console = Consolr::Console.new
+console.start

data/consolr.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'consolr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "consolr"
+  spec.version       = Consolr::VERSION
+  spec.authors       = ["Will Richard", "Sashidhar Guntury"]
+  spec.email         = ["will@tumblr.com", "sashi@tumblr.com", "collins-sm@googlegroups.com"]
+  spec.summary       = %q{consolr is a pure ruby wrapper over IPMI to allow Out of Band communiation with nodes.}
+  spec.description   = %q{Consolr is a utility which speaks to Collins on our behalf and retrieves the address, username and password to connect to that node over IPMI. Passing different flags, we can performs a variety of taks on the node over IPMI. There are safeguards in place to prevent potentially catastrophic actions being performed on nodes.}
+  spec.homepage      = "https://github.com/tumblr/collins/tree/master/support/ruby/consolr"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "collins_auth", "~> 0.1.2"
+end

data/lib/consolr/version.rb

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

data/lib/consolr.rb

@@ -0,0 +1,188 @@
+require 'collins_auth'
+require 'optparse'
+require 'yaml'
+
+module Consolr
+  class Console
+
+    attr_reader :ipmitool_exec, :dangerous_assets, :dangerous_status, :dangerous_actions, :options, :opt_parser
+
+    def initialize
+      config_file = [ENV['CONSOLR_CONFIG'],
+                      '~/.consolr.yml', '~/.consolr.yaml',
+                      '/etc/consolr.yml', '/etc/consolr.yaml',
+                      '/var/db/consolr.yml', '/var/db/consolr.yaml'].compact.find do |config_file|
+        File.readable? config_file and File.size(config_file) > 0
+      end
+
+      config_params = begin
+        YAML.load(File.open(config_file))
+      rescue TypeError => e
+        puts "-------"
+        puts "Failed to load Configuration File ... "
+        puts "Looks like a configuration file doesn't exist."
+        puts "Please look at README.md on creating a configuration file"
+        puts "-------"
+        exit 1
+      rescue ArgumentError => e
+        puts "------"
+        puts "Failed to load Configuration File ... "
+        puts "Looks like the configuration file is not correctly formatted"
+        puts "Please check if your file conforms to YAML spec"
+        puts "------"
+        exit 1
+      end
+      
+      begin
+        @ipmitool_exec = config_params['ipmitool'] # ipmitool absolute path
+      rescue Exception => e
+        puts e
+        puts "-------"
+        puts "Ensure that the ipmitool's path (#{@ipmitool_exec}) is given in the consolr.yml file and is correct"
+        puts "-------"
+        exit 1
+      end
+      
+      # Will be ignored for dangerous actions, no matter what, even with --force
+      begin
+        @dangerous_assets = config_params['dangerous_assets']
+      rescue Exception => e
+        puts e
+        puts "-------"
+        puts "Dangerous Assets -- #{dangrous}"
+        puts "Please make sure dangerous_assets exists and is valid."
+        puts "Supply them in a comma separated list."
+        puts "-------"
+        exit 1
+      end
+
+      # Dangerous actions wont be run in these status, override with --force
+      begin
+        @dangerous_status = config_params['dangerous_status']
+      rescue Exception => e
+        puts e
+        puts "-------"
+        puts "Dangerous Status -- #{@dangeous_status}"
+        puts "Please specify the statuses which are dangerorous, during which dangerous shouldn't be run."
+        puts "-------"
+        exit 1
+      end
+
+      @dangerous_actions = [:off, :reboot] # Must match the symbol in options{}
+
+      @options = {}
+      @opt_parser = OptionParser.new do |opt|
+        opt.banner = "Usage: consolr [OPTIONS]"
+        opt.separator  ""
+        opt.separator  "Options"
+        
+        opt.on("-c","--console","console into node via SOL") { options[:console] = true }
+        opt.on("-d","--dangerous","list dangerous stuff") { options[:dangerous] = true }
+        opt.on("-f","--force","force run dangerous actions") { options[:force] = true }
+        opt.on("-h","--help","help") { exit 0 }
+        opt.on("-H","--hostname ASSET","asset hostname") { |hostname| options[:hostname] = hostname }
+        opt.on("-i","--identify","turn on chassis UID") { options[:identify] = true }
+        opt.on("-k","--kick","kick if someone is hogging the console") { options[:kick] = true }
+        opt.on("-l","--log LOG","System Event Log (SEL) [list|clear]") { |log| options[:log] = log }
+        opt.on("-o","--on","turn on node") { options[:on] = true }
+        opt.on("-r","--reboot","restart node") { options[:reboot] = true }
+        opt.on("-s","--sdr","Sensor Data Repository (SDR)") { options[:sdr] = true }
+        opt.on("-t","--tag ASSET","asset tag") { |tag| options[:tag] = tag }
+        opt.on("-x","--off","turn off node") { options[:off] = true }
+        
+      end
+    end
+    
+    def ipmitool_cmd action
+      system("#{@ipmitool_exec} -I lanplus -H #{@node.ipmi.address} -U #{@node.ipmi.username} -P #{@node.ipmi.password} #{action}")
+      return $?.exitstatus == 0 ? "SUCCESS" : "FAILED"
+    end
+
+    def start
+      @opt_parser.parse! # extract from ARGV[]
+      abort("Please pass either the asset tag or hostname" if options[:tag].nil? and options[:hostname].nil?
+      
+      abort("Cannot find #{@ipmitool_exec}") unless File.exist?(@ipmitool_exec)
+
+      dangerous_body = "Dangerous actions: #{dangerous_actions.join(', ')}\n"\
+        "Dangerous status: #{dangerous_status.join(', ')} (override with --force)\n"\
+        "Dangerous assets: #{dangerous_assets.join(', ')} (ignored no matter what, even with --force)"
+      
+      if options[:dangerous]
+        puts dangerous_body
+        exit 1
+      end
+      
+      begin
+        collins = Collins::Authenticator.setup_client
+      rescue Exception => e
+        puts e
+        puts "-------"
+        puts "There was a problem setting up a connection with Collins."
+        puts "-------"
+        exit 1
+      end
+      
+      if options[:tag] and options[:hostname]
+        abort("Please pass either the hostname OR the tag but not both.")
+      end
+     
+      # match assets like vm-67f5eh, zt-*, etc.
+      nodes = options[:tag] ? (collins.find :tag => options[:tag]) : (collins.find :hostname => options[:hostname])
+      @node = nodes.length == 1 ? nodes.first : abort("Found #{nodes.length} assets, aborting.")
+      
+      %x(/bin/ping -c 1 #{@node.ipmi.address})
+      abort("Cannot ping IP #{@node.ipmi.address} (#{@node.tag})") unless $?.exitstatus == 0
+      
+      if dangerous_assets.include?(@node.tag) and dangerous_actions.any?
+        puts "Asset #{@node.tag} is a crucial asset. Can't execute dangerous actions on this asset."
+      end
+      
+      if options[:force].nil? and dangerous_actions.any? and dangerous_status.include?(@node.status)
+        puts "Cannot run dangerous commands on #{@node.hostname} (#{@node.tag} - #{@node.status})"
+        abort dangerous_body
+      end
+      
+      case
+      when options[:console]
+        puts "--> Opening SOL session (type ~~. to quit)"
+        puts self.ipmitool_cmd("sol activate")
+      
+      when options[:kick]
+        puts self.ipmitool_cmd("sol deactivate")
+      
+      when options[:identify]
+        puts self.ipmitool_cmd("chassis identify")
+      
+      when options[:sdr]
+        puts self.ipmitool_cmd("sdr elist all")
+      
+      when options[:log] == "list"
+        puts self.ipmitool_cmd("sel list")
+      
+      when options[:log] == "clear"
+        puts self.ipmitool_cmd("sel clear")
+      
+      when options[:on]
+        puts self.ipmitool_cmd("power on")
+      
+      when options[:off]
+        puts self.ipmitool_cmd("power off")
+      
+      when options[:reboot]
+        puts self.ipmitool_cmd("power cycle")
+      
+      else
+        begin
+          raise OptionParser::MissingArgument, "specify an action"
+        rescue OptionParser::MissingArgument => e
+          puts e
+          puts @opt_parser
+          exit 0
+        end
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: consolr
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Will Richard
+- Sashidhar Guntury
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2015-07-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: collins_auth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :runtime
+  version_requirements: *id001
+description: Consolr is a utility which speaks to Collins on our behalf and retrieves the address, username and password to connect to that node over IPMI. Passing different flags, we can performs a variety of taks on the node over IPMI. There are safeguards in place to prevent potentially catastrophic actions being performed on nodes.
+email: 
+- will@tumblr.com
+- sashi@tumblr.com
+- collins-sm@googlegroups.com
+executables: 
+- consolr
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- LICENSE
+- README.md
+- bin/consolr
+- consolr.gemspec
+- lib/consolr.rb
+- lib/consolr/version.rb
+has_rdoc: true
+homepage: https://github.com/tumblr/collins/tree/master/support/ruby/consolr
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: consolr is a pure ruby wrapper over IPMI to allow Out of Band communiation with nodes.
+test_files: []
+