starlingx/docs
Code Issues Proposed changes

Merge "Datanet reorg"

Browse Source
This commit is contained in:
Zuul 2021-04-06 16:23:03 +00:00 committed by Gerrit Code Review
commit d22daf9b11
28 changed files with 525 additions and 510 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/_includes/dynamic-vxlan.rest
View File

@ -0,0 +1,2 @@
vswitch-text-1-begin
vswitch-text-1-end

15
doc/source/datanet/index.rs1
View File

@ -1,15 +0,0 @@
===================================
|prod-long| Data Network Management
===================================
- :ref:`Data Networks <data-network-management-data-networks>`
- Displaying Data Network Information
- :ref:`Displaying Data Network Information Using Horizon <displaying-data-network-information-using-horizon>`
- :ref:`Displaying Data Network Information Using the CLI <displaying-data-network-information-using-the-cli>`
- :ref:`The Data Network Topology View <the-data-network-topology-view>`
- :ref:`Adding Data Networks Using the CLI <adding-data-networks-using-the-cli>`
- :ref:`Assigning a Data Network to an Interface <assigning-a-data-network-to-an-interface>`
- :ref:`Removing a Data Network Using the CLI <removing-a-data-network-using-the-cli>`

103
doc/source/datanet/index.rst
View File

@ -1,7 +1,6 @@
.. Data networks file, created by ..
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
You can adapt this file completely to your liking, but it should at least .. _datanet_index:
contain the root `toctree` directive.
============= =============
Data Networks Data Networks
@ -11,93 +10,23 @@ Data Networks
Kubernetes Kubernetes
---------- ----------
.. toctree:: |prod-long| data network management allows you to model the L2 networks that
:maxdepth: 1 are attached to node data, pci-sriov and pci-passthrough interfaces.
data-network-management-data-networks
***********************************
Displaying data network information
***********************************
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
displaying-data-network-information-using-horizon kubernetes/index
displaying-data-network-information-using-the-cli
the-data-network-topology-view
vxlan-data-networks
*********************************************
Adding, assigning, and removing data networks ---------
********************************************* OpenStack
---------
Data networks are used to model the L2 Networks that nodes' data, pci-sriov
and pci-passthrough interfaces attach to.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
adding-data-networks-using-the-cli openstack/index
assigning-a-data-network-to-an-interface
removing-a-data-network-using-the-cli
-------------------
StarlingX OpenStack
-------------------
.. toctree::
:maxdepth: 1
data-networks-overview
*******************
VXLAN data networks
*******************
.. toctree::
:maxdepth: 1
dynamic-vxlan
static-vxlan
differences-between-dynamic-and-static-vxlan-modes
**************************
Adding segmentation ranges
**************************
.. toctree::
:maxdepth: 1
adding-segmentation-ranges-using-the-cli
************************************
Data network interface configuration
************************************
.. toctree::
:maxdepth: 1
configuring-data-interfaces
configuring-data-interfaces-for-vxlans
******************************
MTU values of a data interface
******************************
.. toctree::
:maxdepth: 1
changing-the-mtu-of-a-data-interface-using-the-cli
changing-the-mtu-of-a-data-interface
***********************************
VXLAN data network setup completion
***********************************
.. toctree::
:maxdepth: 1
adding-a-static-ip-address-to-a-data-interface
managing-data-interface-static-ip-addresses-using-the-cli
using-ip-address-pools-for-data-interfaces
managing-ip-address-pools-using-the-cli
adding-and-maintaining-routes-for-a-vxlan-network
vxlan-data-network-setup-completion

192
doc/source/datanet/adding-data-networks-using-the-cli.rst → doc/source/datanet/kubernetes/adding-data-networks-using-the-cli.rst
View File

