starlingx/docs
Code Issues Proposed changes

Host interface config guide: Minor edits for grammar

Browse Source 
Minor edits for consistency with other docs and improved readability.

Change-Id: Id033a1db1543961097d967ac96be7f26faf41187
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2019-12-11 10:21:44 -08:00
parent 6dcae7d18f
commit 3f4a84a6d6
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/configuration/host_interface_network_config.rst
View File

@ -18,7 +18,7 @@ Host Interface and Network Configuration
Interface class configuration Interface class configuration
----------------------------- -----------------------------
The interface class that the logical network interface is connected to. Valid The interface class to which the logical network interface is connected. Valid
classes are: classes are:
``platform`` ``platform``
@ -39,7 +39,7 @@ classes are:
configuration (dual use). configuration (dual use).
``pci-passthrough`` ``pci-passthrough``
For a PCI pass through interface or for an interface that can be used in For a PCI passthrough interface or for an interface that can be used in
either configuration (dual use). either configuration (dual use).
----------------------- -----------------------
@ -181,7 +181,7 @@ The OAM network is required for external control and board management access. It
can be used for container payload external connectivity, depending on can be used for container payload external connectivity, depending on
container payload application network requirements. container payload application network requirements.
To assign an interface to a platform network: Assign an interface to a platform network with the command:
:: ::
@ -196,7 +196,7 @@ Replace parameters with values suitable to your installation. Parameters are:
A name for the interface. A name for the interface.
``NETWORK`` ``NETWORK``
The name or ID of the platform network to assign the interface to. The name or ID of the platform network to which the interface will be assigned.
************* *************
Data networks Data networks
@ -211,7 +211,7 @@ support the application networks. Multiple data networks may be configured as
required and realized over the same or different physical networks. Access to required and realized over the same or different physical networks. Access to
external networks is typically (although not always) granted to worker nodes external networks is typically (although not always) granted to worker nodes
using a data network. The extent of this connectivity, including access to the using a data network. The extent of this connectivity, including access to the
open Internet, is application dependent. open Internet, is application-dependent.
Data networks are created by the administrator to make use of an underlying set Data networks are created by the administrator to make use of an underlying set
of resources on a physical network. of resources on a physical network.
@ -228,13 +228,13 @@ Three types of data networks may be implemented in StarlingX:
networks connected by Layer 3 routers, using a VNI identifier. This allows networks connected by Layer 3 routers, using a VNI identifier. This allows
multiple data networks over physically separated Layer 2 networks. multiple data networks over physically separated Layer 2 networks.
To list the names of the data networks: List the names of the data networks with the command:
:: ::
system datanetwork-list system datanetwork-list
To view details of a data network: View details of a data network with the command:
:: ::
@ -245,7 +245,7 @@ Replace parameters with values suitable to your installation. Parameters are:
``DATA_NETWORK`` ``DATA_NETWORK``
The name or UUID of the data network. The name or UUID of the data network.
To add a data network: Add a data network with the command:
:: ::
@ -279,7 +279,7 @@ Replace parameters with values suitable to your installation. Parameters are:
``TYPE`` ``TYPE``
The type of data network to be created (flat, vlan, or vxlan). The type of data network to be created (flat, vlan, or vxlan).
To assign an interface to a data network: Assign an interface to a data network with the command:
:: ::
@ -294,5 +294,5 @@ Replace parameters with values suitable to your installation. Parameters are:
A name for the interface. A name for the interface.
``DATA_NETWORK`` ``DATA_NETWORK``
The name or ID of the data network to assign the interface to. The name or ID of the data network to which the interface will be assigned.