THIS POST IS #4 IN A SERIES ABOUT “WHAT IS CORE.”
It’s time to move to the what from the how and why. In my experience discussing the framework, it’s important to understand the context at this point because our objective is to define the common ground. If you mistake the intent then it’s much harder to understand the details, but here they are…
I’m hopeful that the framework we’re defining today will ultimately be taken for granted. Until then, relax and remember that this straw man is a work in progress.
These positions have been crafted over the course of several weeks and are constantly evolving. Next steps are to expand discussions to the OpenStack Community for input and review at the next Board Meeting on August 6th. Ultimately, we need to close this issue at the next Summit.
I present them here for reference and encourage the community to bring up dialog on the OpenStack list (positions are sourced here).
Update Aug 13, 2013: These original 12 points have been refined down to 10.
You’re welcome to read the original 12 below, but I recommend skipping over to the refined set.
- SINGLE API / MULTIPLE IMPLEMENTATION MODEL (aka PLUG-IN) DESIRED FOR PROJECTS
- OpenStack will require an open source reference base plug-in implementation for projects (if not part of OpenStack, license model for reference plug-in must be compatible).
- Definition of a plug-in: alternate backend implementations with a common API framework that uses common _code_ to implement the API
- This expects that projects (where technically feasible) are expected to implement a plug-in architecture.
- This is already in place for several projects and addresses around ecosystem support, enabling innovation
- Reference plug-ins are, by definittion, the complete capability set. It is not acceptable to have “core” features that are not functional in the reference plug-in
- API EXTENSION MODEL EXPECTED FOR PROJECTS
- OpenStack will follow architectures patterns that enable API extensions.
- This will enable plug-ins to offer innovative or differentiated features without forcing changes to the reference plug-in implementation
- This will enable the reference to expand without forcing other plug-ins to match all features and recertify
- COMMUNITY MAINTAINED TESTS (TEMPEST?) USED AS BASIS FOR OPENSTACK MARK
- Vendor OpenStack implementations must achieve 100% of must-have coverage?
- Implemented tests can be flagged as may-have requires list [Joshua McKenty]
- Certifiers will be required to disclose their testing gaps.
- This will put a lot of pressure on the Tempest project
- Maintenance of the testing suite to become a core Foundation responsibility. This may require additional resources
- VALIDIBLE REMOTE SELF-CERTIFICATION (ON DEMAND TESTING)
- Plug-in certification is driven by Tempest self-certification model
- Self-certifiers are required to publish their results
- Self-certified are required to publish enough information that a 3rd party could build the reference implementation to pass the tests.
- Self-certified must include the operating systems that have been certified
- It is preferred for self-certified implementation to reference an OpenStack reference architecture “flavor” instead of defining their own reference. (a way to publish and agree on flavors is needed)
- The Foundation needs to define a mechanism of dispute resolution. (A trust but verify model)
- SUBSTITUTE PLUG-IN IMPLEMENTATIONS OK
- If a vendor plug-in passes all relevant tests then it can be considered a full substitute for the reference plug-in
- If a vendor plug-in does NOT pass all relevant test then the vendor is required to include the open source reference in the implementation.
- From the may have pick list – must have all must haves. Must haves are ‘core’ See number 12
- TESTING CERTIFICATION BY PLUG-IN IF >1 REFERENCE PLUG-IN
- Looking forward to having multiple reference plug-ins, Tempest may to distinguish between multiple reference plug-ins.
- You can pass certification by passing just one reference test suite + the project tests.
- The objective for this position is to allow for future OpenStack functions that requires breaking changes to implementation
- OPENSTACK DEFINITIONS APPLY EQUALLY TO ALL DEPLOYMENTS
- There should not be multiple definitions of OpenStack depending on the operator (public, private, community, etc)
- While expected that each deployment is identical, the differences must be quantifiable.
- DISCOVERABLITY OF COMPATIBILITY (VARIATION IS OK)
- Implementations and products are allowed to have variation based on publication of compatibility
- Consumers must have a way to determine how the system is different from reference (posted, discovered, etc)
- Testing must respond in an appropriate way on BOTH pass and fail (the wrong return rejects the entire suite)
- We are NOT stating which projects are required in this position
- MUST USE OPENSTACK API IMPLEMENTATION CODE
- Implementation’s claiming the OpenStack Mark must use the API framework code
- You are not OpenStack, if you pass all the tests but do not use the API framework
- This prevents people from using the API without joining the community
- This also surfaces bit-rot in “PLUGINS” to the larger community
- This behavior improves interoperability because there is more shared code between implementation
- API CONSUMERS SELF-CERTIFY AGAINST THE REFERENCE IMPLEMENTATION
- As an ecosystem partner, you have a need to make a “works against OpenStack” statement that is supportable
- API consumer can claim working against the OpenStack API if it works against any implementation passing all the “must have” tests(YES)
- API consumers can state they are working against the OpenStack API with some “may have” items as requirements
- API consumers are expected to write tests that validate their required behaviors (submitted as “may have” tests)
- The TC will decide which tests are elevated from may-have to must-have
- THE “MUST-HAVE” TESTS DEFINE “OPENSTACK CORE”
- We are NOT defining which items are on the list in this effort, just making the position that it is how we will define core
- May-have tests include items in the integrated release, but which are not core.
- We will have a process by which tests are elevated from may to must lists
- Potentially: the User Committee will nominate tests that elevated to the board
- Must haves – must comply with the Core criteria defined from the IncUp committee results
- The OpenStack board owns the responsibility to define ‘core’ – to approve ‘musts’
- Projects in Incubation or pre-Incubation are not to be included in the ‘may’ list
- SPIDER AND CORE DEFINE A SUBSET OF ALL OPENSTACK TRADEMARKS
- There may be other marks that are managed separately by the foundation, and available for the platform ecosystem as per the Boards discretion
- “OpenStack API Compatible ” mark not part of this discussion. Note: position on this is not clear and should be not be assumed.
- This topic is difficult to close at this time and requires a breath of testing that does not yet exist
- This is a temporary working position that may be revisited
READ POST IS #5: COMMUNITY FEEDBACK