Blame SOURCES/netavark.1

c42b43
.nh
c42b43
.TH netavark(1)
c42b43
.SH NAME
c42b43
.PP
c42b43
netavark - Configure a given network namespace for use by a container
c42b43
c42b43
.SH SYNOPSIS
c42b43
.PP
c42b43
\fBnetavark\fP [\fIoptions\fP] \fIcommand\fP \fInetwork namespace path\fP
c42b43
c42b43
.SH DESCRIPTION
c42b43
.PP
c42b43
Netavark configures a network namespace according to a configuration read from STDIN. The configuration is JSON formatted.
c42b43
c42b43
.SH GLOBAL OPTIONS
c42b43
.SS \fB--file\fP, \fB-f\fP
c42b43
.PP
c42b43
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.
c42b43
c42b43
.SH COMMANDS
c42b43
.SS netavark setup
c42b43
.PP
c42b43
The setup command configures the given network namespace with the given configuration, creating any interfaces and firewall rules necessary.
c42b43
c42b43
.SS netavark teardown
c42b43
.PP
c42b43
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).
c42b43
c42b43
.SS CONFIGURATION FORMAT
c42b43
.PP
c42b43
The configuration accepted is the same for both setup and teardown. It is JSON formatted.
c42b43
c42b43
.PP
c42b43
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)
c42b43
TODO: Transcribe configuration into here in a nice tabular format
c42b43
c42b43
.SH EXAMPLE
c42b43
.PP
c42b43
netavark setup /run/user/1000/podman/netns/d11d1f9c499d
c42b43
c42b43
.PP
c42b43
netavark -f /run/podman/828b0508ae64.conf teardown /run/podman/netns/828b0508ae64
c42b43
c42b43
.SH SEE ALSO
c42b43
.PP
c42b43
podman(1)
c42b43
c42b43
.SH HISTORY
c42b43
.PP
c42b43
September 2021, Originally compiled by Matt Heon mheon@redhat.com
c42b43
\[la]mailto:mheon@redhat.com\[ra]