Skip to content

Commit

Permalink
docs: updated the content per the review feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Gincy Thomas <[email protected]>
  • Loading branch information
datacore-gthomas committed Apr 10, 2024
1 parent 5cad0de commit fd4b39b
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 422 deletions.
2 changes: 1 addition & 1 deletion docs/main/concepts/data-engines/local-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,5 +98,5 @@ A quick summary of the steps to restore include:
- [Local PV LVM Prerequisites](../../user-guides/local-storage-user-guide/local-pv-lvm/lvm-installation.md)
- [Local PV ZFS Prerquisites](../../user-guides/local-storage-user-guide/local-pv-zfs/zfs-installation.md)
- [Installation](../../quickstart-guide/installation.md)
- [Local Storage User Guide](../../../main/user-guides/local-storage-user-guide/)
- [Local Storage User Guide](../../user-guides/local-storage-user-guide/local-pv-hostpath/hostpath-installation.md)

4 changes: 2 additions & 2 deletions docs/main/concepts/data-engines/replicated-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Although Replicated Storage utilizes NVMe-oF, it does not impose any requirement

## Quickstart Guide

OpenEBS provides Local Volume that can be used to provide locally mounted storage to Kubernetes Stateful workloads. Refer to the [Quickstart Guide](../../quickstart-guide/installation.md) for more information.
Refer to the [Quickstart Guide](../../quickstart-guide/installation.md) for more information.

## Source Code and Contributions

