knife-sce 0.2.0

data/.gitignore

@@ -0,0 +1,32 @@
+.rake_tasks~
+tags
+coverage
+rdoc
+pkg
+test/tmp
+test/version_tmp
+tmp
+pkg
+*.gem
+*.rbc
+lib/bundler/man
+spec/reports
+.config
+InstalledFiles
+.bundle
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.DS_Store
+Icon?
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'rspec', '~> 2.7.0'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                              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.rdoc

@@ -0,0 +1,130 @@
+= Knife IBM SCE Extensions
+
+= Description:
+
+IBM SCE tools for Chef's knife.
+
+= Installation:
+
+Be sure you are running the latest version Chef. Versions earlier than 0.10.0 don't support plugins:
+
+    gem install chef
+
+This plugin is distributed as a Ruby Gem. To install it, run:
+
+    gem install knife-sce
+
+Depending on your system's configuration, you may need to run this command with root privileges.
+
+= Configuration:
+
+In order to communicate with the IBM's SCE API you will have to tell Knife about your IBM username and password.  The easiest way to accomplish this is to create some entries in your <tt>knife.rb</tt> file:
+
+    knife[:ibm_username] = "Your IBM username"
+    knife[:ibm_password] = "Your IBM password"
+
+If your knife.rb file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables:
+
+    export IBM_USERNAME=<your IBM SCE username>
+    export IBM_PASSWORD=<your IBM SCE password>
+    
+    knife[:ibm_username] = "#{ENV['IBM_USERNAME']}"
+    knife[:ibm_password] = "#{ENV['IBM_PASSWORD']}"
+
+= Supported knife.rb configuration options
+
+    knife[:ibm_username] = <your IBM SCE username>
+    knife[:ibm_password] = <your IBM SCE password>
+    knife[:sce_image] = <SCE image ID>
+    knife[:sce_flavor] = <SCE flavor>
+    knife[:sce_location_id] = <SCE location>
+    knife[:sce_ssh_user] = <SCE user>
+    knife[:sce_max_timeout] = <SCE timeout> # use high value, SCE 2.2 requires long timeouts, 6000 should be enough
+
+= Subcommands:
+
+== knife sce server create (options)
+
+Provisions a new server in the IBM SCE and then performs a Chef bootstrap (using the SSH protocol).  The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server.  By default the server is bootstrapped using the {ubuntu10.04-gems}[https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/bootstrap/ubuntu10.04-gems.erb] template.  This can be overridden using the <tt>-d</tt> or <tt>--template-file</tt> command options.
+
+== knife sce server delete SERVER [SERVER] (options)
+
+Deletes an existing server in the currently configured SCE account.  <b>PLEASE NOTE</b> - By default, this does not delete the associated node and client objects from the Chef server.  To do so, add the <tt>--purge</tt> flag.
+
+== knife sce server list (options)
+
+Outputs a list of all servers in the currently configured SCE account.  <b>PLEASE NOTE</b> - this shows all instances associated with the account, some of which may not be currently managed by the Chef server.
+
+== knife sce instance data (options)
+
+Generates instance metadata in meant to be used with Opscode's custom SCE image. This will read your knife configuration <tt>~/.chef/knife.rb</tt> for the validation certificate and Chef server URL to use and output in JSON format. The subcommand also accepts a list of roles/recipes that will be in the node's initial run list.
+
+== knife sce key create KEYNAME
+
+Create a key pair of a given name. The response will contain private key which you will have to save somewhere if you would like to use it later on.
+
+== knife sce key delete KEYNAME
+
+Delete a key pair of a given name.
+
+== knife sce key get KEYNAME
+
+Get all the details of a given key.
+
+== knife sce key list
+
+List all key pairs created by the current SCE account.
+
+== knife sce location list (options)
+
+List available locations (data centers).
+
+== knife sce image describe IMAGE_ID [IMAGE_ID]
+
+Outputs all known information about the image.  Use this command to learn what flavors are available for a given image.
+
+== knife sce storage offerings (options)
+
+Lists available storage offerings for current SCE account.
+
+== knife sce volume attach INSTANCE_ID VOLUME [VOLUME]
+
+Attach single or multiple volumes to an instance.  Volumes are not automatically mounted.
+
+== knife sce volume create (options)
+
+Issue a volume creation request.  To learn what is the offer id and supported size, use <tt>knife sce storage offerings</tt>.
+
+== knife sce volume delete VOLUME [VOLUME]
+
+Delete single or multiple volumes.  Volumes must be <tt>Detached</tt> before the delete request is issued.
+
+== knife sce volume detach INSTANCE_ID VOLUME [VOLUME]
+
+Detach single or multiple volumes.
+
+== knife sce volume list (options)
+
+List SCE volumes.
+
+== knife sce vlan list
+
+List SCE VLANs
+
+= License:
+
+Author:: Rad Gruchalski (<radek@gruchalski.com>)
+License:: Apache License, Version 2.0
+
+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/knife-sce.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "knife-sce/version"
+
+Gem::Specification.new do |s|
+  s.name        = "knife-sce"
+  s.version     = Knife::SCE::VERSION
+  s.has_rdoc = true
+  s.authors     = ["Rad Gruchalski"]
+  s.email       = ["radek@gruchalski.com"]
+  s.summary = "IBM SCE tools for Chef's knife"
+  s.description = s.summary
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE" ]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.add_dependency "fog", "~> 1.14.0"
+  s.add_dependency "chef", ">= 0.10.10"
+  %w(rspec-core rspec-expectations rspec-mocks  rspec_junit_formatter).each { |gem| s.add_development_dependency gem }
+  s.require_paths = ["lib"]
+end

