bosh_openstack_cpi 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5afd1fc53c82628dd16ed49daf0c21a2f49adec0
-  data.tar.gz: 9cc83d556ea194f1447f2f3c896ca85e4c54c8ee
+  metadata.gz: f2f6bbe71e06f095631885a4dc2d09b26c86ced6
+  data.tar.gz: 4cf9d421658bde0061f215d0c6defdb9911c2390
 SHA512:
-  metadata.gz: 59c6e5fc8103606d286a3651b6d8a3827322a72b46e730a3d67b0b81e8d9d3545f0bbd8930e6adbbfcd8417e61de19f08b4fdfd2598db0eec949e595f1f9e633
-  data.tar.gz: 636b0ccdaca9d49bfb198acfd5e716411a30a88308cee08189651e9152b59802a8ea2af84b8538339db402528661510977b5cdad28a3fc66f8c668c757debaf4
+  metadata.gz: bac11fd8d51fd5d2c3abbad25ddf117ef512d54cda9ded5626718e04f7a5a1c2dcb00b99f606034b1265ec156552a8163e1d5bc4ca7d3b82aea5ce9126d411b2
+  data.tar.gz: ff6a9d7776a8ad6a40a87ec5adb9f718e71141f0c69007d97e5fc69e8efa2e3aa5bb3c7e4bca6d10cd764b28398d1f45607b874b9c8e458a655b67da40e1fb8d

data/lib/cloud/openstack/cloud.rb

@@ -49,24 +49,18 @@ module Bosh::OpenStackCloud
       @use_dhcp = @openstack_properties.fetch('use_dhcp', true)
 
       unless @openstack_properties['auth_url'].match(/\/tokens$/)
-        @openstack_properties['auth_url'] = @openstack_properties['auth_url'] + '/tokens'
+        if is_v3
+          @openstack_properties['auth_url'] += '/auth/tokens'
+        else
+          @openstack_properties['auth_url'] += '/tokens'
+        end
       end
 
       @openstack_properties['connection_options'] ||= {}
 
       @extra_connection_options = {'instrumentor' => Bosh::OpenStackCloud::ExconLoggingInstrumentor}
 
-      openstack_params = {
-        :provider => 'OpenStack',
-        :openstack_auth_url => @openstack_properties['auth_url'],
-        :openstack_username => @openstack_properties['username'],
-        :openstack_api_key => @openstack_properties['api_key'],
-        :openstack_tenant => @openstack_properties['tenant'],
-        :openstack_domain_name => @openstack_properties['domain'],
-        :openstack_region => @openstack_properties['region'],
-        :openstack_endpoint_type => @openstack_properties['endpoint_type'],
-        :connection_options => @openstack_properties['connection_options'].merge(@extra_connection_options)
-      }
+      @openstack_params = openstack_params
 
       connect_retry_errors = [Excon::Errors::GatewayTimeout, Excon::Errors::SocketError]
 
@@ -79,8 +73,10 @@ module Bosh::OpenStackCloud
       begin
         Bosh::Common.retryable(@connect_retry_options) do |tries, error|
           @logger.error("Failed #{tries} times, last failure due to: #{error.inspect}") unless error.nil?
-          @openstack = Fog::Compute.new(openstack_params)
+          @openstack = Fog::Compute.new(@openstack_params)
         end
+      rescue Excon::Errors::SocketError => e
+        cloud_error(socket_error_msg + "#{e.message}")
       rescue Bosh::Common::RetryCountExceeded, Excon::Errors::ClientError, Excon::Errors::ServerError
         cloud_error('Unable to connect to the OpenStack Compute API. Check task debug log for details.')
       end
@@ -89,23 +85,13 @@ module Bosh::OpenStackCloud
         @openstack,
         @openstack_properties["ignore_server_availability_zone"])
 
-      glance_params = {
-        :provider => 'OpenStack',
-        :openstack_auth_url => @openstack_properties['auth_url'],
-        :openstack_username => @openstack_properties['username'],
-        :openstack_api_key => @openstack_properties['api_key'],
-        :openstack_tenant => @openstack_properties['tenant'],
-        :openstack_domain_name => @openstack_properties['domain'],
-        :openstack_region => @openstack_properties['region'],
-        :openstack_endpoint_type => @openstack_properties['endpoint_type'],
-        :connection_options => @openstack_properties['connection_options'].merge(@extra_connection_options)
-      }
-
       begin
         Bosh::Common.retryable(@connect_retry_options) do |tries, error|
           @logger.error("Failed #{tries} times, last failure due to: #{error.inspect}") unless error.nil?