@ -1,97 +1,97 @@
.. oiq1559818630326 .. oiq1559818630326
.. _adding-data-networks-using-the-cli: .. _adding-data-networks-using-the-cli:
=============================== ===============================
Add Data Networks Using the CLI Add Data Networks Using the CLI
=============================== ===============================
If you prefer, you can add data networks using the CLI. You can set up flat, If you prefer, you can add data networks using the CLI. You can set up flat,
VLAN and VXLAN data networks over physical networks using the **controller-0** VLAN and VXLAN data networks over physical networks using the **controller-0**
command-line interface. The data networks provide connectivity for project command-line interface. The data networks provide connectivity for project
networks. networks.
.. rubric:: |prereq| .. rubric:: |prereq|
.. _adding-data-networks-using-the-cli-prereq-controller-0-ready: .. _adding-data-networks-using-the-cli-prereq-controller-0-ready:
Controller-0 must be installed and configured. Controller-0 must be installed and configured.
.. rubric:: |proc| .. rubric:: |proc|
.. _adding-data-networks-using-the-cli-steps-ek5-4fs-hkb: .. _adding-data-networks-using-the-cli-steps-ek5-4fs-hkb:
- To create a data network using the CLI, use the following command. - To create a data network using the CLI, use the following command.
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system datanetwork-add -d <description> -m <mtu> -p <port> -g <group> -t <ttl> -M <mode> <name> <type> ~(keystone_admin)$ system datanetwork-add -d <description> -m <mtu> -p <port> -g <group> -t <ttl> -M <mode> <name> <type>
where where
**<description>** **<description>**
A description of the data network. A description of the data network.
**<mtu>** **<mtu>**
The MTU of the data network. The MTU of the data network.
.. note:: .. note::
To attach to the data network, data interfaces must be configured To attach to the data network, data interfaces must be configured
with an equal or larger MTU. with an equal or larger MTU.
**<port>** **<port>**
The port of the data network. The port of the data network.
**<group>** **<group>**
The multicast group of the data network. The multicast group of the data network.
**<ttl>** **<ttl>**
The time-to-live of the data network. The time-to-live of the data network.
**<mode>** **<mode>**
For networks of <type> vxlan only, mode can be either **dynamic** or For networks of <type> vxlan only, mode can be either **dynamic** or
**static**. **static**.
If set to **dynamic**, <group> must also be specified. If set to **dynamic**, <group> must also be specified.
**<name>** **<name>**
The name assigned to the data network. The name assigned to the data network.
**<type>** **<type>**
The type of data network to be created \(**flat**, **vlan**, or The type of data network to be created \(**flat**, **vlan**, or
**vxlan**\) **vxlan**\)
.. note:: .. note::
**vxlan** is only applicable to |prod-os|. **vxlan** is only applicable to |prod-os|.
For example, to add a VLAN data network named datanet-a: For example, to add a VLAN data network named datanet-a:
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system datanetwork-add datanet-a vlan ~(keystone_admin)$ system datanetwork-add datanet-a vlan
+--------------+--------------------------------------+ +--------------+--------------------------------------+
| Property | Value | | Property | Value |
+--------------+--------------------------------------+ +--------------+--------------------------------------+
| id | 2 | | id | 2 |
| uuid | 104071a4-1c26-4383-ba07-72e05316d540 | | uuid | 104071a4-1c26-4383-ba07-72e05316d540 |
| name | datanet-a | | name | datanet-a |
| network_type | vlan | | network_type | vlan |
| mtu | 1500 | | mtu | 1500 |
| description | None | | description | None |
+--------------+--------------------------------------+ +--------------+--------------------------------------+
You must configure at least one data network in order to assign data You must configure at least one data network in order to assign data
interfaces to worker nodes and unlock the hosts. interfaces to worker nodes and unlock the hosts.
.. rubric:: |postreq| .. rubric:: |postreq|
For the |prod-os| application, after creating a data network of the VLAN or For the |prod-os| application, after creating a data network of the VLAN or
VXLAN type, you can assign one or more segmentation ranges consisting of a set VXLAN type, you can assign one or more segmentation ranges consisting of a set
of consecutive VLAN IDs \(for VLANs\) or VNIs \(for VXLANs\) using the of consecutive VLAN IDs \(for VLANs\) or VNIs \(for VXLANs\) using the
:command:`openstack network segment range create` command. Segmentation ranges :command:`openstack network segment range create` command. Segmentation ranges
are required in order to set up project networks. are required in order to set up project networks.
.. note:: .. note::
Segmentation ranges are not required in order to attach interfaces and Segmentation ranges are not required in order to attach interfaces and
unlock openstack-compute labeled worker nodes. unlock openstack-compute labeled worker nodes.

30
doc/source/datanet/assigning-a-data-network-to-an-interface.rst → doc/source/datanet/kubernetes/assigning-a-data-network-to-an-interface.rst
View File

@ -1,16 +1,16 @@
.. riw1559818822179 .. riw1559818822179
.. _assigning-a-data-network-to-an-interface: .. _assigning-a-data-network-to-an-interface:
===================================== =====================================
Assign a Data Network to an Interface Assign a Data Network to an Interface
===================================== =====================================
In order to associate the L2 Network definition of a Data Network with a In order to associate the L2 Network definition of a Data Network with a
physical network, the Data Network must be mapped to an Ethernet or Aggregated physical network, the Data Network must be mapped to an Ethernet or Aggregated
Ethernet interface on a compute node. Ethernet interface on a compute node.
The command for performing the mapping has the format: The command for performing the mapping has the format:
:command:`system interface‐datanetwork‐assign` <compute> <interface\_uuid> :command:`system interface‐datanetwork‐assign` <compute> <interface\_uuid>
<datanetwork\_uuid> <datanetwork\_uuid>

