Skip to content

Commit

Permalink
incorporate review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
kmova authored Feb 19, 2018
1 parent d21ada0 commit 3a72bf1
Showing 1 changed file with 31 additions and 22 deletions.
53 changes: 31 additions & 22 deletions documentation/source/intro/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,53 @@ OpenEBS Introduction
====================
OpenEBS is a cloud native storage solution built with the goal of providing containerized storage for containers. Using OpenEBS, a developer can seamlessly get the persistent storage for stateful applications with ease, much of which is automated, while using the popular orchestration platforms such as Kubernetes.

OpenEBS is Container Attached Storage(CAS) - which combines the best of DAS and NAS Storage Solutions. OpenEBS runs within a Kubernetes Cluster as Pods and provides Persistent Volumes to Stateful applications, by making use of storage attached to the Kubernetes Nodes.
OpenEBS is Container Attached Storage(CAS) - which combines the best of DAS and NAS Storage Solutions.

.. image:: ../_static/das-nas-cas.png
:align: center

You can try out OpenEBS on your Kubernetes Cluster using the `Quick Start Guide`_.

.. _Quick Start Guide: ./quick_install.html
At the outset, OpenEBS provides you with:

* A *simple to use* storage solution (simpler than using local storage volumes) for your persistent applications,
* And includes benefits of external storage like snapshots, backup, compression etc.
* Allows you to run Stateful Applications in Kubernetes on any node (any cloud or any on-premise server), any storage (disks attached to servers). Avoid Storage Vendor lock-in!

OpenEBS is Containerized Storage Solution that can be orchestrated by any Container Orchestrators, however - the current versions support orchestration using Kubernetes. To understand how to use OpenEBS with Kubernetes, we highly recommend that you familiarize with `Kubernetes Storage Concepts`_, specifically:

When you install OpenEBS, you get the following:
.. _Kubernetes Storage Concepts: https://kubernetes.io/docs/concepts/storage/persistent-volumes/

* Persistent Volumes and Persistent Volume Claims
* Dynamic Volume Provisioner
* Storage Classes
* OpenEBS Operators and Custom Resources for Managing Storage

A typical stateful application using OpenEBS is as follows:

.. image:: ../_static/openebs-pv-2replica.png
:align: center

OpenEBS Volume comprises of Pods that are managed by Kubernetes itself, and each application gets its own storage controller which provides you with benefits like:

* managing the storage with the same tools that you use to manage kuberentes objects (like *kubectl*)
* scaling up/down replica's as they are deployments with node/pod affinity constraints
* extending the manageability via namespaces/RBAC to storage


You can try out OpenEBS on your Kubernetes Cluster using the `Quick Start Guide`_.

.. _Quick Start Guide: ./quick_install.html

If you are new to Kubernetes, here are some guides that can help you setup Kubernetes and install OpenEBS:

`Minikube`_
.. _Minikube: http://openebs.readthedocs.io/en/latest/install/dev_solutions.html#minikube
`Baremetal`_
.. _Baremetal: http://openebs.readthedocs.io/en/latest/install/on_premise_solutions.html#running-the-setup-on-ubuntu-16-04
`Amazon EC2`_
.. _Amazon EC2: http://openebs.readthedocs.io/en/latest/install/cloud_solutions.html#amazon-cloud
`GKE`_
.. _GKE: http://openebs.readthedocs.io/en/latest/install/cloud_solutions.html#google-cloud
`OpenShift`_
.. _OpenShift: http://openebs.readthedocs.io/en/latest/install/openshift.html
`Minikube`_
.. _Minikube: http://openebs.readthedocs.io/en/latest/install/dev_solutions.html#minikube
`Baremetal`_
.. _Baremetal: http://openebs.readthedocs.io/en/latest/install/on_premise_solutions.html#running-the-setup-on-ubuntu-16-04

Once OpenEBS is installed on your Kubernetes Cluster, you can start using it by specifying OpenEBS Storage Classes in your PVCs. Example:
::
Expand All @@ -50,18 +70,7 @@ Once OpenEBS is installed on your Kubernetes Cluster, you can start using it by

By default, the volume data will be saved under `/var/openebs`. OpenEBS provides the flexibility to change this default location as well as provide options to organize your deployment to use different locations depending the application/namespace. This flexibilty is provided via Custom Resources called - Storage Pools and Volume Policies that tie into Kubernetes Storage Class.

A typical stateful application using OpenEBS is as follows:

.. image:: ../_static/openebs-pv-2replica.png
:align: center

OpenEBS Volume comprises of Pods that are managed by Kubernetes itself, and each application gets its own storage controller which provides you with benefits like:

* managing the storage with the same tools that you use to manage kuberentes objects (like kubectl)
* scaling up/down replica's as they are deployments with node/pod affinity constraints
* extending the manageability via namespaces/RBAC to storage

Ready to try some stateful application with OpenEBS, try:
Ready to try some stateful application with OpenEBS, follow some of the examples:

`MySQL`_
.. _MySQL: http://openebs.readthedocs.io/en/latest/Usecases/percona_db.html#percona-db
Expand Down

0 comments on commit 3a72bf1

Please sign in to comment.