openinfra/refstack
Code Issues Proposed changes

Added Swift Designated Sections based on discussion with John Dickinson,

Browse Source 
Swift PTL, about required and optional compontents.

    This represents a very detailed perspective of Swift and
    we chose to include a lot of optional sections so that we
    could be very specific for discussion.

    Used some descriptions from John's original patch.
    Suggestions for descriptions are welcome, but not required
    at this point in the process.  They could be accepted as future
    patches to this file.

Change-Id: Iccd79508fafa76af923c22afd422c0f860db2c1d
This commit is contained in:
Rob Hirschfeld 2014-11-23 22:15:53 -06:00
parent d9731e6819
commit 922eb30fef
1 changed files with 42 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
defcore/havanasections.json
View File

@ -45,10 +45,48 @@
"sections": []
},
"swift" : {
"guidance": "Not a core capability, no position at this time",
"core-capabilities": false,
"comment": "",
"sections": []
"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",