fog-openstack 0.1.5 → 0.1.6

data/lib/fog/openstack/docs/compute.md

@@ -79,7 +79,7 @@ To see a list of requests supported by the service:
 
 This returns:
 
-	:list_servers, :list_servers_detail, :create_server, :get_server_details, :update_server, :delete_server, :server_actions, :server_action, :reboot_server, :rebuild_server, :resize_server, :confirm_resize_server, :revert_resize_server, :pause_server, :unpause_server, :suspend_server, :resume_server, :rescue_server, :change_server_password, :add_fixed_ip, :remove_fixed_ip, :server_diagnostics, :boot_from_snapshot, :reset_server_state, :get_console_output, :get_vnc_console, :live_migrate_server, :migrate_server, :list_images, :list_images_detail, :create_image, :get_image_details, :delete_image, :list_flavors, :list_flavors_detail, :get_flavor_details, :create_flavor, :delete_flavor, :add_flavor_access, :remove_flavor_access, :list_tenants_with_flavor_access, :list_metadata, :get_metadata, :set_metadata, :update_metadata, :delete_metadata, :delete_meta, :update_meta, :list_addresses, :list_address_pools, :list_all_addresses, :list_private_addresses, :list_public_addresses, :get_address, :allocate_address, :associate_address, :release_address, :disassociate_address, :list_security_groups, :get_security_group, :create_security_group, :create_security_group_rule, :delete_security_group, :delete_security_group_rule, :get_security_group_rule, :list_key_pairs, :create_key_pair, :delete_key_pair, :list_tenants, :set_tenant, :get_limits, :list_volumes, :create_volume, :get_volume_details, :delete_volume, :attach_volume, :detach_volume, :get_server_volumes, :create_volume_snapshot, :list_snapshots, :get_snapshot_details, :delete_snapshot, :list_usages, :get_usage, :get_quota, :get_quota_defaults, :update_quota, :list_hosts, :get_host_details
+	:list_servers, :list_servers_detail, :create_server, :get_server_details, :update_server, :delete_server, :server_actions, :server_action, :reboot_server, :rebuild_server, :resize_server, :confirm_resize_server, :revert_resize_server, :pause_server, :unpause_server, :suspend_server, :resume_server, :rescue_server, :change_server_password, :add_fixed_ip, :remove_fixed_ip, :server_diagnostics, :boot_from_snapshot, :reset_server_state, :get_console_output, :get_vnc_console, :live_migrate_server, :migrate_server, :list_images, :list_images_detail, :create_image, :get_image_details, :delete_image, :list_flavors, :list_flavors_detail, :get_flavor_details, :create_flavor, :delete_flavor, :add_flavor_access, :remove_flavor_access, :list_tenants_with_flavor_access, :list_metadata, :get_metadata, :set_metadata, :update_metadata, :delete_metadata, :delete_meta, :update_meta, :list_addresses, :list_address_pools, :list_all_addresses, :list_private_addresses, :list_public_addresses, :get_address, :allocate_address, :associate_address, :release_address, :disassociate_address, :list_security_groups, :get_security_group, :create_security_group, :create_security_group_rule, :delete_security_group, :delete_security_group_rule, :get_security_group_rule, :list_key_pairs, :create_key_pair, :delete_key_pair, :list_tenants, :set_tenant, :get_limits, :list_volumes, :create_volume, :get_volume_details, :delete_volume, :attach_volume, :detach_volume, :get_server_volumes, :create_snapshot, :list_snapshots, :get_snapshot_details, :delete_snapshot, :list_usages, :get_usage, :get_quota, :get_quota_defaults, :update_quota, :list_hosts, :get_host_details
 
 
 #### Example Request

data/lib/fog/openstack/docs/network.md

