Blame SOURCES/netavark.1

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