104
doc/source/datanet/data-network-management-data-networks.rst → doc/source/datanet/kubernetes/data-network-management-data-networks.rst
View File

@ -1,53 +1,53 @@
.. jjl1559817878161 .. jjl1559817878161
.. _data-network-management-data-networks: .. _data-network-management-data-networks:
=========================== ===========================
Data Networks in Kubernetes Data Networks in Kubernetes
=========================== ===========================
|prod-long| data network management allows you to model the L2 networks that |prod-long| data network management allows you to model the L2 networks that
are attached to node data, pci-sriov and pci-passthrough interfaces. are attached to node data, pci-sriov and pci-passthrough interfaces.
A data network represents a Layer 2 physical or virtual network, or set of A data network represents a Layer 2 physical or virtual network, or set of
virtual networks, used to provide the underlying network connectivity needed virtual networks, used to provide the underlying network connectivity needed
to support the application networks. Multiple data networks may be configured to support the application networks. Multiple data networks may be configured
as required, and realized over the same or different physical networks. Access as required, and realized over the same or different physical networks. Access
to external networks is typically \(although not necessarily\) granted to to external networks is typically \(although not necessarily\) granted to
worker nodes using a data network. The extent of this connectivity, including worker nodes using a data network. The extent of this connectivity, including
access to the open internet, is application dependent. access to the open internet, is application dependent.
Data networks are required for |prod-os| deployments and for the base Data networks are required for |prod-os| deployments and for the base
|prod-long| if you wish to deploy container applications with SR-IOV devices. |prod-long| if you wish to deploy container applications with SR-IOV devices.
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. The following types of data networks can be of resources on a physical network. The following types of data networks can be
created: created:
**flat** **flat**
A data network mapped entirely over the physical network. A data network mapped entirely over the physical network.
**VLAN** **VLAN**
A data network implemented on a physical network using a VLAN identifier. A data network implemented on a physical network using a VLAN identifier.
This allows multiple data networks over the same physical network. This allows multiple data networks over the same physical network.
**VXLAN** **VXLAN**
.. note:: .. note::
This data interface is ONLY applicable to the |prod-os| application. This data interface is ONLY applicable to the |prod-os| application.
Static VXLAN is limited to one data network, and if configured, it must Static VXLAN is limited to one data network, and if configured, it must
be enabled on all openstack-compute labeled nodes. be enabled on all openstack-compute labeled nodes.
A data network implemented across non-contiguous physical networks A data network implemented across non-contiguous physical networks
connected by Layer 3 routers, using a VNI identifier. This allows 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.
.. xbooklink VXLAN Data Networks are specific to |prod-os| application and are described in detail in :ref:`VXLAN Data Networks <vxlan-data-networks>` . .. xbooklink VXLAN Data Networks are specific to |prod-os| application and are described in detail in :ref:`VXLAN Data Networks <vxlan-data-networks>` .
See |prod-os| Configuration and Management: :ref:`VXLAN Data Networks See |prod-os| Configuration and Management: :ref:`VXLAN Data Networks
<vxlan-data-networks>` <vxlan-data-networks>`
There are no specific requirements for network services to be available on the There are no specific requirements for network services to be available on the
data network. However, you must ensure that all network services required by data network. However, you must ensure that all network services required by
the guests running on the worker nodes are available. For configuration the guests running on the worker nodes are available. For configuration
purposes, the worker nodes themselves are entirely served by the services purposes, the worker nodes themselves are entirely served by the services
provided by the controller nodes over the internal management and cluster-host provided by the controller nodes over the internal management and cluster-host
networks. networks.

78
doc/source/datanet/displaying-data-network-information-using-horizon.rst → doc/source/datanet/kubernetes/displaying-data-network-information-using-horizon.rst
View File

