vcloud-launcher 0.0.5 → 0.1.0

data/.gitignore

@@ -9,3 +9,4 @@
 /pkg/
 fog_integration_test.config
 .idea
+/spec/integration/vcloud_tools_testing_config.yaml

data/.travis.yml

@@ -2,8 +2,5 @@
 language: ruby
 rvm:
   - 1.9.3
-branches:
-  except:
-    - master
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.1.0 (2014-06-02)
+
+Features:
+
+  - Support 'pool' mode for VM IP address allocation. Thanks @geriBatai.
+
+Maint:
+
+  - Deprecate 'catalog_item' for 'vapp_template_name' in config.
+  - Deprecate 'catalog' for 'catalog_name' in config.
+
 ## 0.0.5 (2014-05-14)
 
 Features:

data/README.md

@@ -43,6 +43,12 @@ Or install it yourself as:
 
 `vcloud-launch node.yaml`
 
+## Configuration schemas
+
+Configuration schemas can be found in [`lib/vcloud/launcher/schema/`][schema].
+
+[schema]: /lib/vcloud/launcher/schema
+
 ## Credentials
 
 vCloud Launcher is based around [fog](http://fog.io/). To use it you'll need to give it
@@ -125,45 +131,5 @@ Run the integration tests minus some that are very slow:
     bundle exec rake integration:quick
 
 You need access to a suitable vCloud Director organization to run the
-integration tests. It is not necessarily safe to run them against an existing
-environment, unless care is taken with the entities being tested.
-
-The easiest thing to do is create a local shell script called
-`vcloud_env.sh` and set the contents:
-
-    export FOG_CREDENTIAL=test
-    export VCLOUD_VDC_NAME="Name of the VDC"
-    export VCLOUD_CATALOG_NAME="catalog-name"
-    export VCLOUD_TEMPLATE_NAME="name-of-template"
-    export VCLOUD_NETWORK1_NAME="name-of-primary-network"
-    export VCLOUD_NETWORK2_NAME="name-of-secondary-network"
-    export VCLOUD_NETWORK1_IP="ip-on-primary-network"
-    export VCLOUD_NETWORK2_IP="ip-on-secondary-network"
-    export VCLOUD_STORAGE_PROFILE_NAME="storage-profile-name"
-    export VCLOUD_EDGE_GATEWAY="name-of-edge-gateway-in-vdc"
-
-Then run this before you run the integration tests.
-
-### Specific integration tests
-
-#### Storage profile tests
-
-There is an integration test to check storage profile behaviour, but it requires
-a lot of set-up so it is not called by the rake task. If you wish to run it you
-need access to an environment that has two VDCs, each one containing a storage
-profile with the same name. This named storage profile needs to be different
-from the default storage profile.
-
-You will need to set the following environment variables:
-
-      export VDC_NAME_1="Name of the first vDC"
-      export VDC_NAME_2="Name of the second vDC"
-      export VCLOUD_CATALOG_NAME="Catalog name" # Can be the same as above settings if appropriate
-      export VCLOUD_TEMPLATE_NAME="Template name" # Can be the same as above setting if appropriate
-      export VCLOUD_STORAGE_PROFILE_NAME="Storage profile name" # This needs to exist in both vDCs
-      export VDC_1_STORAGE_PROFILE_HREF="Href of the named storage profile in vDC 1"
-      export VDC_2_STORAGE_PROFILE_HREF="Href of the named storage profile in vDC 2"
-      export DEFAULT_STORAGE_PROFILE_NAME="Default storage profile name"
-      export DEFAULT_STORAGE_PROFILE_HREF="Href of default storage profile"
-
-To run this test: `rspec spec/integration/launcher/storage_profile_integration_test.rb`
+integration tests. See the [integration tests README](/spec/integration/README.md) for
+further details.

data/examples/vcloud-launch/complete_vapp_config.yaml

@@ -29,8 +29,8 @@
 vapps:
   - name: 'vapp-example-complete'
     vdc_name: 'Our vDC 1'
-    catalog: 'our-catalog'
-    catalog_item: 'our-template-vapp'
+    catalog_name: 'our-catalog'
+    vapp_template_name: 'our-template-vapp'
     vm:
       hardware_config:
         memory: 4096
@@ -39,6 +39,7 @@ vapps:
       - name: 'FrontendNetwork'
         ip_address: '192.0.2.10'
       - name: 'BackendNetwork'
+        allocation_mode: 'pool'
       extra_disks:
       - name: logs-disk
         size: 10240

data/examples/vcloud-launch/minimal_vapp_config.yaml

@@ -7,5 +7,5 @@
 vapps:
   - name: 'vapp-example-1'
     vdc_name: 'vDC Example [1]'
-    catalog: 'example-catalog'
-    catalog_item: 'our-vapp-template'
+    catalog_name: 'example-catalog'
+    vapp_template_name: 'our-vapp-template'

data/examples/vcloud-launch/multiple_vapps_simple.yaml

@@ -10,8 +10,8 @@ vapps:
 
 - name: vapp-example-1
   vdc_name: "Our VDC1"
-  catalog: our-catalog
-  catalog_item: our-vapp-template
+  catalog_name: our-catalog
+  vapp_template_name: our-vapp-template
   vm:
     hardware_config:
       memory: '4096'
@@ -22,8 +22,8 @@ vapps:
 
 - name: vapp-example-2
   vdc_name: "Our VDC1"
-  catalog: our-catalog
-  catalog_item: our-vapp-template
+  catalog_name: our-catalog
+  vapp_template_name: our-vapp-template
   vm:
     hardware_config:
       memory: '4096'
@@ -34,8 +34,8 @@ vapps:
 
 - name: vapp-example-3
   vdc_name: "Our VDC1"
-  catalog: our-catalog
-  catalog_item: our-vapp-template
+  catalog_name: our-catalog
+  vapp_template_name: our-vapp-template
   vm:
     hardware_config:
       memory: '4096'

data/examples/vcloud-launch/yaml_anchors_example.yaml

@@ -10,7 +10,7 @@
 ---
 anchors:
 
-- &VAPP_TEMPLATE our-vapp-template
+- &VAPP_TEMPLATE_NAME our-vapp-template
 
 - &ENVIRONMENT example
 - &VDC_NAME    example-vdc
@@ -20,18 +20,18 @@ anchors:
 
 - &BASE_VAPP
   vdc_name: *VDC_NAME
-  catalog:  our-catalog
-  catalog_item: *VAPP_TEMPLATE
+  catalog_name:  our-catalog
+  vapp_template_name: *VAPP_TEMPLATE_NAME
 
 - &BASE_VM
   metadata:
     environment:   *ENVIRONMENT
-    vapp_template: *VAPP_TEMPLATE
+    vapp_template: *VAPP_TEMPLATE_NAME
   bootstrap: &BASE_VM_BOOTSTRAP
     script_path: basic_preamble.erb
     vars: &BASE_VM_VARS
       environment: *ENVIRONMENT
-      vapp_template: *VAPP_TEMPLATE
+      vapp_template: *VAPP_TEMPLATE_NAME
       vdc: *VDC_NAME
 
 - &SMALL_VM

data/jenkins.sh

@@ -1,8 +1,16 @@
 #!/bin/bash -x
 set -e
+
+git clean -ffdx
+
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 bundle exec rake
 
+# Obtain the integration test parameters
+git clone git@github.gds:gds/vcloud-tools-testing-config.git
+mv vcloud-tools-testing-config/vcloud_tools_testing_config.yaml spec/integration/
+rm -rf vcloud-tools-testing-config
+
 RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration:all
 
 bundle exec rake publish_gem

data/jenkins_integration_tests.sh

@@ -1,4 +1,13 @@
 #!/bin/bash -x
 set -e
+
+git clean -ffdx
+
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
+
+# Obtain the integration test parameters
+git clone git@github.gds:gds/vcloud-tools-testing-config.git
+mv vcloud-tools-testing-config/vcloud_tools_testing_config.yaml spec/integration/
+rm -rf vcloud-tools-testing-config
+
 RUBYOPT="-r ./tools/fog_credentials" bundle exec rake integration:all

data/lib/vcloud/launcher.rb

@@ -1,6 +1,10 @@
 require 'vcloud/fog'
 require 'vcloud/core'
 
+require 'vcloud/launcher/schema/vm'
+require 'vcloud/launcher/schema/vapp'
+require 'vcloud/launcher/schema/launcher_vapps'
+
 require 'vcloud/launcher/launch'
 require 'vcloud/launcher/vm_orchestrator'
 require 'vcloud/launcher/vapp_orchestrator'

data/lib/vcloud/launcher/launch.rb

@@ -8,7 +8,7 @@ module Vcloud
 
       def run(config_file = nil, cli_options = {})
         set_logging_level(cli_options)
-        config = @config_loader.load_config(config_file, config_schema)
+        config = @config_loader.load_config(config_file, Vcloud::Launcher::Schema::LAUNCHER_VAPPS)
         config[:vapps].each do |vapp_config|
           Vcloud::Core.logger.info("Provisioning vApp #{vapp_config[:name]}.")
           begin
@@ -24,22 +24,6 @@ module Vcloud
         end
       end
 
-      def config_schema
-        {
-          type: 'hash',
-          allowed_empty: false,
-          permit_unknown_parameters: true,
-          internals: {
-            vapps: {
-            type: 'array',
-            required: false,
-            allowed_empty: true,
-            each_element_is: ::Vcloud::Launcher::VappOrchestrator.provision_schema
-          },
-        }
-      }
-      end
-
       def set_logging_level(cli_options)
         if cli_options[:verbose]
           Vcloud::Core.logger.level = Logger::DEBUG

data/lib/vcloud/launcher/schema/launcher_vapps.rb

@@ -0,0 +1,21 @@
+module Vcloud
+  module Launcher
+    module Schema
+
+      LAUNCHER_VAPPS = {
+        type: 'hash',
+        allowed_empty: false,
+        permit_unknown_parameters: true,
+        internals: {
+          vapps: {
+            type: 'array',
+            required: false,
+            allowed_empty: true,
+            each_element_is: Vcloud::Launcher::Schema::VAPP,
+          },
+        },
+      }
+
+    end
+  end
+end

data/lib/vcloud/launcher/schema/vapp.rb

@@ -0,0 +1,22 @@
+module Vcloud
+  module Launcher
+    module Schema
+
+      VAPP = {
+        type: 'hash',
+        required: true,
+        allowed_empty: false,
+        internals: {
+          name:               { type: 'string', required: true, allowed_empty: false },
+          vdc_name:           { type: 'string', required: true, allowed_empty: false },
+          catalog:            { type: 'string', deprecated_by: 'catalog_name', allowed_empty: false },
+          catalog_name:       { type: 'string', required: true, allowed_empty: false },
+          catalog_item:       { type: 'string', deprecated_by: 'vapp_template_name', allowed_empty: false },
+          vapp_template_name: { type: 'string', required: true, allowed_empty: false },
+          vm:                 Vcloud::Launcher::Schema::VM,
+        },
+      }
+
+    end
+  end
+end

data/lib/vcloud/launcher/schema/vm.rb

@@ -0,0 +1,63 @@
+module Vcloud
+  module Launcher
+    module Schema
+
+      VM = {
+        type: 'hash',
+        required: false,
+        allowed_empty: false,
+        internals: {
+          network_connections: {
+            type: 'array',
+            required: false,
+            each_element_is: {
+              type: 'hash',
+              internals: {
+                name: { type: 'string', required: true },
+                ip_address: { type: 'ip_address', required: false },
+                allocation_mode: { type: 'string', required: false },
+              },
+            },
+          },
+          storage_profile: { type: 'string', required: false },
+          hardware_config: {
+            type: 'hash',
+            required: false,
+            internals: {
+              cpu: { type: 'string_or_number', required: false },
+              memory: { type: 'string_or_number', required: false },
+            },
+          },
+          extra_disks: {
+            type: 'array',
+            required: false,
+            allowed_empty: false,
+            each_element_is: {
+              type: 'hash',
+              internals: {
+                name: { type: 'string', required: false },
+                size: { type: 'string_or_number', required: false },
+              },
+            },
+          },
+          bootstrap:   {
+            type: 'hash',
+            required: false,
+            allowed_empty: false,
+            internals: {
+              script_path: { type: 'string', required: false },
+              script_post_processor: { type: 'string', required: false },
+              vars: { type: 'hash', required: false, allowed_empty: true },
+            },
+          },
+          metadata: {
+            type: 'hash',
+            required: false,
+            allowed_empty: true,
+          },
+        },
+      }
+
+    end
+  end
+end

data/lib/vcloud/launcher/vapp_orchestrator.rb

@@ -11,7 +11,9 @@ module Vcloud
           return vapp_existing
         end
 
-        template = Vcloud::Core::VappTemplate.get(vapp_config[:catalog], vapp_config[:catalog_item])
+        template_name = vapp_config[:vapp_template_name] || vapp_config[:catalog_item]
+        catalog_name = vapp_config[:catalog_name] || vapp_config[:catalog]
+        template = Vcloud::Core::VappTemplate.get(template_name, catalog_name)
         template_id = template.id
 
         network_names = extract_vm_networks(vapp_config)
@@ -21,21 +23,6 @@ module Vcloud
         vapp
       end
 
-      def self.provision_schema
-        {
-          type: 'hash',
-          required: true,
-          allowed_empty: false,
-          internals: {
-            name:      { type: 'string', required: true, allowed_empty: false },
-            vdc_name:  { type: 'string', required: true, allowed_empty: false },
-            catalog:   { type: 'string', required: true, allowed_empty: false },
-            catalog_item: { type: 'string', required: true, allowed_empty: false },
-            vm: Vcloud::Launcher::VmOrchestrator.customize_schema,
-          }
-        }
-      end
-
       def self.extract_vm_networks(config)
         if (config[:vm] && config[:vm][:network_connections])
           config[:vm][:network_connections].collect { |h| h[:name] }

data/lib/vcloud/launcher/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Launcher
-    VERSION = '0.0.5'
+    VERSION = '0.1.0'
   end
 end

data/lib/vcloud/launcher/vm_orchestrator.rb

@@ -1,6 +1,7 @@
 module Vcloud
   module Launcher
     class VmOrchestrator
+
       def initialize fog_vm, vapp
         vm_id = fog_vm[:href].split('/').last
         @vm = Core::Vm.new(vm_id, vapp)
@@ -23,63 +24,6 @@ module Vcloud
         )
       end
 
