Remove files that are now mastered in openstack/defcore
Leaving the copy of 2015.03 and js until we understand why it was added here. </housekeeping> Change-Id: If0986b06edb3552662461eb3e6eceb56c3ea206d
This commit is contained in:
Rob Hirschfeld
parent
8f972ce693
commit
09d3cb3d8d
|
|
@ -1,79 +0,0 @@
|
|||
=================================================
|
||||
Understanding the DefCore JSON Schema
|
||||
=================================================
|
||||
|
||||
This folder contains DefCore committee managed files that provide trusted guidance for the OpenStack community.
|
||||
|
||||
Assets for each release are tracked in dedicated subdirectories so JSON schema may change per release if needed.
|
||||
|
||||
NOTE: Changes to file requires approval of the DefCore committee chair(s).
|
||||
|
||||
|
||||
DefCore Process Flow
|
||||
====================
|
||||
|
||||
See: https://wiki.openstack.org/w/images/6/68/DefCoreProcessFlow.pdf
|
||||
|
||||
Terminology
|
||||
====================
|
||||
|
||||
See: https://wiki.openstack.org/wiki/Governance/DefCoreLexicon
|
||||
|
||||
The JSON files have a specific schema to support
|
||||
|
||||
.. code-block:: json
|
||||
|
||||
{ "release": "havana",
|
||||
"schema": "1.0",
|
||||
"criteria" : {
|
||||
"atomic" : { "Description" : "blah blah blah",
|
||||
"name" : "Atomic",
|
||||
"weight": 8
|
||||
},
|
||||
"capabilities": {
|
||||
"example-cap" : { "achievements" : [ "deployed",
|
||||
"future",
|
||||
"complete"],
|
||||
"admin" : true,
|
||||
"core" : false,
|
||||
"description" : "Helpful Description",
|
||||
"flagged" : [ ],
|
||||
"name" : "Friendly Short Name",
|
||||
"tests" : [ "tempest.api.project.file.class.test_name" ]
|
||||
},
|
||||
|
||||
Schema Explanation:
|
||||
-------------------
|
||||
|
||||
* release: provides the release described in the JSON file
|
||||
* schema: version of the schema
|
||||
* criteria: block describing the scoring criteria for the release
|
||||
* criteria/[id]: block for a specific criteria (using an ID)
|
||||
* criteria/[id]/name: friendly name for the criteria
|
||||
* criteria/[id]/description: longer description for the criteria
|
||||
* criteria/[id]/weight: weight applied. All criteria together should = 100
|
||||
* capabilities: block describing all the capabilities identified for the release
|
||||
* capabilities/[id]: block for a specific capability (using an ID)
|
||||
* capabilities/[id]/name: friend name for the capability
|
||||
* capabilities/[id]/description: longer description for the capability
|
||||
* capabilities/[id]/core: boolean set by Board if capability is required
|
||||
* capabilities/[id]/admin: boolean set by PTL if capability is for admin use
|
||||
* capabilities/[id]/achievements: list of criteria passed for this capability (set by Board)
|
||||
* capabilities/[id]/tests: list of tests included in the capability (set by PTL)
|
||||
* capabilities/[id]/flagged: tests that have been excluded for this capability (set by Board)
|
||||
|
||||
Ownership for Changes
|
||||
=====================
|
||||
|
||||
TC/PTL
|
||||
---------------------
|
||||
1. Capabilities Description
|
||||
1. Capabilities Test List
|
||||
|
||||
DefCore
|
||||
---------------------
|
||||
1. Flagged Tests
|
||||
1. Capabilities "Score
|
||||
1. Criteria Names and Descriptions
|
||||
|
||||
|
||||
|
|
@ -1,92 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js" ></script>
|
||||
<script src="http://cdnjs.cloudflare.com/ajax/libs/mustache.js/0.8.1/mustache.min.js"> </script>
|
||||
<script id="header_template" type="x-tmpl-mustache">
|
||||
<h1>OpenStack DefCore</h1>
|
||||
<h2> {{id}} Tracked Capabilities</h2>
|
||||
</script>
|
||||
<script id="capabilities_template" type="x-tmpl-mustache">
|
||||
{{#capabilities}}
|
||||
<ul>
|
||||
<li> <a onclick="$('#{{class}}_tests').toggle(500);return false;" href="#"> {{class}} capabilities ({{count}} of {{total}} total) </a>
|
||||
<div id="{{class}}_tests" style="display:none;">
|
||||
{{#items}}
|
||||
<ul>
|
||||
<li>
|
||||
{{name}}
|
||||
<ul>
|
||||
<li>ID: {{id}}</li>
|
||||
<li>Description: {{description}}</li>
|
||||
<li>Achievements (met {{achievements_count}} of {{criteria_count}} total): {{#achievements}} <a href="#{{.}}">{{.}}</a> {{/achievements}}
|
||||
{{#admin}}<li>Admin rights required</li>{{/admin}}
|
||||
<li>Status: {{status}}</li>
|
||||
<li> <a onclick="toggle_one_item('{{class}}', '{{id}}', 'tests_list');return false;" href="#"> Tests ({{tests_count}}) </a>
|
||||
<div id="{{id}}_tests_list" class="{{class}}_tests_list" style="display:none;">
|
||||
<ul>
|
||||
{{#tests}} <li> {{.}} <a href="javascript:void(get_code_url('{{.}}'));"> [github] </a> </li> {{/tests}}
|
||||
</ul>
|
||||
<div>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
{{/items}}
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
{{/capabilities}}
|
||||
{{^capabilities}}
|
||||
No capabilities!
|
||||
{{/capabilities}}
|
||||
</script>
|
||||
<script id="criteria_template" type="x-tmpl-mustache">
|
||||
{{#criteria}}
|
||||
<ul>
|
||||
<li><a id="{{tag}}" onclick="$('#{{tag}}_ach').toggle(500);return false;" href="#"> {{name}} (tag : {{tag}}) </a> </li>
|
||||
<div id="{{tag}}_ach" style="display:none;">
|
||||
<ul>
|
||||
<li>Description: {{Description}} </li>
|
||||
<li>Weight: {{weight}} </li>
|
||||
</ul>
|
||||
</div>
|
||||
</ul>
|
||||
{{/criteria}}
|
||||
</script>
|
||||
<script src="/js/helpers.js"></script>
|
||||
<script>
|
||||
window.render_page = function(){render_capabilities_page()};
|
||||
$(document).ready(window.render_page);
|
||||
</script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="header"></div>
|
||||
|
||||
Status Filter:<br />
|
||||
<select id="status" onchange="render_page()">
|
||||
<option value="status_all" >All Capabilities</option>
|
||||
<option value="status_required" >Required Capabilities</option>
|
||||
<option value="status_advisory">Advisory Capabilities</option>
|
||||
<option value="status_deprecated">Deprecated Capabilities</option>
|
||||
<option value="status_removed">Removed Capabilities</option>
|
||||
</select>
|
||||
<br>
|
||||
Admin Filter:<br />
|
||||
<select id="admin" onchange="render_page()">
|
||||
<option value="all" >All Capabilities</option>
|
||||
<option value="admin" >Capabilities requiring admin rights</option>
|
||||
<option value="noadmin">Capabilities not requiring admin rights</option>
|
||||
</select>
|
||||
<div id="capabilities"></div>
|
||||
|
||||
<h2>Criterion descriptions</h2>
|
||||
|
||||
<ul id="criteria"></ul>
|
||||
|
||||
<div>Copyright OpenStack Foundation, 2014. Apache 2 License.</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -1,116 +0,0 @@
|
|||
{ "release" : "havana",
|
||||
"status" : "approved",
|
||||
"schema" : "1.0",
|
||||
"projects" : {
|
||||
"nova" : {
|
||||
"guidance": "By default, designated except scheduler, filter, drivers, API extensions and networking.",
|
||||
"core-capabilities": true,
|
||||
"comment": "All code except driver/plugins listed. Even for replaceable drivers or plugins, we still expect use of the existing nova service that wraps those interfaces.",
|
||||
"sections": {
|
||||
"scheduler driver": { "description": "(Host and cell)", "designated": false, "comment": "none provided"},
|
||||
"filter scheduler driver": { "description": "(Host and cell) While the line above implies the entire driver is fair game, this case is incredibly common and worth mentioning specifically.", "designated": false, "comment": "none provided"},
|
||||
"compute driver": { "description": "not provided", "designated": false, "comment": "none provided"},
|
||||
"rest api extensions": { "description": "may be required for capabilities", "designated": false, "comment": "none provided"},
|
||||
"nova networking components": { "description": "not provided", "designated": false, "comment": "none provided"},
|
||||
"nova networking drivers": { "description": "not provided", "designated": false, "comment": "none provided"}
|
||||
}
|
||||
},
|
||||
"glance": {
|
||||
"guidance": "Designated sections are the API implementation code and domain model.",
|
||||
"core-capabilities": true,
|
||||
"comment": "not given",
|
||||
"sections": {
|
||||
"http apis": { "description": "not provided", "designated": true, "comment": "API"},
|
||||
"domain model": { "description": "not provided", "designated": true, "comment": "Shared"},
|
||||
"stores": { "description": "the swift, filesystem, and http stores", "designated": false, "comment": "should be replaceable, vendor-specificddCross platform"},
|
||||
"db driver": { "description": "not provided", "designated": false, "comment": "should be replaceable" },
|
||||
"wsgi framework": { "description": "not provided", "designated": false, "comment": "should be replaceable"}
|
||||
}
|
||||
},
|
||||
"cinder": {
|
||||
"guidance": "Designated sections are the API implementation code",
|
||||
"core-capabilities": true,
|
||||
"comment": "Historically, cinder has had plug-ins around schedulers and drivers.",
|
||||
"sections": {
|
||||
"api": { "description": "API section means actually the CODE that exposes the API, not just API-comparability", "designated": true, "comment": ""},
|
||||
"drivers": { "description": "not provided", "designated": false, "comment": "there MUST be requirements that it implements what's defined as core functionality in the Cinder API"},
|
||||
"scheduler": { "description": "not provided", "designated": false, "comment": "there MUST be requirements that it implements what's defined as core functionality in the Cinder API"},
|
||||
"api extensions": { "description": "not provided", "designated": false, "comment": "should be replaceable"}
|
||||
}
|
||||
},
|
||||
"keystone": {
|
||||
"guidance": "Not a core capability, no position at this time",
|
||||
"core-capabilities": false,
|
||||
"comment": "",
|
||||
"sections": []
|
||||
},
|
||||
"swift" : {
|
||||
"guidance": "Designated sections are proxy server, object server, container server, account server and select middleware",
|
||||
"core-capabilities": true,
|
||||
"comment": "You should use the proxy and storage servers, and you can use your own DiskFile or add new middleware for the proxy or storage nodes. Please review sections for specific middleware guidelines",
|
||||
"sections": {
|
||||
// Group A: *Sections that should be in every Swift deployment* These are the bare minimum pieces of code that I would expect anyone running something called "Swift" to include.
|
||||
"proxy server": { "description": "the proxy server code and, if enabled, the functionality
|
||||
implemented by provided middleware (eg static large objects or signed urls or bulk
|
||||
requests", "designated": true, "comment": ""},
|
||||
"object server": { "description": "the object server code that calls a DiskFile implementation
|
||||
and updates container listings", "designated": true, "comment": ""},
|
||||
"container server": { "description": "the code that provides a list of objects in a container
|
||||
and container metadata", "designated": true, "comment": ""},
|
||||
"account server": { "description": "the code that provides a list of containers and account metadata",
|
||||
"designated": true, "comment": ""},
|
||||
"catch_errors": { "description": "not provided", "designated": true, "comment": "middleware"},
|
||||
"healthcheck": { "description": "not provided", "designated": true, "comment": ""},
|
||||
"bulk": { "description": "not provided", "designated": true, "comment": ""},
|
||||
"slo": { "description": "not provided", "designated": true, "comment": ""},
|
||||
"container-quotas": { "description": "not provided", "designated": true, "comment": ""},
|
||||
"account-quotas": { "description": "not provided", "designated": true, "comment": ""},
|
||||
"tempurl": { "description": "not provided", "designated": true, "comment": ""},
|
||||
//Group B: *Code that should be used, if you are using this functionality* There are several parts of Swift that are features but not always required to be enabled. I would expect deployers using functionality provided by these modules to contribute any changes upstream.
|
||||
"replicators": { "description": "not provided", "designated": false, "comment": "recommended"},
|
||||
"auditors": { "description": "not provided", "designated": false, "comment": "recommended"},
|
||||
"updaters": { "description": "not provided", "designated": false, "comment": "recommended"},
|
||||
"account reaper": { "description": "not provided", "designated": false, "comment": "recommended"},
|
||||
"object expirer": { "description": "not provided", "designated": false, "comment": "recommended"},
|
||||
"ratelimit": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
|
||||
"recon": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
|
||||
"staticweb": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
|
||||
"formpost": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
|
||||
"domain_remap": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
|
||||
"crossdomain": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
|
||||
"cname_lookup": { "description": "not provided", "designated": false, "comment": "middleware, recommended"},
|
||||
//Group C: *Replaceable Sections* These are either intentional areas of extensibility in Swift, or functionality provided in the project because an implementation is required "out of the box".
|
||||
"diskfile": { "description": "the part of the object server that actually persists the object data
|
||||
to a storage volume", "designated": false, "comment": "replaceable"},
|
||||
"cache": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"},
|
||||
"tempauth": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"},
|
||||
"keystoneauth": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"},
|
||||
"proxy-logging": { "description": "not provided", "designated": false, "comment": "middleware, replaceable"}
|
||||
}
|
||||
},
|
||||
"neutron": {
|
||||
"guidance": "Not a core capability, no position at this time",
|
||||
"core-capabilities": false,
|
||||
"comment": "Neutron was not ready for review.",
|
||||
"sections": []
|
||||
},
|
||||
"heat": {
|
||||
"guidance": "Not a core capability, no position at this time",
|
||||
"core-capabilities": false,
|
||||
"comment": "",
|
||||
"sections": []
|
||||
},
|
||||
"horizon": {
|
||||
"guidance": "Not a core capability, no position at this time",
|
||||
"core-capabilities": false,
|
||||
"comment": "",
|
||||
"sections": []
|
||||
},
|
||||
"ceilometer": {
|
||||
"guidance": "Not a core capability, no position at this time",
|
||||
"core-capabilities": false,
|
||||
"comment": "",
|
||||
"sections": []
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue