diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/markdown/podman-network-connect.1.md | 34 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network-disconnect.1.md | 29 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network.1.md | 2 | ||||
| -rw-r--r-- | docs/source/network.rst | 4 |
4 files changed, 69 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-network-connect.1.md b/docs/source/markdown/podman-network-connect.1.md new file mode 100644 index 000000000..58b6e5c44 --- /dev/null +++ b/docs/source/markdown/podman-network-connect.1.md @@ -0,0 +1,34 @@ +% podman-network-connect(1) + +## NAME +podman\-network\-connect - Connect a container to a network + +## SYNOPSIS +**podman network connect** [*options*] network container + +## DESCRIPTION +Connects a container to a network. A container can be connected to a network by name or by ID. +Once connected, the container can communicate with other containers in the same network. + +## OPTIONS +#### **--alias** +Add network-scoped alias for the container. If the network is using the `dnsname` CNI plugin, these aliases +can be used for name resolution on the given network. Multiple *--alias* options may be specificed as input. + +## EXAMPLE + +Connect a container named *web* to a network named *test* +``` +podman network connect test web +``` + +Connect a container name *web* to a network named *test* with two aliases: web1 and web2 +``` +podman network connect --alias web1 --alias web2 test web +``` + +## SEE ALSO +podman(1), podman-network(1), podman-network-disconnect(1), podman-network-inspect(1) + +## HISTORY +November 2020, Originally compiled by Brent Baude <bbaude@redhat.com> diff --git a/docs/source/markdown/podman-network-disconnect.1.md b/docs/source/markdown/podman-network-disconnect.1.md new file mode 100644 index 000000000..95c7018a8 --- /dev/null +++ b/docs/source/markdown/podman-network-disconnect.1.md @@ -0,0 +1,29 @@ +% podman-network-disconnect(1) + +## NAME +podman\-network\-disconnect - Disconnect a container from a network + +## SYNOPSIS +**podman network disconnect** [*options*] network container + +## DESCRIPTION +Disconnects a container from a network. + +## OPTIONS +#### **--force**, **-f** + +Force the container to disconnect from a network + +## EXAMPLE +Disconnect a container named *web* from a network called *test*. + +``` +podman network disconnect test web +``` + + +## SEE ALSO +podman(1), podman-network(1), podman-network-connect(1) + +## HISTORY +November 2020, Originally compiled by Brent Baude <bbaude@redhat.com> diff --git a/docs/source/markdown/podman-network.1.md b/docs/source/markdown/podman-network.1.md index f05b2b78f..d21b200d9 100644 --- a/docs/source/markdown/podman-network.1.md +++ b/docs/source/markdown/podman-network.1.md @@ -13,7 +13,9 @@ The network command manages CNI networks for Podman. It is not supported for roo | Command | Man Page | Description | | ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- | +| connect | [podman-network-connect(1)](podman-network-connect.1.md)| Connect a container to a network| | create | [podman-network-create(1)](podman-network-create.1.md)| Create a Podman CNI network| +| disconnect | [podman-network-disconnect(1)](podman-network-disconnect.1.md)| Disconnect a container from a network| | 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 | diff --git a/docs/source/network.rst b/docs/source/network.rst index e7848c90e..0414c0880 100644 --- a/docs/source/network.rst +++ b/docs/source/network.rst @@ -1,8 +1,12 @@ Network ======= +:doc:`connect <markdown/podman-network-connect.1>` network connect + :doc:`create <markdown/podman-network-create.1>` network create +:doc:`disconnect <markdown/podman-network-disconnect.1>` network disconnect + :doc:`inspect <markdown/podman-network-inspect.1>` network inspect :doc:`ls <markdown/podman-network-ls.1>` network list |