Skip to content

Commit d0885e5

Browse files
committed
Doc: Add network resource descriptions
Add descriptions to the network resource command documentation. Change-Id: I547ffb48f8950311a5ee65d6b535846f2aca0efc
1 parent a0a29df commit d0885e5

8 files changed

Lines changed: 32 additions & 0 deletions

File tree

doc/source/command-objects/availability-zone.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
availability zone
33
=================
44

5+
An **availability zone** is a logical partition of cloud block storage,
6+
compute and network services.
7+
58
Block Storage v2, Compute v2, Network v2
69

710
availability zone list

doc/source/command-objects/network.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
network
33
=======
44

5+
A **network** is an isolated Layer 2 networking segment. There are two types
6+
of networks, project and provider networks. Project networks are fully isolated
7+
and are not shared with other projects. Provider networks map to existing
8+
physical networks in the data center and provide external network access for
9+
servers and other resources. Only an OpenStack administrator can create
10+
provider networks. Networks can be connected via routers.
11+
512
Compute v2, Network v2
613

714
network create

doc/source/command-objects/port.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
port
33
====
44

5+
A **port** is a connection point for attaching a single device, such as the
6+
NIC of a server, to a network. The port also describes the associated network
7+
configuration, such as the MAC and IP addresses to be used on that port.
8+
59
Network v2
610

711
port create

doc/source/command-objects/router.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
router
33
======
44

5+
A **router** is a logical component that forwards data packets between
6+
networks. It also provides Layer 3 and NAT forwarding to provide external
7+
network access for servers on project networks.
8+
59
Network v2
610

711
router add port

doc/source/command-objects/security-group-rule.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
security group rule
33
===================
44

5+
A **security group rule** specifies the network access rules for servers
6+
and other resources on the network.
7+
58
Compute v2, Network v2
69

710
security group rule create

doc/source/command-objects/security-group.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
security group
33
==============
44

5+
A **security group** acts as a virtual firewall for servers and other
6+
resources on a network. It is a container for security group rules
7+
which specify the network access rules.
8+
59
Compute v2, Network v2
610

711
security group create

doc/source/command-objects/subnet-pool.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
subnet pool
33
===========
44

5+
A **subnet pool** contains a collection of prefixes in CIDR notation
6+
that are available for IP address allocation.
7+
58
Network v2
69

710
subnet pool create

doc/source/command-objects/subnet.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
subnet
33
======
44

5+
A **subnet** is a block of IP addresses and associated configuration state.
6+
Subnets are used to allocate IP addresses when new ports are created on a
7+
network.
8+
59
Network v2
610

711
subnet create

0 commit comments

Comments
 (0)