@ -1,40 +1,40 @@
.. qks1559818290232 .. qks1559818290232
.. _displaying-data-network-information-using-horizon: .. _displaying-data-network-information-using-horizon:
============================================== ==============================================
Display Data Network Information Using Horizon Display Data Network Information Using Horizon
============================================== ==============================================
You can view data network details from the Horizon Web interface or the CLI. You can view data network details from the Horizon Web interface or the CLI.
You can also view data network topologies from Horizon. You can also view data network topologies from Horizon.
.. rubric:: |context| .. rubric:: |context|
Using Horizon, you can obtain information about data networks using the Using Horizon, you can obtain information about data networks using the
following: following:
The **Data Network Topology** view. This is a graphical representation of all The **Data Network Topology** view. This is a graphical representation of all
data networks on the system and their connections to worker hosts. You can data networks on the system and their connections to worker hosts. You can
select individual data networks to view details. You can also review active select individual data networks to view details. You can also review active
alarms for data network connections. alarms for data network connections.
.. For more information, see :ref:`The Data Network Topology View <the-data-network-topology-view>`. .. For more information, see :ref:`The Data Network Topology View <the-data-network-topology-view>`.
.. note:: .. note::
You cannot make changes from this view. You cannot make changes from this view.
Both places use the **Data Network Details** tab to present details. If you Both places use the **Data Network Details** tab to present details. If you
prefer, you can view the details using the CLI; for more information, see prefer, you can view the details using the CLI; for more information, see
:ref:`Displaying Data Network Information Using the CLI :ref:`Displaying Data Network Information Using the CLI
<displaying-data-network-information-using-the-cli>`. <displaying-data-network-information-using-the-cli>`.
.. rubric:: |proc| .. rubric:: |proc|
#. From the left pane menu, select **Admin** \> **Platform** \> **Data #. From the left pane menu, select **Admin** \> **Platform** \> **Data
Networks**. Networks**.
#. Click the name of the data network to open the Data Network Overview page. #. Click the name of the data network to open the Data Network Overview page.
Details for the data network are displayed and, in the case of |prod-os|, Details for the data network are displayed and, in the case of |prod-os|,
the project networks. the project networks.

76
doc/source/datanet/displaying-data-network-information-using-the-cli.rst → doc/source/datanet/kubernetes/displaying-data-network-information-using-the-cli.rst
View File

@ -1,39 +1,39 @@
.. anh1559818482640 .. anh1559818482640
.. _displaying-data-network-information-using-the-cli: .. _displaying-data-network-information-using-the-cli:
============================================== ==============================================
Display Data Network Information Using the CLI Display Data Network Information Using the CLI
============================================== ==============================================
You can display information about data networks from the CLI. You can display information about data networks from the CLI.
.. rubric:: |proc| .. rubric:: |proc|
.. _displaying-data-network-information-using-the-cli-steps-zln-xky-hkb: .. _displaying-data-network-information-using-the-cli-steps-zln-xky-hkb:
#. Retrieve the names of the data networks. #. Retrieve the names of the data networks.
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system datanetwork-list ~(keystone_admin)$ system datanetwork-list
+--------------------------------------+--------------+----------+------+ +--------------------------------------+--------------+----------+------+
| uuid | name | network_ | mtu | | uuid | name | network_ | mtu |
| | | type | | | | | type | |
+--------------------------------------+--------------+----------+------+ +--------------------------------------+--------------+----------+------+
| 3a575af8-01a7-44ca-9519-edaa2f06c74b | group0-data0 | vlan | 1500 | | 3a575af8-01a7-44ca-9519-edaa2f06c74b | group0-data0 | vlan | 1500 |
+--------------------------------------+--------------+----------+------+ +--------------------------------------+--------------+----------+------+
#. Review information for a data network from the CLI. #. Review information for a data network from the CLI.
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system datanetwork-show <datanet> ~(keystone_admin)$ system datanetwork-show <datanet>
Where <datanet> is the name or UUID of the data network. Where <datanet> is the name or UUID of the data network.
For example: For example:
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system datanetwork-show group0-data0 ~(keystone_admin)$ system datanetwork-show group0-data0

35
doc/source/datanet/kubernetes/index.rst Normal file
View File

@ -0,0 +1,35 @@
..
.. _datanet_kubernetes_index:
========
Contents
========
.. toctree::
:maxdepth: 1
data-network-management-data-networks
--------------------------------
Display data network information
--------------------------------
.. toctree::
:maxdepth: 1
displaying-data-network-information-using-horizon
displaying-data-network-information-using-the-cli
the-data-network-topology-view
vxlan-data-networks
-------------------------------------
Add, assign, and remove data networks
-------------------------------------
.. toctree::
:maxdepth: 1
adding-data-networks-using-the-cli
assigning-a-data-network-to-an-interface
removing-a-data-network-using-the-cli

106
doc/source/datanet/removing-a-data-network-using-the-cli.rst → doc/source/datanet/kubernetes/removing-a-data-network-using-the-cli.rst
View File

