Skip to content
This repository has been archived by the owner on Aug 30, 2024. It is now read-only.

Home

Jump to bottom
chris grzegorczyk edited this page Oct 14, 2012 · 60 revisions

Eucalyptus Specification/Design/Architecture Documents

Here you will find technical documents which support the evaluation, planning, and implementation of features in Eucalyptus. This the canonical reference for two kinds of documents: feature specifications used in planning releases and generational design documents which evolve iteratively with the ongoing implementation of the system. The purpose of this page is to aggregate and classify these documents from the underlying repository with the raw materials.

Categories

Documents By Category
Release 3.0
pending 		3.1
pending 		3.2 3.3
pending

Purpose of Documents

The purpose of the documents aggregated here is to support the development of new features in Eucalyptus. To that end, they play a role in several stages of the development process:

  1. Feature specification: associated with each feature is an overall document describing the important technical characteristics in a release (or generation) independent fashion. These reflect the understanding of the feature which is used in subsequent steps.
  2. Scope & Estimation: prior to release planning a technical assessment is made about the aspects of functionality to go into a generation of the feature. The spec documents which are associated with a release start life at that time. These subsequently evolve until they have been committed to for a particular release (but may be present even when not committed to a release).
  3. Design & Implementation: a feature which has been committed to a release is supported by a design document for that release. The design documents start their life when work towards that release does. These subsequently evolve until work stops for that release of the feature. (They would then be ported forward to the final documentation).

Document Type Descriptions

There are two classes of documents which you can expect to find the authoritative copy of here: feature specifications used in planning/estimation of releases and generational design documents which evolve iteratively with the ongoing implementation of the system.

Specification documents are intentional and intensional[1]:

  • are "timeless" in that they are overarching and meant to be definitive of the feature overall.
  • evolve over time independent of the features current implementation status.
  • reflect our current understanding of the features definition in the broadest sense.
Specification documents consist of:
  • Specification: overall technical specification of the functional and architectural/quality characteristics.
  • High level design/Architecture: definition of fundamental components, interfaces, behaviours including information, control, and concurrency models.
  • Supporting Documents: API/Service specifications, client tool chains, WSDLs, TCKs.
Generational Documents are specific to a release and meant to serve the tasks surrounding the planning, design, implementation, and delivery of a feature.
  • support the scoping, design, and implementation effort of the feature during that release.
  • defining the design and implementation objectives and details for a particular version of a feature.
  • specific to the context and determined by the constraints of a particular release time frame.
  • change as needed to support the above objectives and are quiesced after those tasks are completed.
Generational documents consist of:
  • Functional requirements: as identified by a corresponding epic in JIRA
  • Specification: release-specific technical interpretation of functional requirements

See Also

To find the documentation you may need please also see:

Clone this wiki locally