Data and documentation maintained by the Interop Working Group
Go to file
Mark T. Voelker f597dd12c0 Move Governance/DesignatedSections into gerrit
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
2015-04-10 11:14:30 -04:00
drafts Complete Havana capabilities as passed by the Board in July 2014 2014-08-23 08:19:41 -05:00
images Move Governance/DesignatedSections into gerrit 2015-04-10 11:14:30 -04:00
js Add GET test results and add report page output 2015-01-20 13:54:38 -08:00
legacy Initial draft of 2015.03 guideline 2015-03-13 09:21:12 -07:00
process Add missing details for 2015A.A3 (Designated Sections) 2015-04-09 14:41:20 -05:00
tools Added Designated-Sections to translator 2015-04-09 23:14:49 -05:00
.gitreview Initial draft of 2015.03 guideline 2015-03-13 09:21:12 -07:00
2015.03.json Minor addition for source link in JSON 2015-04-09 21:54:56 -05:00
2015.03.rst Minor RST Format and xref fix 2015-03-30 21:41:44 -07:00
2015.04.json Minor addition for source link in JSON 2015-04-09 21:54:56 -05:00
2015.04.rst DefCore 2015.04 Guideline Approved by Board April 2nd 2015-04-03 06:52:51 -07:00
2015.next.json Minor addition for source link in JSON 2015-04-09 21:54:56 -05:00
2015.next.rst DefCore 2015.04 Guideline Approved by Board April 2nd 2015-04-03 06:52:51 -07:00
CoreDefinition.rst Fix missing blank line 2015-04-10 09:34:34 -04:00
DesignatedSections.rst Move Governance/DesignatedSections into gerrit 2015-04-10 11:14:30 -04:00
GovernanceProcess.rst Move Governance/DefCoreCommittee Governance Process into gerrit 2015-04-09 18:41:17 -07:00
lexicon.rst Alphabetize the lexicon 2015-04-08 16:31:42 -04:00
ProcessCycles.rst Move Governance/CoreDefinition into gerrit 2015-04-09 19:03:23 -07:00
README.rst Minor addition for source link in JSON 2015-04-09 21:54:56 -05:00

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" ]
    },