diff --git a/doc/lxc-user-nic.sgml.in b/doc/lxc-user-nic.sgml.in index ac8af64e8..18e9b22cc 100644 --- a/doc/lxc-user-nic.sgml.in +++ b/doc/lxc-user-nic.sgml.in @@ -42,17 +42,31 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA lxc-user-nic - Create and attach a nic to another network namespace. + Manage nics in another network namespace lxc-user-nic + create + lxcpath + name pid type bridge - nicname + container nicname + + + + lxc-user-nic + delete + lxcpath + name + path to network namespace + type + bridge + container nicname @@ -61,7 +75,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA lxc-user-nic is a setuid-root program with which - unprivileged users may create network interfaces for use by a lxc container. + unprivileged users may manage network interfaces for use by a + lxc container. It will consult the configuration file @LXC_USERNIC_CONF@ @@ -71,6 +86,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA @LXC_USERNIC_DB@. It ensures that the calling user is privileged over the network namespace to which the interface will be attached. + lxc-user-nic also allows to delete network devices. + Currently only ovs ports can be deleted. @@ -80,6 +97,27 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Options + + + + + + + The path of the container. This is currently not used. + + + + + + + + + + + The name of the container. This is currently not used. + + + @@ -99,7 +137,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - The network interface type to attach. Currently only veth is + The network interface type to attach. Currently only veth is supported. With this type, two interfaces representing each tunnel endpoint are created. One endpoint will be attached to the specified bridge, while the other will be passed into @@ -122,16 +160,29 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - + - The desired interface name in the container. This will be + The desired interface name in the container. This will be eth0 if unspecified. + + + + + + + A path to open to get a file descriptor for the target + network namespace. + This is only relevant when an veth device is deleted. + + + + @@ -159,6 +210,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Author + Christian Brauner christian@brauner.io + Serge Hallyn serge@hallyn.com Daniel Lezcano daniel.lezcano@free.fr