@ -1,54 +1,54 @@
.. lnl1559819027423 .. lnl1559819027423
.. _removing-a-data-network-using-the-cli: .. _removing-a-data-network-using-the-cli:
=================================== ===================================
Remove a Data Network Using the CLI Remove a Data Network Using the CLI
=================================== ===================================
Before you can delete a data network, you must remove any interface Before you can delete a data network, you must remove any interface
associations. associations.
.. rubric:: |context| .. rubric:: |context|
Complete the following steps to delete a data interface. Complete the following steps to delete a data interface.
.. rubric:: |prereq| .. rubric:: |prereq|
The following procedure requires that the host be locked. The following procedure requires that the host be locked.
.. rubric:: |proc| .. rubric:: |proc|
#. Remove the data network from the interface. #. Remove the data network from the interface.
#. Identify the interface to be removed. #. Identify the interface to be removed.
For example: For example:
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system interface-datanetwork-list controller-1 ~(keystone_admin)$ system interface-datanetwork-list controller-1
+--------------+--------------------------------------+--------+------------------+ +--------------+--------------------------------------+--------+------------------+
| hostname | uuid | ifname | datanetwork_name | | hostname | uuid | ifname | datanetwork_name |
+--------------+--------------------------------------+--------+------------------+ +--------------+--------------------------------------+--------+------------------+
| controller-1 | 212d5afc-e417-49fe-919a-d94e9b46c236 | sriov0 | group0-data0 | | controller-1 | 212d5afc-e417-49fe-919a-d94e9b46c236 | sriov0 | group0-data0 |
| controller-1 | 6c2f7066-3889-4291-8928-5fb4b2bccfee | data0 | group0-data0 | | controller-1 | 6c2f7066-3889-4291-8928-5fb4b2bccfee | data0 | group0-data0 |
| controller-1 | c4ac3c62-283e-491f-a08b-2e4a5ece205c | pthru0 | group0-data0 | | controller-1 | c4ac3c62-283e-491f-a08b-2e4a5ece205c | pthru0 | group0-data0 |
+--------------+--------------------------------------+--------+------------------+ +--------------+--------------------------------------+--------+------------------+
#. Remove the network. #. Remove the network.
For example: For example:
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system interface-datanetwork-remove c4ac3c62-283e-491f-a08b-2e4a5ece205c ~(keystone_admin)$ system interface-datanetwork-remove c4ac3c62-283e-491f-a08b-2e4a5ece205c
Deleted Interface DataNetwork: c4ac3c62-283e-491f-a08b-2e4a5ece205c Deleted Interface DataNetwork: c4ac3c62-283e-491f-a08b-2e4a5ece205c
#. Delete the data network from the system. #. Delete the data network from the system.
.. code-block:: none .. code-block:: none
~[keystone_admin]$ system datanetwork-delete <datanetworkUUID> ~[keystone_admin]$ system datanetwork-delete <datanetworkUUID>
where <datanetworkUUID> is the UUID of the data network. where <datanetworkUUID> is the UUID of the data network.

176
doc/source/datanet/the-data-network-topology-view.rst → doc/source/datanet/kubernetes/the-data-network-topology-view.rst
View File

