knife-softlayer 0.4.0 → 0.4.1

data/examples/server.md

@@ -1,81 +1,82 @@
-### Server Examples
-
-These examples all assume you have set your SoftLayer username and api key in `~/.chef/knife.rb` like this:
-
-```ruby
-knife[:softlayer_username] = 'example_user'
-knife[:softlayer_api_key]  = '1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a'
-```
-  
-#### Create server and bootstrap as a chef node
-
-Create a server using an image, a flavor, assign an existing global ip address, and inject two ssh keys.
-
-```sh
-user@localhost> knife softlayer server create --image-id 23f7f05f-3657-4330-8772-329ed2e816bc --assign-global-ip 108.168.254.41 --ssh-keys 12345 23456 --hostname web --domain ibm.com --flavor m1.tiny --run-list 'recipe[redis],recipe[rbenv],recipe[apt]' -i /Users/user/.ssh/my_private_key_rsa  
-```
-
-Create a server, provision a new global ip address and assign it to the server, tag both the chef node and the SoftLayer server with the passed tags. 
-
-```sh
-user@localhost> knife softlayer server create --new-global-ip v4 --tags job=task,private=true --hostname web --domain ibm.com --flavor m1.tiny --run-list 'recipe[redis],recipe[rbenv],recipe[apt]' --ssh-keys 12345 -i /Users/user/.ssh/my_private_key_rsa
-```
-
-Create a server located in specific public and private VLANS.
-
-```sh
-user@localhost> knife softlayer server create --vlan 12345 --private-vlan 23456 --hostname web --domain ibm.com --flavor m1.tiny --run-list 'recipe[redis],recipe[rbenv],recipe[apt]' --ssh-keys 12345 -i /Users/user/.ssh/my_private_key_rsa --new-global-ip v4 --tags job=task,private=true
-```
-
-Create a server specifying options from a JSON file.
-
-```sh
-user@localhost> cat /Users/user/bootstrap.json
-{
-  "hostname": "web",
-  "domain": "ibm.com",
-  "flavor": "m1.xlarge",
-  "run-list": "recipe[redis],recipe[rbenv],recipe[apt]",
-  "ssh-keys": "73148",
-  "identity-file": "/Users/user/.ssh/my_softlayer_key_rsa",
-  "image-id": "23f7f05f-3657-4330-8772-329ed2e816bc"
-}
-
-user@localhost> knife softlayer server create --from-file /Users/user/bootstrap.json
-
-# options file + additional arguments
-user@localhost> knife softlayer server create --from-file /Users/user/bootstrap.json --tags job=task,private=true
-```
-
-Other options.
-
-```sh
-user@localhost> knife softlayer server create --help
-# There are a lot...
-```
-
-#### Destroy a server and its chef node and client
-
-Use the node name as an identifier.
-
-```sh
-user@localhost> knife softlayer server destroy --node-name some-node-name
-Decommissioning SoftLayer VM, this may take a few minutes.
-WARNING: Deleted node some-node-name
-Chef node successfully deleted.
-WARNING: Deleted client some-node-name
-Chef client successfully deleted.
-SoftLayer VM successfully deleted. You are no longer being billed for this instance.
-```
-
-Use the public ip address as an identifier 
-
-```sh
-user@localhost> knife softlayer server destroy --ip-address 33.33.33.33
-Decommissioning SoftLayer VM, this may take a few minutes.
-WARNING: Deleted node 5849421
-Chef node successfully deleted.
-WARNING: Deleted client 5849421
-Chef client successfully deleted.
-SoftLayer VM successfully deleted. You are no longer being billed for this instance.
-```
+### Server Examples
+
+These examples all assume you have set your SoftLayer username and api key in `~/.chef/knife.rb` like this:
+
+```ruby
+knife[:softlayer_username] = 'example_user'
+knife[:softlayer_api_key]  = '1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a'
+```
+  
+#### Create server and bootstrap as a chef node
+
+Create a server using an image, a flavor, assign an existing global ip address, and inject two ssh keys.
+
+```sh
+user@localhost> knife softlayer server create --image-id 23f7f05f-3657-4330-8772-329ed2e816bc --assign-global-ip 108.168.254.41 --ssh-keys 12345 23456 --hostname web --domain ibm.com --flavor m1.tiny --run-list 'recipe[redis],recipe[rbenv],recipe[apt]' -i /Users/user/.ssh/my_private_key_rsa  
+```
+
+Create a server, provision a new global ip address and assign it to the server, tag both the chef node and the SoftLayer server with the passed tags. 
+
+```sh
+user@localhost> knife softlayer server create --new-global-ip v4 --tags job=task,private=true --hostname web --domain ibm.com --flavor m1.tiny --run-list 'recipe[redis],recipe[rbenv],recipe[apt]' --ssh-keys 12345 -i /Users/user/.ssh/my_private_key_rsa
+```
+
+Create a server located in specific public and private VLANS.
+
+```sh
+user@localhost> knife softlayer server create --vlan 12345 --private-vlan 23456 --hostname web --domain ibm.com --flavor m1.tiny --run-list 'recipe[redis],recipe[rbenv],recipe[apt]' --ssh-keys 12345 -i /Users/user/.ssh/my_private_key_rsa --new-global-ip v4 --tags job=task,private=true
+```
+
+Create a server specifying options from a JSON file.
+
+```sh
+user@localhost> cat /Users/user/bootstrap.json
+{
+  "hostname": "web",
+  "domain": "ibm.com",
+  "flavor": "m1.xlarge",
+  "run-list": "recipe[redis],recipe[rbenv],recipe[apt]",
+  "ssh-keys": "73148",
+  "identity-file": "/Users/user/.ssh/my_softlayer_key_rsa",
+  "image-id": "23f7f05f-3657-4330-8772-329ed2e816bc",
+  "user_data": "first_boot=disabled"
+}
+
+user@localhost> knife softlayer server create --from-file /Users/user/bootstrap.json
+
+# options file + additional arguments
+user@localhost> knife softlayer server create --from-file /Users/user/bootstrap.json --tags job=task,private=true
+```
+
+Other options.
+
+```sh
+user@localhost> knife softlayer server create --help
+# There are a lot...
+```
+
+#### Destroy a server and its chef node and client
+
+Use the node name as an identifier.
+
+```sh
+user@localhost> knife softlayer server destroy --node-name some-node-name
+Decommissioning SoftLayer VM, this may take a few minutes.
+WARNING: Deleted node some-node-name
+Chef node successfully deleted.
+WARNING: Deleted client some-node-name
+Chef client successfully deleted.
+SoftLayer VM successfully deleted. You are no longer being billed for this instance.
+```
+
+Use the public ip address as an identifier 
+
+```sh
+user@localhost> knife softlayer server destroy --ip-address 33.33.33.33
+Decommissioning SoftLayer VM, this may take a few minutes.
+WARNING: Deleted node 5849421
+Chef node successfully deleted.
+WARNING: Deleted client 5849421
+Chef client successfully deleted.
+SoftLayer VM successfully deleted. You are no longer being billed for this instance.
+```

