Mark T. Voelker 3b2523a621 Move Guidelines into doc directory
As we add more and more Guidelines over time, the top-level
directory of the defcore repo is becoming increasingly cluttered.
Further, each Guideline includes an RST file that could be
rendered on docs.openstack.org and/or gate-checked for validity
like other RST documents.  This patch moves the Guideline docs
into a dedicated folder in the doc directory using a structure
akin to that of the process docs that already reside there. [1][2]
It also cleans up a few references to documents already in the
doc directory that were missed earlier, and adds a note to the
README indicating what the doc/sources/guidelines directory
contains.

Note that a few links on http://openstack.org/interop and DefCore
wiki pages may need to be updated if/when this change lands.  It
is therefore suggested that this patch be merged only when the
relevant Foundation staff are prepared to make corresponding
updates to the website in order to avoid broken links.

[1] https://review.openstack.org/#/c/189950/
[2] https://review.openstack.org/#/c/189956/

Change-Id: Iddd8a4c191c490f4b0afb8c88c8520da4b97576b
2015-07-30 14:48:54 -05:00

118 lines
2.6 KiB
ReStructuredText

=========================
OpenStack DefCore 2015.05
=========================
:Status: approved
:Replaces: 2015.04
:JSON Master: http://git.openstack.org/cgit/openstack/defcore/tree/2015.05.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 <2015.05.json>`_.
Releases Covered
==============================
Applies to Icehouse, Juno, Kilo
Platform Components
==============================
:Required: Compute, Object
:Advisory: None
:Deprecated: None
:Removed: None
Compute Component Capabilities
==============================
Required Capabilities
-----------------------
* identity-auth (Keystone)
* compute-auth (Nova)
* compute-flavors (Nova)
* compute-images (Nova)
* compute-instance-actions (Nova)
* compute-keypairs (Nova)
* compute-quotas (Nova)
* compute-servers (Nova)
* compute-volume (Nova)
* images-v2 (Nova)
Advisory Capabilities
-----------------------
* auth-token (Keystone)
* compute-servers-metadata (Nova)
Deprecated Capabilities
-------------------------
None
Removed Capabilities
----------------------
None
Object Component Capabilities
=============================
Required Capabilities
-----------------------
* objectstore-object (Swift)
Advisory Capabilities
-----------------------
* identity-auth (Keystone)
* auth-token (Keystone)
Deprecated Capabilities
-------------------------
None
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
----------------------------
None
Deprecated Designated Sections
------------------------------
None
Removed Designated Sections
---------------------------
None