Expand All @@ -46,4 +46,4 @@ Join the vibrant [OpenEBS community on Kubernetes Slack](https://kubernetes.slac
- [OpenEBS Architecture](../architecture.md)
- [Replicated Storage Prerequisites](../../user-guides/replicated-storage-user-guide/prerequisites.md)
- [Installation](../../quickstart-guide/installation.md)
- [Replicated Storage User Guide](../../../main/user-guides/replicated-storage-user-guide/)
- [Replicated Storage User Guide](../../user-guides/replicated-storage-user-guide/rs-installation.md)
12 changes: 6 additions & 6 deletions docs/main/faqs/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To determine exactly where your data is physically stored, you can run the follo

* Run `kubectl get pvc` to fetch the volume name. The volume name looks like: *pvc-ee171da3-07d5-11e8-a5be-42010a8001be*.

* For each volume, you will notice one I/O controller pod and one or more replicas (as per the storage class configuration). You can use the volume ID (ee171da3-07d5-11e8-a5be-42010a8001be) to view information about the volume and replicas using the Replicated Storage [kubectl plugin](../../../docs/main/user-guides/replicated-storage-user-guide/advanced-operations/kubectl-plugin.md)
* For each volume, you will notice one I/O controller pod and one or more replicas (as per the storage class configuration). You can use the volume ID (ee171da3-07d5-11e8-a5be-42010a8001be) to view information about the volume and replicas using the Replicated Storage [kubectl plugin](../user-guides/replicated-storage-user-guide/advanced-operations/kubectl-plugin.md)

[Go to top](#top)

Expand Down Expand Up @@ -459,7 +459,7 @@ Once the above steps are done, the pod should be able to run on this new node wi
[Go to top](#top)
### How is data protected in Replicated Storage (a.k.a Replicated Storage and f.k.a Mayastor)? What happens when a host, client workload, or a data center fails?
### How is data protected in Replicated Storage (a.k.a Replicated Engine and f.k.a Mayastor)? What happens when a host, client workload, or a data center fails?
The OpenEBS Replicated Storage ensures resilience with built-in highly available architecture. It supports on-demand switch over of the NVMe controller to ensure IO continuity in case of host failure. The data is synchronously replicated as per the congigured replication factor to ensure no single point of failure.
Faulted replicas are automatically rebuilt in the background without IO disruption to maintain the replication factor.
Expand Down Expand Up @@ -525,7 +525,7 @@ This documentation contains sections which are focused on initial quickstart dep
Replicated Storage has been built to leverage the performance potential of contemporary, high-end, solid state storage devices as a foremost design consideration. For this reason, the I/O path is predicated on NVMe, a transport which is both highly CPU efficient and which demonstrates highly linear resource scaling. The data path runs entirely within user space, also contributing efficiency gains as syscalls are avoided, and is both interrupt and lock free.
MayaData has performed its own benchmarking tests in collaboration with Intel, using latest generation Intel P5800X Optane devices "The World's Fastest Data Centre SSD". In those tests it was determined that, on average, across a range of read/write ratios and both with and without synchronous mirroring enabled, the overhead imposed by the Replicated Storage's I/O path was well under 10% \(in fact, much closer to 6%\).
MayaData performance benchmarking was done in collaboration with Intel, using latest generation Intel P5800X Optane devices "The World's Fastest Data Centre SSD". In those tests it was determined that, on average, across a range of read/write ratios and both with and without synchronous mirroring enabled, the overhead imposed by the Replicated Storage's I/O path was well under 10% \(in fact, much closer to 6%\).
Further information regarding the testing performed may be found [here](https://openebs.io/blog/mayastor-nvme-of-tcp-performance).
Expand Down Expand Up @@ -581,7 +581,7 @@ No.
### Does Replicated Storage support snapshots? Clones?
No, but these may be features of future releases.
Yes, snapshots and clones support is presently limited to volumes with only one replica. Snapshot and clone support for multi-replica volumes is planned in the upcoming release.
[Go to top](#top)
Expand All @@ -591,7 +591,7 @@ The Replicated Storage nightly builds and releases are compiled and tested on x8
Minimum hardware requirements are discussed in the [quickstart section](../quickstart-guide/installation.md) of this documentation.
Replicated Storage does not run on Raspbery Pi as the version of the SPDK. Replicated Storage requires ARMv8 Crypto extensions which are not currently available for Pi.
Replicated Storage does not run on Raspbery Pi as the current version of SPDK requires ARMv8 Crypto extensions. Replicated Storage requires ARMv8 Crypto extensions which are not currently available for Pi.
[Go to top](#top)
Expand All @@ -615,7 +615,7 @@ The supportability tool generates support bundles, which are used for debugging
### What happens when a PV with reclaim policy set to retain is deleted?
In Kubernetes, when a PVC is created with the reclaim policy set to 'Retain', the PV bound to this PVC is not deleted even if the PVC is deleted. One can manually delete the PV by issuing the command "kubectl delete pv ", however the underlying storage resources could be left behind as the CSI volume provisioner (external provisioner) is not aware of this. To resolve this issue of dangling storage objects, Replicated Storage has introduced a PV garbage collector. This PV garbage collector is deployed as a part of the Replicated Storage CSI controller-plugin.
In Kubernetes, when a PVC is created with the reclaim policy set to 'Retain', the PV bound to this PVC is not deleted even if the PVC is deleted. One can manually delete the PV by issuing the command "kubectl delete pv ", however the underlying storage resources could be left behind as the CSI volume provisioner (external provisioner) is not aware of this. To resolve this issue of dangling storage objects, Replicated Storage has introduced a PV garbage collector. This PV garbage collector is deployed as a part of the Replicated Storage CSI controller-plugin.
[Go to top](#top)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ OpenEBS has a vibrant community that can help you get started. If you have furth

## See Also

- [Quickstart](../../main/quickstart-guide/)
- [Quickstart](../quickstart-guide/installation.md)
- [Installation](../quickstart-guide/installation.md)
- [Deployment](../quickstart-guide/deploy-a-test-application.md)
- [Use Cases and Examples](use-cases-and-examples.mdx)
Expand Down
4 changes: 2 additions & 2 deletions docs/main/quickstart-guide/deploy-a-test-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,5 +223,5 @@ Once the workloads are up and running, the platform or the operations team can o
- [Local PV ZFS](../user-guides/local-storage-user-guide/zfs-localpv.md)
- [Local Storage](../concepts/data-engines/local-storage.md)
- [Replicated Storage](../concepts/data-engines/replicated-storage.md)
- [Local Storage User Guide](../../main/user-guides/local-storage-user-guide/)
- [Replicated Storage User Guide](../../main/user-guides/replicated-storage-user-guide/)
- [Local Storage User Guide](../user-guides/local-storage-user-guide/local-pv-hostpath/hostpath-installation.md)
- [Replicated Storage User Guide](../user-guides/replicated-storage-user-guide/rs-installation.md)
6 changes: 3 additions & 3 deletions docs/main/quickstart-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,11 @@ openebs-single-replica io.openebs.csi-mayastor Delete Immediate

## Post-Installation Considerations

For testing your OpenEBS installation, you can use the `openebs-hostpath` mentioned in the [Local Storage User Guide](../../main/user-guides/local-storage-user-guide/) for provisioning Local PV on hostpath.
For testing your OpenEBS installation, you can use the `openebs-hostpath` mentioned in the [Local Storage User Guide](../user-guides/local-storage-user-guide/local-pv-hostpath/hostpath-installation.md) for provisioning Local PV on hostpath.

You can follow through the below user guides for each of the engines to use storage devices available on the nodes instead of the `/var/openebs` directory to save the data.
- [Local Storage User Guide](../../main/user-guides/local-storage-user-guide/)
- [Replicated Storage User Guide](../../main/user-guides/replicated-storage-user-guide/)
- [Local Storage User Guide](../user-guides/local-storage-user-guide/local-pv-hostpath/hostpath-installation.md)
- [Replicated Storage User Guide](../user-guides/replicated-storage-user-guide/rs-installation.md)

## See Also

Expand Down
113 changes: 0 additions & 113 deletions docs/main/user-guides/local-storage-user-guide/local-pv-lvm/faq.md

This file was deleted.

Loading

0 comments on commit fd4b39b

Please sign in to comment.