Data and documentation maintained by the Interop Working Group
Go to file
Chris Hoge fcf409f427 Added tox.ini and test-requirements for testing
Added tox.ini and test-requirements.txt to allow for .rst
document validation, and other tests to check updates and
changes. The goal will be to add a verify and gate process
to the Defcore project repository.

Change-Id: I9fceae7569d7e3df53c3c3d2567a691dbd406a55
2015-04-10 09:21:46 -07:00
drafts Complete Havana capabilities as passed by the Board in July 2014 2014-08-23 08:19:41 -05:00
images Move Governance/CoreDefinition into gerrit 2015-04-09 15:39:55 -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
GovernanceProcess.rst Move Governance/DefCoreCommittee Governance Process into gerrit 2015-04-09 18:41:17 -07: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
lexicon.rst Alphabetize the lexicon 2015-04-08 16:31:42 -04:00
test-requirements.txt Added tox.ini and test-requirements for testing 2015-04-10 09:21:46 -07:00
tox.ini Added tox.ini and test-requirements for testing 2015-04-10 09:21:46 -07:00

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