Skip to content

Commit b1ae2f9

Browse files
rrajendran17bk201
authored andcommitted
add best practices section to v1.3 and v1.4
1 parent a29cf02 commit b1ae2f9

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

versioned_docs/version-v1.3/advanced/storagenetwork.md

+7
Original file line numberDiff line numberDiff line change
@@ -385,3 +385,10 @@ The storage network may malfunction because of issues with the external network,
385385
### Start VM Manually
386386

387387
After verifying the configuration, users could start VM manually on demand.
388+
389+
390+
## Best Practices
391+
392+
- When configuring an [IP range](#configuration-example) for the storage network, ensure that the allocated IP addresses can service the future needs of the cluster. This is important because Longhorn pods (`instance-manager` and `backing-image-manager`) stop running when new nodes are added to the cluster or more disks are added to a node after the storage network is configured, and when the required number of IPs exceeds the allocated IPs. Resolving the issue involves reconfiguring the storage network with the correct IP range.
393+
394+
- Configure the storage network on a non-`mgmt` cluster network to ensure complete separation of the Longhorn replication traffic from the Kubernetes control plane traffic. Using `mgmt` is possible but not recommended because of the negative impact (resource and bandwidth contention) on the control plane network performance. Use `mgmt` only if your cluster has NIC-related constraints and if you can completely segregate the traffic.

versioned_docs/version-v1.4/advanced/storagenetwork.md

+6
Original file line numberDiff line numberDiff line change
@@ -384,3 +384,9 @@ The storage network may malfunction because of issues with the external network,
384384
### Start VM Manually
385385

386386
After verifying the configuration, users could start VM manually on demand.
387+
388+
## Best Practices
389+
390+
- When configuring an [IP range](#configuration-example) for the storage network, ensure that the allocated IP addresses can service the future needs of the cluster. This is important because Longhorn pods (`instance-manager` and `backing-image-manager`) stop running when new nodes are added to the cluster or more disks are added to a node after the storage network is configured, and when the required number of IPs exceeds the allocated IPs. Resolving the issue involves reconfiguring the storage network with the correct IP range.
391+
392+
- Configure the storage network on a non-`mgmt` cluster network to ensure complete separation of the Longhorn replication traffic from the Kubernetes control plane traffic. Using `mgmt` is possible but not recommended because of the negative impact (resource and bandwidth contention) on the control plane network performance. Use `mgmt` only if your cluster has NIC-related constraints and if you can completely segregate the traffic.

0 commit comments

Comments
 (0)