Merge pull request #3719 from baude/networklist

inclusion of podman network
This commit is contained in:
OpenShift Merge Robot
2019-08-16 17:33:31 +02:00
committed by GitHub
16 changed files with 745 additions and 0 deletions

View File

@ -0,0 +1,50 @@
% podman-network-inspect(1)
## NAME
podman\-network-inspect- Inspect one or more Podman networks
## SYNOPSIS
**podman network inspect** [*network* ...]
## DESCRIPTION
Display the raw (JSON format) network configuration. This command is not available for rootless users.
## EXAMPLE
Inspect the default podman network
```
# podman network inspect podman
[{
"cniVersion": "0.3.0",
"name": "podman",
"plugins": [
{
"type": "bridge",
"bridge": "cni0",
"isGateway": true,
"ipMasq": true,
"ipam": {
"type": "host-local",
"subnet": "10.88.1.0/24",
"routes": [
{ "dst": "0.0.0.0/0" }
]
}
},
{
"type": "portmap",
"capabilities": {
"portMappings": true
}
}
]
}
]
```
## SEE ALSO
podman(1), podman-network(1), podman-network-ls(1)
## HISTORY
August 2019, Originally compiled by Brent Baude <bbaude@redhat.com>

View File

@ -0,0 +1,43 @@
% podman-network-ls(1)
## NAME
podman\-network-ls- Display a summary of CNI networks
## SYNOPSIS
**podman network ls** [*options*]
## DESCRIPTION
Displays a list of existing podman networks. This command is not available for rootless users.
## OPTIONS
**--quiet**, **-q**
The `quiet` options will restrict the output to only the network names
## EXAMPLE
Display networks
```
# podman network ls
NAME VERSION PLUGINS
podman 0.3.0 bridge,portmap
podman2 0.3.0 bridge,portmap
outside 0.3.0 bridge
podman9 0.3.0 bridge,portmap
```
Display only network names
```
# podman network ls -q
podman
podman2
outside
podman9
```
## SEE ALSO
podman(1), podman-network(1), podman-network-inspect(1)
## HISTORY
August 2019, Originally compiled by Brent Baude <bbaude@redhat.com>

View File

@ -0,0 +1,25 @@
% podman-network-rm(1)
## NAME
podman\-network-rm- Delete a Podman CNI network
## SYNOPSIS
**podman network rm** [*network...*]
## DESCRIPTION
Delete one or more Podman networks.
## EXAMPLE
Delete the `podman9` network
```
# podman network rm podman
Deleted: podman9
```
## SEE ALSO
podman(1), podman-network(1), podman-network-inspect(1)
## HISTORY
August 2019, Originally compiled by Brent Baude <bbaude@redhat.com>

21
docs/podman-network.1.md Normal file
View File

@ -0,0 +1,21 @@
% podman-network(1)
## NAME
podman\-network- Manage podman CNI networks
## SYNOPSIS
**podman network** *subcommand*
## DESCRIPTION
The network command manages CNI networks for Podman. It is not supported for rootless users.
## COMMANDS
| Command | Man Page | Description |
| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
| inspect | [podman-network-inspect(1)](podman-network-inspect.1.md)| Displays the raw CNI network configuration for one or more networks|
| ls | [podman-network-ls(1)](podman-network-ls.1.md)| Display a summary of CNI networks |
| rm | [podman-network-rm(1)](podman-network-rm.1.md)| Remove one or more CNI networks |
## SEE ALSO
podman(1)

View File

@ -161,6 +161,7 @@ the exit codes follow the `chroot` standard, see below:
| [podman-logout(1)](podman-logout.1.md) | Logout of a container registry. |
| [podman-logs(1)](podman-logs.1.md) | Display the logs of a container. |
| [podman-mount(1)](podman-mount.1.md) | Mount a working container's root filesystem. |
| [podman-network(1)](podman-network.1.md) | Manage Podman CNI networks. |
| [podman-pause(1)](podman-pause.1.md) | Pause one or more containers. |
| [podman-play(1)](podman-play.1.md) | Play pods and containers based on a structured input file. |
| [podman-pod(1)](podman-pod.1.md) | Management tool for groups of containers, called pods. |