Blame SOURCES/netavark.1

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