Skip to content

Commit 288f99a

Browse files
Apply changes to v1.5 doc
Signed-off-by: Jillian <jillian.maroket@suse.com>
1 parent 65cf256 commit 288f99a

2 files changed

Lines changed: 84 additions & 44 deletions

File tree

docs/networking/clusternetwork.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The [witness node](../advanced/witness.md) is generally not involved in the cust
9999

100100
:::tip
101101

102-
To simplify cluster maintenance, create one network configuration for each node or group of nodes. Without dedicated network configurations, certain maintenance tasks (for example, replacing old NICs with NICs in different slots) will require you to stop and/or migrate the affected VMs before updating the network configuration.
102+
To simplify cluster maintenance, create one network configuration for each node or group of nodes. Without dedicated network configurations, certain maintenance tasks (for example, replacing old NICs with NICs in different slots) will require you to stop and/or migrate the affected virtual machines before updating the network configuration.
103103

104104
:::
105105

versioned_docs/version-v1.5/networking/clusternetwork.md

Lines changed: 83 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -97,49 +97,55 @@ The [witness node](../advanced/witness.md) is generally not involved in the cust
9797

9898
### Create a New Cluster Network
9999

100+
:::tip
101+
102+
To simplify cluster maintenance, create one network configuration for each node or group of nodes. Without dedicated network configurations, certain maintenance tasks (for example, replacing old NICs with NICs in different slots) will require you to stop and/or migrate the affected virtual machines before updating the network configuration.
103+
104+
:::
105+
100106
1. Go to **Networks > ClusterNetworks/Configs**, and then click **Create**.
101107

102-
1. Specify a name for the network.
108+
1. Specify a name for the cluster network.
103109

104-
![](/img/v1.2/networking/create-clusternetwork.png)
110+
![](/img/v1.2/networking/create-clusternetwork.png)
105111

106-
1. Click the **Create Network Config** button on the right of the cluster network to create a new network configuration.
112+
1. On the **ClusterNetworks/Configs** screen, click the **Create Network Config** button of the cluster network you created.
107113

108114
![](/img/v1.2/networking/create-network-config-button.png)
109115

110-
1. In the **Node Selector** tab, specify the name and choose one of the three methods to select nodes where the network configuration will apply. If you want to cover the unselected nodes, you can create another network configuration.
116+
1. On the **Network Config:Create** screen, specify a name for the configuration.
117+
118+
1. On the **Node Selector** tab, select the method for defining the scope of this specific network configuration.
111119

112120
![](/img/v1.2/networking/select-nodes.png)
113121

114-
:::note
122+
:::note
115123

116-
The method **Select all nodes** works only when all nodes use the exact same dedicated NICs for this specific custom cluster network. In other situations (for example, when the cluster has a [witness node](../advanced/witness.md)), you must select either of the remaining methods.
124+
- The method *Select all nodes* works only when all nodes use the exact same dedicated NICs for this specific custom cluster network. In other situations (for example, when the cluster has a [witness node](../advanced/witness.md)), you must select either of the remaining methods.
125+
- If you want the configuration to apply to nodes that are not covered by the selected method, you must create another network configuration.
117126

118-
:::
127+
:::
119128

120-
1. Click the **Uplink** tab to add the NICs, and configure the bond options and link attributes. The bond mode defaults to `active-backup`.
129+
1. On the **Uplink** tab, configure the following settings:
121130

122-
![](/img/v1.2/networking/config-uplink.png)
131+
- **NICs**: The list contains NICs that are common to all selected nodes. NICs that cannot be selected are unavailable on one or more nodes and must be configured. Once troubleshooting is completed, refresh the screen and verify that the NICs can be selected.
132+
- **Bond Options**: The default value is **active-backup**.
133+
- **Attributes**
123134

124-
:::note
135+
![](/img/v1.2/networking/config-uplink.png)
125136

126-
- The NICs drop-down list shows all the common NICs on all the selected nodes. The drop-down list will change as you select different nodes.
127-
- The text `enp7s3 (1/3 Down)` in the NICs drop-down list indicates that the enp7s3 NIC is down in one of the three selected nodes. In this case, you need to find the NIC, set it up, and refresh this page. After this, it should be selectable.
137+
1. Click **Save**.
128138

