fog-softlayer 0.2.1 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODBkZjA5MDMwN2UzM2FlOGJiMmNkYjhmZTkxMGRkNGYwNmFkNDllYg==
+    MTM2MDFlYmQ0NjNhMDI0NjZhM2FmNWRjNjVmNzdhMmRhNDE0YjMzYw==
   data.tar.gz: !binary |-
-    ZDk5ZjI0ZDE2YTA5OWQyN2RhYzNkNDY5OTYzMDFiYWQ2MzJmNWIxOA==
+    MmE5ZjAzZTYzMGVjOGY4YTU5MjQ0OGZkNjkxYTNhMzg4NDYwNThhYg==
 SHA512:
   metadata.gz: !binary |-
-    ODA5NzljZTFlNDZmMjUxYTJiZjI5ZjIzYjViZGY0YmE4M2RjMzRhNmE4MGQ1
-    NGVjY2E3ZTc2YzI0YjQxMWJkNjgxNDc4ODRjMWYwN2Y0NzE4MjM3Zjg2YWEx
-    NGE0OTNhYmVmOTI4MzkwMTNhZTk4NGZkMTdmZjJjNjgzMTBkM2E=
+    NmNlZDRhMDYwZDAwNWExZmZhN2UyMzAyNGExMDU0ZDJmMjJjODMwMWIyMGYx
+    YjY0ZmJjMzgzNTg4YTRiMmY1M2UyYzNiYzI5ZDczOTVmMTVlYTUxNzMyNzMz
+    MDJmNjdhYzZmMzQ0MTc4MmMyNTNlNGRlYzFlMmFjNTJlMzQ3OGM=
   data.tar.gz: !binary |-
-    NmYyN2ZhOGI2Mjg4YjQ5ZTdmOGNjMWViYzgxZWY0ZWM1Y2FmZmI0NGJiNWVk
-    YmI1ZTc5NjUxMDcxODM0ZWU0OWQzYTQwNWJkMjc2OGY3YmI5MjUwM2I0MGYw
-    YjBmYWE2MzBiNDIxOTk2MzZjMzRjZmYyMTExOWIzM2RhNzQxODA=
+    ZTg3YTBiZjI3ZjdiYzBjYWRmN2Q0YTcxNDkxODgzNWZhMzU1ZmJmMjQ1YjAx
+    ODc0YzEzZGEwYjU5ZWIyYTlhMmZhNmRhZGZjY2U5OWYxNzAxNDI0ODU3Zjc0
+    NDRiMWM2MzIyZGQ1ZTU2MTVlODBhNDA5YzU1MTE5MTViOWIxNjU=

data/.travis.yml

@@ -27,7 +27,6 @@ matrix:
 
   allow_failures:
     - rvm: jruby-head
-    - rvm: 1.8.7
 
 notifications:
   email:

data/CHANGELOG.md

@@ -1,26 +1,42 @@
+## 0.3.0 2014-06-26
+
+* Added Network service.
+  * Network model.
+  * Subnet model.
+  * Ip model.
+  * Tag model.
+* Added vlan and private_vlan properties to Server model.
+* Fixed up bare_metal? on Server so it's not a hack. *thanks fernandes*
+* Fixed Bundler/dep issues with Ruby 1.8.7. (Thx @fernandes!)
+* Added some missing license headers.
+* Updated Compute examples and Tag examples to reflect new Network service.
+* Moved shared logic from `lib/fog/softlayer/compute.rb` to `lib/fog/softlayer/core.rb`
+
+## 0.2.1 2014-06-17
+* Add support for SoftLayer Tags on Compute resources.
+
 ## 0.1.1 2014-06-10
 
-    * Fix Compute model after breaking change to SLAPI. :datecenter is no longer optional.
+* Fix Compute model after breaking change to SLAPI. :datacenter is no longer optional.
+
 ## 0.1.0 2014-06-10
 