-      def self.customize_schema
-        {
-          type: 'hash',
-          required: false,
-          allowed_empty: false,
-          internals: {
-            network_connections: {
-              type: 'array',
-              required: false,
-              each_element_is: {
-                type: 'hash',
-                internals: {
-                  name: { type: 'string', required: true },
-                  ip_address: { type: 'ip_address', required: false },
-                },
-              },
-            },
-            storage_profile: { type: 'string', required: false },
-            hardware_config: {
-              type: 'hash',
-              required: false,
-              internals: {
-                cpu: { type: 'string_or_number', required: false },
-                memory: { type: 'string_or_number', required: false },
-              },
-            },
-            extra_disks: {
-              type: 'array',
-              required: false,
-              allowed_empty: false,
-              each_element_is: {
-                type: 'hash',
-                internals: {
-                  name: { type: 'string', required: false },
-                  size: { type: 'string_or_number', required: false },
-                },
-              },
-            },
-            bootstrap:   {
-              type: 'hash',
-              required: false,
-              allowed_empty: false,
-              internals: {
-                script_path: { type: 'string', required: false },
-                script_post_processor: { type: 'string', required: false },
-                vars: { type: 'hash', required: false, allowed_empty: true },
-              },
-            },
-            metadata: {
-              type: 'hash',
-              required: false,
-              allowed_empty: true,
-            },
-          },
-        }
-      end
-
     end
   end
 end