-          @glance = Fog::Image.new(glance_params)
+          @glance = Fog::Image.new(@openstack_params)
         end
+      rescue Excon::Errors::SocketError => e
+        cloud_error(socket_error_msg + "#{e.message}")
       rescue Bosh::Common::RetryCountExceeded, Excon::Errors::ClientError, Excon::Errors::ServerError
         cloud_error('Unable to connect to the OpenStack Image Service API. Check task debug log for details.')
       end
@@ -113,6 +99,10 @@ module Bosh::OpenStackCloud
       @metadata_lock = Mutex.new
     end
 
+    def auth_url
+      @openstack_properties['auth_url']
+    end
+
     ##
     # Creates a new OpenStack Image using stemcell image. It requires access
     # to the OpenStack Glance service.
@@ -222,12 +212,21 @@ module Bosh::OpenStackCloud
 
         network_configurator = NetworkConfigurator.new(network_spec)
 
+        network_spec_security_groups = network_configurator.security_groups
+        resource_pool_spec_security_groups = resource_pool_spec_security_groups(resource_pool)
+
+        if network_spec_security_groups.size > 0 && resource_pool_spec_security_groups.size > 0
+          cloud_error('Cannot define security groups in both network and resource pool.')
+        end
+
         openstack_security_groups = with_openstack { @openstack.security_groups }.collect { |sg| sg.name }
-        security_groups = network_configurator.security_groups(@default_security_groups)
-        security_groups.each do |sg|
+        network_security_groups = network_configurator.security_groups(@default_security_groups)
+        security_groups_to_be_used = resource_pool_spec_security_groups.size > 0 ? resource_pool_spec_security_groups : network_security_groups
+
+        security_groups_to_be_used.each do |sg|
           cloud_error("Security group `#{sg}' not found") unless openstack_security_groups.include?(sg)
         end
-        @logger.debug("Using security groups: `#{security_groups.join(', ')}'")
+        @logger.debug("Using security groups: `#{security_groups_to_be_used.join(', ')}'")
 
         nics = network_configurator.nics
         @logger.debug("Using NICs: `#{nics.join(', ')}'")
@@ -261,9 +260,7 @@ module Bosh::OpenStackCloud
         @logger.debug("Using flavor: `#{resource_pool['instance_type']}'")
 
         keyname = resource_pool['key_name'] || @default_key_name
-        keypair = with_openstack { @openstack.key_pairs.find { |k| k.name == keyname } }
-        cloud_error("Key-pair `#{keyname}' not found") if keypair.nil?
-        @logger.debug("Using key-pair: `#{keypair.name}' (#{keypair.fingerprint})")
+        validate_key_exists(keyname)
 
         use_config_drive = !!@openstack_properties.fetch("config_drive", nil)
 
@@ -275,8 +272,8 @@ module Bosh::OpenStackCloud
           :name => server_name,
           :image_ref => image.id,
           :flavor_ref => flavor.id,
-          :key_name => keypair.name,
-          :security_groups => security_groups,
+          :key_name => keyname,
+          :security_groups => security_groups_to_be_used,
           :os_scheduler_hints => resource_pool['scheduler_hints'],
           :nics => nics,
           :config_drive => use_config_drive,
@@ -302,7 +299,25 @@ module Bosh::OpenStackCloud
         end
 
         @logger.debug("Using boot parms: `#{server_params.inspect}'")
