summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-09-09 19:44:57 +0200
committerGitHub <noreply@github.com>2019-09-09 19:44:57 +0200
commit7042a3d7a539bae79ed63bdc87f432b8ec73afd8 (patch)
tree6f229373f5e436663c8908d0f2409fdbac2f6a2a /docs
parent511b0717454e0619d9d7d201cb10a41201cebef2 (diff)
parentee432cf2792c5dbe81953007f1fd5c87beb3ebd5 (diff)
downloadpodman-7042a3d7a539bae79ed63bdc87f432b8ec73afd8.tar.gz
podman-7042a3d7a539bae79ed63bdc87f432b8ec73afd8.tar.bz2
podman-7042a3d7a539bae79ed63bdc87f432b8ec73afd8.zip
Merge pull request #3862 from baude/networkcreate
podman network create
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-network-create.1.md70
-rw-r--r--docs/podman-network-ls.1.md2
-rw-r--r--docs/podman-network.1.md1
3 files changed, 72 insertions, 1 deletions
diff --git a/docs/podman-network-create.1.md b/docs/podman-network-create.1.md
new file mode 100644
index 000000000..0679d8ee2
--- /dev/null
+++ b/docs/podman-network-create.1.md
@@ -0,0 +1,70 @@
+% podman-network-create(1)
+
+## NAME
+podman\-network-create - Create a Podman CNI network
+
+## SYNOPSIS
+**podman network create** [*options*] name
+
+## DESCRIPTION
+Create a CNI-network configuration for use with Podman. At the time of this writing, the only network
+type that can be created is a *bridge* network.
+
+If no options are provided, Podman will assign a free subnet and name for your network.
+
+Upon completion of creating the network, Podman will display the path to the newly added network file.
+
+## OPTIONS
+**-d**, , **--driver**
+
+Driver to manage the network (default "bridge"). Currently on `bridge` is supported.
+
+**--gateway**
+
+Define a gateway for the subnet. If you want to provide a gateway address, you must also provide a
+*subnet* option.
+
+**--internal**
+
+Restrict external access of this network
+
+**--ip-range**
+
+Allocate container IP from a range. The range must be a complete subnet and in CIDR notation. The *ip-range* option
+must be used with a *subnet* option.
+
+**--subnet**
+
+The subnet in CIDR notation.
+
+## EXAMPLE
+
+Create a network with no options
+```
+# podman network create
+/etc/cni/net.d/cni-podman-4.conflist
+```
+
+Create a network named *newnet* that uses *192.5.0.0/16* for its subnet.
+```
+# podman network create --subnet 192.5.0.0/16 newnet
+/etc/cni/net.d/newnet.conflist
+```
+
+Create a network named *newnet* that uses *192.168.33.0/24* and defines a gateway as *192.168.133.3*
+```
+# podman network create --subnet 192.168.33.0/24 --gateway 192.168.33.3 newnet
+/etc/cni/net.d/newnet.conflist
+```
+
+Create a network that uses a *192.168.55.0/24** subnet and has an IP address range of *192.168.55.129 - 192.168.55.254*.
+```
+# podman network create --subnet 192.168.55.0/24 --ip-range 192.168.55.128/25
+/etc/cni/net.d/cni-podman-5.conflist
+```
+
+## SEE ALSO
+podman(1), podman-network(1), podman-network-inspect(1)
+
+## HISTORY
+August 2019, Originally compiled by Brent Baude <bbaude@redhat.com>
diff --git a/docs/podman-network-ls.1.md b/docs/podman-network-ls.1.md
index 658b86c21..46e424593 100644
--- a/docs/podman-network-ls.1.md
+++ b/docs/podman-network-ls.1.md
@@ -12,7 +12,7 @@ Displays a list of existing podman networks. This command is not available for r
## OPTIONS
**--quiet**, **-q**
-The `quiet` options will restrict the output to only the network names
+The `quiet` option will restrict the output to only the network names
## EXAMPLE
diff --git a/docs/podman-network.1.md b/docs/podman-network.1.md
index c9f6725a3..f05b2b78f 100644
--- a/docs/podman-network.1.md
+++ b/docs/podman-network.1.md
@@ -13,6 +13,7 @@ The network command manages CNI networks for Podman. It is not supported for roo
| Command | Man Page | Description |
| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
+| create | [podman-network-create(1)](podman-network-create.1.md)| Create a Podman CNI 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 |