@ -1,89 +1,89 @@
.. vkv1559818533210 .. vkv1559818533210
.. _the-data-network-topology-view: .. _the-data-network-topology-view:
========================== ==========================
Data Network Topology View Data Network Topology View
========================== ==========================
The Data Network Topology view shows data networks and compute host data The Data Network Topology view shows data networks and compute host data
interface connections for the system using a color-coded graphical display. interface connections for the system using a color-coded graphical display.
Active alarm information is also shown in real time. You can select individual Active alarm information is also shown in real time. You can select individual
hosts or networks to highlight their connections and obtain more details. hosts or networks to highlight their connections and obtain more details.
.. contents:: .. contents::
:local: :local:
:depth: 1 :depth: 1
To display this view, select **Admin** \> **Platform** \> **Data Network To display this view, select **Admin** \> **Platform** \> **Data Network
Topology**. Topology**.
.. image:: figures/sqw1475425312420.png .. image:: ../figures/sqw1475425312420.png
:height: 365px :height: 365px
.. _the-data-network-topology-view-section-N1002F-N1001C-N10001: .. _the-data-network-topology-view-section-N1002F-N1001C-N10001:
------------------------ ------------------------
Selection and Navigation Selection and Navigation
------------------------ ------------------------
The Data Network Topology view shows all worker hosts and data networks The Data Network Topology view shows all worker hosts and data networks
graphically in a framed topology window, and lists them by name in the **Worker graphically in a framed topology window, and lists them by name in the **Worker
Hosts** and **Data Networks** lists to the left of the window. You can select Hosts** and **Data Networks** lists to the left of the window. You can select
an entity using the window or the lists. The selected entity is highlighted in an entity using the window or the lists. The selected entity is highlighted in
both places. both places.
If the topology of the system is too large to fit in the window, you can drag If the topology of the system is too large to fit in the window, you can drag
inside the window to see other areas. You can also bring an entity into view by inside the window to see other areas. You can also bring an entity into view by
selecting it from the lists. The view is panned automatically to show the selecting it from the lists. The view is panned automatically to show the
entity. entity.
.. _the-data-network-topology-view-section-N1004E-N1001C-N10001: .. _the-data-network-topology-view-section-N1004E-N1001C-N10001:
------------------------------- -------------------------------
Additional Details for Entities Additional Details for Entities
------------------------------- -------------------------------
When you select an entity, associated entities are highlighted in the **Worker When you select an entity, associated entities are highlighted in the **Worker
Hosts** list or the **Data Networks** list. For example, if you select the Hosts** list or the **Data Networks** list. For example, if you select the
**group0-data0** data network, all hosts attached to it are highlighted in the **group0-data0** data network, all hosts attached to it are highlighted in the
**Worker Hosts** list. **Worker Hosts** list.
Additional information for the selected entity is available in tabbed pages Additional information for the selected entity is available in tabbed pages
below the topology window. below the topology window.
.. _the-data-network-topology-view-ul-z5z-czh-mx: .. _the-data-network-topology-view-ul-z5z-czh-mx:
- For a worker host, the additional information includes the **Overview**, - For a worker host, the additional information includes the **Overview**,
**Interfaces**, and **LLDP** tabs from the Host Detail, as well as a **Interfaces**, and **LLDP** tabs from the Host Detail, as well as a
**Related Alarms** tab that lists any active alarms associated with the **Related Alarms** tab that lists any active alarms associated with the
host. host.
- For a data network, the additional information includes the - For a data network, the additional information includes the
**Data Network Detail** tab from the Data Network Overview, and a **Data Network Detail** tab from the Data Network Overview, and a
**Related Alarms** tab that lists any active alarms associated with the **Related Alarms** tab that lists any active alarms associated with the
data network. data network.
.. _the-data-network-topology-view-section-N1009C-N1001C-N10001: .. _the-data-network-topology-view-section-N1009C-N1001C-N10001:
--------------- ---------------
Alarm Reporting Alarm Reporting
--------------- ---------------
Active alarms for entities are displayed in real time in the topology window, Active alarms for entities are displayed in real time in the topology window,
using icons superimposed on the entities. The alarms are color-coded for using icons superimposed on the entities. The alarms are color-coded for
severity using the same colors as the Global Alarm Banner. Details for the severity using the same colors as the Global Alarm Banner. Details for the
alarms are listed in the **Related Alarms** tab for the entity. alarms are listed in the **Related Alarms** tab for the entity.
.. image:: figures/eal1475518780745.png .. image:: ../figures/eal1475518780745.png
.. _the-data-network-topology-view-section-N100AD-N1001C-N10001: .. _the-data-network-topology-view-section-N100AD-N1001C-N10001:
------------------------------ ------------------------------
Labels for Network Connections Labels for Network Connections
------------------------------ ------------------------------
Network connections in the topology window may be labeled with the data Network connections in the topology window may be labeled with the data
interface name \(displayed above the connection line\) and LLDP neighbor interface name \(displayed above the connection line\) and LLDP neighbor
information \(displayed below the connection line\). You can show or hide the information \(displayed below the connection line\). You can show or hide the
labels using a button above the lists \(**Show Labels** or **Hide Labels**\). labels using a button above the lists \(**Show Labels** or **Hide Labels**\).

4
doc/source/datanet/vxlan-data-networks.rst → doc/source/datanet/kubernetes/vxlan-data-networks.rst
View File

@ -25,7 +25,7 @@ are included in the outer IP header.
.. only:: partner .. only:: partner
.. include:: ../_includes/vxlan-data-networks.rest .. include:: ../../_includes/vxlan-data-networks.rest
.. _vxlan-data-networks-ul-rzs-kqf-zbb: .. _vxlan-data-networks-ul-rzs-kqf-zbb:
@ -46,5 +46,3 @@ define at least one network segment range.
- :ref:`Static VXLAN <static-vxlan>` - :ref:`Static VXLAN <static-vxlan>`
- :ref:`Differences Between Dynamic and Static VXLAN Modes <differences-between-dynamic-and-static-vxlan-modes>` - :ref:`Differences Between Dynamic and Static VXLAN Modes <differences-between-dynamic-and-static-vxlan-modes>`

6
doc/source/datanet/adding-a-static-ip-address-to-a-data-interface.rst → doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst
View File

