Skip to content

Commit d2f265d

Browse files
committed
docs: added info. regarding nvme_core.multipath
Signed-off-by: Bala Harish <[email protected]>
1 parent da7403e commit d2f265d

File tree

2 files changed

+12
-0
lines changed
  • docs/main/user-guides/replicated-storage-user-guide/replicated-pv-mayastor

2 files changed

+12
-0
lines changed

docs/main/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/HA.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ The HA node agent looks for I/O path failures from applications to their corresp
1919
The volume's replica count must be higher than one for a new target to be established as part of switch-over.
2020
:::
2121

22+
To ensure optimal HA in Replicated PV Mayastor clusters:
23+
24+
- Applications constrained to nodes with the `io-engine label` (`openebs.io/engine=mayastor`) will have the Nexus preferably placed on the same node where the application is scheduled. If the `io-engine` pod on a node is in a bad state, the Nexus may be placed on a different node.
25+
26+
- The kernel parameter `nvme_core.multipath=Y` is mandatory to enable HA functionality. Without this configuration, failover to a new Nexus cannot be achieved effectively.
27+
2228
### How do I disable this feature?
2329

2430
:::info

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ All worker nodes must satisfy the following requirements:
3131
* **HugePage support**
3232
* A minimum of **2GiB of** **2MiB-sized** pages
3333

34+
* Enabling `nvme_core.multipath` is required for High Availability (HA) functionality in Replicated PV Mayastor. Ensure the kernel parameter `nvme_core.multipath=Y` is set during the installation. (This prerequisite is optional.)
35+
36+
:::note
37+
If the application is constrained to nodes with the `io-engine label` (`openebs.io/engine=mayastor`), the Nexus is preferably placed on the same node where the application is scheduled.
38+
:::
39+
3440
### Network Requirements
3541

3642
* Ensure that the following ports are **not** in use on the node:

0 commit comments

Comments
 (0)