summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorRichard Theis <rtheis@us.ibm.com>2016-04-24 19:17:36 -0500
committerRichard Theis <rtheis@us.ibm.com>2016-04-25 06:46:12 -0500
commitd0885e5d5a9f12a74bbf79623f1058f424939e4a (patch)
tree817f1a24989e5703441e58535e15a7ad6709f42b /doc/source
parenta0a29df3e67b29880e62e1974dde18a4993f2aa1 (diff)
downloadpython-openstackclient-d0885e5d5a9f12a74bbf79623f1058f424939e4a.tar.gz
Doc: Add network resource descriptions
Add descriptions to the network resource command documentation. Change-Id: I547ffb48f8950311a5ee65d6b535846f2aca0efc
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/availability-zone.rst3
-rw-r--r--doc/source/command-objects/network.rst7
-rw-r--r--doc/source/command-objects/port.rst4
-rw-r--r--doc/source/command-objects/router.rst4
-rw-r--r--doc/source/command-objects/security-group-rule.rst3
-rw-r--r--doc/source/command-objects/security-group.rst4
-rw-r--r--doc/source/command-objects/subnet-pool.rst3
-rw-r--r--doc/source/command-objects/subnet.rst4
8 files changed, 32 insertions, 0 deletions
diff --git a/doc/source/command-objects/availability-zone.rst b/doc/source/command-objects/availability-zone.rst
index 1f568438..149e1081 100644
--- a/doc/source/command-objects/availability-zone.rst
+++ b/doc/source/command-objects/availability-zone.rst
@@ -2,6 +2,9 @@
availability zone
=================
+An **availability zone** is a logical partition of cloud block storage,
+compute and network services.
+
Block Storage v2, Compute v2, Network v2
availability zone list
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst
index 5d534c59..91eb2b08 100644
--- a/doc/source/command-objects/network.rst
+++ b/doc/source/command-objects/network.rst
@@ -2,6 +2,13 @@
network
=======
+A **network** is an isolated Layer 2 networking segment. There are two types
+of networks, project and provider networks. Project networks are fully isolated
+and are not shared with other projects. Provider networks map to existing
+physical networks in the data center and provide external network access for
+servers and other resources. Only an OpenStack administrator can create
+provider networks. Networks can be connected via routers.
+
Compute v2, Network v2
network create
diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst
index 36e83082..e4cf2cd2 100644
--- a/doc/source/command-objects/port.rst
+++ b/doc/source/command-objects/port.rst
@@ -2,6 +2,10 @@
port
====
+A **port** is a connection point for attaching a single device, such as the
+NIC of a server, to a network. The port also describes the associated network
+configuration, such as the MAC and IP addresses to be used on that port.
+
Network v2
port create
diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst
index 1503516e..1bb9341e 100644
--- a/doc/source/command-objects/router.rst
+++ b/doc/source/command-objects/router.rst
@@ -2,6 +2,10 @@
router
======
+A **router** is a logical component that forwards data packets between
+networks. It also provides Layer 3 and NAT forwarding to provide external
+network access for servers on project networks.
+
Network v2
router add port
diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst
index 8218c81a..b0ac3c94 100644
--- a/doc/source/command-objects/security-group-rule.rst
+++ b/doc/source/command-objects/security-group-rule.rst
@@ -2,6 +2,9 @@
security group rule
===================
+A **security group rule** specifies the network access rules for servers
+and other resources on the network.
+
Compute v2, Network v2
security group rule create
diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst
index 2c6e7a8a..3af11b5a 100644
--- a/doc/source/command-objects/security-group.rst
+++ b/doc/source/command-objects/security-group.rst
@@ -2,6 +2,10 @@
security group
==============
+A **security group** acts as a virtual firewall for servers and other
+resources on a network. It is a container for security group rules
+which specify the network access rules.
+
Compute v2, Network v2
security group create
diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst
index 867153ef..6edbe8e8 100644
--- a/doc/source/command-objects/subnet-pool.rst
+++ b/doc/source/command-objects/subnet-pool.rst
@@ -2,6 +2,9 @@
subnet pool
===========
+A **subnet pool** contains a collection of prefixes in CIDR notation
+that are available for IP address allocation.
+
Network v2
subnet pool create
diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst
index 35134f46..8daa251f 100644
--- a/doc/source/command-objects/subnet.rst
+++ b/doc/source/command-objects/subnet.rst
@@ -2,6 +2,10 @@
subnet
======
+A **subnet** is a block of IP addresses and associated configuration state.
+Subnets are used to allocate IP addresses when new ports are created on a
+network.
+
Network v2
subnet create