Update quickstart-prereq.md

This commit is contained in:
Robert Chacón 2024-10-28 12:12:36 -06:00 committed by GitHub
parent 9587d3283b
commit 061e969296
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -30,8 +30,13 @@ There are two options for the bridge to pass data through your two interfaces:
The regular Linux bridge is recommended for Nvidea/Mellanox NICs such as the ConnectX-5 series (which have superior bridge performance), and VM setups using virtualized NICs. The Bifrost Bridge is recommended for Intel NICs with XDP support, such as the X520 and X710. The regular Linux bridge is recommended for Nvidea/Mellanox NICs such as the ConnectX-5 series (which have superior bridge performance), and VM setups using virtualized NICs. The Bifrost Bridge is recommended for Intel NICs with XDP support, such as the X520 and X710.
To use the Bifrost bridge, skip the regular Linux bridge section below, and be sure to enable Bifrost/XDP in lqos.conf in the [Configuration](configuration.md) section. To use the Bifrost bridge, be sure to enable Bifrost/XDP in lqos.conf in the [Configuration](configuration.md) section.
### Adding a regular Linux bridge (if not using Bifrost XDP bridge)
Below are the instructions to configure Netplan, whether using the Linux Bridge or Bifrost XDP bridge:
## Netplan config
### Netplan for a regular Linux bridge (if not using Bifrost XDP bridge)
From the Ubuntu VM, create a linux interface bridge - br0 - with the two shaping interfaces. From the Ubuntu VM, create a linux interface bridge - br0 - with the two shaping interfaces.
Find your existing .yaml file in /etc/netplan/ with Find your existing .yaml file in /etc/netplan/ with
@ -57,10 +62,8 @@ network:
ethernets: ethernets:
ens18: ens18:
addresses: addresses:
- 10.0.0.12/24 - (addr goes here)
routes: gateway4: (gateway goes here)
- to: default
via: 10.0.0.1
nameservers: nameservers:
addresses: addresses:
- 1.1.1.1 - 1.1.1.1
@ -68,8 +71,10 @@ network:
search: [] search: []
ens19: ens19:
dhcp4: no dhcp4: no
dhcp6: no
ens20: ens20:
dhcp4: no dhcp4: no
dhcp6: no
version: 2 version: 2
bridges: bridges:
br0: br0:
@ -78,10 +83,57 @@ network:
- ens20 - ens20
``` ```
Make sure to replace 10.0.0.12/24 with your LibreQoS VM's address and subnet, and to replace the default gateway 10.0.0.1 with whatever your default gateway is. Make sure to replace `(addr goes here)` with your LibreQoS VM's address and subnet CIDR, and to replace `(gateway goes here)` with whatever your default gateway is.
Then run Then run
```shell ```shell
sudo netplan apply sudo netplan apply
``` ```
### Netplan for the Bifrost XDP bridge
Find your existing .yaml file in /etc/netplan/ with
```shell
cd /etc/netplan/
ls
```
Then edit the .yaml file there with
```shell
sudo nano XX-cloud-init.yaml
```
With XX corresponding to the name of the existing file.
Editing the .yaml file, we need to define the shaping interfaces (here, ens19 and ens20) and add the bridge with those two interfaces. Assuming your interfaces are ens18, ens19, and ens20, here is what your file might look like:
```
network:
ethernets:
ens18:
addresses:
- (addr goes here)
gateway4: (gateway goes here)
nameservers:
addresses:
- (etc)
search: []
ens19:
dhcp4: off
dhcp6: off
ens20:
dhcp4: off
dhcp6: off
```
By setting `dhcp4: off` and `dhcp6: off`, bringing them up but not assigning addresses is part of the normal boot cycle.
Make sure to replace (addr goes here) with your LibreQoS VM's address and subnet CIDR, and to replace `(gateway goes here)` with whatever your default gateway is.
Once everything is in place, run:
```shell
sudo netplan apply
```