Skip to content

Commit

Permalink
update with repository links to overview doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kmova authored Mar 13, 2017
1 parent ee35d22 commit 570c45b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions contribute/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ VSMs are the heart of the OpenEBS - enterprise storage functionality delivered i

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.,

Further details on the VSM can be found under the following two repositories - openebs/longhorn, the golang block storage functionality and openeb/jiva contains the packaging and ci functionality.
Further details on the VSM can be found under the following two repositories - [openebs/longhorn](https://github.com/openebs/longhorn), the golang block storage functionality and [openeb/jiva](https://github.com/openebs/jiva) contains the packaging and ci functionality.

### Maya ( aka storage orchestrator )

Maya makes the storage infrastructure programmable via yaml files that the DevOps can define and commit, just like the container clusters or containerized applications. Maya builds on top of the container orchestration engine capabilities in terms of runtime, scheduling, monitoring etc., and extends the capabilities to orchestrate and simplify the management of storage. Maya will learn and provide storage metrics to the container schedulers for better placements of pods as well as storage migration between hosts within/across cluster(s).

Maya is a set of components that can be further divided as follows:
- Services : These encapsulate a specific functionality like api-server, storage-manager, storage-analytics, sml-engine (storage machine learning engine), that are either installed as binary services are container services. These will be either be running on the Container Control Plane (like the api-server), or on Container-Runtime/Minion hosts ( like storage-manager ) or can be completely out-of-band (storage-analytics). Each of these services are developed under their own repository under the OpenEBS organization.
- Services : These encapsulate a specific functionality like api-server, storage-manager, storage-analytics, sml-engine (storage machine learning engine), that are either installed as binary services are container services. These will be either be running on the Container Control Plane (like the [api-server](https://github.com/openebs/mayaserver)), or on Container-Runtime/Minion hosts ( like storage-manager ) or can be completely out-of-band (storage-analytics). Each of these services are developed under their own repository under the OpenEBS organization.

- Plugins : Maya allows the OpenEBS storage to be run along side any orchestration engine like kubernetes, docker swarm, nomad etc., This is made possible by the maya orchestration engine plugins. For example, one of the ways in which Kubernetes can consume OpenEBS Storage is via the K8s FlexVolume Plugin (openebs-iscsi). The plugin's are also used extensively in the hyperconverged mode to integrated into the various orchestration capabilities. The plugin libraries are developed under the main openebs/openebs repository, under the respective container orchestrator directory.
- Plugins : Maya allows the OpenEBS storage to be run along side any orchestration engine like kubernetes, docker swarm, nomad etc., This is made possible by the maya orchestration engine plugins. For example, one of the ways in which Kubernetes can consume OpenEBS Storage is via the K8s FlexVolume Plugin - [openebs-iscsi](https://github.com/openebs/openebs/tree/master/k8s/lib/plugin/flexvolume). The plugin's are also used extensively in the hyperconverged mode to integrated into the various orchestration capabilities. The plugin libraries are developed under the main openebs/openebs repository, under the respective container orchestrator directory.

- Tools : CLI/UI tools that will help with installation or management of tasks. One of the first tools under heavy development is [maya] (https://github.com/openebs/maya), that aims the simplying the installation of OpenEBS components or plugins.

Expand Down

0 comments on commit 570c45b

Please sign in to comment.