Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

Commit

Permalink
feat(rwx): update information about NFS provisioners
Browse files Browse the repository at this point in the history
Also fixes the naming of NDM to Node Disk Manager for now.

Signed-off-by: kmova <[email protected]>
  • Loading branch information
kmova committed Dec 19, 2020
1 parent b2d7a22 commit 7b600c3
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 8 deletions.
9 changes: 9 additions & 0 deletions docs/alphafeatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This page provides an overview of OpenEBS components and features presently in A

The list of alpha features include:
- [Dynamic Local PV - Rawfile](#dynamic-local-pv-rawfile)
- [Dynamic NFS Provisioner](#dynamic-nfs-provisioner)

:::note
Upgrade is not supported for features in Alpha version.
Expand All @@ -24,4 +25,12 @@ For additional details and detailed instructions on how to get started with Open

<hr>

## Dynamic NFS Provisioner

OpenEBS is developing a dynamic NFS PV provisioner that can setup a new NFS server on top of any block storage.

For additional details and detailed instructions on how to get started with OpenEBS NFS PV provisioner please refer this [Quickstart guide](https://github.com/openebs/dynamic-nfs-provisioner).

<hr>

<br>
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ For those applications that do not need storage level replication, LocalPV may b



## Node Device Manager<a name="NDM"></a>
## Node Disk Manager<a name="NDM"></a>

------

Expand Down
4 changes: 2 additions & 2 deletions docs/ndm.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: ndm
title: Node Device Manager
title: Node Disk Manager
sidebar_label: NDM
---
------



Node Device Manager(NDM) is an important component in the OpenEBS architecture. NDM treats block devices as resources that need to be monitored and managed just like other resources such as CPU, Memory and Network. It is a daemonset which runs on each node, detects attached block devices based on the filters and loads them as block devices custom resource into Kubernetes. These custom resources are aimed towards helping hyper-converged Storage Operators by providing abilities like:
Node Disk Manager(NDM) is an important component in the OpenEBS architecture. NDM treats block devices as resources that need to be monitored and managed just like other resources such as CPU, Memory and Network. It is a daemonset which runs on each node, detects attached block devices based on the filters and loads them as block devices custom resource into Kubernetes. These custom resources are aimed towards helping hyper-converged Storage Operators by providing abilities like:

- Easy to access inventory of Block Devices available across the Kubernetes Cluster.
- Predict failures on the Disks to help with taking preventive actions.
Expand Down
16 changes: 12 additions & 4 deletions docs/rwm.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
---
id: rwm
title: Provisioning Read-Write-Many (RWM) PVCs
sidebar_label: Read-Write-Many (RWM)
title: Provisioning Read-Write-Many (RWX) PVCs
sidebar_label: Read-Write-Many (RWX)
---
------

NFS server provisioner stable helm chart is widely used for deploying NFS servers on Kubernetes cluster. This server provides PVCs in RWM mode so that multiple web applications can access the data in a shared fashion. OpenEBS cStor volumes are used as persistent backend storage for these nfs servers to provide a scalable and manageable RWM shared storage solution.
NFS server provisioner stable helm chart is widely used for deploying NFS servers on Kubernetes cluster. This server provides PVCs in RWX mode so that multiple web applications can access the data in a shared fashion. OpenEBS cStor volumes are used as persistent backend storage for these nfs servers to provide a scalable and manageable RWX shared storage solution.

:::note OpenEBS Dynamic NFS Provisioner
OpenEBS includes an alpha version of OpenEBS Dynamic NFS provisioner that allows users to create an NFS PV that sets up an new Kernel NFS instance for each PV on top of users choice of backend storage.

This project is currently under active development. For getting started and getting involved in developing this project, check out https://github.com/openebs/dynamic-nfs-provisioner.

The rest of this document contains instructions about the NFS server provisioner maintained by the Kubernetes SIGs community.
:::



Expand Down Expand Up @@ -74,7 +82,7 @@ An example helm install command is
helm install stable/nfs-server-provisioner --namespace=nfs-wp-provisioner --name=openebs-nfs-wordpress --set=persistence.enabled=true,persistence.storageClass=openebs-cstor-disk,persistence.size=5Gi,storageClass.name=wordpress-nfs-sc1,storageClass.provisionerName=openebs.io/nfs
```

**Note:** It is recommended that the OpenEBS storage class specifies 10% more space than what is required by the RWM PVC. For example, if RWM PVC requires 100G, then provision cStor volume with 110G.
**Note:** It is recommended that the OpenEBS storage class specifies 10% more space than what is required by the RWX PVC. For example, if RWX PVC requires 100G, then provision cStor volume with 110G.

<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/ugndm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: ugndm
title: Node Device Manager User Guide
title: Node Disk Manager User Guide
sidebar_label: NDM
---
------
Expand Down

0 comments on commit 7b600c3

Please sign in to comment.