Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: restructured the replicated storage docs (created a new folder for Replicated PV Mayastor) and corrected the cross references #417

Merged
merged 2 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/main/concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Using a single controller to implement synchronous replication of data to a fixe

The OpenEBS volume services layer exposes the volumes as:
- Device or Directory paths in case of Local Storage (a.k.a Local Engine)
- NVMe Target in case of Replicated Storage (a.k.a Replicated Engine or Mayastor)
- NVMe Target in case of Replicated Storage (a.k.a Replicated Engine)

### Volume Data Layer

Expand All @@ -80,7 +80,7 @@ The storage layer forms the basic building blocks for persisting the data. The s

The storage layer is outside the purview of the OpenEBS Data Engines and is available to the Kubernetes storage constructs using standard operating system or Linux software constructs.

The Data Engines consume the storage as a device, a device pool or a filesystem directory.
The Data Engines consume the storage as a device, a device pool, or a filesystem directory.

## Control Plane

Expand Down
4 changes: 2 additions & 2 deletions docs/main/concepts/data-engines/data-engines.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ The below table identifies a few differences among the different OpenEBS Local S

### Replicated Storage

Replicated Storage (a.k.a Replicated Engine or Mayastor) can synchronously replicate the data to multiple nodes. These engines protect against node failures, by allowing the volume to be accessible from one of the other nodes where the data was replicated to. The replication can also be set up across availability zones helping applications move across availability zones. Replicated Volumes are also capable of enterprise storage features like snapshots, clone, volume expansion, and so forth.
Replicated Storage (a.k.a Replicated Engine) can synchronously replicate the data to multiple nodes. These engines protect against node failures, by allowing the volume to be accessible from one of the other nodes where the data was replicated to. The replication can also be set up across availability zones helping applications move across availability zones. Replicated Volumes are also capable of enterprise storage features like snapshots, clone, volume expansion, and so forth.

:::tip
Depending on the type of storage attached to your Kubernetes worker nodes and application performance requirements, you can select from [Local Storage](local-storage.md) or [Replicated Storage](replicated-storage.md).
Expand Down Expand Up @@ -163,4 +163,4 @@ For the latest updates and discussions, community users are invited to join the
## See Also

- [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)
- [Replicated Storage User Guide](../../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation.md)
6 changes: 2 additions & 4 deletions docs/main/concepts/data-engines/local-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,7 @@ A quick summary of the steps to restore include:
## See Also

- [OpenEBS Architecture](../architecture.md)
- [Local PV Hostpath Prerequisites](../../user-guides/local-storage-user-guide/local-pv-hostpath/hostpath-installation.md)
- [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)
- [Quickstart](../quickstart-guide/installation.md)
- [Deployment](../quickstart-guide/deploy-a-test-application.md)
- [Local Storage User Guide](../../user-guides/local-storage-user-guide/local-pv-hostpath/hostpath-installation.md)

8 changes: 4 additions & 4 deletions docs/main/concepts/data-engines/replicated-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: In this document you will learn about Replicated Storage and its de

## Replicated Storage Overview