data/examples/vlan.md

@@ -1,85 +1,85 @@
-### VLAN examples
-
-These examples all assume you have set your SoftLayer username and api key in `~/.chef/knife.rb` like this:
-
-```ruby
-knife[:softlayer_username] = 'example_user'
-knife[:softlayer_api_key]  = '1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a'
-```
-  
-#### Create a new VLAN
-
-```sh
-user@localhost> knife softlayer vlan create
-Enter a vlan name:
-```
-
-```sh
-user@localhost> knife softlayer vlan create
-Enter a vlan name: my-new-vlan
-Enter a datacenter name: 
-```
-
-```sh
-user@localhost> knife softlayer vlan create
-Enter a vlan name: my-new-vlan
-Enter a datacenter name: wdc01
-Enter a router hostname: 
-```
-
-```sh
-user@localhost> knife softlayer vlan create
-Enter a vlan name: my-new-vlan
-Enter a datacenter name: wdc01
-Enter a router hostname: bcr05a.wdc01
-Enter a network space:[PUBLIC]
-```
-
-```sh
-user@localhost> knife softlayer vlan create
-Enter a vlan name: my-new-vlan
-Enter a datacenter name: wdc01
-Enter a router hostname: bcr05a.wdc01
-Enter a network space:[PUBLIC] PRIVATE # routers that start with bcr are for private VLANS; fcr are for public VLANS
-VLAN successfully created.  Provisioning may take a few minutes to complete.
-```
-
-#### List VLANS
-
-```sh
-user@localhost> knife softlayer vlan list
-+--------+----------------------+--------------+---------------+--------------+
-| id     | name                 | datacenter   | network_space | router       |
-+--------+----------------------+--------------+---------------+--------------+
-| 379384 | [none]               | Washington 1 | PUBLIC        | fcr02.wdc01  |
-+--------+----------------------+--------------+---------------+--------------+
-| 379386 | [none]               | Washington 1 | PRIVATE       | bcr02.wdc01  |
-+--------+----------------------+--------------+---------------+--------------+
-| 563298 | my-new-vlan          | Washington 1 | PRIVATE       | bcr02.wdc01  |
-+--------+----------------------+--------------+---------------+--------------+
-| 339652 | [none]               | San Jose 1   | PUBLIC        | fcr01a.sjc01 |
-+--------+----------------------+--------------+---------------+--------------+
-| 339654 | [none]               | San Jose 1   | PRIVATE       | bcr01a.sjc01 |
-+--------+----------------------+--------------+---------------+--------------+
-| 557984 | [none]               | Dallas 5     | PUBLIC        | fcr02a.dal05 |
-+--------+----------------------+--------------+---------------+--------------+
-| 557986 | [none]               | Dallas 5     | PRIVATE       | bcr02a.dal05 |
-+--------+----------------------+--------------+---------------+--------------+
-```
-
-#### Show a particular VLAN
-
-```sh
-user@localhost> knife softlayer vlan show 563298
-ID: 563298
-Name: my-new-vlan
-Datacenter: wdc01
-Network Space: PRIVATE
-Router: bcr02.wdc01
-Subnets:
-  +--------+------+---------------+---------------+---------------+---------+------------+------------+
-  | id     | cidr | gateway_ip    | network_id    | broadcast     | type    | datacenter | ip_version |
-  +--------+------+---------------+---------------+---------------+---------+------------+------------+
-  | 572522 | 30   | 10.32.181.241 | 10.32.181.240 | 10.32.181.243 | PRIMARY | wdc01      | 4          |
-  +--------+------+---------------+---------------+---------------+---------+------------+------------+
-```
+### VLAN examples
+
+These examples all assume you have set your SoftLayer username and api key in `~/.chef/knife.rb` like this:
+
+```ruby
+knife[:softlayer_username] = 'example_user'
+knife[:softlayer_api_key]  = '1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a'
+```
+  
+#### Create a new VLAN
+
+```sh
+user@localhost> knife softlayer vlan create
+Enter a vlan name:
+```
+
+```sh
+user@localhost> knife softlayer vlan create
+Enter a vlan name: my-new-vlan
+Enter a datacenter name: 
+```
+
+```sh
+user@localhost> knife softlayer vlan create
+Enter a vlan name: my-new-vlan
+Enter a datacenter name: wdc01
+Enter a router hostname: 
+```
+
+```sh
+user@localhost> knife softlayer vlan create
+Enter a vlan name: my-new-vlan
+Enter a datacenter name: wdc01
+Enter a router hostname: bcr05a.wdc01
+Enter a network space:[PUBLIC]
+```
+
+```sh
+user@localhost> knife softlayer vlan create
+Enter a vlan name: my-new-vlan
+Enter a datacenter name: wdc01
+Enter a router hostname: bcr05a.wdc01
+Enter a network space:[PUBLIC] PRIVATE # routers that start with bcr are for private VLANS; fcr are for public VLANS
+VLAN successfully created.  Provisioning may take a few minutes to complete.
+```
+
+#### List VLANS
+
+```sh
+user@localhost> knife softlayer vlan list
++--------+----------------------+--------------+---------------+--------------+
+| id     | name                 | datacenter   | network_space | router       |
++--------+----------------------+--------------+---------------+--------------+
+| 379384 | [none]               | Washington 1 | PUBLIC        | fcr02.wdc01  |
++--------+----------------------+--------------+---------------+--------------+
+| 379386 | [none]               | Washington 1 | PRIVATE       | bcr02.wdc01  |
++--------+----------------------+--------------+---------------+--------------+
+| 563298 | my-new-vlan          | Washington 1 | PRIVATE       | bcr02.wdc01  |
++--------+----------------------+--------------+---------------+--------------+
+| 339652 | [none]               | San Jose 1   | PUBLIC        | fcr01a.sjc01 |
++--------+----------------------+--------------+---------------+--------------+
+| 339654 | [none]               | San Jose 1   | PRIVATE       | bcr01a.sjc01 |
++--------+----------------------+--------------+---------------+--------------+
+| 557984 | [none]               | Dallas 5     | PUBLIC        | fcr02a.dal05 |
++--------+----------------------+--------------+---------------+--------------+
+| 557986 | [none]               | Dallas 5     | PRIVATE       | bcr02a.dal05 |
++--------+----------------------+--------------+---------------+--------------+
+```
+
+#### Show a particular VLAN
+
+```sh
+user@localhost> knife softlayer vlan show 563298
+ID: 563298
+Name: my-new-vlan
+Datacenter: wdc01
+Network Space: PRIVATE
+Router: bcr02.wdc01
+Subnets:
+  +--------+------+---------------+---------------+---------------+---------+------------+------------+
+  | id     | cidr | gateway_ip    | network_id    | broadcast     | type    | datacenter | ip_version |
+  +--------+------+---------------+---------------+---------------+---------+------------+------------+
+  | 572522 | 30   | 10.32.181.241 | 10.32.181.240 | 10.32.181.243 | PRIMARY | wdc01      | 4          |
+  +--------+------+---------------+---------------+---------------+---------+------------+------------+
+```

