Skip to contentSkip to conversation

user_mode_linux_howto_v2: add VDE vector support in doc

PATCH In review Renzo Davoli 2 participants 4 messages Jul 30, 2024 – Aug 9, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 2/2 user_mode_linux_howto_v2: add VDE vector support in doc

Add a description of the VDE vector transport in user_mode_linux_howto_v2.rst.

---
 .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)
Documentation/virt/uml/user_mode_linux_howto_v2.rst +37 -0
index 27942446f406..584000b743f3 100644
@@ -217,6 +217,8 @@ remote UML and other VM instances.
 +-----------+--------+------------------------------------+------------+
 | fd        | vector | dependent on fd type               | varies     |
 +-----------+--------+------------------------------------+------------+
+| vde       | vector | dep. on VDE VPN: Virt.Net Locator  | varies     |
++-----------+--------+------------------------------------+------------+
 | tuntap    | legacy | none                               | ~ 500Mbit  |
 +-----------+--------+------------------------------------+------------+
 | daemon    | legacy | none                               | ~ 450Mbit  |
@@ -573,6 +575,41 @@ https://github.com/NetSys/bess/wiki/Built-In-Modules-and-Ports
 
 BESS transport does not require any special privileges.
 
+VDE vector transport
+--------------------
+
+Virtual Distributed Ethernet (VDE) is a project whose main goal is to provide a
+highly flexible support for virtual networking.
+
+http://wiki.virtualsquare.org/#/tutorials/vdebasics
+
+Common usages of VDE include fast prototyping and teaching.
+
+Examples:
+
+   ``vecX:transport=vde,vnl=tap://tap0``
+
+use tap0
+
+   ``vecX:transport=vde,vnl=slirp://``
+
+use slirp
+
+   ``vec0:transport=vde,vnl=vde:///tmp/switch``
+
+connect to a vde switch
+
+   ``vecX:transport=\"vde,vnl=cmd://ssh remote.host //tmp/sshlirp\"``
+
+connect to a remote slirp (instant VPN: convert ssh to VPN, it uses sshlirp)
+https://github.com/virtualsquare/sshlirp
+
+   ``vec0:transport=vde,vnl=vxvde://234.0.0.1``
+
+connect to a local area cloud (all the UML nodes using the same
+multicast address running on hosts in the same multicast domain (LAN)
+will be automagically connected together to a virtual LAN.
+
 Configuring Legacy transports
 =============================
 
reviewer
#1 lore raw
Quoted 21 lines · Renzo Davoli

Add a description of the VDE vector transport in user_mode_linux_howto_v2.rst.

---
 .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)
Documentation/virt/uml/user_mode_linux_howto_v2.rst +2 -0
index 27942446f406..584000b743f3 100644
@@ -217,6 +217,8 @@ remote UML and other VM instances.
 +-----------+--------+------------------------------------+------------+
 | fd        | vector | dependent on fd type               | varies     |
 +-----------+--------+------------------------------------+------------+
+| vde       | vector | dep. on VDE VPN: Virt.Net Locator  | varies     |
++-----------+--------+------------------------------------+------------+
 | tuntap    | legacy | none                               | ~ 500Mbit  |
 +-----------+--------+------------------------------------+------------+
 | daemon    | legacy | none                               | ~ 450Mbit  |

Documentation/virt/uml/user_mode_linux_howto_v2.rst https://github.com/NetSys/bess/wiki/Built-In-Modules-and-Ports · line 581

Quoted 7 lines
Documentation/virt/uml/user_mode_linux_howto_v2.rst +4 -0
@@ -573,6 +575,41 @@ https://github.com/NetSys/bess/wiki/Built-In-Modules-and-Ports
 
 BESS transport does not require any special privileges.
 
+VDE vector transport
+--------------------
+
+Virtual Distributed Ethernet (VDE) is a project whose main goal is to provide a

is to provide

Quoted 20 lines
Documentation/virt/uml/user_mode_linux_howto_v2.rst +20 -0
+highly flexible support for virtual networking.
+
+http://wiki.virtualsquare.org/#/tutorials/vdebasics
+
+Common usages of VDE include fast prototyping and teaching.
+
+Examples:
+
+   ``vecX:transport=vde,vnl=tap://tap0``
+
+use tap0
+
+   ``vecX:transport=vde,vnl=slirp://``
+
+use slirp
+
+   ``vec0:transport=vde,vnl=vde:///tmp/switch``
+
+connect to a vde switch
+

Documentation/virt/uml/user_mode_linux_howto_v2.rst https://github.com/NetSys/bess/wiki/Built-In-Modules-and-Ports · line 611

