f597dd12c0
At the April 8, 2015 DefCore Scale.11 meeting, the DefCore committee decided to migrate some existing wiki artifacts into gerrit. This patch represents one such migration. This patch reproduces content previously housed at the following URL in RST so that it can be placed more easily in source control: https://wiki.openstack.org/wiki/Governance/DesignatedSections One trivial formatting change has been made to best accommodate the new RST format: the page title has been changed from the old wiki-enforced heading "Governance/DesignatedSections" to the more plain-English equivalent "Designated Sections". I've also removed the sentence "The DefCore Committee maintains this page" from the top since ownership is now implied in gerrit. Aside from these changes, the text of the document is completely unaltered from it's state in the wiki on the day this patch was submitted. Change-Id: Iee78f8eeec3db6525edb821f5cb34c67a072269f
Understanding the DefCore Guidelines
This repository contains DefCore committee managed files that provide guidance for the OpenStack community.
NOTE: Changes to file requires approval of the DefCore committee chair(s).
DefCore Process Flow
see /process/2015A.rst or later
Terminology
see lexicon.rst
JSON Schema
The JSON files have a specific schema to support
{ "id": "2015.03", # Spec name (date based)
"source": "http://git.openstack.org/cgit/openstack/defcore/", # git repo for files
"schema": "1.2", # Schema version
"status": "approved", # can be draft, review or approved
"replaces": "2014.07", # previous spec
"releases": ["icehouse"], # array of releases, lower case
"platform": { # platform components
"required": ["compute", "object"], # array
"advisory": [], # incoming array
"depricated": [], # outgoing array
"removed": [] # removed array
},
"components": { # components detail
"compute": { # component name
"required": [ # required array
"compute-auth"],
"advisory": [ # incoming array
"compute-servers-metadata"],
"deprecated": [], # outgoing array
"removed": [ # removed array
"volume"]
},
},
"criteria" : { # explains achievements
"atomic" : { "Description" : "blah blah blah",
"name" : "Atomic",
"weight": 8
},
"capabilities": { # capabilities listed in components
"example-cap" : # capability
{ "achievements" : # array of criteria met
[ "deployed",
"future",
"complete"],
"admin" : false, # is admin API
"status" : "required", # de-normalized from components
"description" : "Helpful Description",
"flagged" : [ ], # flagged tests array
"name" : "Friendly Short Name",
"tests" : # list of tests (please use UUIDs)
[ "tempest.api.project.file.class.test_name" ]
},