fog-openstack 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85c015f66fafdd1aeb99e59443520114635930dc
-  data.tar.gz: d0915c5216fd3e3bfd6c47f010a5e7dccabb0aee
+  metadata.gz: 33930f096ce867d0d328ccfcf748104caefefcf8
+  data.tar.gz: a0ffe19cfb27b239d8a1376c18711433c341015e
 SHA512:
-  metadata.gz: 56f592d5413f1f712421cc7fa16f973b8b2445f89f0b4e719e3431350061795bc5bfa56e320a83e8173870409d1af3d4df08fdbedfd33e3d7b21edf2d5ec32f5
-  data.tar.gz: 360408ce8e42a4b21ea35f01d85bc76348ad18d99b7609d4e57f1b5284e2c3763432d2648203b34bbe529bd2994b5d078ad52c1562d18473676b5d1360ce4f2d
+  metadata.gz: 8c0529686e26404cd6d80ac858c78adcb16a275383031959bec90a161887be1ae043140c1d9921fe2cd3f55a2856370561c0c9d4b808440e1c925a8601f29294
+  data.tar.gz: 3317ae20e8b81989572b91af05fd5298a13da6a604028e3b50f8ccc840da268f507d4b84359cf63c7f9b57bf871c3c52356752b4d05ce27be63f9ec86d528dd9

data/.rubocop.yml

@@ -82,6 +82,8 @@ SpaceBeforeFirstArg:
   Enabled: false
 SpecialGlobalVars:
   AutoCorrect: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
 StringLiterals:
   Enabled: false
 StringLiteralsInInterpolation:
@@ -91,4 +93,4 @@ TrailingCommaInLiteral:
 WhileUntilModifier:
   Enabled: false
 WordArray:
-  AutoCorrect: false
+  AutoCorrect: false

data/README.md

@@ -340,11 +340,42 @@ end
 Excon.get cirros_location, response_block: streamer
 image_out.close
 
-image.images.create name:             "cirros",
-                    disk_format:      "qcow2",
-                    container_format: "bare"
-
-image.upload_data File.binread(image_out.path)
+image_handle = image.images.create name:             "cirros",
+                                   disk_format:      "qcow2",
+                                   container_format: "bare"
+
+# => <Fog::Image::OpenStack::V2::Image
+#      id="67c4d02c-5601-4619-bd14-d2f7f96a046c",
+#      name="cirros",
+#      visibility="private",
+#      tags=[],
+#      self="/v2/images/67c4d02c-5601-4619-bd14-d2f7f96a046c",
+#      size=nil,
+#      disk_format="qcow2",
+#      container_format="bare",
+#      id="67c4d02c-5601-4619-bd14-d2f7f96a046c",
+#      checksum=nil,
+#      self="/v2/images/67c4d02c-5601-4619-bd14-d2f7f96a046c",
+#      file="/v2/images/67c4d02c-5601-4619-bd14-d2f7f96a046c/file",
+#      min_disk=0,
+#      created_at="2016-10-31T03:38:28Z",
+#      updated_at="2016-10-31T03:38:28Z",
+#      protected=false,
+#      status="queued",
+#      min_ram=0,
+#      owner="6b9ec8080b8443c5afe2267a39b9bf74",
+#      properties=nil,
+#      metadata=nil,
+#      location=nil,
+#      network_allocated=nil,
+#      base_image_ref=nil,
+#      image_type=nil,
+#      instance_uuid=nil,
+#      user_id=nil
+#    >
+
+
+image_handle.upload_data File.binread(image_out.path)
 
 ```
 

data/docs/common/connection_params.md

@@ -0,0 +1,45 @@
+### 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>
+  <tr>
+    <td>:debug_request</td>
+    <td>debug print request (default: false)</td>
+  </tr>
+  <tr>
+    <td>:debug_response</td>
+    <td>debug print response (default: false)</td>
+  </tr>
+</table>

data/docs/common/resources.md

@@ -0,0 +1,11 @@
+## 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)
+* [Excon Github repo](https://github.com/geemus/excon)
+
+
+## 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/docs/compute.md

@@ -26,43 +26,7 @@ Next, create a connection to the Compute Service:
 
 **Note** `openstack_username` and `openstack_tenant` default to `admin` if omitted.
 
-### 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>
+Read more about the [Optional Connection Parameters](common/connection_params.md)
 
 
 ## Fog Abstractions
@@ -668,13 +632,5 @@ Example code using Compute can be found [here](https://github.com/fog/fog/tree/m
 
 ## Additional Resources
 
-* [fog.io](http://fog.io/)
-* [Fog rdoc](http://rubydoc.info/gems/fog/)
-* [Fog Github repo](https://github.com/fog/fog)
-* [Fog Github Issues](https://github.com/fog/fog/issues)
-* [Excon Github repo](https://github.com/geemus/excon)
 * [OpenStack Compute API](http://docs.openstack.org/api/openstack-compute/2/content/)
-
-## Support and Feedback
-
-Your feedback is appreciated! If you have specific issues with the **fog** SDK, you should file an [issue via Github](https://github.com/fog/fog/issues).
+* [more resources and feedback](common/resources.md)

data/docs/getting_started.md

@@ -34,7 +34,7 @@ gem 'fog-openstack'
 
 After creating your `Gemfile` execute the following command to install the libraries:
 
-	bundle install	
+	bundle install
 
 ## Next Steps
 
@@ -43,7 +43,7 @@ Now that you have installed Fog and obtained your credentials, you are ready to
 Start by executing the following command:
 
 	irb
-	
+
 Once `irb` has launched you will need to require the Fog library.
 
 If using Ruby 1.8.x execute the following command:
@@ -68,14 +68,15 @@ Fog::OpenStack.services
 These services can be explored in further depth in the following documents:
 
 * [Compute](compute.md)
+* [Introspection](introspection.md)
+* [Metering](metering.md)
+* [Network](network.md)
+* [NFV](nfv.md)
+* [Orchestration](orchestration.md)
+* [Planning](planning.md)
+* [Shared File System](shared_file_system.md)
 * [Storage (Swift)](storage.md)
+* [Workflow](workflow.md)
 
 ## Additional Resources
-* [fog.io](http://fog.io)
-* [Fog rdoc](http://rubydoc.info/gems/fog)
-* [Fog Github repo](https://github.com/fog/fog)
-* [Release Notes](https://github.com/fog/fog/blob/master/changelog.txt)
-
-
-## Support and Feedback
-Your feedback is appreciated! If you have specific issues with the **fog** SDK, you should file an [issue via Github](https://github.com/fog/fog/issues).
+[resources and feedback](common/resources.md)

data/docs/network.md

@@ -26,44 +26,7 @@ service = Fog::Network::OpenStack.new(
 )
 ```
 