129-
:::
139+
### Change a Network Configuration
130140

131-
:::note
141+
Changes to existing network configurations may affect Harvester virtual machines and workloads, and external devices such as switches and routers. For more information, see [Network Topology](./deep-dive.md#network-topology).
132142

133-
Starting with Harvester v1.1.2, Harvester supports updating network configs. Make sure to stop all affected VMs before updating network configs.
143+
:::info important
134144

135-
To simplify cluster maintenance, create one network configuration for each node or group of nodes. Without dedicated network configurations, certain maintenance tasks (for example, replacing old NICs with NICs in different slots) will require you to stop and/or migrate the affected VMs before updating the network configuration.
145+
You must stop all affected virtual machines before changing a network configuration.
136146

137147
:::
138148

139-
### Change a Network Configuration
140-
141-
Changes to existing network configurations may affect Harvester virtual machines and workloads, and external devices such as switches and routers. For more information, see [Network Topology](./deep-dive.md#network-topology).
142-
143149
The following sections outline the steps you must perform to change the MTU of a network configuration. The sample cluster network used in these sections has `cn-data` that was built with a MTU value `1500` and is intended to be changed with value `9000`.
144150

145151
![](/img/v1.4/networking/set-a-new-mtu-value.png)
@@ -187,43 +193,59 @@ If you must change the MTU, perform the following steps:
187193
188194
1. Test the new MTU on Harvester nodes using commands such as `ping`. You must send the messages to a Harvester node with the new MTU or a node with an external IP.
189195
190-
Example:
196+
In the following example, the network is `cn-data`, the CIDR is `192.168.100.0/24`, and the gateway is `192.168.100.1`.
191197
192-
Suppose a CIDR `192.168.100.0/24` and gateway `192.168.100.1` is prepared for the cn-data network.
193-
194-
1. Set an IP 192.168.100.100 on bridge device
198+
1. Set the IP `192.168.100.100` on the bridge device.
195199
200+
```
196201
$ ip addr add dev cn-data-br 192.168.100.100/24
202+
```
197203
198-
1. Add a route for destination IP like `8.8.8.8` via the gateway
204+
1. Add a route for the destination IP (for example, `8.8.8.8`) via the gateway.
199205
206+
```
200207
$ ip route add 8.8.8.8 via 192.168.100.1 dev cn-data-br
208+
```
201209
202-
1. ping 8.8.8.8 from the new IP 192.168.100.100
210+
1. Ping the destination IP from the new IP `192.168.100.100`.
203211
212+
```
204213
$ ping 8.8.8.8 -I 192.168.100.100
205214
PING 8.8.8.8 (8.8.8.8) from 192.168.100.100 : 56(84) bytes of data.
206215
64 bytes from 8.8.8.8: icmp_seq=1 ttl=59 time=8.52 ms
207216
64 bytes from 8.8.8.8: icmp_seq=2 ttl=59 time=8.90 ms
208217
...
218+
```
209219
210-
1. ping with different size to validate new MTU
220+
1. Ping the destination IP with a different packet size to validate the new MTU.
211221
222+
```
212223
$ ping 8.8.8.8 -s 8800 -I 192.168.100.100
213224
214225
PING 8.8.8.8 (8.8.8.8) from 192.168.100.100 : 8800(8828) bytes of data
215226
216227
The param `-s` specify the ping packet size, which can test if the new MTU really works
228+
```
217229
218-
1. Remove the added test route
230+
1. Remove the route that you used for testing.
219231
232+
```
220233
$ ip route delete 8.8.8.8 via 192.168.100.1 dev cn-data-br
234+
```
221235
222-
1. Remove the added test ip
236+
1. Remove the IP that you used for testing.
223237
238+
```
224239
$ ip addr delete 192.168.100.100/24 dev cn-data-br
240+
```
241+
242+
1. Add back the network configurations that you removed.
225243
226-
1. Add back the network configurations that you removed, change the MTU in each one, and verify that the new MTU was applied.
244+
:::info important
245+
246+
You must change the MTU in each one, and verify that the new MTU was applied.
247+
248+
:::
227249
228250
1. Edit the YAML of all virtual machine networks that are attached to the target cluster network.
229251
@@ -295,7 +317,7 @@ The storage network is used by `driver.longhorn.io`, which is Harvester's defaul
295317
296318
If you must change the MTU, perform the following steps:
297319
298-
1. Stop all the VMs.
320+
1. Stop all virtual machines.
299321
300322
1. Disable the Harvester [Storage Network](../advanced/storagenetwork.md#harvester-storage-network-setting).
301323
@@ -333,47 +355,65 @@ If you must change the MTU, perform the following steps:
333355
334356
1. Test the new MTU on Harvester nodes using commands such as `ping`. You must send the messages to a Harvester node with the new MTU or to a node with an external IP.
335357
336-
Example:
358+
In the following example, the network is `cn-data`, the CIDR is `192.168.100.0/24`, and the gateway is `192.168.100.1`.
337359
338-
Suppose a CIDR `192.168.100.0/24` and gateway `192.168.100.1` is prepared for the cn-data network.
339-
340-
1. Set an IP 192.168.100.100 on bridge device
360+
1. Set the IP `192.168.100.100` on the bridge device.
341361
362+
```
342363
$ ip addr add dev cn-data-br 192.168.100.100/24
364+
```
343365
344-
1. Add a route for destination IP like `8.8.8.8` via the gateway
366+
1. Add a route for the destination IP (for example, `8.8.8.8`) via the gateway.
345367
368+
```
346369
$ ip route add 8.8.8.8 via 192.168.100.1 dev cn-data-br
370+
```
347371
348-
1. ping 8.8.8.8 from the new IP 192.168.100.100
372+
1. Ping the destination IP from the new IP `192.168.100.100`.
349373
374+
```
350375
$ ping 8.8.8.8 -I 192.168.100.100
351376
PING 8.8.8.8 (8.8.8.8) from 192.168.100.100 : 56(84) bytes of data.
352377
64 bytes from 8.8.8.8: icmp_seq=1 ttl=59 time=8.52 ms
353378
64 bytes from 8.8.8.8: icmp_seq=2 ttl=59 time=8.90 ms
354379
...
380+
```
355381
356-
1. ping with different size to validate new MTU
382+
1. Ping the destination IP with a different packet size to validate the new MTU.
357383
384+
```
358385
$ ping 8.8.8.8 -s 8800 -I 192.168.100.100
359386
360387
PING 8.8.8.8 (8.8.8.8) from 192.168.100.100 : 8800(8828) bytes of data
361388
362389
The param `-s` specify the ping packet size, which can test if the new MTU really works
390+
```
363391
364-
1. Remove the added test route
392+
1. Remove the route that you used for testing.
365393
394+
```
366395
$ ip route delete 8.8.8.8 via 192.168.100.1 dev cn-data-br
396+
```
367397
368-
1. Remove the added test ip
398+
1. Remove the IP that you used for testing.
369399
400+
```
370401
$ ip addr delete 192.168.100.100/24 dev cn-data-br
402+
```
403+
404+
1. Add back the network configurations that you removed.
371405
372-
1. Add back the network configurations that you removed, change the MTU in each one, and verify that the new MTU was applied.
406+
:::info important
373407
374-
1. Enable and configure the Harvester [storage network setting](../advanced/storagenetwork.md#harvester-storage-network-setting), ensuring that the [prerequisites](../advanced/storagenetwork.md#prerequisites) are met.
408+
You must change the MTU in each one, and verify that the new MTU was applied.
375409
376-
Allow some time for the setting to be disabled, and then [verify that the change was applied](../advanced/storagenetwork.md#verify-configuration-is-completed).
410+
:::
411+
412+
1. Enable and configure the Harvester [storage network setting](../advanced/storagenetwork.md#harvester-storage-network-setting).
413+
414+
Ensure that the [prerequisites](../advanced/storagenetwork.md#prerequisites) are met.
415+
416+
1. Allow some time for the setting to be enabled, and then [verify that the change was applied](../advanced/storagenetwork.md#verify-configuration-is-completed).
377417
378418
1. Edit the YAML of all virtual machine networks that are attached to the target cluster network.
379419

0 commit comments

Comments
 (0)