openinfra
/
interop
Code Issues Proposed changes

Create 2016.01 REVIEW for Board Presentation 

Create a new Guideline for Board and community review
from the current .next guideline.

This patch will be merged at the Board meeting.

NOTE: it is REVIEW status, not approved.  Approval
is scheduled for 2016.01.

Change-Id: I7f0152a80ae4a4619717b9ac89eb691a018847b7
This commit is contained in:
Rob Hirschfeld 2015-10-16 17:54:50 -05:00 committed by robhirschfeld
parent b66a7bfead
commit c1e8b3383f
3 changed files with 3189 additions and 172 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3006
2016.01.json Normal file
View File

File diff suppressed because it is too large Load Diff

181
doc/source/guidelines/2016.01.rst Normal file
View File

@ -0,0 +1,181 @@
=========================
OpenStack DefCore 2016.01
=========================
:Status: review
:Replaces: 2015.07
:JSON Master: http://git.openstack.org/cgit/openstack/defcore/tree/2016.01.json
This document outlines the mandatory capabilities and designated
sections required to exist in a software installation in order to
be eligible to use marks controlled by the OpenStack Foundation.
This document was generated from the `master JSON version <2016.01.json>`_.
Releases Covered
==============================
Applies to Juno, Kilo, Liberty
Platform Components
==============================
:Required: Compute, Object
:Advisory: None
:Deprecated: None
:Removed: None
Compute Component Capabilities
==============================
Required Capabilities
-----------------------
* identity-v3-tokens-create (Keystone)
* compute-auth-create (Nova)
* compute-auth-get (Nova)
* compute-auth-set (Nova)
* compute-images-create (Nova)
* compute-images-delete (Nova)
* compute-images-get (Nova)
* compute-images-list (Nova)
* compute-instance-actions-get (Nova)
* compute-instance-actions-list (Nova)
* compute-keypairs-create (Nova)
* compute-quotas-get (Nova)
* compute-servers-create (Nova)
* compute-servers-delete (Nova)
* compute-servers-get (Nova)
* compute-servers-host (Nova)
* compute-servers-invalid (Nova)
* compute-servers-list (Nova)
* compute-servers-lock (Nova)
* compute-servers-name (Nova)
* compute-servers-reboot (Nova)
* compute-servers-rebuild (Nova)
* compute-servers-resize (Nova)
* compute-servers-stop (Nova)
* compute-servers-update (Nova)
* compute-servers-verify (Nova)
* compute-volume-attach (Nova)
* compute-volume-get (Nova)
* compute-volume-list (Nova)
* images-v2-index (Nova)
* compute-servers-metadata-delete (Nova)
* compute-servers-metadata-get (Nova)
* compute-servers-metadata-list (Nova)
* compute-servers-metadata-set (Nova)
* compute-servers-metadata-update (Nova)
Advisory Capabilities
-----------------------
* networks-floating-ips-CRUD-and-associate (Neutron)
* networks-l3-router (Neutron)
* networks-l2-CRUD (Neutron)
* networks-l3-CRUD (Neutron)
* networks-security-groups-CRUD (Neutron)
* compute-list-api-versions (Nova)
* images-v2-remove (Glance)
* images-v2-update (Glance)
* images-v2-share (Glance)
* images-v2-import (Glance)
* images-v2-list (Glance)
* images-v2-delete (Glance)
* images-v2-get (Glance)
* volumes-v2-create-delete (Cinder)
* volumes-v2-attach-detach (Cinder)
* volumes-v2-snapshot-create-delete (Cinder)
* volumes-v2-get (Cinder)
* volumes-v2-list (Cinder)
* volumes-v2-update (Cinder)
* volumes-v2-copy-image-to-volume (Cinder)
* volumes-v2-copy-volume-to-image (Cinder)
* volumes-v2-clone (Cinder)
* volumes-v2-qos (Cinder)
* volumes-v2-availability-zones (Cinder)
* volumes-v2-extensions (Cinder)
* volumes-v2-metadata (Cinder)
* volumes-v2-transfer (Cinder)
* volumes-v2-reserve (Cinder)
* volumes-v2-readonly (Cinder)
* identity-v3-api-discovery (Keystone)
Deprecated Capabilities
-------------------------
* identity-v2-tokens-create (Keystone)
* compute-servers-change (Nova)
Removed Capabilities
----------------------
None
Object Component Capabilities
=============================
Required Capabilities
-----------------------
* objectstore-object-access (Swift)
* objectstore-object-copy (Swift)
* objectstore-object-create (Swift)
* objectstore-object-delete (Swift)
* objectstore-object-get (Swift)
* objectstore-object-put (Swift)
* objectstore-object-upload (Swift)
* objectstore-object-versioned (Swift)
* objectstore-temp-url-get (Swift)
* identity-v3-tokens-create (Keystone)
Advisory Capabilities
-----------------------
None
Deprecated Capabilities
-------------------------
* identity-v2-tokens-create (Keystone)
Removed Capabilities
----------------------
None
Designated Sections
=====================================
The following designated sections apply to the same releases as
this specification.
Required Designated Sections
----------------------------
* Cinder : Designated sections are the API implementation code
* Glance : Designated sections are the API implementation code and domain
model.
* Keystone : Designation is outlined per API grouping. Identity (user and
group) management APIs will not be designated. API access (with exception of
auth) may be prohibited by policy (resulting in HTTP 403). Designated APIs
include both v2.0 and v3 versions where applicable.
* Nova : By default, designated except scheduler, filter, drivers, API
extensions and networking.
* Swift : Designated sections are proxy server, object server, container
server, account server and select middleware
Advisory Designated Sections
----------------------------
* Neutron : By default, designated for all code backing required capabilities
except plugable components such as plugins, drivers, and API extensions other
than those listed below.
Deprecated Designated Sections
------------------------------
None
Removed Designated Sections
---------------------------
None

