vcloud-walker 3.2.1 → 3.2.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.2.2 (2014-05-01)
+
+  - Use pessimistic version dependency for vcloud-core
+
 ## 3.2.1 (2014-04-22)
 
 Bugfixes:

data/README.md

@@ -1,6 +1,7 @@
 # VCloud Walker
 
-Vcloud-walker is a command line tool, to describe different VMware vCloud Director 5.1 entities. It uses Fog under the hood.
+Vcloud-walker is a command line tool, to describe different VMware vCloud
+Director 5.1 entities. It uses Fog under the hood.
 
 ## Installation
 
@@ -24,7 +25,8 @@ You can perform following operations with walker.
 #### Walk vdcs:
    vcloud-walk vdcs
 
-describes all vdcs within given organization. This includes vapp, vm and network information.
+describes all vdcs within given organization. This includes vapp, vm and network
+information.
 
 #### Walk catalogs:
     vcloud-walk catalogs
@@ -39,54 +41,52 @@ describes all organization networks.
 #### Walk edgegateways:
     vcloud-walk edgegateways
 
-describes all edgegateway for given organization. Each edgegateway includes configuration for firewall, load balancer and nat services.
+describes all edgegateway for given organization. Each edgegateway includes
+configuration for firewall, load balancer and nat services.
 
 #### Walk entire organization:
      vcloud-walk organization
 
-describes the entire organization, which includes edgegateway, catalogs, networks and vdcs within an organization.
+describes the entire organization, which includes edgegateway, catalogs,
+networks and vdcs within an organization.
 
-### Credentials
+## Credentials
 