-        server = with_openstack { @openstack.servers.create(server_params) }
+        begin
+          server = with_openstack { @openstack.servers.create(server_params) }
+        rescue Excon::Errors::Timeout => e
+          @logger.debug(e.backtrace)
+          cloud_error_message = "VM creation with name '#{server_params[:name]}' received a timeout. " +
+                                "The VM might still have been created by OpenStack.\nOriginal message: "
+          raise Bosh::Clouds::VMCreationFailed.new(false), cloud_error_message + e.message
+        rescue Excon::Errors::NotFound, Fog::Compute::OpenStack::NotFound => e
+          not_existing_net_ids = not_existing_net_ids(nics)
+          if not_existing_net_ids.empty?
+            raise e
+          else
+            @logger.debug(e.backtrace)
+            cloud_error_message = "VM creation with name '#{server_params[:name]}' failed. Following network " +
+            "IDs are not existing or not accessible from this project: '#{not_existing_net_ids.join(",")}'. " +
+            "Make sure you do not use subnet IDs"
+            raise Bosh::Clouds::VMCreationFailed.new(false), cloud_error_message
+          end
+        end
 
         @logger.info("Creating new server `#{server.id}'...")
         begin
@@ -331,6 +346,22 @@ module Bosh::OpenStackCloud
       end
     end
 
+    def not_existing_net_ids(nics)
+      result = []
+      begin
+        network = connect_to_network_service
+        nics.each do |nic|
+          if nic["net_id"]
+            result << nic["net_id"] unless network.networks.get(nic["net_id"])
+          end
+        end
+      rescue Bosh::Clouds::CloudError => e
+        @logger.debug(e.backtrace)
+      end
+      result
+    end
+
+
     ##
     # Terminates an OpenStack server and waits until it reports as terminated
     #
@@ -387,22 +418,9 @@ module Bosh::OpenStackCloud
     # @raise [Bosh::Clouds:NotSupported] If there's a network change that requires the recreation of the VM
     def configure_networks(server_id, network_spec)
       with_thread_name("configure_networks(#{server_id}, ...)") do
-        @logger.info("Configuring `#{server_id}' to use the following " \
-                     "network settings: #{network_spec.pretty_inspect}")
-        network_configurator = NetworkConfigurator.new(network_spec)
-
-        server = with_openstack { @openstack.servers.get(server_id) }
-        cloud_error("Server `#{server_id}' not found") unless server
-
-        compare_security_groups(server, network_configurator.security_groups(@default_security_groups))
-
-        compare_private_ip_addresses(server, network_configurator.private_ips)
-
-        network_configurator.configure(@openstack, server)
+        raise Bosh::Clouds::NotSupported,
+          'network configuration change requires VM recreation: %s' % [network_spec]
 
-        update_agent_settings(server) do |settings|
-          settings['networks'] = agent_network_spec(network_spec)
-        end
       end
     end
 
@@ -662,6 +680,10 @@ module Bosh::OpenStackCloud
       @az_provider.select(volumes, resource_pool_az)
     end
 
+    def is_v3
+      @options['openstack']['auth_url'].match(/\/v3(?=\/|$)/)
+    end
+
     private
 
     ##
@@ -670,22 +692,10 @@ module Bosh::OpenStackCloud
     #
     #
     def connect_to_volume_service
-      volume_params = {
-        :provider => "OpenStack",
-        :openstack_auth_url => @openstack_properties['auth_url'],
-        :openstack_username => @openstack_properties['username'],
-        :openstack_api_key => @openstack_properties['api_key'],
-        :openstack_tenant => @openstack_properties['tenant'],
-        :openstack_domain_name => @openstack_properties['domain'],
-        :openstack_region => @openstack_properties['region'],
-        :openstack_endpoint_type => @openstack_properties['endpoint_type'],
-        :connection_options => @openstack_properties['connection_options'].merge(@extra_connection_options)
-      }
-
       begin
         Bosh::Common.retryable(@connect_retry_options) do |tries, error|
           @logger.error("Failed #{tries} times, last failure due to: #{error.inspect}") unless error.nil?
-          @volume ||= Fog::Volume.new(volume_params)
+          @volume ||= Fog::Volume.new(@openstack_params)
         end
       rescue Bosh::Common::RetryCountExceeded, Excon::Errors::ClientError, Excon::Errors::ServerError => e
         cloud_error("Unable to connect to the OpenStack Volume API: #{e.message}. Check task debug log for details.")
@@ -694,6 +704,32 @@ module Bosh::OpenStackCloud
       @volume
     end
 
