Skip to content

Commit

Permalink
Add Glossary of terms
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelvirgil committed May 13, 2015
1 parent d6c23ef commit 8abdb74
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Container Application Specification

## Problem Statement
Currently there is no standard mechanism to define a composite multi-container application or composite service composed of aggregate pre-defined building blocks spanning multiple hosts and clustered deployments. In addition, the associated metadata and artifact management requires separate processes outside the context of the application itself.
Currently there is no standard mechanism to define a composite multi-container application or composite service composed of aggregate pre-defined building blocks spanning multiple hosts and clustered deployments. In addition, the associated metadata and artifact management requires separate processes outside the context of the application itself.

## What is Nulecule?
It's a made-up word meaning ["the mother of all atomic particles"](http://simpsons.wikia.com/wiki/Made-up_words) pronounced `nu-le-cule`
Expand All @@ -21,6 +21,18 @@ Nulecule specification enables complex applications to be defined, packaged and

![Alt Nulecule specification high-level story.](/images/NuleculeHigh-LevelStory.png "Nulecule specification high-level story")

## Glossary
* __Container Image__: Platform-agnostic term referring to Docker, Rkt or other packaging and transport protocol.
* __Layered Image__: The foundation image of a container plus other tools, applications and content added.
* __Association__ of container images related to Nulecule application:
+ __Aggregation__ - Reference to one or more discrete container images integral to the operation and loosely coupled to the lifecycle of the Nulecule application - can be another Nulecule Application or container image reference

This comment has been minimized.

Copy link
@vpavlin

vpavlin May 13, 2015

This needs to be indented

+ __Composition__ - Reference to one or more container images that are required and tightly coupled to the Nulecule application with some functioning only in the presence of one or more referenced container images - can be another Nulecule Application or container image reference

This comment has been minimized.

Copy link
@vpavlin

vpavlin May 13, 2015

This needs to be indented

* __Include__ - Refers to the ability to include common resources, parameters or definitions needed to deploy onto a orchestration provider. For example, an OpenShift provider may include the kubernetes provider artifacts and add OpenShift functionality on top of kubernetes capabilities.
* __Provider__ - Plugin interface for specific deployment platform, an orchestration provider
* __Dependency Management__: Refers to the ability to define order of deployment and managed dependencies including configurable parameters layered on top of stock container images, as well as the providers included in the application definition
* __Directed Graph__: Declarative representation of dependencies in the context of a Nulecule application
* __Parameters__ - Variables that can have default values and can be overridden by the answers file

## User Experience

### Kelly the System Administrator
Expand Down Expand Up @@ -70,4 +82,3 @@ Please review the [contributing guidelines](CONTRIBUTING.md) before submitting p
## TODO

* Create schema validation script

1 comment on commit 8abdb74

@michaelvirgil
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indented both Aggregation & Composition - both need to be associated with associations.

Thanks.

Please sign in to comment.