fog-zj 0.1.28

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7667308472e1ff7d40481adcfa2fd5ec503d60fe
+  data.tar.gz: 1a60c57e09e31f2b85dfa705f7bfbf87b68d4033
+SHA512:
+  metadata.gz: fcbd5b08b996c265859285e368cdfbbca492ef1e8af3e97edc3bb623927652b99bd1e054a678ee45ae89afe46a4f787e9d4ce3e5de7baea2ced50450c8f8ef25
+  data.tar.gz: 00c1caedca50a6fa0a4d1cc0dfe67dd78fcdf406406fa1014a227752846578d1fcb4dc60bb8cc4ec89e5b85af89633c478b09c5b93b90bf039a5bff33d5c866b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+gemfiles/Gemfile-1.9.lock
+.DS_Store
+.idea/
+vendor/bundle

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,110 @@
+#
+# Overrides
+#
+AbcSize:
+  Severity: refactor
+AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+BlockNesting:
+  Severity: refactor
+ClassLength:
+  Max: 150
+  Severity: refactor
+ClassCheck:
+  EnforcedStyle: kind_of?
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    find_all: select
+    map: collect
+    reduce: inject
+CyclomaticComplexity:
+  Severity: refactor
+FormatString:
+  EnforcedStyle: percent
+HashSyntax:
+  EnforcedStyle: hash_rockets
+LineLength:
+  Max: 120
+  Severity: refactor
+MethodLength:
+  Max: 25
+  Severity: refactor
+# Exclude test methods from BlockLength.
+Metrics/BlockLength:
+  ExcludedMethods:
+  - after
+  - before
+  - context
+  - describe
+  - it
+  - model_tests
+  - namespace
+  - draw  
+ParameterLists:
+  Severity: refactor
+PerceivedComplexity:
+  Severity: refactor
+RedundantReturn:
+  AllowMultipleReturnValues: true
+SignalException:
+  EnforcedStyle: only_raise
+SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+TrivialAccessors:
+  AllowPredicates: true
+#
+# Enabled/Disabled
+#
+ClassAndModuleChildren:
+  Enabled: false
+DefEndAlignment:
+  AutoCorrect: true
+Documentation:
+  Enabled: false
+Encoding:
+  Enabled: false
+EndAlignment:
+  AutoCorrect: true
+ExtraSpacing:
+  AutoCorrect: false # https://github.com/bbatsov/rubocop/issues/2280
+FindEach:
+  Enabled: false
+GuardClause:
+  Enabled: false
+IfUnlessModifier:
+  Enabled: false
+NumericLiterals:
+  AutoCorrect: false
+  MinDigits: 7
+ParallelAssignment:
+  Enabled: false
+PerlBackrefs:
+  Enabled: false
+ReadWriteAttribute:
+  AutoCorrect: false
+RescueModifier:
+  AutoCorrect: false
+SingleLineBlockParams:
+  Enabled: false
+SpaceBeforeFirstArg:
+  Enabled: false
+SpecialGlobalVars:
+  AutoCorrect: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+StringLiterals:
+  Enabled: false
+StringLiteralsInInterpolation:
+  Enabled: false
+TrailingCommaInArrayLiteral:
+  Enabled: false
+TrailingCommaInHashLiteral:
+  Enabled: false
+WhileUntilModifier:
+  Enabled: false
+WordArray:
+  AutoCorrect: false

data/.ruby-gemset

@@ -0,0 +1 @@
+fog-openstack

data/.travis.yml

@@ -0,0 +1,32 @@
+language: ruby
+sudo: false
+before_install:
+  - gem update bundler
+script:
+  - bundle exec rake test TESTOPTS="--verbose"
+  - bundle exec rake spec
+env:
+  - JRUBY_OPTS=--debug
+matrix:
+  fast_finish: true
+  include:
+  - rvm: 2.2.10
+    gemfile: Gemfile
+  - rvm: 2.3.7
+    gemfile: Gemfile
+  - rvm: 2.4.4
+    gemfile: Gemfile
+  - rvm: 2.5.1
+    gemfile: Gemfile
+  - rvm: jruby-head
+    gemfile: Gemfile
+  allow_failures:
+  - rvm: jruby-head
+notifications:
+  webhooks:
+    urls:
+    - https://webhooks.gitter.im/e/af95aadff4470a9732b9
+    on_success: change
+    on_failure: always
+    on_start: never
+  email: false

