Skip to content

Commit 7bcbd3c

Browse files
authored
Merge pull request #1376 from kernelkit/copilot/review-issue-947
Document VETH pair limitation with containers
2 parents f708f9b + 91374a1 commit 7bcbd3c

3 files changed

Lines changed: 16 additions & 2 deletions

File tree

doc/container.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -668,6 +668,12 @@ set:
668668

669669
For an example of both, see the next section.
670670

671+
> [!IMPORTANT]
672+
> **VETH Pair Limitation:** When using VETH pairs with containers, at least
673+
> one side of the pair must remain in the host namespace. It is currently
674+
> not possible to create VETH pairs where both ends are assigned to different
675+
> containers. One end must always be accessible from the host.
676+
671677
[^3]: Something which the container bridge network type does behind the
672678
scenes with one end of an automatically created VETH pair.
673679

src/confd/yang/confd/infix-if-container.yang

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,11 @@ submodule infix-if-container {
5959

6060
identity host {
6161
base container-network;
62-
description "Host device, e.g., one end of a VETH pair or other host interface.";
62+
description "Host device, e.g., one end of a VETH pair or other host interface.
63+
64+
Note: When using VETH pairs, at least one side must remain in the
65+
host namespace. Both ends of a VETH pair cannot be assigned to
66+
different containers.";
6367
}
6468

6569
/*

src/confd/yang/confd/infix-if-veth.yang

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ submodule infix-if-veth {
1313

1414
organization "KernelKit";
1515
contact "kernelkit@googlegroups.com";
16-
description "Linux virtual Ethernet pair extension for ietf-interfaces.";
16+
description "Linux virtual Ethernet pair extension for ietf-interfaces.
17+
18+
Note: When using VETH pairs with containers, at least one side
19+
of the pair must remain in the host namespace. Both ends of a
20+
VETH pair cannot be assigned to different containers.";
1721

1822
revision 2023-06-05 {
1923
description "Initial revision.";

0 commit comments

Comments
 (0)