**Replicated Storage** (a.k.a Replicated Engine or Mayastor) is a progressive sub-project of the CNCF (Cloud Native Computing Foundation) Open Source initiative [**OpenEBS**](https://openebs.io/). OpenEBS is a Container Native Storage (CNS) solution that extends Kubernetes by providing a declarative data plane, offering resilient and adaptable storage for stateful applications.
**Replicated Storage** (a.k.a Replicated Engine) is a progressive sub-project of the CNCF (Cloud Native Computing Foundation) Open Source initiative **OpenEBS**. OpenEBS is a Container Native Storage (CNS) solution that extends Kubernetes by providing a declarative data plane, offering resilient and adaptable storage for stateful applications.

## Design Goals

Expand Down Expand Up @@ -45,6 +45,6 @@ Join the vibrant [OpenEBS community on Kubernetes Slack](https://kubernetes.slac
## See Also

- [OpenEBS Architecture](../architecture.md)
- [Replicated Storage Prerequisites](../../user-guides/replicated-storage-user-guide/rs-installation.md#prerequisites)
- [Installation](../../quickstart-guide/installation.md)
- [Replicated Storage User Guide](../../user-guides/replicated-storage-user-guide/rs-installation.md)
- [Quickstart](../quickstart-guide/installation.md)
- [Deployment](../quickstart-guide/deploy-a-test-application.md)
- [Replicated Storage User Guide](../../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation.md)
3 changes: 1 addition & 2 deletions docs/main/introduction-to-openebs/introduction-to-openebs.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ In the case of [Replicated Volumes](#replicated-volumes):
:::note
OpenEBS contributors prefer to call the Distributed Block Storage volumes as **Replicated Volumes**, to avoid confusion with traditional block storage for the following reasons:
* Distributed block storage tends to shard the data blocks of a volume across many nodes in the cluster. Replicated volumes persist all the data blocks of a volume on a node and for durability replicate the entire data to other nodes in the cluster.
* While accessing volume data, distributed block storage depends on metadata hashing algorithms to locate the node where the block resides, whereas replicated volumes can access the data from any of the nodes where data is persisted (aka replica nodes).
* While accessing volume data, distributed block storage depends on metadata hashing algorithms to locate the node where the block resides, whereas replicated volumes can access the data from any of the nodes where data is persisted (a.k.a replica nodes).
* Replicated volumes have a lower blast radius compared to traditional distributed block storage.
* Replicated volumes are designed for Cloud Native stateful workloads that require a large number of volumes with capacity that can typically be served from a single node as opposed to a single large volume with data sharded across multiple nodes in the cluster.
:::
Expand Down Expand Up @@ -79,7 +79,6 @@ OpenEBS has a vibrant community that can help you get started. If you have furth
## See Also

- [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)
- [Container Native Storage (CNS)](../concepts/container-native-storage.md)
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 @@ -11,7 +11,7 @@ description: This section will help you to deploy a test application.
:::info
- See [Local PV LVM Deployment](../user-guides/local-storage-user-guide/local-pv-lvm/lvm-deployment.md) to deploy Local PV LVM.
- See [Local PV ZFS Deployment](../user-guides/local-storage-user-guide/local-pv-zfs/zfs-deployment.md) to deploy Local PV ZFS.
- See [Replicated Storage Deployment](../user-guides/replicated-storage-user-guide/rs-deployment.md) to deploy Replicated Storage (a.k.a Replicated Engine or Mayastor).
- See [Replicated PV Mayastor Deployment](../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-deployment.md) to deploy Replicated PV Mayastor.
:::

# Deploy an Application
Expand Down Expand Up @@ -224,4 +224,4 @@ Once the workloads are up and running, the platform or the operations team can o
- [Local Storage](../concepts/data-engines/local-storage.md)
- [Replicated Storage](../concepts/data-engines/replicated-storage.md)
- [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)
- [Replicated Storage User Guide](../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation.md)
4 changes: 2 additions & 2 deletions docs/main/quickstart-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If this is your first time installing OpenEBS Local Storage (a.k.a Local Engines
- [Local PV LVM](../user-guides/local-storage-user-guide/local-pv-lvm/lvm-installation.md#prerequisites)
- [Local PV ZFS](../user-guides/local-storage-user-guide/local-pv-zfs/zfs-installation.md#prerequisites)

For OpenEBS Replicated Storage (a.k.a Replicated Engine or Mayastor), make sure that your Kubernetes nodes meet the [required prerequisites](../user-guides/replicated-storage-user-guide/rs-installation.md#prerequisites).
For OpenEBS Replicated Storage (a.k.a Replicated Engine), make sure that your Kubernetes nodes meet the [required prerequisites](../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation.md#prerequisites).

At a high-level, OpenEBS requires:

Expand Down Expand Up @@ -189,7 +189,7 @@ For testing your OpenEBS installation, you can use the `openebs-hostpath` mentio

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](../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)
- [Replicated Storage User Guide](../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation.md)

## See Also

Expand Down
6 changes: 3 additions & 3 deletions docs/main/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ description: This page contains list of supported OpenEBS releases.

OpenEBS is a collection of data engines and operators to create different types of replicated and local persistent volumes for Kubernetes Stateful workloads. Kubernetes volumes can be provisioned via CSI Drivers or using Out-of-tree Provisioners. The status of the various components as of v4.0.0 are as follows:

- Local Storage
- Local Storage (a.k.a Local Engine)
- [Local PV Hostpath 4.0.0](https://github.com/openebs/dynamic-localpv-provisioner) (stable)
- [Local PV LVM 1.5.0](https://github.com/openebs/lvm-localpv) (stable)
- [Local PV ZFS 2.5.0](https://github.com/openebs/zfs-localpv) (stable)

- Replicated Storage (a.k.a Replicated Engine or Mayastor)
- [Mayastor](https://github.com/openebs/mayastor) 2.6.0 (stable)
- Replicated Storage (a.k.a Replicated Engine)
- [Replicated PV Mayastor 2.6.0](https://github.com/openebs/mayastor) (stable)

- Out-of-tree (External Storage) Provisioners
- [Local PV Hostpath](https://github.com/openebs/dynamic-localpv-provisioner) 4.0.0 (stable)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ description: This section explains about the Call-Home Metrics.
---
# Call-home Metrics

## Replicated Storage Default Information Collection
## Replicated PV Mayastor Default Information Collection

By default, Replicated Storage (a.k.a Replicated Engine or Mayastor) collects basic information related to the number and scale of user-deployed instances. The collected data is anonymous and is encrypted at rest. This data is used to understand storage usage trends, which in turn helps maintainers prioritize their contributions to maximize the benefit to the community as a whole.
By default, Replicated PV Mayastor collects basic information related to the number and scale of user-deployed instances. The collected data is anonymous and is encrypted at rest. This data is used to understand storage usage trends, which in turn helps maintainers prioritize their contributions to maximize the benefit to the community as a whole.

:::info
No user-identifiable information, hostnames, passwords, or volume data are collected. **ONLY** the below-mentioned information is collected from the cluster.
Expand All @@ -21,34 +21,34 @@ A summary of the information collected is given below:
| :--- |
|**K8s cluster ID**: This is a SHA-256 hashed value of the UID of your Kubernetes cluster's `kube-system` namespace.|
|**K8s node count**: This is the number of nodes in your Kubernetes cluster.|
|**Product name**: This field displays the name Replicated Storage.|
|**Product version**: This is the deployed version of Replicated Storage.|
|**Deploy namespace**: This is a SHA-256 hashed value of the name of the Kubernetes namespace where Replicated Storage Helm chart is deployed.|
|**Product name**: This field displays the name Replicated PV Mayastor.|
|**Product version**: This is the deployed version of Replicated PV Mayastor.|
|**Deploy namespace**: This is a SHA-256 hashed value of the name of the Kubernetes namespace where Replicated PV Mayastor Helm chart is deployed.|
|**Storage node count**: This is the number of nodes on which the IO engine pods are scheduled and running.|

|**Pool information**|
| :--- |
|**Pool count**: This is the number of Replicated Storage DiskPools in your cluster.|
|**Pool maximum size**: This is the capacity of the Replicated Storage DiskPool with the highest capacity.|
|**Pool minimum size**: This is the capacity of the Replicated Storage DiskPool with the lowest capacity.|
|**Pool mean size**: This is the average capacity of the Replicated Storage DiskPools in your cluster.|
|**Pool capacity percentiles**: This calculates and returns the capacity distribution of Replicated Storage DiskPools for the 50th, 75th and the 90th percentiles.|
|**Pool count**: This is the number of Replicated PV Mayastor DiskPools in your cluster.|
|**Pool maximum size**: This is the capacity of the Replicated PV Mayastor DiskPool with the highest capacity.|
|**Pool minimum size**: This is the capacity of the Replicated PV Mayastor DiskPool with the lowest capacity.|
|**Pool mean size**: This is the average capacity of the Replicated PV Mayastor DiskPools in your cluster.|
|**Pool capacity percentiles**: This calculates and returns the capacity distribution of Replicated PV Mayastor DiskPools for the 50th, 75th and the 90th percentiles.|
| **Pools created**: This is the number of successful pool creation attempts.|
| **Pools deleted**: This is the number of successful pool deletion attempts.|

|**Volume information**|
| :--- |
|**Volume count**: This is the number of Replicated Storage Volumes in your cluster.|
|**Volume minimum size**: This is the capacity of the Replicated Storage Volume with the lowest capacity.|
|**Volume mean size**: This is the average capacity of the Replicated Storage Volumes in your cluster.|
|**Volume capacity percentiles**: This calculates and returns the capacity distribution of Replicated Storage Volumes for the 50th, 75th and the 90th percentiles.|
|**Volume count**: This is the number of Replicated PV Mayastor Volumes in your cluster.|
|**Volume minimum size**: This is the capacity of the Replicated PV Mayastor Volume with the lowest capacity.|
|**Volume mean size**: This is the average capacity of the Replicated PV Mayastor Volumes in your cluster.|
|**Volume capacity percentiles**: This calculates and returns the capacity distribution of Replicated PV Mayastor Volumes for the 50th, 75th and the 90th percentiles.|
| **Volumes created**: This is the number of successful volume creation attempts.|
| **Volumes deleted**: This is the number of successful volume deletion attempts. |

|**Replica Information**|
| :--- |
|**Replica count**: This is the number of Replicated Storage Volume replicas in your cluster.|
|**Average replica count per volume**: This is the average number of replicas each Replicated Storage Volume has in your cluster.|
|**Replica count**: This is the number of Replicated PV Mayastor Volume replicas in your cluster.|
|**Average replica count per volume**: This is the average number of replicas each Replicated PV Mayastor Volume has in your cluster.|

### Storage Location of Collected Data

Expand Down
Loading
Loading