data/knife-softlayer.gemspec

@@ -1,39 +1,39 @@
-#
-# Author:: Matt Eldridge (<matt.eldridge@us.ibm.com>)
-# © Copyright IBM Corporation 2014.
-#
-# LICENSE: Apache 2.0 (http://www.apache.org/licenses/)
-#
-
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'knife-softlayer/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "knife-softlayer"
-  spec.version       = Knife::Softlayer::VERSION
-  spec.authors       = ["Matt Eldridge"]
-  spec.email         = ["matt.eldridge@us.ibm.com"]
-  spec.summary       = %q{SoftLayer VM support for Chef's knife utility.}
-  spec.description   = %q{A knife plugin for launching and bootstrapping instances in the IBM SoftLayer cloud.}
-  spec.homepage      = "https://github.com/SoftLayer/knife-softlayer"
-  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{^(spec|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "fog-softlayer", "~> 0.3.30"
-  spec.add_dependency "knife-windows", "> 0.5.12"
-  spec.add_dependency "net-ssh", "> 2.8.0"
-
-  spec.add_development_dependency "mixlib-config", "~>2.0"
-  spec.add_development_dependency "chef", ">=0.10.10"
-  spec.add_development_dependency "rspec", "~>2.14"
-  spec.add_development_dependency "rake", "~>10.1"
-  spec.add_development_dependency "sdoc", "~>0.3"
-  spec.add_development_dependency "bundler", "~>1.5"
-  spec.add_development_dependency "osrcry"
-end
+#
+# Author:: Matt Eldridge (<matt.eldridge@us.ibm.com>)
+# © Copyright IBM Corporation 2014.
+#
+# LICENSE: Apache 2.0 (http://www.apache.org/licenses/)
+#
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife-softlayer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knife-softlayer"
+  spec.version       = Knife::Softlayer::VERSION
+  spec.authors       = ["Matt Eldridge"]
+  spec.email         = ["matt.eldridge@us.ibm.com"]
+  spec.summary       = %q{SoftLayer VM support for Chef's knife utility.}
+  spec.description   = %q{A knife plugin for launching and bootstrapping instances in the IBM SoftLayer cloud.}
+  spec.homepage      = "https://github.com/SoftLayer/knife-softlayer"
+  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{^(spec|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fog-softlayer", "~> 1.1.1"
+  spec.add_dependency "knife-windows", "> 0.5.12"
+  spec.add_dependency "net-ssh", "> 2.8.0"
+
+  spec.add_development_dependency "mixlib-config", "~>2.0"
+  spec.add_development_dependency "chef", ">=0.10.10"
+  spec.add_development_dependency "rspec", "~>2.14"
+  spec.add_development_dependency "rake", "~>10.1"
+  spec.add_development_dependency "sdoc", "~>0.3"
+  spec.add_development_dependency "bundler", "~>1.5"
+  spec.add_development_dependency "osrcry"
+end

data/lib/chef/knife/flavor/base.rb

@@ -1,52 +1,52 @@
-#
-# Author:: Matt Eldridge (<matt.eldridge@us.ibm.com>)
-# © Copyright IBM Corporation 2014.
-#
-# LICENSE: Apache 2.0 (http://www.apache.org/licenses/)
-#
-
-require 'chef/knife'
-
-class Chef
-  class Knife
-    module SoftlayerFlavorBase
-
-      ##
-      # Build table of all VM configuration options.
-      # @return [Hash]
-      def options_table
-        columns = [
-            "| CORES",
-            "| RAM",
-            "| DISK",
-            "| OS",
-            "| NETWORK [MBS]",
-            "| DATACENTER",
-        ]
-
-        6.times { columns << '| ========== ' }
-
-        opts = connection.request(:virtual_guest, :get_create_object_options).body
-        cpu = opts['processors']
-        ram = opts['memory']
-        disk = opts['blockDevices'].sort_by{|d| d['itemPrice']['item']['description'] unless d['itemPrice'].nil? }
-        os = opts['operatingSystems']
-        net = opts['networkComponents']
-        datacenter = opts['datacenters']
-
-        i = 0
-        until i >= opts.keys.map{|key| opts[key].count }.sort.last do
-          columns << (cpu[i].nil? ? '|  ' : '|  ' + cpu[i]['itemPrice']['item']['description'])
-          columns << (ram[i].nil? ? '|  ' : '|  ' + ram[i]['template']['maxMemory'].to_s + " [#{ram[i]['itemPrice']['item']['description']}]")
-          columns << (disk[i].nil? ? '|  ' : '|  ' + disk[i]['itemPrice']['item']['description'])
-          columns << (os[i].nil? ? '|  ' : '|  ' + os[i]['template']['operatingSystemReferenceCode'])
-          columns << (net[i].nil? ? '|  ' : '|  ' + net[i]['template']['networkComponents'].first['maxSpeed'].to_s)
-          columns << (datacenter[i].nil? ? '|  ' : '|  ' + datacenter[i]['template']['datacenter']['name'])
-          i+=1
-        end
-        columns
-      end
-
-    end
-  end
-end
+#
+# Author:: Matt Eldridge (<matt.eldridge@us.ibm.com>)
+# © Copyright IBM Corporation 2014.
+#
+# LICENSE: Apache 2.0 (http://www.apache.org/licenses/)
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    module SoftlayerFlavorBase
+
+      ##
+      # Build table of all VM configuration options.
+      # @return [Hash]
+      def options_table
+        columns = [
+            "| CORES",
+            "| RAM",
+            "| DISK",
+            "| OS",
+            "| NETWORK [MBS]",
+            "| DATACENTER",
+        ]
+
+        6.times { columns << '| ========== ' }
+
+        opts = connection.request(:virtual_guest, :get_create_object_options).body
+        cpu = opts['processors']
+        ram = opts['memory']
+        disk = opts['blockDevices'].sort_by{|d| d['itemPrice']['item']['description'] unless d['itemPrice'].nil? }
+        os = opts['operatingSystems']
+        net = opts['networkComponents']
+        datacenter = opts['datacenters']
+
+        i = 0
+        until i >= opts.keys.map{|key| opts[key].count }.sort.last do
+          columns << (cpu[i].nil? ? '|  ' : '|  ' + cpu[i]['itemPrice']['item']['description'])
+          columns << (ram[i].nil? ? '|  ' : '|  ' + ram[i]['template']['maxMemory'].to_s + " [#{ram[i]['itemPrice']['item']['description']}]")
+          columns << (disk[i].nil? ? '|  ' : '|  ' + disk[i]['itemPrice']['item']['description'])
+          columns << (os[i].nil? ? '|  ' : '|  ' + os[i]['template']['operatingSystemReferenceCode'])
+          columns << (net[i].nil? ? '|  ' : '|  ' + net[i]['template']['networkComponents'].first['maxSpeed'].to_s)
+          columns << (datacenter[i].nil? ? '|  ' : '|  ' + datacenter[i]['template']['datacenter']['name'])
+          i+=1
+        end
+        columns
+      end
+
+    end
+  end
+end