-    * Add missing get method to Fog::DNS::Softlayer::Record.
-    * Add OS attribute and ssh_password method to Compute model.
+* Add missing get method to Fog::DNS::Softlayer::Record.
+* Add OS attribute and ssh_password method to Compute model.
 
 ### 0.0.9 2014-06-10
 
- * Initial support for DNS.
+* Initial support for DNS.
 
 ### 0.0.8 2014-06-05
 
- * Released support for Object Storage.
+* Released support for Object Storage.
 
 ### 0.0.7 2014-05-29
 
- * Compute requests and models initial development complete.  Supports both VMs and BMC.
- * Storage requests and models initial development complete.
+* Compute requests and models initial development complete.  Supports both VMs and BMC.
+* Storage requests and models initial development complete.
 
 ### 0.0.1 / 2014-04-18
 
-Enhancements:
-
 * Initial release of `fog-softlayer` module.

data/CONTRIBUTING.md

@@ -1,30 +1,18 @@
-# Contributing to fog-softlayer
+## Getting Involved
 
-We are happy to accept contributions to fog-softlayer.  Please follow the guidelines below.  
+New contributors are always welcome, when it doubt please ask questions. We strive to be an open and welcoming community. Please be nice to one another.
 
-* Sign our contributor agreement (CLA) You can find the [CLA here](./docs/cla-individual.pdf).
+### Coding
 
