Skip to content

Commit 3031285

Browse files
authored
docs: Update OpenEBS Docs (#538)
Signed-off-by: Bala Harish <161304963+balaharish7@users.noreply.github.com>
1 parent f54daf9 commit 3031285

File tree

10 files changed

+34
-16
lines changed

10 files changed

+34
-16
lines changed

docs/main/Solutioning/backup-and-restore/kubevirt-backup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ description: In this document, you learn about KubeVirt VM Backup and Restore us
1111

1212
## Overview
1313

14-
KubeVirt extends Kubernetes with virtual machine (VM) management capabilities, enabling a unified platform for both containerized and virtualized workloads. Live migration of VMs is a critical feature for achieving high availability, zero-downtime maintenance, and workload mobility. However, live migration in KubeVirt requires shared ReadWriteMany (RWX) storage that can be accessed across multiple nodes.
14+
As Kubernetes continues to gain traction in enterprise environments, there is a growing need to support traditional workloads like virtual machines (VMs) alongside containerized applications. KubeVirt extends Kubernetes by enabling the deployment and management of VMs within a Kubernetes-native ecosystem.
1515

16-
OpenEBS Replicated PV Mayastor is a high-performance, container-native block storage engine that provides persistent storage for Kubernetes. While Replicated PV Mayastor does not natively support RWX volumes, it can be integrated with an NFS server pod and the NFS CSI driver to provide shared access to storage volumes. This document guides you through the setup and validation of a KubeVirt live migration environment using OpenEBS Replicated PV Mayastor and NFS.
16+
To protect KubeVirt-based VMs, a robust backup strategy is essential. This document outlines a step-by-step method to back up KubeVirt virtual machines using Velero, a popular backup and disaster recovery tool for Kubernetes, in combination with Replicated PV Mayastor VolumeSnapshots. This approach provides consistent, point-in-time VM backups that are fully integrated with Kubernetes storage primitives and cloud-native workflows.
1717

1818
## Environment
1919

docs/main/Solutioning/openebs-on-kubernetes-platforms/openshift.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ Before installing Replicated PV Mayastor, make sure that you meet the following
6969
oc adm policy -n openebs add-scc-to-user privileged -z default
7070
```
7171
72+
:::note
73+
It is strongly recommended to use the `-z` (service account) flag as described above, as it helps prevent typographical errors and ensures that access is granted exclusively to the specified service account. If the service account is not in the current project, use the `-n` (namespace) option to specify the applicable project namespace.
74+
:::
75+
7276
## Install Replicated PV Mayastor on OpenShift
7377
7478
Refer to the [OpenEBS Installation Documentation](../../quickstart-guide/installation.md#installation-via-helm) to install Replicated PV Mayastor using Helm.

docs/main/Solutioning/read-write-many/kubevirt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ description: In this document, you learn about KubeVirt VM Live Migration with N
1010

1111
## Overview
1212

13-
As Kubernetes continues to gain traction in enterprise environments, there is a growing need to support traditional workloads like virtual machines (VMs) alongside containerized applications. KubeVirt extends Kubernetes by enabling the deployment and management of VMs within a Kubernetes-native ecosystem.
13+
KubeVirt extends Kubernetes with virtual machine (VM) management capabilities, enabling a unified platform for both containerized and virtualized workloads. Live migration of VMs is a critical feature for achieving high availability, zero-downtime maintenance, and workload mobility. However, live migration in KubeVirt requires shared ReadWriteMany (RWX) storage that can be accessed across multiple nodes.
1414

15-
To protect KubeVirt-based VMs, a robust backup strategy is essential. This document outlines a step-by-step method to back up KubeVirt virtual machines using Velero, a popular backup and disaster recovery tool for Kubernetes, in combination with Replicated PV Mayastor VolumeSnapshots. This approach provides consistent, point-in-time VM backups that are fully integrated with Kubernetes storage primitives and cloud-native workflows.
15+
OpenEBS Replicated PV Mayastor is a high-performance, container-native block storage engine that provides persistent storage for Kubernetes. While Replicated PV Mayastor does not natively support RWX volumes, it can be integrated with an NFS server pod and the NFS CSI driver to provide shared access to storage volumes. This document guides you through the setup and validation of a KubeVirt live migration environment using OpenEBS Replicated PV Mayastor and NFS.
1616

1717
## Environment
1818

docs/main/releases.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,22 @@ OpenEBS is delighted to introduce the following new features with OpenEBS 4.3.2:
3535
### General
3636

3737
- **Kubectl OpenEBS Plugin**
38+
3839
A new unified CLI plugin has been introduced. If you have deployed your cluster using the OpenEBS umbrella chart, you can now manage all supported storages - Local PV Hostpath, Local PV LVM, Local PV ZFS, and Replicated PV Mayastor using a single plugin.
3940

4041
- **One-Step Upgrade**
42+
4143
OpenEBS now supports a unified, one-step upgrade process for all its storages. This umbrella upgrade mechanism simplifies and streamlines the upgrade procedure across the OpenEBS ecosystem.
4244

4345
- **Enhanced Supportability**
46+
4447
- Support bundle collection is now available for all stable OpenEBS storages — Replicated PV Mayastor, Local PV Hostpath, Local PV LVM and Local PV ZFS using the `kubectl openebs dump system` command.
4548
- This unified supportability approach enables consistent and comprehensive system state capture, significantly improving the efficiency of debugging and troubleshooting. Previously, this capability was limited to Replicated PV Mayastor via the `kubectl-mayastor` plugin.
4649

4750
### Replicated Storage
4851

4952
**At-Rest Encryption**
53+
5054
You can now configure disk pools with your own encryption key, allowing volume replicas to be encrypted at rest. This is useful if you are working in environments with compliance or security requirements.
5155

5256
## Enhancements
@@ -74,6 +78,7 @@ OpenEBS is delighted to introduce the following new features with OpenEBS 4.3.2:
7478
### Local Storage
7579

7680
**For Local PV ZFS**
81+
7782
- The quota property is now correctly retained during upgrades.
7883
- Volume restores now maintain backward compatibility for `quotatype` values.
7984
- Fixed a crash in the controller caused by unhandled errors in the `CSI NodeGetInfo` call.

docs/main/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/configuration/rs-rdma.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Before enabling and using RDMA in Replicated PV Mayastor, ensure the following p
2121

2222
1. **Interface Validation**
2323

24-
Ensure that the interface name specified in `io-engine.target.nvmf.iface` exists on all io-engine nodes. Misconfiguration of this parameter can lead to unexpected behavior.
24+
Ensure that the interface name specified in `io_engine.target.nvmf.iface` exists on all io-engine nodes. Misconfiguration of this parameter can lead to unexpected behavior.
2525
If the interface name is not RDMA-capable on a node, Replicated PV Mayastor volume targets on such nodes will support only TCP connections.
2626

2727
2. **Application Node Requirements**
2828

29-
Application nodes must also be RDMA-capable to connect to RDMA-enabled volume targets. This capability is independent of the Helm-provided interface name for `io-engine.target.nvmf.iface`. RDMA connections will work as long as the application node has an RDMA-capable device.
29+
Application nodes must also be RDMA-capable to connect to RDMA-enabled volume targets. This capability is independent of the Helm-provided interface name for `io_engine.target.nvmf.iface`. RDMA connections will work as long as the application node has an RDMA-capable device.
3030

3131
3. **TCP Fallback Behavior**
3232

@@ -50,9 +50,9 @@ Before enabling and using RDMA in Replicated PV Mayastor, ensure the following p
5050

5151
To enable the RDMA feature via Helm:
5252

53-
1. Set `io-engine.target.nvmf.rdma.enabled` to `true`.
53+
1. Set `io_engine.target.nvmf.rdma.enabled` to `true`.
5454

55-
2. Set `io-engine.target.nvmf.iface` to a valid network interface name that exists on an RNIC.
55+
2. Set `io_engine.target.nvmf.iface` to a valid network interface name that exists on an RNIC.
5656

5757
3. Verify that all nodes are properly configured with RDMA-capable hardware and that network interfaces are correctly identified and accessible.
5858

docs/versioned_docs/version-4.3.x/Solutioning/backup-and-restore/kubevirt-backup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ description: In this document, you learn about KubeVirt VM Backup and Restore us
1111

1212
## Overview
1313

14-
KubeVirt extends Kubernetes with virtual machine (VM) management capabilities, enabling a unified platform for both containerized and virtualized workloads. Live migration of VMs is a critical feature for achieving high availability, zero-downtime maintenance, and workload mobility. However, live migration in KubeVirt requires shared ReadWriteMany (RWX) storage that can be accessed across multiple nodes.
14+
As Kubernetes continues to gain traction in enterprise environments, there is a growing need to support traditional workloads like virtual machines (VMs) alongside containerized applications. KubeVirt extends Kubernetes by enabling the deployment and management of VMs within a Kubernetes-native ecosystem.
1515

16-
OpenEBS Replicated PV Mayastor is a high-performance, container-native block storage engine that provides persistent storage for Kubernetes. While Replicated PV Mayastor does not natively support RWX volumes, it can be integrated with an NFS server pod and the NFS CSI driver to provide shared access to storage volumes. This document guides you through the setup and validation of a KubeVirt live migration environment using OpenEBS Replicated PV Mayastor and NFS.
16+
To protect KubeVirt-based VMs, a robust backup strategy is essential. This document outlines a step-by-step method to back up KubeVirt virtual machines using Velero, a popular backup and disaster recovery tool for Kubernetes, in combination with Replicated PV Mayastor VolumeSnapshots. This approach provides consistent, point-in-time VM backups that are fully integrated with Kubernetes storage primitives and cloud-native workflows.
1717

1818
## Environment
1919

docs/versioned_docs/version-4.3.x/Solutioning/openebs-on-kubernetes-platforms/openshift.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ Before installing Replicated PV Mayastor, make sure that you meet the following
6969
oc adm policy -n openebs add-scc-to-user privileged -z default
7070
```
7171
72+
:::note
73+
It is strongly recommended to use the `-z` (service account) flag as described above, as it helps prevent typographical errors and ensures that access is granted exclusively to the specified service account. If the service account is not in the current project, use the `-n` (namespace) option to specify the applicable project namespace.
74+
:::
75+
7276
## Install Replicated PV Mayastor on OpenShift
7377
7478
Refer to the [OpenEBS Installation Documentation](../../quickstart-guide/installation.md#installation-via-helm) to install Replicated PV Mayastor using Helm.

docs/versioned_docs/version-4.3.x/Solutioning/read-write-many/kubevirt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ description: In this document, you learn about KubeVirt VM Live Migration with N
1010

1111
## Overview
1212

13-
As Kubernetes continues to gain traction in enterprise environments, there is a growing need to support traditional workloads like virtual machines (VMs) alongside containerized applications. KubeVirt extends Kubernetes by enabling the deployment and management of VMs within a Kubernetes-native ecosystem.
13+
KubeVirt extends Kubernetes with virtual machine (VM) management capabilities, enabling a unified platform for both containerized and virtualized workloads. Live migration of VMs is a critical feature for achieving high availability, zero-downtime maintenance, and workload mobility. However, live migration in KubeVirt requires shared ReadWriteMany (RWX) storage that can be accessed across multiple nodes.
1414

15-
To protect KubeVirt-based VMs, a robust backup strategy is essential. This document outlines a step-by-step method to back up KubeVirt virtual machines using Velero, a popular backup and disaster recovery tool for Kubernetes, in combination with Replicated PV Mayastor VolumeSnapshots. This approach provides consistent, point-in-time VM backups that are fully integrated with Kubernetes storage primitives and cloud-native workflows.
15+
OpenEBS Replicated PV Mayastor is a high-performance, container-native block storage engine that provides persistent storage for Kubernetes. While Replicated PV Mayastor does not natively support RWX volumes, it can be integrated with an NFS server pod and the NFS CSI driver to provide shared access to storage volumes. This document guides you through the setup and validation of a KubeVirt live migration environment using OpenEBS Replicated PV Mayastor and NFS.
1616

1717
## Environment
1818

docs/versioned_docs/version-4.3.x/releases.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,22 @@ OpenEBS is delighted to introduce the following new features with OpenEBS 4.3.2:
3535
### General
3636

3737
- **Kubectl OpenEBS Plugin**
38+
3839
A new unified CLI plugin has been introduced. If you have deployed your cluster using the OpenEBS umbrella chart, you can now manage all supported storages - Local PV Hostpath, Local PV LVM, Local PV ZFS, and Replicated PV Mayastor using a single plugin.
3940

4041
- **One-Step Upgrade**
42+
4143
OpenEBS now supports a unified, one-step upgrade process for all its storages. This umbrella upgrade mechanism simplifies and streamlines the upgrade procedure across the OpenEBS ecosystem.
4244

4345
- **Enhanced Supportability**
46+
4447
- Support bundle collection is now available for all stable OpenEBS storages — Replicated PV Mayastor, Local PV Hostpath, Local PV LVM and Local PV ZFS using the `kubectl openebs dump system` command.
4548
- This unified supportability approach enables consistent and comprehensive system state capture, significantly improving the efficiency of debugging and troubleshooting. Previously, this capability was limited to Replicated PV Mayastor via the `kubectl-mayastor` plugin.
4649

4750
### Replicated Storage
4851

4952
**At-Rest Encryption**
53+
5054
You can now configure disk pools with your own encryption key, allowing volume replicas to be encrypted at rest. This is useful if you are working in environments with compliance or security requirements.
5155

5256
## Enhancements
@@ -74,6 +78,7 @@ OpenEBS is delighted to introduce the following new features with OpenEBS 4.3.2:
7478
### Local Storage
7579

7680
**For Local PV ZFS**
81+
7782
- The quota property is now correctly retained during upgrades.
7883
- Volume restores now maintain backward compatibility for `quotatype` values.
7984
- Fixed a crash in the controller caused by unhandled errors in the `CSI NodeGetInfo` call.

docs/versioned_docs/version-4.3.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/configuration/rs-rdma.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Before enabling and using RDMA in Replicated PV Mayastor, ensure the following p
2121

2222
1. **Interface Validation**
2323

24-
Ensure that the interface name specified in `io-engine.target.nvmf.iface` exists on all io-engine nodes. Misconfiguration of this parameter can lead to unexpected behavior.
24+
Ensure that the interface name specified in `io_engine.target.nvmf.iface` exists on all io-engine nodes. Misconfiguration of this parameter can lead to unexpected behavior.
2525
If the interface name is not RDMA-capable on a node, Replicated PV Mayastor volume targets on such nodes will support only TCP connections.
2626

2727
2. **Application Node Requirements**
2828

29-
Application nodes must also be RDMA-capable to connect to RDMA-enabled volume targets. This capability is independent of the Helm-provided interface name for `io-engine.target.nvmf.iface`. RDMA connections will work as long as the application node has an RDMA-capable device.
29+
Application nodes must also be RDMA-capable to connect to RDMA-enabled volume targets. This capability is independent of the Helm-provided interface name for `io_engine.target.nvmf.iface`. RDMA connections will work as long as the application node has an RDMA-capable device.
3030

3131
3. **TCP Fallback Behavior**
3232

@@ -50,9 +50,9 @@ Before enabling and using RDMA in Replicated PV Mayastor, ensure the following p
5050

5151
To enable the RDMA feature via Helm:
5252

53-
1. Set `io-engine.target.nvmf.rdma.enabled` to `true`.
53+
1. Set `io_engine.target.nvmf.rdma.enabled` to `true`.
5454

55-
2. Set `io-engine.target.nvmf.iface` to a valid network interface name that exists on an RNIC.
55+
2. Set `io_engine.target.nvmf.iface` to a valid network interface name that exists on an RNIC.
5656

5757
3. Verify that all nodes are properly configured with RDMA-capable hardware and that network interfaces are correctly identified and accessible.
5858

0 commit comments

Comments
 (0)