-You will need to specify the credentials for your VMware environment. Vcloud-walker uses fog to query the VMware api,
-which offers two ways to do this.
+vCloud Walker is based around [fog](http://fog.io/). To use it you'll need to give it
+credentials that allow it to talk to a vCloud Director environment.
 
-#### 1. Create a `.fog` file containing your credentials
+1. Create a '.fog' file in your home directory.
 
-An example of .fog file is:
+  For example:
 
-````
-default:
-  vcloud_director_username: 'user_id@org_id'
-  vcloud_director_password: 'password'
-  vcloud_director_host: 'api_endpoint'
-````
+      test_credentials:
+        vcloud_director_host: 'host.api.example.com'
+        vcloud_director_username: 'username@org_name'
+        vcloud_director_password: ''
 
-To understand more about `.fog` files, visit the 'Credentials' section here => http://fog.io/about/getting_started.html.
+2. Obtain a session token. First, curl the API:
 
-### 2. Log on externally and supply your session token
+        curl -D- -d '' \
+            -H 'Accept: application/*+xml;version=5.1' -u '<username>@<org_name>' \
+            https://<host.api.example.com>/api/sessions
 
-You can choose to log on externally by interacting independently with the API and supplying your session token to the
-tool by setting the `FOG_VCLOUD_TOKEN` ENV variable. This option reduces the risk footprint by allowing the user to
-store their credentials in safe storage. The default token lifetime is '30 minutes idle' - any activity extends the life by another 30 mins.
+  This will prompt for your password.
 
-A basic example of this would be the following:
+  From the headers returned, the value of the `x-vcloud-authorization` header is your
+  session token, and this will be valid for 30 minutes idle - any activity will extend
+  its life by another 30 minutes.
 
-    curl
-       -D-
-       -d ''
-       -H 'Accept: application/*+xml;version=5.1' -u '<user>@<org>'
-       https://host.com/api/sessions
+3. Specify your credentials and session token at the beginning of the command. For example:
 
-This will prompt for your password.
+        FOG_CREDENTIAL=test_credentials \
+            FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= \
+            vcloud-walk organization
 
-From the headers returned, select the header below
+  You may find it easier to export one or both of the values as environment variables.
 
-     x-vcloud-authorization: AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF=
+  **NB** It is also possible to sidestep the need for the session token by saving your
+  password in the fog file. This is **not recommended**.
 
-Use token as ENV var FOG_VCLOUD_TOKEN
-
-    FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= vcloud-walk organization
 
 ### Output
 
@@ -95,6 +95,16 @@ You can use command line option ```--yaml``` for yaml output.
 
 Find sample json output in docs/examples directory.
 
+## The vCloud API
+
+vCloud Tools currently use version 5.1 of the [vCloud API](http://pubs.vmware.com/vcd-51/index.jsp?topic=%2Fcom.vmware.vcloud.api.doc_51%2FGUID-F4BF9D5D-EF66-4D36-A6EB-2086703F6E37.html). Version 5.5 may work but is not currently supported. You should be able to access the 5.1 API in a 5.5 environment, and this *is* currently supported.
+
+The default version is defined in [Fog](https://github.com/fog/fog/blob/244a049918604eadbcebd3a8eaaf433424fe4617/lib/fog/vcloud_director/compute.rb#L32).
+
+If you want to be sure you are pinning to 5.1, or use 5.5, you can set the API version to use in your fog file, e.g.
+
+`vcloud_director_api_version: 5.1`
+
 ## Debugging
 
 `export EXCON_DEBUG=true` - this will print out the API requests and responses.

data/jenkins.sh

@@ -7,9 +7,6 @@ git clean -fdx
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 bundle exec rake
 
-./scripts/generate_fog_conf_file.sh
-export FOG_RC=fog_integration_test.config
-bundle exec rake integration_test
-rm fog_integration_test.config
+RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration_test
 
 bundle exec rake publish_gem

data/jenkins_integration_tests.sh

@@ -2,10 +2,4 @@
 set -e
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 
-./scripts/generate_fog_conf_file.sh
-
-export FOG_RC=fog_integration_test.config
-
-bundle exec rake integration_test
-
-rm fog_integration_test.config
+RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration_test

data/lib/vcloud/walker/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Walker
-    VERSION = '3.2.1'
+    VERSION = '3.2.2'
   end
 end

data/tools/fog_credentials.rb

@@ -0,0 +1,17 @@
+# Initialiser for getting vCloud credentials into Fog from Jenkins build
+# parameters, without needing to write them to disk. To be used with:
+#
+#     RUBYOPT="-r ./tools/fog_credentials" bundle exec integration
+#
+# Replace with FOG_VCLOUD_TOKEN support when we have a tool:
+#
+#     https://www.pivotaltracker.com/story/show/68989754
+#
+require 'bundler/setup'
+require 'fog'
+
+Fog.credentials = {
+  :vcloud_director_host     => ENV['API_HOST'],
+  :vcloud_director_username => ENV['API_USERNAME'],
+  :vcloud_director_password => ENV['API_PASSWORD'],
+}

data/vcloud-walker.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '~> 1.8.0'
   s.add_runtime_dependency 'methadone'
   s.add_runtime_dependency 'fog', '>= 1.21.0'
-  s.add_runtime_dependency 'vcloud-core', '>= 0.0.12'
+  s.add_runtime_dependency 'vcloud-core', '~> 0.0.12'
   s.add_development_dependency 'simplecov', '~> 0.8.2'
   s.add_development_dependency 'gem_publisher', '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-walker
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,7 +128,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.12
   type: :runtime
@@ -136,7 +136,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.12
 - !ruby/object:Gem::Dependency
@@ -211,7 +211,6 @@ files:
 - scripts/configure_walker_ci_vse.rb
 - scripts/data/walker_ci/carrenza.yaml
 - scripts/data/walker_ci/skyscape.yaml
-- scripts/generate_fog_conf_file.sh
 - spec/fog_interface_spec.rb
 - spec/integration/vcloud_walker_spec.rb
 - spec/spec_helper.rb
@@ -226,6 +225,7 @@ files:
 - spec/walk/vapp_spec.rb
 - spec/walk/vdcs_spec.rb
 - spec/walk/vm_spec.rb
+- tools/fog_credentials.rb
 - vcloud-walker.gemspec
 homepage: https://github.com/alphagov/vcloud-walker
 licenses:
@@ -242,7 +242,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 425878083933319331
+      hash: 523235107079612422
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -251,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 425878083933319331
+      hash: 523235107079612422
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/scripts/generate_fog_conf_file.sh

@@ -1,6 +0,0 @@
-cat <<EOF >fog_integration_test.config
-default:
-    vcloud_director_username: '$API_USERNAME'
-    vcloud_director_password: '$API_PASSWORD'
-    vcloud_director_host: '$API_HOST'
-EOF