| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 1 | == Gophercloud -- V0.1.0 image:https://secure.travis-ci.org/rackspace/gophercloud.png?branch=master["build status",link="https://travis-ci.org/rackspace/gophercloud"] |
| Glen Campbell | a1f6f22 | 2013-06-20 11:10:46 -0700 | [diff] [blame] | 2 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 3 | Gophercloud currently lets you authenticate with OpenStack providers to create and manage servers. |
| 4 | We are working on extending the API to further include cloud files, block storage, DNS, databases, security groups, and other features. |
| Samuel A. Falvo II | ff3f09d | 2013-06-20 17:54:26 -0700 | [diff] [blame] | 5 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 6 | WARNING: This library is still in the very early stages of development. Unless you want to contribute, it probably isn't what you want. Yet. |
| Samuel A. Falvo II | 9e271cf | 2014-02-25 11:21:43 -0800 | [diff] [blame] | 7 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 8 | === Outstanding Features |
| Samuel A. Falvo II | 0755281 | 2013-06-27 15:02:13 -0700 | [diff] [blame] | 9 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 10 | 1. Apache 2.0 License, making Gophercloud friendly to commercial and open-source enterprises alike. |
| 11 | 2. Gophercloud is one of the most actively maintained Go SDKs for OpenStack. |
| 12 | 3. Gophercloud supports Identity V2 and Nova V2 APIs. More coming soon! |
| 13 | 4. The up-coming Gophercloud 0.2.0 release supports API extensions, and makes writing support for new extensions easy. |
| 14 | 5. Gophercloud supports automatic reauthentication upon auth token timeout, if enabled by your software. |
| 15 | 6. Gophercloud is the only SDK implementation with actual acceptance-level integration tests. |
| Samuel A. Falvo II | ff3f09d | 2013-06-20 17:54:26 -0700 | [diff] [blame] | 16 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 17 | === What Does it Look Like? |
| Samuel A. Falvo II | ff3f09d | 2013-06-20 17:54:26 -0700 | [diff] [blame] | 18 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 19 | The Gophercloud 0.1.0 and earlier APIs are now deprecated and obsolete. |
| 20 | No new feature development will occur for 0.1.0 or 0.0.0. |
| 21 | However, we will accept and provide bug fixes for these APIs. |
| 22 | Please refer to the acceptance tests in the master brach for code examples using the v0.1.0 API. |
| 23 | The most up to date documentation for version 0.1.x can be found at link:http://godoc.org/github.com/rackspace/gophercloud[our Godoc.org documentation]. |
| Samuel A. Falvo II | ff3f09d | 2013-06-20 17:54:26 -0700 | [diff] [blame] | 24 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 25 | We are working on a new API that provides much better support for extensions, pagination, and other features that proved difficult to implement before. |
| 26 | This new API will be substantially more Go-idiomatic as well; one of the complaints received about 0.1.x and earlier is that it didn't "feel" right. |
| 27 | To see what this new API is going to look like, you can look at the code examples up on the link:http://gophercloud.io/docs.html[Gophercloud website]. |
| 28 | If you're interested in tracking progress, note that features for version 0.2.0 will appear in the `v0.2.0` branch until merged to master. |
| Samuel A. Falvo II | 0755281 | 2013-06-27 15:02:13 -0700 | [diff] [blame] | 29 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 30 | === How can I Contribute? |
| Samuel A. Falvo II | 0755281 | 2013-06-27 15:02:13 -0700 | [diff] [blame] | 31 | |
| Marc Abramowitz | e012f6d | 2014-08-12 09:10:00 -0700 | [diff] [blame] | 32 | After using Gophercloud for a while, you might find that it lacks some useful feature, or that existing behavior seems buggy. We welcome contributions |
| 33 | from our users for both missing functionality as well as for bug fixes. We encourage contributors to collaborate with the |
| 34 | link:http://gophercloud.io/community.html[Gophercloud community.] |
| Samuel A. Falvo II | 0755281 | 2013-06-27 15:02:13 -0700 | [diff] [blame] | 35 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 36 | Finally, Gophercloud maintains its own link:http://gophercloud.io[announcements and updates blog.] |
| 37 | Feel free to check back now and again to see what's new. |
| Samuel A. Falvo II | 0755281 | 2013-06-27 15:02:13 -0700 | [diff] [blame] | 38 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 39 | == License |
| stackedsax | 563bf05 | 2013-06-25 13:21:00 -0700 | [diff] [blame] | 40 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 41 | Copyright (C) 2013, 2014 Rackspace, Inc. |
| Samuel A. Falvo II | ff3f09d | 2013-06-20 17:54:26 -0700 | [diff] [blame] | 42 | |
| Samuel A. Falvo II | d79a705 | 2014-03-10 17:18:03 -0700 | [diff] [blame] | 43 | Licensed under the Apache License, Version 2.0 |
| Samuel A. Falvo II | ff3f09d | 2013-06-20 17:54:26 -0700 | [diff] [blame] | 44 | |