Thierry Carrez 2653cae001 Introduce "TC-approved release" in process
The OpenStack Foundation bylaws mandate the following:

The Technical Committee shall designate a subset of the OpenStack
Project an “OpenStack Technical Committee Approved Release” from
time to time. The Board of Directors may determine "Trademark
Designated OpenStack Software" from time to time, which will be a
subset of the "OpenStack Technical Committee Approved Release".

Therefore it is necessary that capabilities and designated sections
used in trademark guidelines are chosen from a superset of projects
code and features designated by the TC and called "the TC-approved
Release".

This change proposes to introduce the "TC-approved release" in the
Defcore process to make sure we don't miss that critical step.

Change-Id: Ie99c6ae7f9da590469a22155ccb286d789cc0ebf
2015-04-13 11:23:01 +02: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%