Jump to: navigation, search

Difference between revisions of "RefStack"

(Architecture)
m (Change doc references from DefCore to InteropWG)
(19 intermediate revisions by 6 users not shown)
Line 1: Line 1:
'''The vendor-facing toolset for registration of interop-compliance endpoints and credentials for on-demand testing'''<br/>
+
'''Toolset for testing interoperability between OpenStack clouds.'''<br />
  
Welcome to the home page of RefStack. Right now, it is mostly a collection of digital documents that inform the RefStack project, but this page will get cleaned up and ordered as the organizing process goes on.
+
== RefStack Design ==
 +
 
 +
RefStack provides the [[Governance/InteropWG|Interop Working Group]], a.k.a. DefCore committee, the tools for vendors and other users to run API tests against their clouds to provide the Interop Working Group with a reliable overview of what APIs and capabilities are being used in the marketplace. This will help to guide the Interop Working Group-defined capabilities and help ensure interoperability across the entire OpenStack ecosystem. It can be used to validate whether and how well actual OpenStack installations fit the OpenStack Foundation's requirements for OpenStack [http://www.openstack.org/brand/interop/ branding]. As determined through requirements analysis and specifications, it consists of a client that will gather OpenStack Tempest test results for the Stack under test, a User Interface for analyzing results, and a reporting structure that allows on-line and off-line options for submission for certification.
  
== RefStack Design ==
 
RefStack is the intended tool to validate whether and how well actual OpenStack installations fit the OpenStack Foundation's requirements for OpenStack branding. As determined through requirements analysis and specifications, it consists of a backend that will run OpenStack Tempest tests from a container installed on the Stack under test, a User Interface for configuring test runs and analyzing results, and a reporting structure that allows no, on-line, and off-line options for submission for certification.
 
 
=== Requirements ===
 
=== Requirements ===
[[RefStack/DefCore_Requirements|DefCore Specified Requirements]]<br />
+
 
 +
[[RefStack/DefCore_Requirements|Interop Working Group Requirements]]<br />
 
[[RefStack/UseCases|Use Cases]]<br />
 
[[RefStack/UseCases|Use Cases]]<br />
[[RefStack/Tempest_Reqs|Tempest Requirements]]
 
  
 
=== Architecture ===
 
