update the overview about VSM

bizviznavneet · Mar 13, 2017 · 11258a7 · 11258a7
1 parent c14b219
commit 11258a7
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/contribute/design/README.md b/contribute/design/README.md
@@ -2,12 +2,32 @@
 
 ##Overview
 
-OpenEBS is a open source storage platform delivering containerized block storage for containers. OpenEBS aims at making storage instrastructure programmable, easy-to-use, consumed by applications via self-service. OpenEBS takes upgrades of storage software seriously. 
+OpenEBS is a open source storage platform delivering containerized block storage for containers. OpenEBS aims at making storage instrastructure programmable, easy-to-use, consumed by applications via self-service. OpenEBS takes storage software upgrade seriously.
 
 The storage is containerized through concept called VSM or "Virtual Storage Machine". VSMs are fully isolated user space storage engines that present the block storage at the front end through iSCSI, NBD or TCMU protocol and consume raw storage from a local OpenEBS host or remote storage. OpenEBS uses maya, a storage orchestration engine that helps in managing local and remote storage, integrate into the container orchestrators like Kubernetes, Docker Swarm, Nomad etc., manages QoS policies for VSMs.
 
 ##Architecture
 
+OpenEBS, being container native, seamlessely integrates easily into the container orchestartors. In the following diagram, we use Kubernetes as an example (and also the first orchestrator into which OpenEBS is integrated). 
+![OpenEBS Deployment](../../documentation/source/_static/architecture-overview-hc.png)
+
+OpenEBS comprises of VSMs and Maya. 
+
+### VSM ( aka storage containers or storage pods )
+
+VSMs are the heart of the OpenEBS - enterprise storage functionality delivered in containers. VSMs provide persistent storage for containers, with resliency against system failures via a distrubuted architecture, faster access to the storage, snapshot and backup capabilities. In addition, provides mechanism for monitoring the usage and enforcing QoS policies. 
+
+VSMs are scheduled onto the container hosts using Orchestration Engines. VSMs consume the disk storage from the local host or  remote storage using volume plugins (k8s flexvolumes). 
+
+VSMs are described in yaml files, just like application pods. The VSMs can be deployed through K8s Pods, Deployments, Services, StatefulSets etc., 
+
+### Maya ( aka storage orchestrator )
+
+
+
+
+OpenEBS can also be deployed in the dedicated environment like the traditial software defined storage, and can be connected via the storage plugins. 
+
 
 ##Detailed Design Documents