+    def connect_to_network_service
+      begin
+        Bosh::Common.retryable(@connect_retry_options) do |tries, error|
+          @logger.error("Failed #{tries} times, last failure due to: #{error.inspect}") unless error.nil?
+          network ||= Fog::Network.new(@openstack_params)
+        end
+      rescue Bosh::Common::RetryCountExceeded, Excon::Errors::ClientError, Excon::Errors::ServerError => e
+        cloud_error("Unable to connect to the OpenStack Network API: #{e.message}. Check task debug log for details.")
+      end
+    end
+
+    def openstack_params
+      {
+          :provider => 'OpenStack',
+          :openstack_auth_url => @openstack_properties['auth_url'],
+          :openstack_username => @openstack_properties['username'],
+          :openstack_api_key => @openstack_properties['api_key'],
+          :openstack_tenant => @openstack_properties['tenant'],
+          :openstack_project_name => @openstack_properties['project'],
+          :openstack_domain_name => @openstack_properties['domain'],
+          :openstack_region => @openstack_properties['region'],
+          :openstack_endpoint_type => @openstack_properties['endpoint_type'],
+          :connection_options => @openstack_properties['connection_options'].merge(@extra_connection_options)
+      }
+    end
+
     ##
     # Generates an unique name
     #
@@ -893,42 +929,6 @@ module Bosh::OpenStackCloud
       end
     end
 
-    ##
-    # Compares actual server security groups with those specified at the network spec
-    #
-    # @param [Fog::Compute::OpenStack::Server] server OpenStack server
-    # @param [Array] specified_sg_names Security groups specified at the network spec
-    # @return [void]
-    # @raise [Bosh::Clouds:NotSupported] If the security groups change, we need to recreate the VM as you can't
-    # change the security group of a running server, so we need to send the InstanceUpdater a request to do it for us
-    def compare_security_groups(server, specified_sg_names)
-      actual_sg_names = with_openstack { server.security_groups }.collect { |sg| sg.name }
-
-      unless actual_sg_names.sort == specified_sg_names.sort
-        raise Bosh::Clouds::NotSupported,
-              'security groups change requires VM recreation: %s to %s' %
-              [actual_sg_names.join(', '), specified_sg_names.join(', ')]
-      end
-    end
-
-    ##
-    # Compares actual server private IP addresses with the IP address specified at the network spec
-    #
-    # @param [Fog::Compute::OpenStack::Server] server OpenStack server
-    # @param [Array] specified_ip_addresses IP addresses specified at the network spec (if Manual network)
-    # @return [void]
-    # @raise [Bosh::Clouds:NotSupported] If the IP address change, we need to recreate the VM as you can't
-    # change the IP address of a running server, so we need to send the InstanceUpdater a request to do it for us
-    def compare_private_ip_addresses(server, specified_ip_addresses)
-      actual_ip_addresses = with_openstack { server.private_ip_addresses }
-
-      unless specified_ip_addresses.empty? || actual_ip_addresses.sort == specified_ip_addresses.sort
-        raise Bosh::Clouds::NotSupported,
-              'IP address change requires VM recreation: %s to %s' %
-              [actual_ip_addresses.join(', '), specified_ip_addresses.join(', ')]
-      end
-    end
-
     ##
     # Checks if the OpenStack flavor has ephemeral disk
     #
@@ -973,32 +973,62 @@ module Bosh::OpenStackCloud
     # @return [void]
     # @raise [ArgumentError] if options are not valid
     def validate_options
