ffa9f7
.nh
ffa9f7
.TH netavark(1)
ffa9f7
.SH NAME
ffa9f7
.PP
ffa9f7
netavark - Configure a given network namespace for use by a container
ffa9f7
ffa9f7
.SH SYNOPSIS
ffa9f7
.PP
ffa9f7
\fBnetavark\fP [\fIoptions\fP] \fIcommand\fP \fInetwork namespace path\fP
ffa9f7
ffa9f7
.SH DESCRIPTION
ffa9f7
.PP
ffa9f7
Netavark configures a network namespace according to a configuration read from STDIN. The configuration is JSON formatted.
ffa9f7
ffa9f7
.SH GLOBAL OPTIONS
ffa9f7
.SS \fB--file\fP, \fB-f\fP
ffa9f7
.PP
ffa9f7
Instead of reading from STDIN, read the configuration to be applied from the given file. \fB-f -\fP may also be used to flag reading from STDIN.
ffa9f7
ffa9f7
.SH COMMANDS
ffa9f7
.SS netavark setup
ffa9f7
.PP
ffa9f7
The setup command configures the given network namespace with the given configuration, creating any interfaces and firewall rules necessary.
ffa9f7
ffa9f7
.SS netavark teardown
ffa9f7
.PP
ffa9f7
The teardown command is the inverse of the setup command, undoing any configuration applied. Some interfaces may not be deleted (bridge interfaces, for example, will not be removed).
ffa9f7
ffa9f7
.SS CONFIGURATION FORMAT
ffa9f7
.PP
ffa9f7
The configuration accepted is the same for both setup and teardown. It is JSON formatted.
ffa9f7
ffa9f7
.PP
ffa9f7
Format is https://github.com/containers/podman/blob/cd7b48198c38c5028540e85dc72dd3406f4318f0/libpod/network/types/network.go#L164-L173 but we will also send a Networks array including all the network definitions (https://github.com/containers/podman/blob/cd7b48198c38c5028540e85dc72dd3406f4318f0/libpod/network/types/network.go#L32-L62)
ffa9f7
TODO: Transcribe configuration into here in a nice tabular format
ffa9f7
ffa9f7
.SH EXAMPLE
ffa9f7
.PP
ffa9f7
netavark setup /run/user/1000/podman/netns/d11d1f9c499d
ffa9f7
ffa9f7
.PP
ffa9f7
netavark -f /run/podman/828b0508ae64.conf teardown /run/podman/netns/828b0508ae64
ffa9f7
ffa9f7
.SH SEE ALSO
ffa9f7
.PP
ffa9f7
podman(1)
ffa9f7
ffa9f7
.SH HISTORY
ffa9f7
.PP
ffa9f7
September 2021, Originally compiled by Matt Heon mheon@redhat.com
ffa9f7
\[la]mailto:mheon@redhat.com\[ra]