data/lib/chef/knife/sce_address_create.rb

@@ -0,0 +1,77 @@
+#
+# Author:: Rad Gruchalski (<radek@gruchalski.com>)
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife/sce_base'
+
+class Chef
+  class Knife
+    class SceAddressCreate < Knife
+
+      include Knife::SceBase
+
+      banner "knife sce address create LOCATION"
+      
+      def run
+        
+        $stdout.sync = true
+
+        validate!
+        
+        location = nil
+        begin
+          location = connection.locations.get(@name_args[0])
+        rescue
+          ui.error "Location #{@name_args[0]} is not a valid location ID."
+          exit 1
+        end
+        
+        if location.nil?
+          ui.error "Location #{@name_args[0]} is not a valid location ID."
+          exit 1
+        end
+        
+        offering_id = nil
+        address_offerings = connection.list_address_offerings[:body]["addresses"]
+        address_offerings.each do |offer|
+          if offer["location"] == location.id
+            offering_id = offer["id"]
+          end
+        end
+        
+        if offering_id.nil?
+          ui.error "Could not fetch offer ID for location #{location.name}"
+          exit 1
+        end
+        
+        puts "Creating an IP address at #{location.name} for offer ID #{offering_id}"
+        
+        response = connection.create_address(@name_args[0], offering_id)
+        if response.is_a?(Excon::Response)
+          puts "\n"
+          puts "New IP address allocated, IP value will be available for you shortly."
+          puts "Please use 'knife sce address list' and check the 'State' of allocation '#{response[:body]["id"]}'."
+          puts "Your IP is available for use when it is in state 'Free'."
+          puts "\n"
+        else
+          ui.error response[:body].to_s
+          exit 1
+        end
+        
+      end
+    end
+  end
+end

data/lib/chef/knife/sce_address_delete.rb

@@ -0,0 +1,51 @@
+#
+# Author:: Rad Gruchalski (<radek@gruchalski.com>)
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife/sce_base'
+
+class Chef
+  class Knife
+    class SceAddressDelete < Knife
+
+      include Knife::SceBase
+
+      banner "knife sce address delete ADDRESS [ADDRESS]"
+      
+      def run
+        
+        $stdout.sync = true
+
+        validate!
+        
+        @name_args.each do |given_ip|
+          connection.addresses.all.each do |address|
+            if address.ip == given_ip
+              ui.confirm "Are you sure you want to delete IP address #{given_ip}"
+              begin
+                address.destroy
+              rescue
+                # ignore errors
+              end
+              puts "Address #{given_ip} deleted."
+            end
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/chef/knife/sce_address_list.rb

@@ -0,0 +1,71 @@
+#
+# Author:: Rad Gruchalski (<radek@gruchalski.com>)
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife/sce_base'
+
+class Chef
+  class Knife
+    class SceAddressList < Knife
+
+      include Knife::SceBase
+
+      banner "knife sce address list"
+      
+      def run!
+        connection.addresses.all
+      end
+      
+      def run
+        $stdout.sync = true
+
+        validate!
+        
+        address_list = [
+          ui.color('Address ID', :bold),
+          ui.color("Location", :bold),
+          ui.color("IP", :bold),
+          ui.color('State', :bold),
+          ui.color('Instance ID', :bold),
+          ui.color('Offering ID', :bold),
+          ui.color('VLAN ID', :bold),
+          ui.color('Hostname', :bold),
+          ui.color('Owner', :bold)
+          
+        ].flatten.compact
+        
+        output_column_count = address_list.length
+        
+        addresses = run!
+        
+        addresses.each do |address|
+          address_list << address.id.to_s
+          address_list << connection.locations.get(address.location).name.to_s
+          address_list << address.ip.to_s
+          address_list << address.state.to_s
+          address_list << address.instance_id.to_s
+          address_list << address.offering_id.to_s
+          address_list << address.vlan_id.to_s
+          address_list << address.hostname.to_s
+          address_list << address.owner.to_s
+        end
+        
+        puts ui.list(address_list, :uneven_columns_across, output_column_count)
+
+      end
+    end
+  end
+end

data/lib/chef/knife/sce_address_offerings.rb

@@ -0,0 +1,68 @@
+#
+# Author:: Rad Gruchalski (<radek@gruchalski.com>)
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife/sce_base'
+
+class Chef
+  class Knife
+    class SceAddressOfferings < Knife
+
+      include Knife::SceBase
+
+      banner "knife sce address offerings (options)"
+      
+      option :datacenter,
+        :short => "-Z LOCATION_ID",
+        :long => "--data-center LOCATION_ID",
+        :description => "Data center location ID, use knife sce location list to learn more about possible locations."
+      
+      def run
+        
+        $stdout.sync = true
+
+        validate!
+        
+        offer_list = [
+          ui.color('Offering ID', :bold),
+          ui.color("Location", :bold),
+          ui.color('Price', :bold)
+        ].flatten.compact
+        
+        output_column_count = offer_list.length
+        
+        address_offerings = connection.list_address_offerings[:body]["addresses"]
+        
+        address_offerings.each do |offer|
+          
+          did = datacenter_id
+          if did.nil? or did.eql?( offer["location"] )
+          
+            offer_list << offer["id"].to_s
+            offer_list << connection.locations.get(offer["location"]).name
+            offer_list << "#{offer['price']['rate']}#{offer['price']['currencyCode']}/#{offer['price']['pricePerQuantity']}#{offer['price']['unitOfMeasure']}"
+          
+          end
+          
+        end
+        
+        puts "\n"
+        puts ui.list(offer_list, :uneven_columns_across, output_column_count)
+        
+      end
+    end
+  end
+end