@@ -0,0 +1,283 @@
+# Network (Neutron)
+
+This document explains how to get started using OpenStack Network (Neutron) with Fog. It assumes you have read the [Getting Started with Fog and OpenStack](getting_started.md) document.
+
+## Starting irb console
+
+Start by executing the following command:
+```
+irb
+```
+Once `irb` has launched you need to require the Fog library by executing:
+```
+require 'fog/openstack'
+```
+## Create Service
+
+Next, create a connection to the Network Service:
+```
+service = Fog::Network::OpenStack.new(
+	:openstack_auth_url     => 'http://KEYSTONE_HOST:KEYSTONE_PORT/v3/auth/tokens', # OpenStack Keystone v3 endpoint
+	:openstack_username     => OPEN_STACK_USER,                                     # Your OpenStack Username
+	:openstack_domain_name  => OPEN_STACK_DOMAIN,                                   # Your OpenStack Domain name
+	:openstack_project_name => OPEN_STACK_PROJECT,                                  # Your OpenStack Project name
+	:openstack_api_key      => OPEN_STACK_PASSWORD,                                 # Your OpenStack Password
+	:connection_options     => {}                                                   # Optional
+)
+```
+
+### Optional Connection Parameters
+
+Fog supports passing additional connection parameters to its underlying HTTP library (Excon) using the `:connection_options` parameter.
+
+<table>
+	<tr>
+		<th>Key</th>
+		<th>Description</th>
+	</tr>
+	<tr>
+		<td>:connect_timeout</td>
+		<td>Connection timeout (default: 60 seconds)</td>
+	</tr>
+	<tr>
+		<td>:read_timeout</td>
+		<td>Read timeout for connection (default: 60 seconds)</td>	</tr>
+	<tr>
+		<td>:write_timeout</td>
+		<td>Write timeout for connection (default: 60 seconds)</td>
+	</tr>
+	<tr>
+		<td>:proxy</td>
+		<td>Proxy for HTTP and HTTPS connections</td>
+	</tr>
+	<tr>
+		<td>:ssl_ca_path</td>
+		<td>Path to SSL certificate authorities</td>
+	</tr>
+	<tr>
+		<td>:ssl_ca_file</td>
+		<td>SSL certificate authority file</td>
+	</tr>
+	<tr>
+		<td>:ssl_verify_peer</td>
+		<td>SSL verify peer (default: true)</td>
+	</tr>
+</table>
+
+
+## Fog Abstractions
+
+Fog provides both a **model** and **request** abstraction. The request abstraction provides the most efficient interface and the model abstraction wraps the request abstraction to provide a convenient `ActiveModel` like interface.
+
+### Request Layer
+
+The request abstraction maps directly to the [OpenStack Network API](http://developer.openstack.org/api-ref-networking-v2.html). It provides the most efficient interface to the OpenStack Network service.
+
+To see a list of requests supported by the service:
+```
+service.requests
+```
+
+This returns:
+```
+:list_networks, :create_network, :delete_network, :get_network, :update_network,
+:list_ports, :create_port, :delete_port, :get_port, :update_port,
+:list_subnets, :create_subnet, :delete_subnet, :get_subnet, :update_subnet,
+:list_floating_ips, :create_floating_ip, :delete_floating_ip, :get_floating_ip, :associate_floating_ip, :disassociate_floating_ip,
+:list_routers, :create_router, :delete_router, :get_router, :update_router, :add_router_interface, :remove_router_interface,
+:list_lb_pools, :create_lb_pool, :delete_lb_pool, :get_lb_pool, :get_lb_pool_stats, :update_lb_pool,
+:list_lb_members, :create_lb_member, :delete_lb_member, :get_lb_member, :update_lb_member,
+:list_lb_health_monitors, :create_lb_health_monitor, :delete_lb_health_monitor, :get_lb_health_monitor, :update_lb_health_monitor, :associate_lb_health_monitor, :disassociate_lb_health_monitor,
+:list_lb_vips, :create_lb_vip, :delete_lb_vip, :get_lb_vip, :update_lb_vip,
+:list_vpn_services, :create_vpn_service, :delete_vpn_service, :get_vpn_service, :update_vpn_service,
+:list_ike_policies, :create_ike_policy, :delete_ike_policy, :get_ike_policy, :update_ike_policy,
+:list_ipsec_policies, :create_ipsec_policy, :delete_ipsec_policy, :get_ipsec_policy, :update_ipsec_policy,
+:list_ipsec_site_connections, :create_ipsec_site_connection, :delete_ipsec_site_connection, :get_ipsec_site_connection, :update_ipsec_site_connection,
+:list_rbac_policies, :create_rbac_policy, :delete_rbac_policy, :get_rbac_policy, :update_rbac_policy,
+:create_security_group, :delete_security_group, :get_security_group, :list_security_groups,
+:create_security_group_rule, :delete_security_group_rule, :get_security_group_rule, :list_security_group_rules,
+:set_tenant, :get_quotas, :get_quota, :update_quota, :delete_quota
+```
+
+#### Example Request
+
+To request a list of networks:
+```
+response = service.list_networks
+```
+This returns in the following `Excon::Response`:
+```
+#<Excon::Response:0x007fd20d34e0e0
+  @data={
+    :body=>{"networks"=>[
+      {"id"=>"f9c54735-a230-443e-9379-b87f741cc1b1", "name"=>"Public", "subnets"=>["db50da7f-1248-43d2-aa30-1c10da0d380d"], "shared"=>true, "status"=>"ACTIVE", "tenant_id"=>"a51fd915", "provider_network_type"=>"vlan", "router:external"=>false, "admin_state_up"=>true},
+      {"id"=>"e624a36d-762b-481f-9b50-4154ceb78bbb", "name"=>"network_1", "subnets"=>["2e4ec6a4-0150-47f5-8523-e899ac03026e"], "shared"=>false, "status"=>"ACTIVE", "admin_state_up"=>true, "tenant_id"=>"f8b26a6032bc47718a7702233ac708b9"}]},
+    :status=>200,
+    :headers=>{}},
+  @body={"networks"=>[
+    {"id"=>"f9c54735-a230-443e-9379-b87f741cc1b1", "name"=>"Public", "subnets"=>["db50da7f-1248-43d2-aa30-1c10da0d380d"], "shared"=>true, "status"=>"ACTIVE", "tenant_id"=>"a51fd915", "provider_network_type"=>"vlan", "router:external"=>false, "admin_state_up"=>true},
+    {"id"=>"e624a36d-762b-481f-9b50-4154ceb78bbb", "name"=>"network_1", "subnets"=>["2e4ec6a4-0150-47f5-8523-e899ac03026e"], "shared"=>false, "status"=>"ACTIVE", "admin_state_up"=>true, "tenant_id"=>"f8b26a6032bc47718a7702233ac708b9"}]},
+  @headers={},
+  @status=200,
+  @remote_ip=nil,
+  @local_port=nil,
+  @local_address=nil
+>
+```
+To view the status of the response:
+```
+response.status
+```
+**Note**: Fog is aware of valid HTTP response statuses for each request type. If an unexpected HTTP response status occurs, Fog will raise an exception.
+
+To view response body:
+```
+response.body
+```
+This will return:
+```
+{"networks"=>[
+  {"id"=>"f9c54735-a230-443e-9379-b87f741cc1b1", "name"=>"Public", "subnets"=>["db50da7f-1248-43d2-aa30-1c10da0d380d"], "shared"=>true, "status"=>"ACTIVE", "tenant_id"=>"a51fd915", "provider_network_type"=>"vlan", "router:external"=>false, "admin_state_up"=>true},
+  {"id"=>"e624a36d-762b-481f-9b50-4154ceb78bbb", "name"=>"network_1", "subnets"=>["2e4ec6a4-0150-47f5-8523-e899ac03026e"], "shared"=>false, "status"=>"ACTIVE", "admin_state_up"=>true, "tenant_id"=>"f8b26a6032bc47718a7702233ac708b9"}]
+}
+```
+To learn more about Network request methods refer to [rdoc](http://www.rubydoc.info/gems/fog-openstack/Fog/Network/OpenStack/Real). To learn more about Excon refer to [Excon GitHub repo](https://github.com/geemus/excon).
+
+### Model Layer
+
+Fog models behave in a manner similar to `ActiveModel`. Models will generally respond to `create`, `save`,  `persisted?`, `destroy`, `reload` and `attributes` methods. Additionally, fog will automatically create attribute accessors.
+
+Here is a summary of common model methods:
+
+<table>
+	<tr>
+		<th>Method</th>
+		<th>Description</th>
+	</tr>
+	<tr>
+		<td>create</td>
+		<td>
+			Accepts hash of attributes and creates object.<br>
+			Note: creation is a non-blocking call and you will be required to wait for a valid state before using resulting object.
+		</td>
+	</tr>
+	<tr>
+		<td>save</td>
+		<td>Saves object.<br>
+		Note: not all objects support updating object.</td>
+	</tr>
+	<tr>
+		<td>persisted?</td>
+		<td>Returns true if the object has been persisted.</td>
+	</tr>
+	<tr>
+		<td>destroy</td>
+		<td>
+			Destroys object.<br>
+			Note: this is a non-blocking call and object deletion might not be instantaneous.
+		</td>
+	<tr>
+		<td>reload</td>
+		<td>Updates object with latest state from service.</td>
+	<tr>
+		<td>ready?</td>
+		<td>Returns true if object is in a ready state and able to perform actions. This method will raise an exception if object is in an error state.</td>
+	</tr>
+	<tr>
+		<td>attributes</td>
+		<td>Returns a hash containing the list of model attributes and values.</td>
+	</tr>
+		<td>identity</td>
+		<td>
+			Returns the identity of the object.<br>
+			Note: This might not always be equal to object.id.
+		</td>
+	</tr>
+	<tr>
+		<td>wait_for</td>
+		<td>This method periodically reloads model and then yields to specified block until block returns true or a timeout occurs.</td>
+	</tr>
+</table>
+
+To see a list of collections supported by the service:
+```
+service.collections
+```
+This returns:
+```
+:networks, :ports, :subnets, :floating_ips, :routers,
+:lb_pools, :lb_members, :lb_health_monitors, :lb_vips,
+:vpn_services, :ike_policies, :ipsec_policies, :ipsec_site_connections,
+:rbac_policies, :security_groups, :security_group_rules
+```
+
+#### Example Request
+
+To request a collection of networks:
+```
+networks = service.networks
+```
+This returns in the following `Fog::OpenStack::Model`:
+```
+<Fog::Network::OpenStack::Networks
+  filters={}
+  [<Fog::Network::OpenStack::Network
+      id="f9c54735-a230-443e-9379-b87f741cc1b1",
+      name="Public",
+      subnets=        <Fog::Network::OpenStack::Subnets
+        filters={}
+        [<Fog::Network::OpenStack::Subnet ... >]
+      >,
+      shared=true,
+      status="ACTIVE",
+      admin_state_up=true,
+      tenant_id="a51fd915",
+      provider_network_type="vlan",
+      provider_physical_network=nil,
+      provider_segmentation_id=nil,
+      router_external=false
+    >,
+                <Fog::Network::OpenStack::Network
+      id="e624a36d-762b-481f-9b50-4154ceb78bbb",
+      name="network_1",
+      subnets=        <Fog::Network::OpenStack::Subnets
+        filters={}
+        []
+      >,
+      shared=false,
+      status="ACTIVE",
+      admin_state_up=true,
+      tenant_id="f8b26a6032bc47718a7702233ac708b9",
+      provider_network_type=nil,
+      provider_physical_network=nil,
+      provider_segmentation_id=nil,
+      router_external=nil
+    >
+  ]
+>
+```
+
+To access the name of the first network:
+```
+networks.first.name
+```
+This will return:
+```
+"Public"
+```
+## Examples
+
+Example code using Network can be found [here](https://github.com/fog/fog-openstack/tree/master/lib/fog/openstack/examples/network).
+
+## Additional Resources
+
+* [fog.io](http://fog.io/)
+* [fog-openstack rdoc](http://rubydoc.info/gems/fog-openstack)
+* [fog-openstack Github repo](https://github.com/fog/fog-openstack)
+* [fog-openstack Github Issues](https://github.com/fog/fog-openstack/issues)
+* [Excon Github repo](https://github.com/geemus/excon)
+* [OpenStack Network API](http://developer.openstack.org/api-ref-networking-v2.html)
+
+## Support and Feedback
+
+Your feedback is appreciated! If you have specific issues with the **fog-openstack** SDK, you should file an [issue via Github](https://github.com/fog/fog-openstack/issues).

data/lib/fog/openstack/docs/nfv.md

@@ -0,0 +1,144 @@
+# NFV
+
+This document explains how to get started using NFV with
+fog-openstack.
+
+Please also refer to the
+[Getting Started with Fog and the OpenStack](getting_started.md) document.
+
+Tacker is an OpenStack service for NFV Orchestration with a general purpose
+VNF Manager to deploy and operate Virtual Network Functions (VNFs) and Network
+Services on an NFV Platform. It is based on ETSI MANO Architectural Framework.
+
+# OpenStack setup
+
+## The catalog
+For the fog-openstack's introspection service to work, the corresponding
+service must be defined in the OpenStack catalog.
+
+```bash
+openstack catalog show servicevm
++-----------+-----------------------------------------+
+| Field     | Value                                   |
++-----------+-----------------------------------------+
+| endpoints | regionOne                               |
+|           |   publicURL: http://172.16.0.21:8888/   |
+|           |   internalURL: http://172.16.0.21:8888/ |
+|           |   adminURL: http://172.16.0.21:8888/    |
+|           |                                         |
+| name      | tacker                                  |
+| type      | servicevm                               |
++-----------+-----------------------------------------+
+```
+
+Depending on the OpenStack release, the NFV service might be installed
+but not defined yet in the catalog. In such case, you must add the service and
+corresponding endpoints to create the catalog entry:
+
+```bash
+source ./stackrc
+openstack service create --name tacker --description "Tacker Project" servicevm
+openstack endpoint create --region regionOne tacker --publicurl http://example.com:8888 --internalurl http://example.com:8888 --adminurl http://example.com:8888
+```
+
+# Work flow
+A usual work-flow might consist of:
+* Create vnfd
+* Deploy vnf using vnfd
+* Retrieve vnf and vnfd data
+
+For more details please refer to
+http://docs.openstack.org/developer/tacker/
+
+Using 'irb', we start with authentication:
+
+```ruby
+@user     = "admin"
+@project  = "admin"
+@password = "secret"
+@base_url = "http://keystone.example.com:5000/v3/auth/tokens"
+
+require 'rubygems'
+require 'fog/openstack'
+
+@connection_params = {
+  :openstack_auth_url     => @base_url,
+  :openstack_username     => @user,
+  :openstack_api_key      => @password,
+  :openstack_project_name => @project,
+  :openstack_domain_id    => "default"
+}
+```
+
+## Vnfd management
+
+### Create vnfd
+
+```ruby
+vnfd_data = {:attributes    => {:vnfd => "template_name: sample-vnfd\ndescription: demo-example\n\nservice_properties:\n  Id: sample-vnfd\n  vendor: tacker\n  version: 1\n\nvdus:\n  vdu1:\n    id: vdu1\n    vm_image: cirros\n    instance_type: m1.tiny\n\n    network_interfaces:\n      management:\n        network: net_mgmt\n        management: true\n      pkt_in:\n        network: net0\n      pkt_out:\n        network: net1\n\n    placement_policy:\n      availability_zone: nova\n\n    auto-scaling: noop\n\n    config:\n      param0: key0\n      param1: key1\n"},
+             :service_types => [{:service_type => "vnfd"}],
+             :mgmt_driver   => "noop",
+             :infra_driver  => "heat"}
+auth      = {"tenantName" => "admin", "passwordCredentials" => {"username" => "admin","password" => "password"}}
+vnfd      = Fog::NFV[:openstack].vnfds.create(:vnfd => vnfd_data, :auth => auth)
+```
+
+### List vnfds
+
+```ruby
+vnfds = Fog::NFV[:openstack].vnfds
+```
+
+### Get vnfd
+
+```ruby
+vnfd = Fog::NFV[:openstack].vnfds.last
+vnfd = Fog::NFV[:openstack].vnfds.get(vnfd.id)
+```
+
+### Destroy vnfd
+
+```ruby
+vnfd = Fog::NFV[:openstack].vnfds.last
+vnfd.destroy
+```
+
+## Vnf management
+
+### Create vnf using vnfd
+
+```ruby
+vnfd     = Fog::NFV[:openstack].vnfds.last
+vnf_data = {:vnfd_id => vnfd.id, :name => 'Test'}
+auth     = {"tenantName" => "admin", "passwordCredentials" => {"username" => "admin","password" => "password"}}
+vnf      = Fog::NFV[:openstack].vnfs.create(:vnf => vnf_data, :auth => auth)
+```
+
+### List vnfs
+
+```ruby
+vnfs = Fog::NFV[:openstack].vnfs
+```
+
+### Get vnf
+
+```ruby
+vnf = Fog::NFV[:openstack].vnfs.last
+vnf = Fog::NFV[:openstack].vnfs.get(vnf.id)
+```
+
+### Update vnf
+
+```ruby
+vnf      = Fog::NFV[:openstack].vnfs.last
+vnf_data = {"attributes": {"config": "vdus:\n  vdu1:<sample_vdu_config> \n\n"}}
+auth     = {"tenantName" => "admin", "passwordCredentials" => {"username" => "admin","password" => "password"}}
+vnf      = vnf.update(:vnf => vnf_data, :auth => auth)
+```
+
+### Destroy vnf
+
+```ruby
+vnf = Fog::NFV[:openstack].vnfs.last
+vnf.destroy
+```

data/lib/fog/openstack/examples/compute/block_device_mapping_v2.rb

@@ -11,17 +11,17 @@ compute_client ||= ::Fog::Compute::OpenStack.new(
   :openstack_api_key  => password,
   :openstack_username => username,
   :openstack_auth_url => auth_url,
-  :openstack_tenant   => tenant,
+  :openstack_tenant   => tenant
 )
 
-vm = compute_client.servers.create(
+_vm = compute_client.servers.create(
   :name                    => name,
   :flavor_ref              => flavor,
   :block_device_mapping_v2 => [
     {
-      :boot_index            => 0
+      :boot_index            => 0,
       :device_name           => "vda",
-      :source_type           => "volume",  # Or "snapshot"
+      :source_type           => "volume", # Or "snapshot"
       :destination_type      => "volume",
       :delete_on_termination => false,
       :uuid                  => cinder_uddi,