-      schema = Membrane::SchemaParser.parse do
-        {
-          'openstack' => {
-            'auth_url' => String,
-            'username' => String,
-            'api_key' => String,
-            'tenant' => String,
-            optional('domain') => String,
-            optional('region') => String,
-            optional('endpoint_type') => String,
-            optional('state_timeout') => Numeric,
-            optional('stemcell_public_visibility') => enum(String, bool),
-            optional('connection_options') => Hash,
-            optional('boot_from_volume') => bool,
-            optional('default_key_name') => String,
-            optional('default_security_groups') => [String],
-            optional('wait_resource_poll_interval') => Integer,
-            optional('config_drive') => enum('disk', 'cdrom'),
-          },
-          'registry' => {
-            'endpoint' => String,
-            'user' => String,
-            'password' => String,
-          },
-          optional('agent') => Hash,
-        }
+      if @options['openstack'] && is_v3
+        schema = Membrane::SchemaParser.parse do
+          {
+            'openstack' => {
+              'auth_url' => String,
+              'username' => String,
+              'api_key' => String,
+              'project' => String,
+              'domain' => String,
+              optional('region') => String,
+              optional('endpoint_type') => String,
+              optional('state_timeout') => Numeric,
+              optional('stemcell_public_visibility') => enum(String, bool),
+              optional('connection_options') => Hash,
+              optional('boot_from_volume') => bool,
+              optional('default_key_name') => String,
+              optional('default_security_groups') => [String],
+              optional('wait_resource_poll_interval') => Integer,
+              optional('config_drive') => enum('disk', 'cdrom'),
+            },
+            'registry' => {
+              'endpoint' => String,
+              'user' => String,
+              'password' => String,
+            },
+            optional('agent') => Hash,
+          }
+        end
+      else
+        schema = Membrane::SchemaParser.parse do
+          {
+            'openstack' => {
+              'auth_url' => String,
+              'username' => String,
+              'api_key' => String,
+              'tenant' => String,
+              optional('domain') => String,
+              optional('region') => String,
+              optional('endpoint_type') => String,
+              optional('state_timeout') => Numeric,
+              optional('stemcell_public_visibility') => enum(String, bool),
+              optional('connection_options') => Hash,
+              optional('boot_from_volume') => bool,
+              optional('default_key_name') => String,
+              optional('default_security_groups') => [String],
+              optional('wait_resource_poll_interval') => Integer,
+              optional('config_drive') => enum('disk', 'cdrom'),
+            },
+            'registry' => {
+              'endpoint' => String,
+              'user' => String,
+              'password' => String,
+            },
+            optional('agent') => Hash,
+          }
+        end
       end
       schema.validate(@options)
     rescue Membrane::SchemaValidationError => e
@@ -1055,5 +1085,26 @@ module Bosh::OpenStackCloud
         @logger.warn("Failed to destroy server: #{delete_server_error.inspect}\n#{delete_server_error.backtrace.join('\n')}")
       end
     end
+
+    def resource_pool_spec_security_groups(resource_pool_spec)
+      if resource_pool_spec && resource_pool_spec.has_key?("security_groups")
+        unless resource_pool_spec["security_groups"].is_a?(Array)
+          raise ArgumentError, "security groups must be an Array"
+        end
+        return resource_pool_spec["security_groups"]
+      end
+
+      []
+    end
+
+    def validate_key_exists(keyname)
+      keypair = with_openstack { @openstack.key_pairs.find { |k| k.name == keyname } }
+      cloud_error("Key-pair `#{keyname}' not found") if keypair.nil?
+      @logger.debug("Using key-pair: `#{keypair.name}' (#{keypair.fingerprint})")
+    end
+
+    def socket_error_msg
+      "Unable to connect to the OpenStack Keystone API #{@openstack_params[:openstack_auth_url]}\n"
+    end
   end
 end

data/lib/cloud/openstack/helpers.rb

@@ -26,17 +26,24 @@ module Bosh::OpenStackCloud
         yield
 
       rescue Excon::Errors::RequestEntityTooLarge => e
-        # If we find a rate limit error, parse message, wait, and retry
+        message = "OpenStack API Request Entity Too Large error: \nCheck task debug log for details."
         overlimit = parse_openstack_response(e.response, "overLimit", "overLimitFault")
-        unless overlimit.nil? || retries >= MAX_RETRIES
-          wait_time = overlimit["retryAfter"] || e.response.headers["Retry-After"] || DEFAULT_RETRY_TIMEOUT
+
+        if overlimit
+          message.insert(46, overlimit["message"])
           details = "#{overlimit["message"]} - #{overlimit["details"]}"
-          @logger.debug("OpenStack API Over Limit (#{details}), waiting #{wait_time} seconds before retrying") if @logger
-          sleep(wait_time.to_i)
-          retries += 1
-          retry
+
+          if retries < MAX_RETRIES
+            wait_time = overlimit["retryAfter"] || e.response.headers["Retry-After"] || DEFAULT_RETRY_TIMEOUT
+            @logger.debug("OpenStack API Over Limit (#{details}), waiting #{wait_time} seconds before retrying") if @logger
+            sleep(wait_time.to_i)
+            retries += 1
+            retry
+          end
+        else
+          message.insert(46, e.response.body)
         end
