Difference between revisions of "Facilities Specification Template"
From Gcube Wiki
m (Created page with ' == Overview == == Key Features == == Subsystems == Subsystem Specification Template') |
m |
||
(15 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | This is the template for Facilities Specifications. | |
== Overview == | == Overview == | ||
+ | Few lines with a promotional 'flavour', e.g. ''"gCube xxx facilities offer scalable, high-performance, reliable, open source instruments for ..."'' | ||
== Key Features == | == Key Features == | ||
+ | A bullet list highlighting the main features offered by the facilities. The 'flavour' should be catchy and user-friendly. Some examples are (from MongoDB): | ||
+ | |||
+ | ;Document-oriented storage | ||
+ | :JSON-style documents with dynamic schemas offer simplicity and power. | ||
+ | |||
+ | ;Full Index Support | ||
+ | :Index on any attribute, just like you're used to. | ||
+ | |||
+ | ;Replication & High Availability | ||
+ | :Mirror across LANs and WANs for scale and peace of mind. | ||
+ | |||
+ | ;Auto-Sharding | ||
+ | :Scale horizontally without compromising functionality. | ||
== Subsystems == | == Subsystems == | ||
+ | |||
+ | Because | ||
+ | # the identified facilities might be quite extent / "fat" from the functional point of view and | ||
+ | # the information introduced so far is very generic from a technical point of view | ||
+ | one or more 'subsystem' pages should be created. | ||
+ | |||
+ | Each subsystem page is expected to provide the reader with a description capturing '''design''' and '''deployment aspects''' as well as '''supported use cases'''. The following template is proposed: | ||
[[Subsystem Specification Template]] | [[Subsystem Specification Template]] | ||
+ | |||
+ | Next step will be the identification of the subsystems for each facility. |
Latest revision as of 23:25, 12 February 2012
This is the template for Facilities Specifications.
Overview
Few lines with a promotional 'flavour', e.g. "gCube xxx facilities offer scalable, high-performance, reliable, open source instruments for ..."
Key Features
A bullet list highlighting the main features offered by the facilities. The 'flavour' should be catchy and user-friendly. Some examples are (from MongoDB):
- Document-oriented storage
- JSON-style documents with dynamic schemas offer simplicity and power.
- Full Index Support
- Index on any attribute, just like you're used to.
- Replication & High Availability
- Mirror across LANs and WANs for scale and peace of mind.
- Auto-Sharding
- Scale horizontally without compromising functionality.
Subsystems
Because
- the identified facilities might be quite extent / "fat" from the functional point of view and
- the information introduced so far is very generic from a technical point of view
one or more 'subsystem' pages should be created.
Each subsystem page is expected to provide the reader with a description capturing design and deployment aspects as well as supported use cases. The following template is proposed:
Subsystem Specification Template
Next step will be the identification of the subsystems for each facility.