Data and documentation maintained by the Interop Working Group
f477e97973
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/CoreDefinition Two minor formatting changes have been made to best accommodate the new RST format: 1. The page title has changed from the old wiki-enforced heading "Governance/CoreDefinition" to the more plain-English equivalent "Core Definition". Aside from this change, the text of the document is completely unaltered from it's state in the wiki on the day this patch was submitted. 2. The placement of the principles image has changed. It is now placed at the top of the Principles section instead of alongside the first two principles in the list in order to accommodate those reading the RST as raw/unrendered plaintext. Change-Id: I5aac99478981253e51f68605b5473175fc313eb3 |
||
|---|---|---|
| drafts | ||
| images | ||
| js | ||
| legacy | ||
| process | ||
| .gitreview | ||
| 2015.03.json | ||
| 2015.03.rst | ||
| 2015.04.json | ||
| 2015.04.rst | ||
| 2015.next.json | ||
| 2015.next.rst | ||
| CoreDefinition.rst | ||
| lexicon.rst | ||
| README.rst | ||
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)
"schema": "1.1", # 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" ]
},