Datanet reorg

Split content into kubernetes and openstack to align with refactoring of other docs.
Incorporated review comments
doc/source/_includes/dynamic-vxlan.rest update

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I4c27aa4d1d5d405824eda669d5f484987e7789de
Signed-off-by: Ron Stone <ronald.stone@windriver.com>

doc/source/_includes/dynamic-vxlan.rest

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

doc/source/datanet/index.rs1

@@ -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>`
-

doc/source/datanet/index.rst

@@ -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
@@ -11,93 +10,23 @@ Data Networks
 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::
-   :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::
-   :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

doc/source/datanet/kubernetes/index.rst

@@ -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

doc/source/datanet/kubernetes/the-data-network-topology-view.rst

@@ -18,7 +18,7 @@ hosts or networks to highlight their connections and obtain more details.
 To display this view, select **Admin** \> **Platform** \> **Data Network
 Topology**.
 
-.. image:: figures/sqw1475425312420.png
+.. image:: ../figures/sqw1475425312420.png
    :height: 365px
 
 .. _the-data-network-topology-view-section-N1002F-N1001C-N10001:
@@ -75,7 +75,7 @@ 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
 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:
 

doc/source/datanet/kubernetes/vxlan-data-networks.rst

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

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

@@ -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
         the **IPv6 Addressing Mode** to **Static**.
 
-        .. image:: figures/bju1538154656153.png
+        .. image:: ../figures/bju1538154656153.png
 
 #.  Add an IPv4 or IPv6 address to the interface.
 
     #.  On the Host Detail page, click the **Name** of the interface to open
         the Interface Detail page.
 
-        .. image:: figures/jow1443041105867.png
+        .. image:: ../figures/jow1443041105867.png
 
     #.  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,
         192.168.1.3/24\), and then click **Create Address**.

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

@@ -38,7 +38,6 @@ For example:
     ~(keystone_admin)]$ system host-if-modify compute-0 enp0s8 --imtu 1496
 
 .. note::
-
     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
     networks.

doc/source/datanet/openstack/data-networks-overview.rst

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

doc/source/datanet/openstack/dynamic-vxlan.rst

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

doc/source/datanet/openstack/index.rst

@@ -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

doc/source/datanet/openstack/managing-ip-address-pools-using-the-cli.rst

@@ -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:
 
-------------------------
+----------------------
-Creating an Address pool
+Create an Address pool
-------------------------
+----------------------
 
 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:
 
----------------------
+------------------
-Listing address pools
+List address pools
----------------------
+------------------
 
 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:
 
--------------------------
+----------------------
-Modifying an address pool
+Modify an address pool
--------------------------
+----------------------
 
 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:
 
-------------------------
+----------------------
-Deleting an address pool
+Delete an address pool
-------------------------
+----------------------
 
 To delete an address pool, use a command of the following form:
 

doc/source/datanet/openstack/static-vxlan.rst

@@ -20,7 +20,7 @@ to receive the packet in order to reach the |VM|.
 
 .. only:: partner
 
-    .. include:: ../_includes/static-vxlan.rest
+    .. include:: ../../_includes/static-vxlan.rest
 
     :start-after: vswitch-text-1-begin
     :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
 enabled on all OpenStack compute nodes.
 
-.. figure:: figures/oeg1510005898965.png
+.. figure:: ../figures/oeg1510005898965.png
 
     `Static Endpoint Distribution`
 

doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst

@@ -37,7 +37,7 @@ To make interface changes, you must lock the compute node first.
 
 #.  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
     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
     dialog box.
 
-    .. image:: figures/jow1445971475692.png
+    .. image:: ../figures/jow1445971475692.png
 
     **Name**
         A name used for selecting the pool during data interface setup.