Documentation ¶
Overview ¶
Package netns provides a utility function that allows a user to perform actions in a different network namespace
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Do ¶
Do takes a function which it will call in the network namespace specified by nsName. The goroutine that calls this will lock itself to its current OS thread, hop namespaces, call the given function, hop back to its original namespace, and then unlock itself from its current OS thread. Do returns an error if an error occurs at any point besides in the invocation of the given function, or if the given function itself returns an error.
The callback function is expected to do something simple such as just creating a socket / opening a connection, as it's not desirable to start complex logic in a goroutine that is pinned to the current OS thread. Also any goroutine started from the callback function may or may not execute in the desired namespace.
Example (HttpClient) ¶
package main import ( "net" "net/http" "time" "github.com/teachain/goarista/netns" ) func main() { vrf := "management" vrf = netns.VRFToNetNS(vrf) // vrf is now "ns-management" dial := func(network, address string) (net.Conn, error) { var conn net.Conn err := netns.Do(vrf, func() error { var err error conn, err = (&net.Dialer{ Timeout: 30 * time.Second, // This is the connection timeout KeepAlive: 30 * time.Second, }).Dial(network, address) return err }) return conn, err } client := &http.Client{ Transport: &http.Transport{ //TLSClientConfig: ..., <- if you need SSL/TLS. Dial: dial, }, Timeout: 30 * time.Second, // This is the request timeout } resp, err := client.Get("http://example.com") _ = resp _ = err }
Output:
func NewNSListener ¶
NewNSListener creates a new net.Listener bound to a network namespace. The listening socket will be bound to the specified local address and will have the specified tos.
func ParseAddress ¶
ParseAddress takes in an address string, parsing out the address and an optional VRF name. It returns the namespace corresponding to the VRF. The expected form is [<vrf-name>/]address:port. However, ParseAddress will not actually check to see if the VRF name or address are valid. Presumably, when those values are used later, they will fail if they are malformed
func VRFToNetNS ¶
VRFToNetNS converts a VRF name to network namespace's name corresponding to that VRF.