-* If you're contributing on behalf of your employer we'll need a signed copy of our corporate contributor agreement (CCLA) as well.  You can find the [CCLA here](./docs/cla-corporate.pdf).
-    
-* Fork the repo, make your changes, and open a pull request.
+* Pick a task:
+  * Offer feedback on open [pull requests](https://github.com/softlayer/fog/pulls).
+  * Review open [issues](https://github.com/softlayer/fog/issues) for things to help on.
+  * [Create an issue](https://github.com/softlayer/fog/issues/new) to start a discussion on additions or features.
+* Fork the project, add your changes and tests to cover them in a topic branch.
+* Commit your changes and rebase against `softlayer/fog` to ensure everything is up to date.
+* [Submit a pull request](https://github.com/softlayer/fog/compare/).
 
-## Issue Tracking
-
-You can file tickets to describe the bug you'd like to fix or feature you'd
-like to add on the [fog-softlayer project](https://github.com/softlayer/fog-softlayer/issues) on github.
-
-## Testing Instructions
-
-To run tests, run the following Ruby tool commands from the root of your local copy of
-fog-softlayer:
-
-    bundle install
-    bundle exec rake travis
-    
-**All tests must pass** before your contribution can be merged. Thus it's a good idea
-to execute the tests without your change to be sure you understand how to run
-them, as well as after to validate that you've avoided regressions.
-
-All but the most trivial changes should include **at least one unit test case** to exercise the
-new / changed code; please add tests to your pull request in this common case.
+### Non-Coding
 
+* Offer feedback on open [issues](https://github.com/softlayer/fog/issues).
+* Organize or volunteer at events.

data/CONTRIBUTORS.md

@@ -1,2 +1,2 @@
 * Celso Fernandes <fernandes@zertico.com>
-* Matt Eldridge <matt.eldridge@us.ibm.com>
+* Matt Eldridge <matt.eldridge@us.ibm.com>

data/Rakefile

@@ -34,7 +34,7 @@ def name
 end
 
 def version
-  Fog::VERSION
+  Fog::Softlayer::VERSION
 end
 
 def date
@@ -198,7 +198,7 @@ task :gemspec => :validate do
   replace_header(spec, :version)
   replace_header(spec, :date)
   #comment this out if your rubyforge_project has a different name
-  replace_header(spec, :rubyforge_project)
+  #replace_header(spec, :rubyforge_project)
 
   File.open(gemspec_file, 'w') { |io| io.write(spec) }
   puts "Updated #{gemspec_file}"
@@ -209,7 +209,7 @@ task :validate do
   libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/tasks"]
   unless libfiles.empty?
     puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
-    exit!
+    #exit!
   end
   unless Dir['VERSION*'].empty?
     puts "A `VERSION` file at root level violates Gem best practices."

data/examples/compute.md

@@ -32,6 +32,94 @@ These examples all assume you have `~/.fog` which contains the following
    server.state # => 'Running', 'Stopped', 'Terminated', etc.
    ```
 
+1. Get all servers tagged with certain tags.
+
+	```ruby
+	prod_fe_servers = @sl.servers.tagged_with(['production', 'frontend'])
+	# => [ <Fog::Compute::Softlayer::Server>,
+	#	<Fog::Compute::Softlayer::Server>,
+	#	<Fog::Compute::Softlayer::Server>,
+	#	<Fog::Compute::Softlayer::Server>,
+	#	<Fog::Compute::Softlayer::Server>,]		
+	```
+   
+1. Get a server's public/frontend VLAN
+
+	```ruby
+	server = @sl.servers.get(12345)
+	server.vlan
+	# => <Fog::Network::Softlayer::Network
+    #	id=123456,
+	#   name='frontend-staging-vlan',
+	#   modify_date="2014-02-22T12:42:31-06:00",
+	#   note=nil,
+	#   tags=['sparkle', 'motion'],
+	#   type="STANDARD",
+	#   datacenter=    <Fog::Network::Softlayer::Datacenter
+	#     id=168642,
+	#     long_name="San Jose 1",
+	#     name="sjc01"
+	#   >,
+	#   network_space="PUBLIC",
+	#   router={"hostname"=>"fcr01a.sjc01", "id"=>82412, "datacenter"=>{"id"=>168642, "longName"=>"San Jose 1", "name"=>"sjc01"}}
+  	# >
+	```
+	
+1. Get a server's private/backend VLAN
+
+	```ruby
+	server = @sl.servers.get(12345)
+	server.private_vlan
+	# =>  <Fog::Network::Softlayer::Network
+	#    id=123456,
+	#    name='backend-staging-vlan',
+	#    modify_date="2014-02-22T12:42:33-06:00",
+	#    note=nil,
+	#    tags=[],
+	#    type="STANDARD",
+	#    datacenter=    <Fog::Network::Softlayer::Datacenter
+	#	    id=168642,
+	#    	long_name="San Jose 1",
+	#    	name="sjc01"
+	#   >,
+	#   network_space="PRIVATE",
+    #	router={"hostname"=>"bcr01a.sjc01", "id"=>82461, "datacenter"=>{"id"=>168642, "longName"=>"San Jose 1", "name"=>"sjc01"}}
+  	# >
+	
+	```
+	
+1. Get a server's tags
+
+	```ruby
+		server = @sl.servers.get(12345)
+		server.tags
+		# => ['production', 'frontend']
+	```
+	
+1. Add tags to a server
+
+	```ruby
+		server = @sl.servers.get(12345)
+		server.tags
+		# => ['production', 'frontend']
+		server.add_tags(['sparkle', 'motion']
+		# => true
+		server.tags
+		# => ['production', 'frontend', 'sparkle', 'motion']
+	```
+
+1. Delete tags from a server
+
+	```ruby
+		server = @sl.servers.get(12345)
+		server.tags
+		# => ['production', 'frontend', 'sparkle', 'motion']
+		server.delete_tags(['sparkle', 'motion']
+		# => true
+		server.tags
+		# => ['production', 'frontend']
+	```
+
 1. Provision a new VM with flavor (simple).
 
    ```ruby
@@ -45,7 +133,7 @@ These examples all assume you have `~/.fog` which contains the following
      new_server.id # => 1337
    ```
 
-1. Provision a new BMC instance with flavor (simple).
+1. Provision a new Bare Metal instance with flavor (simple).
 
    ```ruby
      opts = {
@@ -75,7 +163,7 @@ These examples all assume you have `~/.fog` which contains the following
      }
    ```
 
-1. Provision a BMC Instance without a flavor
+1. Provision a Bare Metal Instance without a flavor
 
    ```ruby
    opts = {
@@ -92,9 +180,32 @@ These examples all assume you have `~/.fog` which contains the following
      }
    ```
 
-1. Delete a VM or BMC instance.
+1. Delete a VM or Bare Metal instance.
 
    ```ruby
    	  @sl.servers.get(<server id>).destroy
    ```
+   
+1. Provision a Server (works the same for VM and Bare Metal) into a specific VLAN
+
+	```ruby
+	# I want to launch another server to hold docker containers into my existing staging VLANs
+	# I'll start by getting a staging server so I can use its vlans as a reference.
+	staging_server = @sl.servers.tagged_with(['staging', 'docker']).first # => <Fog::Compute::Softlayer::Server>
+	
+	opts = {
+	  :flavor_id => 'm1.large', 
+	  :image_id => '23f7f05f-3657-4330-8772-329ed2e816bc',  # Ubuntu Docker Image
+	  :domain => 'staging.example.com',
+	  :datacenter => 'ams01', # This needs to be the same datacenter as the target VLAN of course.
+	  :name => 'additional-docker-host',
+	  :vlan => staging.server.vlan, # Passing in a <Fog::Network::Softlayer::Network> object.
+	  :private_vlan => staging.server.private_vlan.id, # Passing in an Integer (the id of a network/vlan) works too. 
+	}
+
+	new_staging_server = @sl.servers.create(opts)
+	# => <Fog::Compute::Softlayer::Server>
+	
+	
+	```
 

data/examples/network.md

@@ -0,0 +1,285 @@
+### Network Examples
+
+Note that SoftLayer uses the term `VLAN`.  The Fog project tries to keep things provider independent, and we'll be referring to them as `networks`.
+
+
+These examples all assume you have `~/.fog` which contains the following
+
+
+   ```yaml  
+   :softlayer_username: example-username
+   :softlayer_api_key: 1a1a1a1a1a1a1a1a1a11a1a1a1a1a1a1a1a1a1 
+  ```
+
+#### Create a connection to SoftLayer Network
+
+```ruby
+	require 'fog/softlayer'
+	@sl = Fog::Network[:softlayer]
+```
+
+#### Use the Models
+1. List existing networks.
+
+   ```ruby
+    nets = @sl.networks
+    # => [ <Fog::Network::Softlayer::Network
+    #  	id=123456,
+    #	name="some-optional-name",
+    #	modify_date="2014-06-25T17:10:57-05:00",
+    #	note=nil,
+    #	tags=["sparkle", "motion", "public"],
+    #	type="STANDARD",
+    #	datacenter=	<Fog::Network::Softlayer::Datacenter
+    #		id=12345,
+    #		long_name="Washington, DC 1",
+    #		name="wdc01"
+    #		>,
+    #	network_space="PUBLIC"
+    #	router={"hostname"=>"fcr02.wdc01", "id"=>40378, "datacenter"=>{"id"=>37473, "longName"=>"Washington, DC 1", "name"=>"wdc01"}}
+    #	>,
+    #	<Fog::Network::Softlayer::Network
+    #	id=123457,
+    #	name="some-other-optional-name",
+    #	modify_date="2014-06-25T17:11:57-05:00",
+    #	note=nil,
+    #	tags=["sparkle", "motion", "private"],
+    #	type="STANDARD",
+    #	datacenter=	<Fog::Network::Softlayer::Datacenter
+    #		id=12345,
+    #		long_name="Washington, DC 1",
+    #		name="wdc01"
+    #		>,
+    #	network_space="PRIVATE"
+    #	router={"hostname"=>"bcr02.wdc01", "id"=>40379, "datacenter"=>{"id"=>37473, "longName"=>"Washington, DC 1", "name"=>"wdc01"}}
+    #	>,    	  	
+	# ]
+   ```
+   
+1. Get a network by ID.
+
+	```ruby
+	net = @sl.networks.get(123456)
+	# => <Fog::Network::Softlayer::Network
+    #	id=123456,
+    #	name="some-name",
+    #	modify_date="2014-06-25T17:10:57-05:00",
+    #	note=nil,
+    #	tags=["sparkle", "motion", "public"],
+    #	type="STANDARD",
+    #	datacenter=	<Fog::Network::Softlayer::Datacenter
+    #		id=12345,
+    #		long_name="Washington, DC 1",
+    #		name="wdc01"
+    #		>,
+    #	network_space="PUBLIC"
+    #	router={"hostname"=>"fcr02.wdc01", "id"=>40378, "datacenter"=>{"id"=>37473, "longName"=>"Washington, DC 1", "name"=>"wdc01"}}
+    #	>
+	```
+	
+1. Get a network by name.
+
+	```ruby
+	@sl.networks.by_name('some-name')
+	# => <Fog::Network::Softlayer::Network
+    #	id=123456,
+    #	name="some-name",
+    #	modify_date="2014-06-25T17:10:57-05:00",
+    #	note=nil,
+    #	tags=["sparkle", "motion", "public"],
+    #	type="STANDARD",
+    #	datacenter=	<Fog::Network::Softlayer::Datacenter
+    #		id=12345,
+    #		long_name="Washington, DC 1",
+    #		name="wdc01"
+    #		>,
+    #	network_space="PUBLIC"
+    #	router={"hostname"=>"fcr02.wdc01", "id"=>40378, "datacenter"=>{"id"=>37473, "longName"=>"Washington, DC 1", "name"=>"wdc01"}}
+    #	>
+	```
+	
+1. Get all networks with a particular tag.
+
+	```ruby
+	prod_backend_nets = @sl.networks.tagged_with(['production', 'private'])
+	# => [<Fog::Network::Softlayer::Network>,
+	#	<Fog::Network::Softlayer::Network>,
+	#	<Fog::Network::Softlayer::Network>,
+	#	]    	
+	```
+	
+1. Get a network's tags.
+
+	```ruby
+		net = @sl.networks.get(123456)
+    	net.tags
+    	# => ['sparkle', 'motion', 'production', 'public']
+	```
+	
+1. Get a network's router.
+
+	```ruby
+		net = @sl.networks.by_name('some-name')
+		net.router
+		# => {"hostname"=>"bcr02a.ams01",
+		# "id"=>190854,
+		# "datacenter"=>{"id"=>265592, "longName"=>"Amsterdam 1", "name"=>"ams01"}}
+	```
+
+1. Get a network's subnets.
+
+	```ruby
+		net = @sl.networks.get(123456)
+		net.subnets
+		# => [  <Fog::Network::Softlayer::Subnet
+	    # id=123456,
+	    # name=nil,
+	    # network_id="37.58.125.72",
+	    # vlan_id=123456,
+	    # cidr=29,
+	    # ip_version=4,
+	    # type="ADDITIONAL_PRIMARY",
+	    # gateway_ip="37.58.125.73",
+	    # broadcast="37.58.125.79",
+	    # gateway=nil,
+    	# datacenter="ams01"
+	  # >,
+	   # <Fog::Network::Softlayer::Subnet
+	    # id=123457,
+    	# name=nil,
+	    # network_id="81.95.147.148",
+    	# vlan_id=123456,
+	    # cidr=30,
+	    # ip_version=4,
+    	# type="PRIMARY",
+	    # gateway_ip="81.95.147.149",
+	    # broadcast="81.95.147.151",
+	    # gateway=nil,
+	    # datacenter="ams01"
+	  # >]
+	```
+	
+1. Get a subnet's IP Addresses.
+
+	```ruby
+		net = @sl.networks.get(123456)
+		# Here I'm selecting the primary subnet...
+		subnet = net.subnets.select { |vlan| vlan.type == "PRIMARY" }.first
+		# => <Fog::Network::Softlayer::Subnet
+	    # id=123457,
+	    # ...
+	    # >
+	    addys = subnet.addresses
+	    # => [  <Fog::Network::Softlayer::Ip
+   		 # id=19222174,
+	     # subnet_id=630962,
+	     # address="37.58.125.72",
+	     # broadcast=false,
+	     # gateway=false,
+	     # network=true,
+	     # reserved=false,
+	     # note=nil,
+	     # assigned_to=nil
+		 # >,
+		# <Fog::Network::Softlayer::Ip
+   		 #  id=19222174,
+		 #  subnet_id=630962,
+		 #  address="37.58.125.73",
+		 #  broadcast=false,
+		 #  gateway=true,
+		 #  network=false,
+		 #  reserved=false,
+		 #  note=nil,
+		 #  assigned_to=nil
+		 #  >,
+		# <Fog::Network::Softlayer::Ip
+   		 #  id=19222174,
+		 #  subnet_id=630962,
+		 #  address="37.58.125.74",
+		 #  broadcast=false,
+		 #  gateway=false,
+		 #  network=false,
+		 #  reserved=false,
+		 #  note=nil,
+		 #  assigned_to={"fullyQualifiedDomainName"=>"hostname.example.com", "id"=>281730}
+		 #  >,
+		# <Fog::Network::Softlayer::Ip
+   		 #  id=19222174,
+		 #  subnet_id=630962,
+		 #  address="37.58.125.75",
+		 #  broadcast=false,
+		 #  gateway=false,
+		 #  network=false,
+		 #  reserved=false,
+		 #  note=nil,
+		 #  assigned_to={"fullyQualifiedDomainName"=>"hostname-2.example.com", "id"=>281730}
+		 #  >,
+		# ...,
+	   #  ]	    
+	```
+	
+1. Create a new network.
+
+	```ruby
+		# We're creating a network in wdc01, the same steps will work for any datacenter.
+		# @sl.datacenters will give you a list of available datacenters.
+		
+		wdc01 = @sl.datacenters.by_name('wdc01')
+		wdc01.routers
+		# => [{"hostname"=>"bcr01.wdc01", "id"=>16358},
+		# {"hostname"=>"bcr02.wdc01", "id"=>40379},
+		# {"hostname"=>"bcr03a.wdc01", "id"=>85816},
+		# {"hostname"=>"bcr04a.wdc01", "id"=>180611},
+		# {"hostname"=>"bcr05a.wdc01", "id"=>235754},
+		# {"hostname"=>"fcr01.wdc01", "id"=>16357},
+		# {"hostname"=>"fcr02.wdc01", "id"=>40378},
+		# {"hostname"=>"fcr03a.wdc01", "id"=>85814},
+		# {"hostname"=>"fcr04a.wdc01", "id"=>180610},
+		# {"hostname"=>"fcr05a.wdc01", "id"=>235748}]
+		 
+		# We want to create a public network so be sure to use one of the fcr* routers.
+		# If we were creating a private network we'd want to use a bcr* router.
+		
+		opts = {
+		 :name => 'my-new-network', 
+		 :datacenter => wdc01,
+		 :router => wdc01.routers[4],
+		 :network_space => 'PUBLIC',
+		}
+		
+		@sl.networks.create(opts)		
+	```
+	
+1. Add tags to a network.
+
+	```ruby
+		net = @sl.networks.by_name('my-new-network')
+		net.tags
+		# => ['sparkle']
+		net.add_tags(['motion'])
+		# => true
+		net.tags
+		# => ['sparkle', 'motion']
+	```
+	
+1. Delete tags from a network.
+
+	```ruby
+		net = @sl.networks.by_name('my-new-network')
+		net.tags
+		# => ['sparkle', 'motion']
+		net.delete_tags(['motion'])
+		# => true
+		net.tags
+		# => ['sparkle']
+	```
+
+1. Delete a network.
+
+	```ruby
+		@sl.networks.by_name('my-retired-network').destroy
+		# => true
+		
+		# You can't delete a network if it has actively routed addresses...
+	```
+