@ -45,18 +45,18 @@ To make interface changes, you must lock the compute host first.
#. In the Edit Interface dialog box, set the **IPv4 Addressing Mode** or #. In the Edit Interface dialog box, set the **IPv4 Addressing Mode** or
the **IPv6 Addressing Mode** to **Static**. the **IPv6 Addressing Mode** to **Static**.
.. image:: figures/bju1538154656153.png .. image:: ../figures/bju1538154656153.png
#. Add an IPv4 or IPv6 address to the interface. #. Add an IPv4 or IPv6 address to the interface.
#. On the Host Detail page, click the **Name** of the interface to open #. On the Host Detail page, click the **Name** of the interface to open
the Interface Detail page. the Interface Detail page.
.. image:: figures/jow1443041105867.png .. image:: ../figures/jow1443041105867.png
#. Click **Create Address** to open the Create Address dialog box. #. Click **Create Address** to open the Create Address dialog box.
.. image:: figures/jow1442607685238.png .. image:: ../figures/jow1442607685238.png
#. Enter the IPv4 or IPv6 address and netmask \(for example, #. Enter the IPv4 or IPv6 address and netmask \(for example,
192.168.1.3/24\), and then click **Create Address**. 192.168.1.3/24\), and then click **Create Address**.

0
doc/source/datanet/adding-and-maintaining-routes-for-a-vxlan-network.rst → doc/source/datanet/openstack/adding-and-maintaining-routes-for-a-vxlan-network.rst
View File

0
doc/source/datanet/adding-segmentation-ranges-using-the-cli.rst → doc/source/datanet/openstack/adding-segmentation-ranges-using-the-cli.rst
View File

1
doc/source/datanet/changing-the-mtu-of-a-data-interface-using-the-cli.rst → doc/source/datanet/openstack/changing-the-mtu-of-a-data-interface-using-the-cli.rst
View File

@ -38,7 +38,6 @@ For example:
~(keystone_admin)]$ system host-if-modify compute-0 enp0s8 --imtu 1496 ~(keystone_admin)]$ system host-if-modify compute-0 enp0s8 --imtu 1496
.. note:: .. note::
You cannot set the |MTU| on an openstack-compute-labeled compute node You cannot set the |MTU| on an openstack-compute-labeled compute node
interface to a value smaller than the largest |MTU| used on its data interface to a value smaller than the largest |MTU| used on its data
networks. networks.

0
doc/source/datanet/changing-the-mtu-of-a-data-interface.rst → doc/source/datanet/openstack/changing-the-mtu-of-a-data-interface.rst
View File

0
doc/source/datanet/configuring-data-interfaces-for-vxlans.rst → doc/source/datanet/openstack/configuring-data-interfaces-for-vxlans.rst
View File

0
doc/source/datanet/configuring-data-interfaces.rst → doc/source/datanet/openstack/configuring-data-interfaces.rst
View File

2
doc/source/datanet/data-networks-overview.rst → doc/source/datanet/openstack/data-networks-overview.rst
View File