Quoted 10 lines
Documentation/virt/uml/user_mode_linux_howto_v2.rst +10 -0
+   ``vecX:transport=\"vde,vnl=cmd://ssh remote.host //tmp/sshlirp\"``
+
+connect to a remote slirp (instant VPN: convert ssh to VPN, it uses sshlirp)
+https://github.com/virtualsquare/sshlirp
+
+   ``vec0:transport=vde,vnl=vxvde://234.0.0.1``
+
+connect to a local area cloud (all the UML nodes using the same
+multicast address running on hosts in the same multicast domain (LAN)
+will be automagically connected together to a virtual LAN.

Missing a close/right paren ')' somewhere. I suppose that you meant the typo "automagically".

Quoted 5 lines
Documentation/virt/uml/user_mode_linux_howto_v2.rst +1 -0
+
 Configuring Legacy transports
 =============================
 
Signature · 1 line
~Randy
#2 lore raw
Quoted 2 lines · Randy Dunlap

Missing a close/right paren ')' somewhere. I suppose that you meant the typo "automagically".

thank you Randy. I have fixed the typos in the emended patch here below.

Add a description of the VDE vector transport in user_mode_linux_howto_v2.rst.

---
 .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)
Documentation/virt/uml/user_mode_linux_howto_v2.rst +37 -0
index 27942446f406..32a90baf263b 100644
@@ -217,6 +217,8 @@ remote UML and other VM instances.
 +-----------+--------+------------------------------------+------------+
 | fd        | vector | dependent on fd type               | varies     |
 +-----------+--------+------------------------------------+------------+
+| vde       | vector | dep. on VDE VPN: Virt.Net Locator  | varies     |
++-----------+--------+------------------------------------+------------+
 | tuntap    | legacy | none                               | ~ 500Mbit  |
 +-----------+--------+------------------------------------+------------+
 | daemon    | legacy | none                               | ~ 450Mbit  |
@@ -573,6 +575,41 @@ https://github.com/NetSys/bess/wiki/Built-In-Modules-and-Ports
 
 BESS transport does not require any special privileges.
 
+VDE vector transport
+--------------------
+
+Virtual Distributed Ethernet (VDE) is a project whose main goal is to provide a
+highly flexible support for virtual networking.
+
+http://wiki.virtualsquare.org/#/tutorials/vdebasics
+
+Common usages of VDE include fast prototyping and teaching.
+
+Examples:
+
+   ``vecX:transport=vde,vnl=tap://tap0``
+
+use tap0
+
+   ``vecX:transport=vde,vnl=slirp://``
+
+use slirp
+
+   ``vec0:transport=vde,vnl=vde:///tmp/switch``
+
+connect to a vde switch
+
+   ``vecX:transport=\"vde,vnl=cmd://ssh remote.host //tmp/sshlirp\"``
+
+connect to a remote slirp (instant VPN: convert ssh to VPN, it uses sshlirp)
+https://github.com/virtualsquare/sshlirp
+
+   ``vec0:transport=vde,vnl=vxvde://234.0.0.1``
+
+connect to a local area cloud: all the UML nodes using the same
+multicast address running on hosts in the same multicast domain (LAN)
+will be automatically connected together to a virtual LAN.
+
 Configuring Legacy transports
 =============================
 
reviewer Acked-by
#3 lore raw
Quoted 9 lines · Renzo Davoli
Quoted 2 lines · Randy Dunlap

Missing a close/right paren ')' somewhere. I suppose that you meant the typo "automagically".

thank you Randy. I have fixed the typos in the emended patch here below.

Add a description of the VDE vector transport in user_mode_linux_howto_v2.rst.

LGTM. Thanks.

Quoted 59 lines
---
 .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)
Documentation/virt/uml/user_mode_linux_howto_v2.rst +37 -0
index 27942446f406..32a90baf263b 100644
@@ -217,6 +217,8 @@ remote UML and other VM instances.
 +-----------+--------+------------------------------------+------------+
 | fd        | vector | dependent on fd type               | varies     |
 +-----------+--------+------------------------------------+------------+
+| vde       | vector | dep. on VDE VPN: Virt.Net Locator  | varies     |
++-----------+--------+------------------------------------+------------+
 | tuntap    | legacy | none                               | ~ 500Mbit  |
 +-----------+--------+------------------------------------+------------+
 | daemon    | legacy | none                               | ~ 450Mbit  |
@@ -573,6 +575,41 @@ https://github.com/NetSys/bess/wiki/Built-In-Modules-and-Ports
 
 BESS transport does not require any special privileges.
 
+VDE vector transport
+--------------------
+
+Virtual Distributed Ethernet (VDE) is a project whose main goal is to provide a
+highly flexible support for virtual networking.
+
+http://wiki.virtualsquare.org/#/tutorials/vdebasics
+
+Common usages of VDE include fast prototyping and teaching.
+
+Examples:
+
+   ``vecX:transport=vde,vnl=tap://tap0``
+
+use tap0
+
+   ``vecX:transport=vde,vnl=slirp://``
+
+use slirp
+
+   ``vec0:transport=vde,vnl=vde:///tmp/switch``
+
+connect to a vde switch
+
+   ``vecX:transport=\"vde,vnl=cmd://ssh remote.host //tmp/sshlirp\"``
+
+connect to a remote slirp (instant VPN: convert ssh to VPN, it uses sshlirp)
+https://github.com/virtualsquare/sshlirp
+
+   ``vec0:transport=vde,vnl=vxvde://234.0.0.1``
+
+connect to a local area cloud: all the UML nodes using the same
+multicast address running on hosts in the same multicast domain (LAN)
+will be automatically connected together to a virtual LAN.
+
 Configuring Legacy transports
 =============================
 
Signature · 1 line
~Randy