summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-04-28 16:46:16 +0000
committerGerrit Code Review <review@openstack.org>2016-04-28 16:46:17 +0000
commitf1d14de6da5d0f61e34f9e6841e965439c85d629 (patch)
treee41ebeb6398b42afbb7c2821238f213ecbb56b6b /doc/source/command-objects
parent6bf60180a2968d93946fdc8b924cf4057f5713df (diff)
parentd0885e5d5a9f12a74bbf79623f1058f424939e4a (diff)
downloadpython-openstackclient-f1d14de6da5d0f61e34f9e6841e965439c85d629.tar.gz
Merge "Doc: Add network resource descriptions"
Diffstat (limited to 'doc/source/command-objects')
-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