ITQC/containernetworking-plugins
24
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 34 Wiki Activity

pkg/ip: improve docstring for SetupVeth

Browse Source
This commit is contained in:
Gabe Rosenhouse 2017-03-13 11:27:12 -07:00
parent 71d96ea91c
commit bb322572eb
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ip/link.go
View File

@ -109,9 +109,10 @@ func ifaceFromNetlinkLink(l netlink.Link) net.Interface {
} }
} }
// SetupVeth sets up a virtual ethernet link. // SetupVeth sets up a pair of virtual ethernet devices.
// Should be in container netns, and will switch back to hostNS to set the host // Call SetupVeth from inside the container netns. It will create both veth
// veth end up. // devices and move the host-side veth into the provided hostNS namespace.
// On success, SetupVeth returns (hostVeth, containerVeth, nil)
func SetupVeth(contVethName string, mtu int, hostNS ns.NetNS) (net.Interface, net.Interface, error) { func SetupVeth(contVethName string, mtu int, hostNS ns.NetNS) (net.Interface, net.Interface, error) {
hostVethName, contVeth, err := makeVeth(contVethName, mtu) hostVethName, contVeth, err := makeVeth(contVethName, mtu)
if err != nil { if err != nil {