@ -49,4 +49,4 @@ OpenStack Neutron commands, see :ref:`Adding Segmentation Ranges Using the CLI
.. only:: partner .. only:: partner
.. include:: ../_includes/data-networks-overview.rest .. include:: ../../_includes/data-networks-overview.rest

0
doc/source/datanet/differences-between-dynamic-and-static-vxlan-modes.rst → doc/source/datanet/openstack/differences-between-dynamic-and-static-vxlan-modes.rst
View File

6
doc/source/datanet/dynamic-vxlan.rst → doc/source/datanet/openstack/dynamic-vxlan.rst
View File

@ -33,12 +33,12 @@ for more complex routing requirements but requires IP multicast enabled routers.
.. only:: partner .. only:: partner
.. include:: ../_includes/dynamic-vxlan.rest .. include:: ../../_includes/dynamic-vxlan.rest
:start-after: vswitch-text-1-begin :start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end :end-before: vswitch-text-1-end
.. figure:: figures/eol1510005391750.png .. figure:: ../figures/eol1510005391750.png
Multicast Endpoint Distribution Multicast Endpoint Distribution
@ -52,7 +52,7 @@ Multicast Endpoint Distribution
.. only:: partner .. only:: partner
.. include:: ../_includes/dynamic-vxlan.rest .. include:: ../../_includes/dynamic-vxlan.rest
:start-after: vswitch-text-1-begin :start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end :end-before: vswitch-text-1-end

67
doc/source/datanet/openstack/index.rst Normal file
View File

@ -0,0 +1,67 @@
.. Data networks file, created by
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
========
Contents
========
.. toctree::
:maxdepth: 1
data-networks-overview
-------------------
VXLAN data networks
-------------------
.. toctree::
:maxdepth: 1
dynamic-vxlan
static-vxlan
differences-between-dynamic-and-static-vxlan-modes
-----------------------
Add segmentation ranges
-----------------------
.. toctree::
:maxdepth: 1
adding-segmentation-ranges-using-the-cli
------------------------------------
Data network interface configuration
------------------------------------
.. toctree::
:maxdepth: 1
configuring-data-interfaces
configuring-data-interfaces-for-vxlans
------------------------------
MTU values of a data interface
------------------------------
.. toctree::
:maxdepth: 1
changing-the-mtu-of-a-data-interface-using-the-cli
changing-the-mtu-of-a-data-interface
-----------------------------------
VXLAN data network setup completion
-----------------------------------
.. toctree::
:maxdepth: 1
adding-a-static-ip-address-to-a-data-interface
managing-data-interface-static-ip-addresses-using-the-cli
using-ip-address-pools-for-data-interfaces
managing-ip-address-pools-using-the-cli
adding-and-maintaining-routes-for-a-vxlan-network
vxlan-data-network-setup-completion

0
doc/source/datanet/managing-data-interface-static-ip-addresses-using-the-cli.rst → doc/source/datanet/openstack/managing-data-interface-static-ip-addresses-using-the-cli.rst
View File

24
doc/source/datanet/managing-ip-address-pools-using-the-cli.rst → doc/source/datanet/openstack/managing-ip-address-pools-using-the-cli.rst
View File

@ -23,9 +23,9 @@ To make interface changes, you must lock the compute node first.
.. _managing-ip-address-pools-using-the-cli-section-N1003C-N1001F-N10001: .. _managing-ip-address-pools-using-the-cli-section-N1003C-N1001F-N10001:
------------------------ ----------------------
Creating an Address pool Create an Address pool
------------------------ ----------------------
To create an address pool, use a command of the following form: To create an address pool, use a command of the following form:
@ -58,9 +58,9 @@ where:
.. _managing-ip-address-pools-using-the-cli-section-N10109-N1001F-N10001: .. _managing-ip-address-pools-using-the-cli-section-N10109-N1001F-N10001:
--------------------- ------------------
Listing address pools List address pools
--------------------- ------------------
To list existing address pools, use a command of the following form: To list existing address pools, use a command of the following form:
@ -72,9 +72,9 @@ where **<uuid>** is the universally unique identifier for the pool.
.. _managing-ip-address-pools-using-the-cli-section-N10131-N1001F-N10001: .. _managing-ip-address-pools-using-the-cli-section-N10131-N1001F-N10001:
------------------------- ----------------------
Modifying an address pool Modify an address pool
------------------------- ----------------------
To modify an address pool, use a command of the following form: To modify an address pool, use a command of the following form:
@ -84,9 +84,9 @@ To modify an address pool, use a command of the following form:
.. _managing-ip-address-pools-using-the-cli-section-N1015F-N1001F-N10001: .. _managing-ip-address-pools-using-the-cli-section-N1015F-N1001F-N10001:
------------------------ ----------------------
Deleting an address pool Delete an address pool
------------------------ ----------------------
To delete an address pool, use a command of the following form: To delete an address pool, use a command of the following form:

4
doc/source/datanet/static-vxlan.rst → doc/source/datanet/openstack/static-vxlan.rst
View File

@ -20,7 +20,7 @@ to receive the packet in order to reach the |VM|.
.. only:: partner .. only:: partner
.. include:: ../_includes/static-vxlan.rest .. include:: ../../_includes/static-vxlan.rest
:start-after: vswitch-text-1-begin :start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end :end-before: vswitch-text-1-end
@ -29,7 +29,7 @@ to receive the packet in order to reach the |VM|.
Static |VXLAN| is limited to use on one data network. If configured, it must be Static |VXLAN| is limited to use on one data network. If configured, it must be
enabled on all OpenStack compute nodes. enabled on all OpenStack compute nodes.
.. figure:: figures/oeg1510005898965.png .. figure:: ../figures/oeg1510005898965.png
`Static Endpoint Distribution` `Static Endpoint Distribution`

4
doc/source/datanet/using-ip-address-pools-for-data-interfaces.rst → doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst
View File

@ -37,7 +37,7 @@ To make interface changes, you must lock the compute node first.
#. Select the **Address Pools** tab. #. Select the **Address Pools** tab.
.. image:: figures/jow1445971002260.png .. image:: ../figures/jow1445971002260.png
You can use the controls on the Address Pools page to create, update, or You can use the controls on the Address Pools page to create, update, or
delete address pools. delete address pools.
@ -45,7 +45,7 @@ To make interface changes, you must lock the compute node first.
#. To create an address pool, click **Create Address Pool** and complete the #. To create an address pool, click **Create Address Pool** and complete the
dialog box. dialog box.
.. image:: figures/jow1445971475692.png .. image:: ../figures/jow1445971475692.png
**Name** **Name**
A name used for selecting the pool during data interface setup. A name used for selecting the pool during data interface setup.

0
doc/source/datanet/vxlan-data-network-setup-completion.rst → doc/source/datanet/openstack/vxlan-data-network-setup-completion.rst
View File