-        cloud_error("OpenStack API Request Entity Too Large error. Check task debug log for details.", e)
+        cloud_error(message, e)
 
       rescue Excon::Errors::ServiceUnavailable => e
         unless retries >= MAX_RETRIES

data/lib/cloud/openstack/network_configurator.rb

@@ -110,7 +110,7 @@ module Bosh::OpenStackCloud
     #
     # @param [Array] default Default security groups
     # @return [Array] security groups
-    def security_groups(default)
+    def security_groups(default = nil)
       if @security_groups.empty? && default
         default
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bosh_openstack_cpi
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Piston Cloud Computing / VMware
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bosh_common
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +116,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- USAGE.md
 - bin/bosh_openstack_console
 - bin/openstack_cpi
 - lib/bosh_openstack_cpi.rb

data/README.md

@@ -1,37 +0,0 @@
-# OpenStack BOSH Cloud Provider Interface
-
-## Bringing the world’s most popular open source platform-as-a-service to the world’s most popular open source infrastructure-as-a-service platform
-
-This repo contains software designed to manage the deployment of Cloud Foundry on top of OpenStack, using Cloud Foundry BOSH. Say what?
-
-## OpenStack
-
-OpenStack is a collection of interrelated open source projects that, together, form a pluggable framework for building massively-scalable infrastructure as a service clouds. OpenStack represents the world's largest and fastest-growing open cloud community, a global collaboration of over 150 leading companies.
-
-## Cloud Foundry
-
-Cloud Foundry is the leading open source platform-as-a-service (PaaS) offering with a fast growing ecosystem and strong enterprise demand.
-
-## BOSH
-
-Cloud Foundry BOSH is an open source tool chain for release engineering, deployment and lifecycle management of large scale distributed services. In this manual we describe the architecture, topology, configuration, and use of BOSH, as well as the structure and conventions used in packaging and deployment.
-
-## OpenStack and Cloud Foundry, Together using BOSH
-
-Cloud Foundry BOSH defines a Cloud Provider Interface API that enables platform-as-a-service deployment across multiple cloud providers - initially VMWare's vSphere and AWS. Piston Cloud has partnered with VMWare to provide a CPI for OpenStack, opening up Cloud Foundry deployment to an entire ecosystem of public and private OpenStack deployments.
-
-Using a popular cloud-services client written in Ruby, the OpenStack CPI manages the deployment of a set of virtual machines and enables applications to be deployed dynamically using Cloud Foundry. A common image, called a stem-cell, allows Cloud Foundry BOSH to rapidly build new virtual machines enabling rapid scale-out.
-
-We've partnered with VMWare to deliver this project, because the leading open-source platform-as-a-service offering should work seamlessly with deployments of the leading open-source infrastructure-as-a-service project. The work being done to develop this CPI, will enable customers of any OpenStack cloud to use Cloud Foundry to accelerate development of cloud applications and drive value by working against a common service API.
-
-## Piston Cloud Computing, Inc.
-
-Piston Cloud Computing, Inc. is the enterprise OpenStack™ company. Founded in early 2011 by technical team leads from NASA and Rackspace®, Piston Cloud is built around OpenStack, the fastest-growing, massively scalable cloud framework. Piston Enterprise OS™ (pentOS™) is the first fully- automated bare-metal cloud operating system built on OpenStack and the first OpenStack distribution specifically focused on security and easy operation of enterprise private clouds for the enterprise.  
-
-## Legal Stuff
-
-This project, as well as OpenStack and Cloud Foundry, are Apache2-licensed Open Source.
-
-VMware and Cloud Foundry are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions.
-
-OpenStack is a registered trademark of OpenStack, LLC.

data/USAGE.md