-### 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>
-
+Read more about the [Optional Connection Parameters](common/connection_params.md)
 
 ## Fog Abstractions
 
@@ -271,13 +234,5 @@ Example code using Network can be found [here](https://github.com/fog/fog-openst
 
 ## 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).
+* [more resources and feedback](common/resources.md)

data/docs/orchestration.md

@@ -35,6 +35,8 @@ service = Fog::Orchestration::OpenStack.new({
 ```
 We will use this `service` to interact with the Orchestration resources, `stack`, `event`,  `resource`, and `template`
 
+Read more about the [Optional Connection Parameters](common/connection_params.md)
+
 ## Stacks
 
 Get a list of stacks you own:
@@ -333,5 +335,3 @@ stack = service.stacks.get(stack.stack_name, stack.id)
 stack.stack_status
 => "ROLLBACK_IN_PROGRESS"
 ```
-
-

data/docs/planning.md

@@ -40,43 +40,7 @@ service = Fog::Openstack.new({
 })
 ```
 
-### 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>
+Read more about the [Optional Connection Parameters](common/connection_params.md)
 
 ## Fog Abstractions
 
@@ -257,14 +221,5 @@ The remainder of this document details the model abstraction.
 
 ## Additional Resources
 
-* [fog.io](http://fog.io/)
-* [Fog rdoc](http://rubydoc.info/gems/fog/)
-* [Fog Github repo](https://github.com/fog/fog)
-* [Fog Github Issues](https://github.com/fog/fog/issues)
-* [Excon Github repo](https://github.com/geemus/excon)
 * [Tuskar API](http://docs.openstack.org/developer/tuskar/)
-
-## Support and Feedback
-
-Your feedback is appreciated! If you have specific issues with the **fog** SDK, you should file an [issue via Github](https://github.com/fog/fog/issues).
-
+* [more resources and feedback](common/resources.md)

data/docs/shared_file_system.md

@@ -0,0 +1,82 @@
+# Shared File System (Manila)
+
+This document explains how to get started using OpenStack Shared File System (Manila) 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
+```
+
+or if you use bundler for managing your gems:
+```
+bundle exec 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 Shared File System Service:
+```
+service = Fog::SharedFileSystem::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
+)
+```
+
+Read more about the [Optional Connection Parameters](common/connection_params.md)
+
+## 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 Shared File System API](http://developer.openstack.org/api-ref/shared-file-systems). It provides the most efficient interface to the OpenStack Shared File System service.
+
+To see a list of requests supported by the service:
+```
+service.requests
+```
+
+#### Example Request
+
+To request a list of networks:
+```
+response = service.list_shares
+```
+
+To learn more about Shared File System request methods refer to [rdoc](http://www.rubydoc.info/gems/fog-openstack/Fog/SharedFileSystem/OpenStack/Real).
+
+### 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.
+
+To see a list of collections supported by the service:
+```
+service.collections
+```
+
+#### Example Request
+
+To request a collection of share networks:
+```
+networks = service.networks
+```
+
+## Examples
+
+Example code using Shared File System can be found [here](https://github.com/fog/fog-openstack/tree/master/examples/share).
+
+## Additional Resources
+
+* [OpenStack Shared File System API](http://developer.openstack.org/api-ref/shared-file-systems/)
+* [more resources and feedback](common/resources.md)