Update readme to current information.

Change-Id: If801581b140e153418c5dc8182b37249640d5d06
This commit is contained in:
David Lenwell 2015-02-15 19:25:55 -08:00
parent 5c09a4a57e
commit baced31e2a

View File

@ -1,32 +1,61 @@
RefStack/TCUP and Driver Test
=============================
refstack
========
This project support collection and publication of Community Test results for OpenStack. There are multiple components of this effort:
**What is refstack?**
* `RefStack <doc/refstack.md>`_: Community-facing API for registration of interop-compliance endpoints for on-demand testing.
* Driver Test
- Toolset for testing interoperability between OpenStack clouds.
- Database backed website supporting collection and publication of
Community Test results for OpenStack.
- User interface to display individual test run results.
Participate
-----------------------------------------
**Overview**
* General
* Mailing List: fits@openstack.org
* IRC: #refstack on Freenode
* Dev Meetings: https://wiki.openstack.org/wiki/Meetings#DefCore_.2F_RefStack_Development_Meeting
* Web-site: http://refstack.org
* Wiki: https://wiki.openstack.org/wiki/RefStack
refstack intends on being THE source of tools for interoperability testing
of OpenStack clouds.
* Development
refstack provides users in the OpenStack community with a Tempest wrapper,
refstack-client, that helps to verify interoperability of their cloud
with other OpenStack clouds. It does so by validating any cloud
implementation against the OpenStack Tempest API tests.
* Launchpad: https://launchpad.net/refstack
* Blueprints: https://blueprints.launchpad.net/refstack
* Bugs: https://bugs.launchpad.net/refstack
* Code Reviews: https://review.openstack.org/#q,status:open+refstack,n,z
**refstack and DefCore** - The prototypical use case for refstack provides
the DefCore Committee the tools for vendors and other users to run API
tests against their clouds to provide the DefCore committee with a reliable
overview of what APIs and capabilities are being used in the marketplace.
This will help to guide the DefCore-defined capabilities and help ensure
interoperability across the entire OpenStack ecosystem. It can also
be used to validate clouds against existing DefCore capability lists,
giving you assurance that your cloud faithfully implements OpenStack
standards.
Collecting the Results > Running RefStack
-----------------------------------------
**Value Add for Vendors** - Vendors can use refstack to demonstrate that
their distros, and/or their customers' installed clouds remain with OpenStack
after their software has been incorporated into the distro or cloud.
RefStack is a Web UI and API used to collect and display test results. This information is used by the DefCore committee to help select must-pass capabilities.
**refstack consists of two parts:**
`RefStack docs <doc/refstack.md>`_
* **refstack-api**
Our API isn't just for us to collect data from private and public cloud
vendors. It can be used by vendors in house to compare interoperability
data over time.
* install docs: `doc/refstack.md <doc/refstack.md>`_
* repository: http://git.openstack.org/cgit/stackforge/refstack
* storyboard: https://storyboard.openstack.org/#!/project/700
* reviews: https://review.OpenStack.org/#q,status:open+refstack,n,z
* **refstack-client**
refstack-client contains the tools you will need to run the DefCore tests.
* repository: http://git.openstack.org/cgit/stackforge/refstack-client
* storyboard: https://storyboard.openstack.org/#!/project/703
* reviews: https://review.openstack.org/#q,status:open+refstack-client,n,z
**Get involved!**
* Mailing List: fits@OpenStack.org
* IRC: #refstack on Freenode
* Dev Meetings: Mondays @ 19:00 UTC in #openstack-meeting-alt on Freenode
* Web-site: http://refstack.net
* Wiki: https://wiki.OpenStack.org/wiki/refstack