@@ -1,143 +0,0 @@
-# BOSH OpenStack Cloud Provider Interface
-# Copyright (c) 2009-2013 VMware, Inc.
-# Copyright (c) 2012 Piston Cloud Computing, Inc.
-
-For online documentation see: http://rubydoc.info/gems/bosh_openstack_cpi/
-
-## Options
-
-These options are passed to the OpenStack CPI when it is instantiated.
-
-### OpenStack options
-
-The registry options are passed to the Openstack CPI by the BOSH director based on the settings in `director.yml`:
-
-* `auth_url` (required)
-  URL of the OpenStack Identity endpoint to connect to
-* `username` (required)
-  OpenStack user name
-* `api_key` (required)
-  OpenStack API key
-* `tenant` (required)
-  OpenStack tenant name
-* `domain` (optional)
-  OpenStack domain name
-* `region` (optional)
-  OpenStack region
-* `endpoint_type` (optional)
-  OpenStack endpoint type (publicURL (default), adminURL, internalURL)
-* `state_timeout` (optional)
-  Timeout (in seconds) for OpenStack resources desired state (by default 300)
-* `stemcell_public_visibility` (optional)
-  Set public visibility for stemcells (true or false (default))
-* `connection_options` (optional)
-  Hash containing optional connection parameters to the OpenStack API (`ssl_verify_peer`, `omit_default_port`, ...)
-* `default_key_name` (required)
-  default OpenStack ssh key name to assign to created virtual machines
-* `default_security_group` (required)
-  default OpenStack security group to assign to created virtual machines
-* `ignore_server_availability_zone` (optional)
-  When creating a disk, do not use the availability zone of the server, fall back to Openstacks default. Commonly used if Ceph is used for block storage. Defaults to false.
-
-### Registry options
-
-The registry options are passed to the Openstack CPI by the BOSH director based on the settings in `director.yml`:
-
-* `endpoint` (required)
-  OpenStack registry URL
-* `user` (required)
-  OpenStack registry user
-* `password` (required)
-  OpenStack registry password
-
-### Agent options
-
-The agent options are passed to the OpenStack CPI by the BOSH director based on the settings in `director.yml`:
-
-## Network options
-
-The OpenStack CPI supports these networks types:
-
-* `type` (required)
-  can be `dynamic` for a DHCP assigned IP by OpenStack, `manual` for a static IP assigned manually at the BOSH deployment manifest or `vip` to use a Floating IP (which needs to be already allocated)
-
-These options are specified under `cloud_properties` in the `networks` section of a BOSH deployment manifest:
-
-* `security_groups` (optional)
-  the OpenStack security groups to assign to VMs. If not specified, it'll use the default security groups set at the OpenStack options
-
-* `net_id` (required for `manual` networks)
-  the OpenStack Quantum network UUID to attach as a NIC to VMs.
-
-## Resource pool options
-
-These options are specified under `cloud_properties` in the `resource_pools` section of a BOSH deployment manifest:
-
-* `instance_type` (required)
-  which type of instance (OpenStack flavor) the VMs should belong to
-* `availability_zone` (optional)
-  the OpenStack availability zone the VMs should be created in
-* `scheduler_hints` (optional)
-  [filters](http://docs.openstack.org/developer/nova/devref/filter_scheduler.html) that will be passed to Nova.
-
-## Example
-
-This is a sample of how OpenStack specific properties are used in a BOSH deployment manifest:
-
-    ---
-    name: sample
-    director_uuid: 38ce80c3-e9e9-4aac-ba61-97c676631b91
-
-    ...
-
-    networks:
-      - name: default
-        type: dynamic
-        cloud_properties:
-          security_groups:
-            - default
-          net_id: 2438bca2-24fa-450f-ae7b-ec2e53b51984
-      - name: static
-        type: manual
-        subnets:
-          - name: private
-            range: 10.0.1.0/24
-            gateway: 10.0.1.1
-            reserved:
-              - 10.0.1.2 - 10.0.1.9
-            static:
-              - 10.0.1.10 - 10.0.1.20
-            cloud_properties:
-              security_groups:
-                - default
-              net_id: 8d8b84b4-faa6-4605-9fbf-c179bdae4282
-      - name: floating
-        type: vip
-        cloud_properties: {}
-    ...
-
-    resource_pools:
-      - name: common
-        network: default
-        size: 1
-        stemcell:
-          name: bosh-openstack-kvm-ubuntu
-          version: latest
-        cloud_properties:
-          instance_type: m1.small
-          availability_zone:
-          scheduler_hints:
-            group: af09abf2-2283-47d6-f2bd-2932a9ae949c
-
-    ...
-
-    properties:
-      openstack:
-        auth_url: http://pistoncloud.com/:5000/v2.0
-        username: christopher
-        api_key: QRoqsenPsNGX6
-        tenant: Bosh
-        region: RegionOne
-        endpoint_type: publicURL
-        default_key_name: bosh
-        default_security_groups: ["bosh"]