Mark T. Voelker a498b82b36 Move Governance/CoreCriteria 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/CoreCriteria

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/CoreCriteria" to the more plain-English equivalent
"Core Criteria".  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.

Change-Id: I60b679e909d961c0c66de0035d7bd010abdb36ad
2015-04-10 10:36:26 -04:00
2015-03-13 09:21:12 -07:00
2015-03-13 09:21:12 -07:00
2015-03-30 21:41:44 -07:00
2015-04-08 16:31:42 -04: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" ]
    },
Description
Data and documentation maintained by the Interop Working Group
Readme 7.3 MiB
Languages
Python 61.3%
Shell 23.3%
JavaScript 10.7%
HTML 4.7%