174
next.json
View File

@ -1,10 +1,10 @@
{
"id": "2016.next",
"id": "next",
"schema": "1.3",
"reference": "https://git.openstack.org/cgit/openstack/defcore/schema/1.3.rst",
"source": "http://git.openstack.org/cgit/openstack/defcore/",
"status": "draft",
"replaces": "2015.05",
"replaces": "2016.01",
"releases": ["juno", "kilo", "liberty"],
"platform": {
"required": ["compute", "object"],
@ -2835,173 +2835,3 @@
"trust API": {"description": "APIs for managing delegation (via trusts) of roles from one user/group to another user/group", "designated": true, "comment": "none provided"},
"resource API": {"description": "APIs for managing resources (projects/tenants and/or domains)", "designated": true, "comment": "In the releases prior to Kilo this is covered by the assignment API"},
"revoke API": {"description": "APIs for revocation event handling", "designated": false, "comment": "Highly recommended and required for Fernet (non-persistent) tokens"}
}
},
"glance": {
"guidance": "Designated sections are the API implementation code and domain model.",
"comment": "not given",
"sections": {
"http apis": { "description": "not provided", "designated": true, "comment": "API"},
"domain model": { "description": "not provided", "designated": true, "comment": "Shared"},
"stores": { "description": "the swift, filesystem, and http stores", "designated": false, "comment": "should be replaceable, vendor-specificddCross platform"},
"db driver": { "description": "not provided", "designated": false, "comment": "should be replaceable" },
"wsgi framework": { "description": "not provided", "designated": false, "comment": "should be replaceable"}
}
},
"cinder": {
"guidance": "Designated sections are the API implementation code",
"comment": "Historically, cinder has had plug-ins around schedulers and drivers.",
"sections": {
"api": { "description": "API section means actually the CODE that exposes the API, not just API-comparability", "designated": true, "comment": ""},
"drivers": { "description": "not provided", "designated": false, "comment": "there MUST be requirements that it implements what's defined as core functionality in the Cinder API"},
"scheduler": { "description": "not provided", "designated": false, "comment": "there MUST be requirements that it implements what's defined as core functionality in the Cinder API"},
"api extensions": { "description": "not provided", "designated": false, "comment": "should be replaceable"}
}
},
"swift" : {
"guidance": "Designated sections are proxy server, object server, container server, account server and select middleware",
"required": true,
"comment": "You should use the proxy and storage servers, and you can use your own DiskFile or add new middleware for the proxy or storage nodes. Please review sections for specific middleware guidelines",
"sections": {
"proxy server": { "description": "the proxy server code and, if enabled, the functionality implemented by provided middleware (eg static large objects or signed urls or bulk requests",
"designated": true, "comment": ""},
"object server": { "description": "the object server code that calls a DiskFile implementation and updates container listings",
"designated": true, "comment": ""},
"container server": { "description": "the code that provides a list of objects in a container and container metadata",
"designated": true, "comment": ""},
"account server": { "description": "the code that provides a list of containers and account metadata",
"designated": true, "comment": ""},
"catch_errors": { "description": "not provided", "designated": true, "comment": "middleware"},
"healthcheck": { "description": "not provided", "designated": true, "comment": ""},
"bulk": { "description": "not provided", "designated": true, "comment": ""},
"slo": { "description": "not provided", "designated": true, "comment": ""},
"container-quotas": { "description": "not provided", "designated": true, "comment": ""},
"account-quotas": { "description": "not provided", "designated": true, "comment": ""},
"tempurl": { "description": "not provided", "designated": true, "comment": ""},
"replicators": { "description": "not provided", "designated": false, "comment": "recommended"},
"auditors": { "description": "not provided", "designated": false, "comment": "recommended"},
"updaters": { "description": "not provided", "designated": false, "comment": "recommended"},
"account reaper": { "description": "not provided", "designated": false, "comment": "recommended"},
"object expirer": { "description": "not provided", "designated": false, "comment": "recommended"},
"ratelimit": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
"recon": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
"staticweb": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
"formpost": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
"domain_remap": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
"crossdomain": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
"cname_lookup": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
"diskfile": { "description": "the part of the object server that actually persists the object data to a storage volume",
"designated": false, "comment": "replaceable"},
"cache": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"},
"tempauth": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"},
"keystoneauth": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"},
"proxy-logging": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"}
}
}
},
"advisory" : {
"neutron" : {
"guidance": "By default, designated for all code backing required capabilities except plugable components such as plugins, drivers, and API extensions other than those listed below.",
"required": false,
"comment": "Intentionally replaceable code such as network plugins, ML2 drivers, IPAM drivers, schedulers are not designated.",
"sections": {
"Scheduler drivers": { "description": "Scheduler drivers", "designated": false, "comment": "none provided"},
"IPAM drivers": { "description": "IPAM drivers", "designated": false, "comment": "none provided"},
"Network plugins": { "description": "Network backend plugins", "designated": false, "comment": "none provided"},
"ML2 drivers": { "description": "ML2 type and mechanism drivers", "designated": false, "comment": "none provided"},
"Core API and server": { "description": "Core API and server", "designated": true, "comment": "none provided"},
"Core API quota extension": { "description": "Quota API", "designated": true, "comment": "none provided"},
"Core API security group extension": { "description": "Security group API", "designated": true, "comment": "none provided"},
"Core API L3 extension": { "description": "L3 API for floating IPs and routers", "designated": true, "comment": "none provided"},
"Agents": { "description": "Agents if used by relevant driver", "designated": true, "comment": "Some drivers require the use of community-developed agents to provide required Capabilities (such as L3 networking). If a product uses such agents, they are designated."},
"RPC": { "description": "RPC API", "designated": true, "comment": "none provided"}
}
}
},
"deprecated" : {},
"removed" : {},
"informational" : {
"heat": {
"guidance": "Not a core capability, no position at this time",
"required": false,
"comment": "",
"sections": []
},
"horizon": {
"guidance": "Not a core capability, no position at this time",
"required": false,
"comment": "",
"sections": []
},
"ceilometer": {
"guidance": "Not a core capability, no position at this time",
"required": false,
"comment": "",
"sections": []
}
}
},
"criteria": {
"atomic": {
"Description": "Capabilities is unique and cannot be built out of other must-pass capabilities",
"name": "Atomic",
"weight": 8
},
"clients": {
"Description": "Candidates are widely used capabilities: Should be included if part of common libraries (Fog, Apache jclouds, etc)",
"name": "Used by Clients",
"weight": 8
},
"complete": {
"Description": "Where the code being tested has a designated area of alternate implementation (extension framework) as per the Core Principles, there should be parity in capability tested across extension implementations. This also implies that the capability test is not configuration specific or locked to non-open technology",
"name": "Complete",
"weight": 8
},
"deployed": {
"Description": "Candidates are widely deployed capabilities. We favor capabilities that are supported by multiple public cloud providers and private cloud products",
"name": "Widely Deployed",
"weight": 8
},
"discover": {
"Description": "Capability being tested is Service Discoverable (can be found in Keystone and via service introspection)",
"name": "Discoverable",
"weight": 8
},
"doc": {
"Description": "Should be well documented, particularly the expected behavior. This can be a very subjective measure and we expect to refine this definition over time",
"name": "Documented",
"weight": 8
},
"foundation": {
"Description": "Test capabilities that are required by other must-pass tests and/or depended on by many other capabilities",
"name": "Foundation",
"weight": 8
},
"future": {
"Description": "Should reflect future technical direction (from the project technical teams and the TC) and help manage deprecated capabilities",
"name": "Future Direction",
"weight": 9
},
"proximity": {
"Description": "Sometimes called a Test Cluster, selects for Capabilities that are related to Core Capabilities. This helps ensure that related capabilities are managed together",
"name": "Proximity",
"weight": 8
},
"stable": {
"Description": "Test is required stable for >2 releases because we don't want DefCore capabilities that do not have dependable APIs",
"name": "Stable",
"weight": 9
},
"sticky": {
"Description": "A test that is a must-pass test should stay a must-pass test. This makes DefCore capabilities sticky release per release. Leaving Core is disruptive to the ecosystem",
"name": "Core in Last Release",
"weight": 9
},
"tools": {
"Description": "Candidates are widely used capabilities:Should be included if supported by common tools (RightScale, Scalr, CloudForms, ...)",
"name": "Used by Tools",
"weight": 9
}
}
}