=== Architecture ===
'''For a quick overview, see the''' [https://github.com/stackforge/refstack Refstack README]<br />
+
'''For a quick overview, see the''' [https://github.com/openstack/refstack RefStack README]<br />
 +
 
 +
==== refstack-server ====
 +
The RefStack server is comprised of two components: the API and the UI. The API contains the REST endpoints needed for a user to upload and retrieve test result data sets which are stored in a MySQL database. The UI is an AngularJS based front-end for browsing uploaded data and viewing how test results stack up against Interop Working Group capabilities.
  
[[RefStack/TCup|TCup -- Tempest in a Container]]<br />
+
==== refstack-client ====
[[RefStack/UI|RefStack User Interface]]<br />
+
The RefStack client is a Tempest wrapper that will run the Tempest API tests and will format the results in a way that the RefStack API expects. The client does the following things:
[[RefStack/Database|RefStack Database]]<br />
+
* Extracts just the 'Passed' tests from the generated subunit file.
[[RefStack/API|RefStack API]]<br />
+
* Retrieves the cloud provider ID (here, we use the Keystone service ID as the CPID), and associates it with the results.
[[RefStack/ProcessFlow|RefStack Process Flow]]
+
* Gives the ability to upload data to a RefStack server.
  
 
== Resources ==
 
== Resources ==
'''Website:'''  http://refstack.org/<br />
+
'''Website:'''  https://refstack.openstack.org/<br />
Mailing list: fits@lists.openstack.org<br />
+
Mailing list: openstack-dev@lists.openstack.org<br />
 
IRC:
 
IRC:
 
:Server:  irc.freenode.net
 
:Server:  irc.freenode.net
Line 29: Line 32:
  
 
=== Repositories ===
 
=== Repositories ===
https://github.com/stackforge/refstack<br/>
+
https://github.com/openstack/refstack<br />
git@github.com:stackforge/refstack.git
+
https://github.com/openstack/refstack-client
 
 
=== Etherpads ===
 
==== DefCore ====
 
Much discussion, requirements definition and design for RefStack take place under the DefCore Umbrella.  So as not to lose this knowledge, that which is not included on the Defcore pages is incorporated within the RefStack pages.<br />
 
 
 
[[Governance/DefCoreCommittee|DefCore Committee]]
 
 
 
https://etherpad.openstack.org/p/DefCoreTestCriteria<br />
 
https://etherpad.openstack.org/p/DefCoreRefStackUseCases<br />
 
https://wiki.openstack.org/wiki/Meetings/DefCore
 
 
 
==== RefStack ====
 
https://etherpad.openstack.org/p/RefStack_2-19-14_F2F_meeting_notes<br/>
 
  
=== Planning and Schedules ===
 
* Roadmap (link to Roadmap on governance page?)
 
* Sprints (link to Trello)
 
 
=== RefStack Meetings ===
 
=== RefStack Meetings ===
 
Weekly IRC meeting:
 
Weekly IRC meeting:
:Thursdays 2200UTC in #meeting-alt
+
[[Meetings/Refstack| Meeting page]]
[http://eavesdrop.openstack.org/meetings/refstack/2014/ 2014 Minutes and log directory]<br />
 
https://etherpad.openstack.org/p/RefStack_Full_Minutes_2-20-2014<br/>
 
[[Meetings#DefCore_.2F_RefStack_Development_Meeting|DefCore/RefStack Development Meeting]]<br />
 
[https://etherpad.openstack.org/p/refstack-hack-day-march3 RefStack Hack Day March3]
 
  
=== DefCore Meetings ===
+
=== Blueprints ===
OpenStack-DefCore Bylaws Subcommittee Meeting
+
https://blueprints.launchpad.net/refstack<br />
:Thu 3/13/2014  15:30 UTC
 
:+1-702-696-4520; or +1-866-409-2889; Participant Code: 261 942 3593
 
'''Geolocated Meetings'''
 
  
[[Meetings#DefCore_Progress_Update_Meeting|DefCore Progress Update Meeting]] PistonCloud, San Francisco, CA<br />
+
=== Reviews ===
: Agenda at https://etherpad.openstack.org/p/DefCoreElephant.4<br />
+
[https://review.openstack.org/#/q/status:open+openstack/refstack,n,z Gerrit RefStack Reviews]<br />
:3pm PST (01:00 3/4/2014 UTC)
 
  
March working meeting:  3/3/2014  Tentative location:  PistonCloud, San Francisco, CA
+
=== FAQs ===
:Working Technical meetup 9am-5pm PST
 
:Defcore Committee Meeting 3pm-5pm PST (01:00 3/4/2014 UTC)
 
  
=== Blueprints ===
 
https://blueprints.launchpad.net/refstack<br/>
 
https://etherpad.openstack.org/p/RefStackBlueprint
 
=== Reviews ===
 
[https://review.openstack.org/#/q/status:open+project:stackforge/refstack,n,z Gerrit RefStack Reviews]
 
=== FAQs ===
 
 
=== Blogs, Articles, Etc. ===
 
=== Blogs, Articles, Etc. ===
 
http://robhirschfeld.com/2014/01/07/defcore-critieria/
 
http://robhirschfeld.com/2014/01/07/defcore-critieria/
 +
 +
[[Category:InteropWG]]

Revision as of 23:58, 9 December 2016

Toolset for testing interoperability between OpenStack clouds.

RefStack Design

RefStack provides the Interop Working Group, a.k.a. DefCore committee, the tools for vendors and other users to run API tests against their clouds to provide the Interop Working Group with a reliable overview of what APIs and capabilities are being used in the marketplace. This will help to guide the Interop Working Group-defined capabilities and help ensure interoperability across the entire OpenStack ecosystem. It can be used to validate whether and how well actual OpenStack installations fit the OpenStack Foundation's requirements for OpenStack branding. As determined through requirements analysis and specifications, it consists of a client that will gather OpenStack Tempest test results for the Stack under test, a User Interface for analyzing results, and a reporting structure that allows on-line and off-line options for submission for certification.

Requirements

Interop Working Group Requirements
Use Cases

Architecture

For a quick overview, see the RefStack README

refstack-server

The RefStack server is comprised of two components: the API and the UI. The API contains the REST endpoints needed for a user to upload and retrieve test result data sets which are stored in a MySQL database. The UI is an AngularJS based front-end for browsing uploaded data and viewing how test results stack up against Interop Working Group capabilities.

refstack-client

The RefStack client is a Tempest wrapper that will run the Tempest API tests and will format the results in a way that the RefStack API expects. The client does the following things:

  • Extracts just the 'Passed' tests from the generated subunit file.
  • Retrieves the cloud provider ID (here, we use the Keystone service ID as the CPID), and associates it with the results.
  • Gives the ability to upload data to a RefStack server.

Resources

Website: https://refstack.openstack.org/
Mailing list: openstack-dev@lists.openstack.org
IRC:

Server: irc.freenode.net
Channel: #refstack

Launchpad home page: https://launchpad.net/refstack

Contains links to blueprints, bugs and other project tracking information

Repositories

https://github.com/openstack/refstack
https://github.com/openstack/refstack-client

RefStack Meetings

Weekly IRC meeting: Meeting page

Blueprints

https://blueprints.launchpad.net/refstack

Reviews

Gerrit RefStack Reviews

FAQs

Blogs, Articles, Etc.

http://robhirschfeld.com/2014/01/07/defcore-critieria/