data/.zuul.yaml

@@ -0,0 +1,35 @@
+- project:
+    check:
+      jobs:
+        - fog-openstack-unittest-test
+        - fog-openstack-unittest-spec
+
+- job:
+    name: fog-openstack-unittest-test
+    parent: init-test
+    description: |
+      fog-openstack unittest test tests
+    run: playbooks/fog-openstack-unittest-test/run.yaml
+    vars:
+      rvm:
+        2.2.10
+        2.3.7
+        2.4.4
+        2.5.1
+        jruby-head
+    nodeset: ubuntu-xenial
+
+- job:
+    name: fog-openstack-unittest-spec
+    parent: init-test
+    description: |
+      fog-openstack unittest spec tests
+    run: playbooks/fog-openstack-unittest-spec/run.yaml
+    vars:
+      rvm:
+        2.2.10
+        2.3.7
+        2.4.4
+        2.5.1
+        jruby-head
+    nodeset: ubuntu-xenial

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+# 1.10.1 2013/04/04
+
+## Storage
+
+* Added storage (Swift) example to set account quotas:
+
+  https://github.com/fog/fog/blob/master/lib/fog/openstack/examples/storage/set-account-quota.rb
+
+* Added account impersonation to the storage service
+
+  Now it's possible to use an admin account with a reseller
+  role to impersonate other accounts and set account metadata
+  headers. See the account quotas example included in this release
+
+## Network
+
+* create_network request updated
+
+  Implements provider extensions when creating networks.
+
+  See http://docs.openstack.org/trunk/openstack-network/admin/content/provider_attributes.html
+
+* Network Router support (Quantum)
+
+  Added router model/collection and related requests.
+
+* New network service example
+
+  See https://github.com/fog/fog/blob/master/lib/fog/openstack/examples/network/network_subnets_routers.rb
+
+* :openstack_endpoint_type parameter was added to the network service
+
+## Image
+
+* Added basic image service example (Glance)
+
+  Download CirrOS 0.3.0 image from launchpad (~6.5MB) to /tmp
+  and upload it to Glance.
+
+  See https://github.com/fog/fog/blob/master/lib/fog/openstack/examples/image/upload-test-image.rb
+
+* Check for glance version (fog only supports v1)
+
+## Compute
+
+* create_server and the Server model where updated to allow booting a VM
+  with NICs (net_id, port_id, fixed_ip).

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at matt.darby@rackspace.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+## Getting Involved
+
+New contributors are always welcome, when it doubt please ask questions. We strive to be an open and welcoming community. Please be nice to one another.
+
+### Coding
+
+* Pick a task:
+  * Offer feedback on open [pull requests](https://github.com/fog/fog-openstack/pulls).
+  * Review open [issues](https://github.com/fog/fog-openstack/issues) for things to help on.
+  * [Create an issue](https://github.com/fog/fog-openstack/issues/new) to start a discussion on additions or features.
+* Fork the project, add your changes and tests to cover them in a topic branch.
+* Commit your changes and rebase against `fog/fog-openstack` to ensure everything is up to date.
+* [Submit a pull request](https://github.com/fog/fog-openstack/compare/).
+
+### Non-Coding
+
+* Offer feedback on open [issues](https://github.com/fog/fog-openstack/issues).
+* Organize or volunteer at events.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fog-openstack.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2015 [CONTRIBUTORS.md](https://github.com/fog/fog-rackspace/blob/master/CONTRIBUTORS.md)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,572 @@
+# Fog::OpenStack
+
+[![Gem Version](https://badge.fury.io/rb/fog-openstack.svg)](http://badge.fury.io/rb/fog-openstack) [![Build Status](https://travis-ci.org/fog/fog-openstack.svg?branch=master)](https://travis-ci.org/fog/fog-openstack) [![Dependency Status](https://gemnasium.com/fog/fog-openstack.svg)](https://gemnasium.com/fog/fog-openstack) [![Coverage Status](https://coveralls.io/repos/github/fog/fog-openstack/badge.svg?branch=master)](https://coveralls.io/github/fog/fog-openstack?branch=master) [![Code Climate](https://codeclimate.com/github/fog/fog-openstack.svg)](https://codeclimate.com/github/fog/fog-openstack) [![Join the chat at https://gitter.im/fog/fog-openstack](https://badges.gitter.im/fog/fog-openstack.svg)](https://gitter.im/fog/fog-openstack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+This is the plugin Gem to talk to [OpenStack](http://openstack.org) clouds via fog.
+
+The main maintainers for the OpenStack sections are @dhague, @Ladas, @seanhandley, @mdarby and @jjasghar. Please send CC them on pull requests.
+
+## Supported OpenStack APIs
+
+See the list of [supported OpenStack projects](supported.md).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fog-openstack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fog-openstack
+
+## Usage
+
+### Initial Setup
+
+Require the gem:
+
+```ruby
+require "fog/openstack"
+```
+
+Checklist:
+
+* Before you can do anything with an OpenStack cloud, you need to authenticate yourself with the identity service, "Keystone".
+* All following examples assume that `@connection_params` is a hash of valid connection information for an OpenStack cloud.
+* The `:openstack_username` and `:openstack_api_key` keys must map to a valid user/password combination in Keystone.
+* If you don't know what domain your user belongs to, chances are it's the `default` domain. By default, all users are a member of the `default` domain unless otherwise specified.
+
+Connection parameters:
+
+```ruby
+@connection_params = {
+  openstack_auth_url:     "http://devstack.test:5000/v3/auth/tokens",
+  openstack_username:     "admin",
+  openstack_api_key:      "password",
+  openstack_project_name: "admin",
+  openstack_domain_id:    "default"
+}
+```
+
+If you're using Keystone V2, you don't need to supply domain details but ensure the `openstack_auth_url` parameter references the correct endpoint.
+
+```ruby
+@connection_params = {
+  openstack_auth_url:     "http://devstack.test:5000/v2.0/tokens",
+  openstack_username:     "admin",
+  openstack_api_key:      "password",
+  openstack_project_name: "admin"
+}
+```
+
+If you're not sure whether your OpenStack cloud uses Keystone V2 or V3 then you can find out by logging into the dashboard (Horizon) and navigating to "Access & Security" under the "Project" section. Select "API Access" and find the line for the Identity Service. If the endpoint has "v3" in it, you're on Keystone V3, if it has "v2" then (surprise) you're on Keystone V2.
+
+If you need a version of OpenStack to test against, get youself a copy of [DevStack](http://docs.openstack.org/developer/devstack/).
+
+### Networking Gotcha
+
+Note that tenants (aka projects) in OpenStack usually require that you create a default gateway router in order to allow external access to your instances.
+
+The exception is if you're using Nova (and not Neutron) for your instance networking. If you're using Neutron, you'll want to [set up your default gateway](https://github.com/fog/fog-openstack/blob/usage_doc/README.md#networking-neutron) before you try to give instances public addresses (aka floating IPs).
+
+### Compute (Nova)
+
+Initialise a connection to the compute service:
+
+```ruby
+compute = Fog::Compute::OpenStack.new(@connection_params)
+```
+
+Get a list of available images for use with booting new instances:
+
+```ruby
+p compute.images
+# =>   <Fog::Compute::OpenStack::Images
+#     filters={},
+#     server=nil
+#     [
+#                   <Fog::Compute::OpenStack::Image
+#         id="57a67f8a-7bae-4578-b684-b9b4dcd48d7f",
+#         ...
+#       >
+#     ]
+#   >
+```
+
+List available flavors so we can decide how powerful to make this instance:
+
+```ruby
+p compute.flavors
+# =>   <Fog::Compute::OpenStack::Flavors
+#     [
+#                   <Fog::Compute::OpenStack::Flavor
+#         id="1",
+#         name="m1.tiny",
+#         ram=512,
+#         disk=1,
+#         vcpus=1,
+#         ...
+#       >,
+#                   <Fog::Compute::OpenStack::Flavor
+#         id="2",
+#         name="m1.small",
+#         ram=2048,
+#         disk=20,
+#         vcpus=1,
+#         ...
+#       >,
+#       ...
+
+```
+
+Now we know the `id` numbers of a valid image and a valid flavor, we can instantiate an instance:
+
+```ruby
+flavor   = compute.flavors[0]
+image    = compute.images[0]
+instance = compute.servers.create name: 'test',
+                                  image_ref: image.id,
+                                  flavor_ref: flavor.id
+
+# Optionally, wait for the instance to provision before continuing
+instance.wait_for { ready? }
+# => {:duration=>17.359134}
+
+p instance
+# =>   <Fog::Compute::OpenStack::Server
+#     id="63633125-26b5-4fe1-a909-0f44d1ab3337",
+#     instance_name=nil,
+#     addresses={"public"=>[{"OS-EXT-IPS-MAC:mac_addr"=>"fa:16:3e:f4:75:ab", "version"=>4, "addr"=>"1.2.3.4", "OS-EXT-IPS:type"=>"fixed"}]},
+#     flavor={"id"=>"2"},
+#     host_id="f5ea01262720d02e886508bc4fa994782c516557d232c72aeb79638e",
+#     image={"id"=>"57a67f8a-7bae-4578-b684-b9b4dcd48d7f"},
+#     name="test",
+#     personality=nil,
+#     progress=0,
+#     accessIPv4="",
+#     accessIPv6="",
+#     availability_zone="nova",
+#     user_data_encoded=nil,
+#     state="ACTIVE",
+#     created=2016-03-07 08:07:36 UTC,
+#     updated=2016-03-07 08:07:52 UTC,
+#     tenant_id="06a9a90c60074cdeae5f7fdd0048d9ac"
+#     ...
+#   >
+```
+
+And destroy it when we're done:
+
+```ruby
+instance.destroy
+# => true
+```
+
+You'll probably need your instances to be accessible via SSH. [Learn more about SSH keypairs](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/).
+
+Allow TCP traffic through port 22:
+
+```ruby
+security_group = compute.security_groups.create name:  "Test SSH",
+                                                description: "Allow access to port 22"
+# =>   <Fog::Compute::OpenStack::SecurityGroup
+#     id="e5d53d00-b3f9-471a-b90f-985694b966ed",
+#     name="Test SSH",
+#     description="Allow access to port 22",
+#     security_group_rules=    <Fog::Compute::OpenStack::SecurityGroupRules
+#       [
+
+#       ]
+#     >,
+#     tenant_id="06a9a90c60074cdeae5f7fdd0048d9ac"
+#   >
+
+compute.security_group_rules.create parent_group_id: security_group.id,
+                                    ip_protocol:     "tcp",
+                                    from_port:       22,
+                                    to_port:         22
+
+key_pair = compute.key_pairs.create name:       "My Public Key",
+                                    public_key: "/full/path/to/ssh.pub"
+# =>   <Fog::Compute::OpenStack::KeyPair
+#     name="My Public Key",
+#     ...
+#     user_id="20746f49211e4037a91269df6a3fbf7b",
+#     id=nil
+#   >
+```
+
+Now create a new server using the security group and keypair we created:
+
+```ruby
+instance = compute.servers.create name:            "Test 2",
+                                  image_ref:       image.id,
+                                  flavor_ref:      flavor.id,
+                                  key_name:        key_pair.name,
+                                  security_groups: security_group
+# =>   <Fog::Compute::OpenStack::Server
+#     id="e18ebdfb-e5f5-4a45-929f-4cc9926dc2c7",
+#     name="Test 2",
+#     state="ACTIVE",
+#     tenant_id="06a9a90c60074cdeae5f7fdd0048d9ac",
+#     key_name="My Public Key",
+#   >
+# (some data omitted for brevity)
+```
+
+Finally, assign a floating IP address to make this instance sit under a world-visible public IP address:
+
+```ruby
+pool_name = compute.addresses.get_address_pools[0]['name']
+floating_ip_address = compute.addresses.create pool: pool_name
+instance.associate_address floating_ip_address.ip
+
+p floating_ip_address
+# =>   <Fog::Compute::OpenStack::Address
+#     id="54064324-ce7d-448d-9753-94497b29dc91",
+#     ip="1.2.3.4",
+#     pool="external",
+#     fixed_ip="192.168.0.96",
+#     instance_id="e18ebdfb-e5f5-4a45-929f-4cc9926dc2c7"
+#   >
+```
+
+Now you can SSH into the instance:
+
+```
+$ ssh cirros@1.2.3.4
+The authenticity of host '1.2.3.4 (1.2.3.4)' can't be established.
+RSA key fingerprint is SHA256:cB0L/owUtcHsMhFhsuSZXxK4oRg/uqP/6IriUomQnQQ.
+Are you sure you want to continue connecting (yes/no)? yes
+Warning: Permanently added '1.2.3.4' (RSA) to the list of known hosts.
+$ pwd
+/home/cirros
+```
+
+### Volume (Cinder)
+
+Create and attach a volume to a running instance:
+
+```ruby
+compute = Fog::Compute::OpenStack.new(@connection_params)
+
+volume = compute.volumes.create name:        "Test",
+                                description: "Testing",
+                                size:        1
+# =>   <Fog::Compute::OpenStack::Volume
+#     id="4a212986-c6b6-4a93-8319-c6a98e347750",
+#     name="Test",
+#     description="Testing",
+#     size=1,
+#     availability_zone="Production",
+#     created_at="2016-03-07T13:40:43.914063",
+#     attachments=[{}]
+#   >
+
+flavor   = compute.flavors[3]
+image    = compute.images[0]
+instance = compute.servers.create name:       "test",
+                                  image_ref:  image.id,
+                                  flavor_ref: flavor.id
+instance.wait_for { ready? }
+
+volume.reload
+
+instance.attach_volume(volume.id, "/dev/vdb")
+```
+
+Detach volume and create a snapshot:
+
+```ruby
+instance.detach_volume(volume.id)
+volume.reload
+
+compute.snapshots.create volume_id:   volume.id,
+                         name:        "test",
+                         description: "test"
+# =>   <Fog::Compute::OpenStack::Snapshot
+#     id="7a8c9192-25ee-4364-be91-070b7a6d9855",
+#     name="test",
+#     description="test",
+#     volume_id="4a212986-c6b6-4a93-8319-c6a98e347750",
+#     status="creating",
+#     size=1,
+#     created_at="2016-03-07T13:47:11.543814"
+#   >
+```
+
+Destroy a volume:
+```ruby
+volume.destroy
+# => true
+```
+
+### Image (Glance)
+
+Download Glance image:
+
+```ruby
+
+image = Fog::Image::OpenStack.new(@connection_params)
+
+image_out = File.open("/tmp/cirros-image-download", 'wb')
+
+streamer = lambda do |chunk, _, _|
+  image_out.write chunk
+end
+
+image.download_image(image.images.first.id, response_block: streamer)
+
+```
+
+Create Glance image from file or URL:
+
+```ruby
+
+cirros_location = "http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img"
+image_out = File.open("/tmp/cirros-image-#{SecureRandom.hex}", 'wb')
+
+streamer = lambda do |chunk, _, _|
+  image_out.write chunk
+end
+
+Excon.get cirros_location, response_block: streamer
+image_out.close
+
+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)
+
+```
+
+Destroy image:
+
+```ruby
+cirros = image.images.get("4beedb46-e32f-4ef3-a87b-7f1234294dc1")
+cirros.destroy
+```
+
+### Identity (Keystone)
+
+List domains (Keystone V3 only):
+
+```ruby
+identity = Fog::Identity::OpenStack.new(@connection_params)
+
+identity.domains
+# =>   <Fog::Identity::OpenStack::V3::Domains
+#     [
+#                   <Fog::Identity::OpenStack::V3::Domain
+#         id="default",
+#         description="",
+#         enabled=true,
+#         name="Default",
+#       >
+#     ]
+#   >
+```
+
+List projects (aka tenants):
+
+```ruby
+identity.projects
+# =>   <Fog::Identity::OpenStack::V3::Projects
+#     [
+#                   <Fog::Identity::OpenStack::V3::Project
+#         id="008e5537d3424295a03560abc923693c",
+#         domain_id="default",
+#         description="Project 1",
+#         enabled=true,
+#         name="project_1",
+#       >,
+#        ...
+#        ]
+
+# On Keystone V2
+identity.tenants
+# =>   <Fog::Identity::OpenStack::V2::Tenants
+#     [ ... ]
+```
+
+List users:
+
+```ruby
+identity.users
+# =>   <Fog::Identity::OpenStack::V3::Users
+#     [ ... ]
+```
+
+Create/destroy new user:
+
+```ruby
+project_id = identity.projects[0].id
+
+user = identity.users.create name: "test",
+                             project_id: project_id,
+                             email: "test@test.com",
+                             password: "test"
+# =>   <Fog::Identity::OpenStack::V3::User
+#     id="474a59153ebd4e709938e5e9b614dc57",
+#     default_project_id=nil,
+#     description=nil,
+#     domain_id="default",
+#     email="test@test.com",
+#     enabled=true,
+#     name="test",
+#     password="test"
+#   >
+
+user.destroy
+# => true
+```
+
+Create/destroy new tenant:
+
+```ruby
+
+project = identity.projects.create name: "test",
+                                   description: "test"
+# =>   <Fog::Identity::OpenStack::V3::Project
+#     id="423559128a7249f2973cdb7d5d581c4d",
+#     domain_id="default",
+#     description="test",
+#     enabled=true,
+#     name="test",
+#     parent_id=nil,
+#     subtree=nil,
+#     parents=nil
+#   >
+
+project.destroy
+# => true
+```
+
+Grant user role on tenant and revoke it:
+
+```ruby
+role = identity.roles.select{|role| role.name == "_member_"}[0]
+# =>   <Fog::Identity::OpenStack::V3::Role
+#     id="9fe2ff9ee4384b1894a90878d3e92bab",
+#     name="_member_",
+#   >
+
+project.grant_role_to_user(role.id, user.id)
+
+project.revoke_role_from_user(role.id, user.id)
+```
+
+### Networking (Neutron)
+
+Set up a project's public gateway (needed for external access):
+
+```ruby
+
+identity  = Fog::Identity::OpenStack.new(@connection_params)
+
+tenants = identity.projects.select do |project|
+  project.name == @connection_params[:openstack_project_name]
+end
+
+tenant_id = tenants[0].id
+
+neutron = Fog::Network::OpenStack.new(@connection_params)
+
+network = neutron.networks.create name:      "default",
+                                  tenant_id: tenant_id
+
+subnet  = network.subnets.create  name:            "default",
+                                  cidr:            "192.168.0.0/24",
+                                  network_id:      network.id,
+                                  ip_version:      4,
+                                  dns_nameservers: ["8.8.8.8", "8.8.4.4"],
+                                  tenant_id:       tenant_id
+
+external_network = neutron.networks.select(&:router_external)[0]
+
+router = neutron.routers.create   name:                  'default',
+                                  tenant_id:             tenant_id,
+                                  external_gateway_info: external_network.id
+
+neutron.add_router_interface router.id, subnet.id
+
+```
+
+### Further Reading
+
+* See [the documentation directory](https://github.com/fog/fog-openstack/tree/master/lib/fog/openstack/docs) for more examples.
+* Read the [OpenStack API documentation](http://developer.openstack.org/api-ref.html).
+* Also, remember that reading the code itself is the best way to educate yourself on how best to interact with this gem.
+
+## Development
+
+```
+$ git clone https://github.com/fog/fog-openstack.git # Clone repository
+$ cd fog-openstack; bin/setup   # Install dependencies from project directory
+$ bundle exec rake test   # Run tests
+$ bundle exec rake spec   # Run tests
+$ bin/console   # Run interactive prompt that allows you to experiment (optional)
+$ bundle exec rake install   # Install gem to your local machine (optional)
+```
+
+You can also use a docker image for development and running tests. Once you have
+cloned the repository, it can be run with:
+```
+$ docker-compose up test
+$ docker-compose up ruby # Start a container with the ruby environment
+```
+
+In order to release a new version, perform the following steps:
+
+1. Update version number in `version.rb`.
+2. Run `bundle exec rake release`, which will create a git tag for the version.
+3. Push git commits and tags.
+4. Push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fog/fog-openstack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).