diff mbox series

[2/2] user_mode_linux_howto_v2: add VDE vector support in doc

Message ID ZqjwuBOlysJl8kn_@cs.unibo.it
State Accepted
Headers show
Series [1/2] vector_user: add VDE support | expand

Commit Message

Renzo Davoli July 30, 2024, 1:55 p.m. UTC
Add a description of the VDE vector transport in user_mode_linux_howto_v2.rst.

Signed-off-by: Renzo Davoli <renzo@cs.unibo.it>
---
 .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)

Comments

Randy Dunlap July 30, 2024, 2:18 p.m. UTC | #1
On 7/30/24 6:55 AM, Renzo Davoli wrote:
> Add a description of the VDE vector transport in user_mode_linux_howto_v2.rst.
> 
> Signed-off-by: Renzo Davoli <renzo@cs.unibo.it>
> ---
>  .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
> 
> diff --git a/Documentation/virt/uml/user_mode_linux_howto_v2.rst b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> index 27942446f406..584000b743f3 100644
> --- a/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> +++ b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> @@ -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

                                                                   is to provide

> +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.

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

> +
>  Configuring Legacy transports
>  =============================
>  
>
Renzo Davoli Aug. 9, 2024, 1:11 p.m. UTC | #2
On Tue, Jul 30, 2024 at 07:18:04AM -0700, Randy Dunlap wrote:
> 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.

Signed-off-by: Renzo Davoi <renzo@cs.unibo.it>
---
 .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/Documentation/virt/uml/user_mode_linux_howto_v2.rst b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
index 27942446f406..32a90baf263b 100644
--- a/Documentation/virt/uml/user_mode_linux_howto_v2.rst
+++ b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
@@ -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
 =============================
Randy Dunlap Aug. 9, 2024, 2:27 p.m. UTC | #3
On 8/9/24 6:11 AM, Renzo Davoli wrote:
> On Tue, Jul 30, 2024 at 07:18:04AM -0700, Randy Dunlap wrote:
>> 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.
> 
> Signed-off-by: Renzo Davoi <renzo@cs.unibo.it>

LGTM. Thanks.

Acked-by: Randy Dunlap <rdunlap@infradead.org>


> ---
>  .../virt/uml/user_mode_linux_howto_v2.rst          | 37 ++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
> 
> diff --git a/Documentation/virt/uml/user_mode_linux_howto_v2.rst b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> index 27942446f406..32a90baf263b 100644
> --- a/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> +++ b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
> @@ -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
>  =============================
>
diff mbox series

Patch

diff --git a/Documentation/virt/uml/user_mode_linux_howto_v2.rst b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
index 27942446f406..584000b743f3 100644
--- a/Documentation/virt/uml/user_mode_linux_howto_v2.rst
+++ b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
@@ -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
 =============================