32ce79536e
Initial draft of 2015.03 guideline as passed by the board. We are condensing two steps into one here > format & content. After we accept this, we will create a new prelim guideline for the next review cycle (target at 2015.04!). I've also moved from files out of the root directory for cleanup. The RST and JSON files should match in content. Change-Id: I40623b38e80a7d4a65a66d7210f6dfad5835c371
117 lines
8.2 KiB
JSON
117 lines
8.2 KiB
JSON
{ "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": []
|
|
}
|
|
}
|
|
}
|