diff --git a/doc/source/_includes/dynamic-vxlan.rest b/doc/source/_includes/dynamic-vxlan.rest index e69de29bb..577dc8782 100644 --- a/doc/source/_includes/dynamic-vxlan.rest +++ b/doc/source/_includes/dynamic-vxlan.rest @@ -0,0 +1,2 @@ +vswitch-text-1-begin +vswitch-text-1-end \ No newline at end of file diff --git a/doc/source/datanet/index.rs1 b/doc/source/datanet/index.rs1 deleted file mode 100644 index ec713b678..000000000 --- a/doc/source/datanet/index.rs1 +++ /dev/null @@ -1,15 +0,0 @@ -=================================== -|prod-long| Data Network Management -=================================== - -- :ref:`Data Networks ` -- Displaying Data Network Information - - - :ref:`Displaying Data Network Information Using Horizon ` - - :ref:`Displaying Data Network Information Using the CLI ` - - :ref:`The Data Network Topology View ` - -- :ref:`Adding Data Networks Using the CLI ` -- :ref:`Assigning a Data Network to an Interface ` -- :ref:`Removing a Data Network Using the CLI ` - diff --git a/doc/source/datanet/index.rst b/doc/source/datanet/index.rst index 5392839ca..042469f06 100644 --- a/doc/source/datanet/index.rst +++ b/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 - contain the root `toctree` directive. +.. + +.. _datanet_index: ============= Data Networks @@ -11,93 +10,23 @@ Data Networks Kubernetes ---------- -.. toctree:: - :maxdepth: 1 - - data-network-management-data-networks - -*********************************** -Displaying data network information -*********************************** +|prod-long| data network management allows you to model the L2 networks that +are attached to node data, pci-sriov and pci-passthrough interfaces. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - displaying-data-network-information-using-horizon - displaying-data-network-information-using-the-cli - the-data-network-topology-view - vxlan-data-networks + kubernetes/index -********************************************* -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 - 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 \ No newline at end of file + openstack/index diff --git a/doc/source/datanet/adding-data-networks-using-the-cli.rst b/doc/source/datanet/kubernetes/adding-data-networks-using-the-cli.rst similarity index 95% rename from doc/source/datanet/adding-data-networks-using-the-cli.rst rename to doc/source/datanet/kubernetes/adding-data-networks-using-the-cli.rst index d04b9d818..3b20c13d5 100644 --- a/doc/source/datanet/adding-data-networks-using-the-cli.rst +++ b/doc/source/datanet/kubernetes/adding-data-networks-using-the-cli.rst @@ -1,97 +1,97 @@ - -.. oiq1559818630326 -.. _adding-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, -VLAN and VXLAN data networks over physical networks using the **controller-0** -command-line interface. The data networks provide connectivity for project -networks. - -.. rubric:: |prereq| - - -.. _adding-data-networks-using-the-cli-prereq-controller-0-ready: - -Controller-0 must be installed and configured. - -.. rubric:: |proc| - -.. _adding-data-networks-using-the-cli-steps-ek5-4fs-hkb: - -- To create a data network using the CLI, use the following command. - - .. code-block:: none - - ~(keystone_admin)$ system datanetwork-add -d -m -p -g -t -M - - where - - **** - A description of the data network. - - **** - The MTU of the data network. - - .. note:: - To attach to the data network, data interfaces must be configured - with an equal or larger MTU. - - **** - The port of the data network. - - **** - The multicast group of the data network. - - **** - The time-to-live of the data network. - - **** - For networks of vxlan only, mode can be either **dynamic** or - **static**. - - If set to **dynamic**, must also be specified. - - **** - The name assigned to the data network. - - **** - The type of data network to be created \(**flat**, **vlan**, or - **vxlan**\) - - .. note:: - **vxlan** is only applicable to |prod-os|. - - For example, to add a VLAN data network named datanet-a: - - .. code-block:: none - - ~(keystone_admin)$ system datanetwork-add datanet-a vlan - +--------------+--------------------------------------+ - | Property | Value | - +--------------+--------------------------------------+ - | id | 2 | - | uuid | 104071a4-1c26-4383-ba07-72e05316d540 | - | name | datanet-a | - | network_type | vlan | - | mtu | 1500 | - | description | None | - +--------------+--------------------------------------+ - - You must configure at least one data network in order to assign data - interfaces to worker nodes and unlock the hosts. - -.. rubric:: |postreq| - -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 -of consecutive VLAN IDs \(for VLANs\) or VNIs \(for VXLANs\) using the -:command:`openstack network segment range create` command. Segmentation ranges -are required in order to set up project networks. - -.. note:: - Segmentation ranges are not required in order to attach interfaces and + +.. oiq1559818630326 +.. _adding-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, +VLAN and VXLAN data networks over physical networks using the **controller-0** +command-line interface. The data networks provide connectivity for project +networks. + +.. rubric:: |prereq| + + +.. _adding-data-networks-using-the-cli-prereq-controller-0-ready: + +Controller-0 must be installed and configured. + +.. rubric:: |proc| + +.. _adding-data-networks-using-the-cli-steps-ek5-4fs-hkb: + +- To create a data network using the CLI, use the following command. + + .. code-block:: none + + ~(keystone_admin)$ system datanetwork-add -d -m -p -g -t -M + + where + + **** + A description of the data network. + + **** + The MTU of the data network. + + .. note:: + To attach to the data network, data interfaces must be configured + with an equal or larger MTU. + + **** + The port of the data network. + + **** + The multicast group of the data network. + + **** + The time-to-live of the data network. + + **** + For networks of vxlan only, mode can be either **dynamic** or + **static**. + + If set to **dynamic**, must also be specified. + + **** + The name assigned to the data network. + + **** + The type of data network to be created \(**flat**, **vlan**, or + **vxlan**\) + + .. note:: + **vxlan** is only applicable to |prod-os|. + + For example, to add a VLAN data network named datanet-a: + + .. code-block:: none + + ~(keystone_admin)$ system datanetwork-add datanet-a vlan + +--------------+--------------------------------------+ + | Property | Value | + +--------------+--------------------------------------+ + | id | 2 | + | uuid | 104071a4-1c26-4383-ba07-72e05316d540 | + | name | datanet-a | + | network_type | vlan | + | mtu | 1500 | + | description | None | + +--------------+--------------------------------------+ + + You must configure at least one data network in order to assign data + interfaces to worker nodes and unlock the hosts. + +.. rubric:: |postreq| + +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 +of consecutive VLAN IDs \(for VLANs\) or VNIs \(for VXLANs\) using the +:command:`openstack network segment range create` command. Segmentation ranges +are required in order to set up project networks. + +.. note:: + Segmentation ranges are not required in order to attach interfaces and unlock openstack-compute labeled worker nodes. \ No newline at end of file diff --git a/doc/source/datanet/assigning-a-data-network-to-an-interface.rst b/doc/source/datanet/kubernetes/assigning-a-data-network-to-an-interface.rst similarity index 93% rename from doc/source/datanet/assigning-a-data-network-to-an-interface.rst rename to doc/source/datanet/kubernetes/assigning-a-data-network-to-an-interface.rst index b467f7d14..4bc33af2a 100644 --- a/doc/source/datanet/assigning-a-data-network-to-an-interface.rst +++ b/doc/source/datanet/kubernetes/assigning-a-data-network-to-an-interface.rst @@ -1,16 +1,16 @@ - -.. riw1559818822179 -.. _assigning-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 -physical network, the Data Network must be mapped to an Ethernet or Aggregated -Ethernet interface on a compute node. - -The command for performing the mapping has the format: - -:command:`system interface‐datanetwork‐assign` + +.. riw1559818822179 +.. _assigning-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 +physical network, the Data Network must be mapped to an Ethernet or Aggregated +Ethernet interface on a compute node. + +The command for performing the mapping has the format: + +:command:`system interface‐datanetwork‐assign` \ No newline at end of file diff --git a/doc/source/datanet/data-network-management-data-networks.rst b/doc/source/datanet/kubernetes/data-network-management-data-networks.rst similarity index 97% rename from doc/source/datanet/data-network-management-data-networks.rst rename to doc/source/datanet/kubernetes/data-network-management-data-networks.rst index 5911c021b..bc97063e7 100644 --- a/doc/source/datanet/data-network-management-data-networks.rst +++ b/doc/source/datanet/kubernetes/data-network-management-data-networks.rst @@ -1,53 +1,53 @@ - -.. jjl1559817878161 -.. _data-network-management-data-networks: - -=========================== -Data Networks in Kubernetes -=========================== - -|prod-long| data network management allows you to model the L2 networks that -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 -virtual networks, used to provide the underlying network connectivity needed -to support the application networks. Multiple data networks may be configured -as required, and realized over the same or different physical networks. Access -to external networks is typically \(although not necessarily\) granted to -worker nodes using a data network. The extent of this connectivity, including -access to the open internet, is application dependent. - -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. - -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 -created: - -**flat** - A data network mapped entirely over the physical network. -**VLAN** - A data network implemented on a physical network using a VLAN identifier. - This allows multiple data networks over the same physical network. - -**VXLAN** - .. note:: - This data interface is ONLY applicable to the |prod-os| application. - - Static VXLAN is limited to one data network, and if configured, it must - be enabled on all openstack-compute labeled nodes. - - A data network implemented across non-contiguous physical networks - connected by Layer 3 routers, using a VNI identifier. This allows - 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 ` . - See |prod-os| Configuration and Management: :ref:`VXLAN Data Networks - ` - -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 -the guests running on the worker nodes are available. For configuration -purposes, the worker nodes themselves are entirely served by the services -provided by the controller nodes over the internal management and cluster-host + +.. jjl1559817878161 +.. _data-network-management-data-networks: + +=========================== +Data Networks in Kubernetes +=========================== + +|prod-long| data network management allows you to model the L2 networks that +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 +virtual networks, used to provide the underlying network connectivity needed +to support the application networks. Multiple data networks may be configured +as required, and realized over the same or different physical networks. Access +to external networks is typically \(although not necessarily\) granted to +worker nodes using a data network. The extent of this connectivity, including +access to the open internet, is application dependent. + +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. + +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 +created: + +**flat** + A data network mapped entirely over the physical network. +**VLAN** + A data network implemented on a physical network using a VLAN identifier. + This allows multiple data networks over the same physical network. + +**VXLAN** + .. note:: + This data interface is ONLY applicable to the |prod-os| application. + + Static VXLAN is limited to one data network, and if configured, it must + be enabled on all openstack-compute labeled nodes. + + A data network implemented across non-contiguous physical networks + connected by Layer 3 routers, using a VNI identifier. This allows + 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 ` . + See |prod-os| Configuration and Management: :ref:`VXLAN Data Networks + ` + +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 +the guests running on the worker nodes are available. For configuration +purposes, the worker nodes themselves are entirely served by the services +provided by the controller nodes over the internal management and cluster-host networks. \ No newline at end of file diff --git a/doc/source/datanet/displaying-data-network-information-using-horizon.rst b/doc/source/datanet/kubernetes/displaying-data-network-information-using-horizon.rst similarity index 95% rename from doc/source/datanet/displaying-data-network-information-using-horizon.rst rename to doc/source/datanet/kubernetes/displaying-data-network-information-using-horizon.rst index a6304493e..1d3e8d949 100644 --- a/doc/source/datanet/displaying-data-network-information-using-horizon.rst +++ b/doc/source/datanet/kubernetes/displaying-data-network-information-using-horizon.rst @@ -1,40 +1,40 @@ - -.. qks1559818290232 -.. _displaying-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 also view data network topologies from Horizon. - -.. rubric:: |context| - -Using Horizon, you can obtain information about data networks using the -following: - -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 -select individual data networks to view details. You can also review active -alarms for data network connections. - -.. For more information, see :ref:`The Data Network Topology View `. - -.. note:: - You cannot make changes from this view. - -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 -:ref:`Displaying Data Network Information Using the CLI -`. - -.. rubric:: |proc| - -#. From the left pane menu, select **Admin** \> **Platform** \> **Data - Networks**. - -#. 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|, + +.. qks1559818290232 +.. _displaying-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 also view data network topologies from Horizon. + +.. rubric:: |context| + +Using Horizon, you can obtain information about data networks using the +following: + +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 +select individual data networks to view details. You can also review active +alarms for data network connections. + +.. For more information, see :ref:`The Data Network Topology View `. + +.. note:: + You cannot make changes from this view. + +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 +:ref:`Displaying Data Network Information Using the CLI +`. + +.. rubric:: |proc| + +#. From the left pane menu, select **Admin** \> **Platform** \> **Data + Networks**. + +#. 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|, the project networks. \ No newline at end of file diff --git a/doc/source/datanet/displaying-data-network-information-using-the-cli.rst b/doc/source/datanet/kubernetes/displaying-data-network-information-using-the-cli.rst similarity index 92% rename from doc/source/datanet/displaying-data-network-information-using-the-cli.rst rename to doc/source/datanet/kubernetes/displaying-data-network-information-using-the-cli.rst index a74dc4f89..f7e55cfda 100644 --- a/doc/source/datanet/displaying-data-network-information-using-the-cli.rst +++ b/doc/source/datanet/kubernetes/displaying-data-network-information-using-the-cli.rst @@ -1,39 +1,39 @@ - -.. anh1559818482640 -.. _displaying-data-network-information-using-the-cli: - -============================================== -Display Data Network Information Using the CLI -============================================== - -You can display information about data networks from the CLI. - -.. rubric:: |proc| - -.. _displaying-data-network-information-using-the-cli-steps-zln-xky-hkb: - -#. Retrieve the names of the data networks. - - .. code-block:: none - - ~(keystone_admin)$ system datanetwork-list - +--------------------------------------+--------------+----------+------+ - | uuid | name | network_ | mtu | - | | | type | | - +--------------------------------------+--------------+----------+------+ - | 3a575af8-01a7-44ca-9519-edaa2f06c74b | group0-data0 | vlan | 1500 | - +--------------------------------------+--------------+----------+------+ - -#. Review information for a data network from the CLI. - - .. code-block:: none - - ~(keystone_admin)$ system datanetwork-show - - Where is the name or UUID of the data network. - - For example: - - .. code-block:: none - + +.. anh1559818482640 +.. _displaying-data-network-information-using-the-cli: + +============================================== +Display Data Network Information Using the CLI +============================================== + +You can display information about data networks from the CLI. + +.. rubric:: |proc| + +.. _displaying-data-network-information-using-the-cli-steps-zln-xky-hkb: + +#. Retrieve the names of the data networks. + + .. code-block:: none + + ~(keystone_admin)$ system datanetwork-list + +--------------------------------------+--------------+----------+------+ + | uuid | name | network_ | mtu | + | | | type | | + +--------------------------------------+--------------+----------+------+ + | 3a575af8-01a7-44ca-9519-edaa2f06c74b | group0-data0 | vlan | 1500 | + +--------------------------------------+--------------+----------+------+ + +#. Review information for a data network from the CLI. + + .. code-block:: none + + ~(keystone_admin)$ system datanetwork-show + + Where is the name or UUID of the data network. + + For example: + + .. code-block:: none + ~(keystone_admin)$ system datanetwork-show group0-data0 \ No newline at end of file diff --git a/doc/source/datanet/kubernetes/index.rst b/doc/source/datanet/kubernetes/index.rst new file mode 100644 index 000000000..6d5b2e5c4 --- /dev/null +++ b/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 diff --git a/doc/source/datanet/removing-a-data-network-using-the-cli.rst b/doc/source/datanet/kubernetes/removing-a-data-network-using-the-cli.rst similarity index 93% rename from doc/source/datanet/removing-a-data-network-using-the-cli.rst rename to doc/source/datanet/kubernetes/removing-a-data-network-using-the-cli.rst index 4c834e7e3..dc6b1a066 100644 --- a/doc/source/datanet/removing-a-data-network-using-the-cli.rst +++ b/doc/source/datanet/kubernetes/removing-a-data-network-using-the-cli.rst @@ -1,54 +1,54 @@ - -.. lnl1559819027423 -.. _removing-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 -associations. - -.. rubric:: |context| - -Complete the following steps to delete a data interface. - -.. rubric:: |prereq| - -The following procedure requires that the host be locked. - -.. rubric:: |proc| - -#. Remove the data network from the interface. - - #. Identify the interface to be removed. - - For example: - - .. code-block:: none - - ~(keystone_admin)$ system interface-datanetwork-list controller-1 - +--------------+--------------------------------------+--------+------------------+ - | hostname | uuid | ifname | datanetwork_name | - +--------------+--------------------------------------+--------+------------------+ - | controller-1 | 212d5afc-e417-49fe-919a-d94e9b46c236 | sriov0 | group0-data0 | - | controller-1 | 6c2f7066-3889-4291-8928-5fb4b2bccfee | data0 | group0-data0 | - | controller-1 | c4ac3c62-283e-491f-a08b-2e4a5ece205c | pthru0 | group0-data0 | - +--------------+--------------------------------------+--------+------------------+ - - #. Remove the network. - - For example: - - .. code-block:: none - - ~(keystone_admin)$ system interface-datanetwork-remove c4ac3c62-283e-491f-a08b-2e4a5ece205c - Deleted Interface DataNetwork: c4ac3c62-283e-491f-a08b-2e4a5ece205c - -#. Delete the data network from the system. - - .. code-block:: none - - ~[keystone_admin]$ system datanetwork-delete - + +.. lnl1559819027423 +.. _removing-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 +associations. + +.. rubric:: |context| + +Complete the following steps to delete a data interface. + +.. rubric:: |prereq| + +The following procedure requires that the host be locked. + +.. rubric:: |proc| + +#. Remove the data network from the interface. + + #. Identify the interface to be removed. + + For example: + + .. code-block:: none + + ~(keystone_admin)$ system interface-datanetwork-list controller-1 + +--------------+--------------------------------------+--------+------------------+ + | hostname | uuid | ifname | datanetwork_name | + +--------------+--------------------------------------+--------+------------------+ + | controller-1 | 212d5afc-e417-49fe-919a-d94e9b46c236 | sriov0 | group0-data0 | + | controller-1 | 6c2f7066-3889-4291-8928-5fb4b2bccfee | data0 | group0-data0 | + | controller-1 | c4ac3c62-283e-491f-a08b-2e4a5ece205c | pthru0 | group0-data0 | + +--------------+--------------------------------------+--------+------------------+ + + #. Remove the network. + + For example: + + .. code-block:: none + + ~(keystone_admin)$ system interface-datanetwork-remove c4ac3c62-283e-491f-a08b-2e4a5ece205c + Deleted Interface DataNetwork: c4ac3c62-283e-491f-a08b-2e4a5ece205c + +#. Delete the data network from the system. + + .. code-block:: none + + ~[keystone_admin]$ system datanetwork-delete + where is the UUID of the data network. \ No newline at end of file diff --git a/doc/source/datanet/the-data-network-topology-view.rst b/doc/source/datanet/kubernetes/the-data-network-topology-view.rst similarity index 94% rename from doc/source/datanet/the-data-network-topology-view.rst rename to doc/source/datanet/kubernetes/the-data-network-topology-view.rst index 2b8f1198a..5c35eaa2c 100644 --- a/doc/source/datanet/the-data-network-topology-view.rst +++ b/doc/source/datanet/kubernetes/the-data-network-topology-view.rst @@ -1,89 +1,89 @@ - -.. vkv1559818533210 -.. _the-data-network-topology-view: - -========================== -Data Network Topology View -========================== - -The Data Network Topology view shows data networks and compute host data -interface connections for the system using a color-coded graphical display. -Active alarm information is also shown in real time. You can select individual -hosts or networks to highlight their connections and obtain more details. - -.. contents:: - :local: - :depth: 1 - -To display this view, select **Admin** \> **Platform** \> **Data Network -Topology**. - -.. image:: figures/sqw1475425312420.png - :height: 365px - -.. _the-data-network-topology-view-section-N1002F-N1001C-N10001: - ------------------------- -Selection and Navigation ------------------------- - -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 -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 -both places. - -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 -selecting it from the lists. The view is panned automatically to show the -entity. - -.. _the-data-network-topology-view-section-N1004E-N1001C-N10001: - -------------------------------- -Additional Details for Entities -------------------------------- - -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 -**group0-data0** data network, all hosts attached to it are highlighted in the -**Worker Hosts** list. - -Additional information for the selected entity is available in tabbed pages -below the topology window. - -.. _the-data-network-topology-view-ul-z5z-czh-mx: - -- For a worker host, the additional information includes the **Overview**, - **Interfaces**, and **LLDP** tabs from the Host Detail, as well as a - **Related Alarms** tab that lists any active alarms associated with the - host. - -- For a data network, the additional information includes the - **Data Network Detail** tab from the Data Network Overview, and a - **Related Alarms** tab that lists any active alarms associated with the - data network. - -.. _the-data-network-topology-view-section-N1009C-N1001C-N10001: - ---------------- -Alarm Reporting ---------------- - -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 -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 - -.. _the-data-network-topology-view-section-N100AD-N1001C-N10001: - ------------------------------- -Labels for Network Connections ------------------------------- - -Network connections in the topology window may be labeled with the data -interface name \(displayed above the connection line\) and LLDP neighbor -information \(displayed below the connection line\). You can show or hide the + +.. vkv1559818533210 +.. _the-data-network-topology-view: + +========================== +Data Network Topology View +========================== + +The Data Network Topology view shows data networks and compute host data +interface connections for the system using a color-coded graphical display. +Active alarm information is also shown in real time. You can select individual +hosts or networks to highlight their connections and obtain more details. + +.. contents:: + :local: + :depth: 1 + +To display this view, select **Admin** \> **Platform** \> **Data Network +Topology**. + +.. image:: ../figures/sqw1475425312420.png + :height: 365px + +.. _the-data-network-topology-view-section-N1002F-N1001C-N10001: + +------------------------ +Selection and Navigation +------------------------ + +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 +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 +both places. + +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 +selecting it from the lists. The view is panned automatically to show the +entity. + +.. _the-data-network-topology-view-section-N1004E-N1001C-N10001: + +------------------------------- +Additional Details for Entities +------------------------------- + +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 +**group0-data0** data network, all hosts attached to it are highlighted in the +**Worker Hosts** list. + +Additional information for the selected entity is available in tabbed pages +below the topology window. + +.. _the-data-network-topology-view-ul-z5z-czh-mx: + +- For a worker host, the additional information includes the **Overview**, + **Interfaces**, and **LLDP** tabs from the Host Detail, as well as a + **Related Alarms** tab that lists any active alarms associated with the + host. + +- For a data network, the additional information includes the + **Data Network Detail** tab from the Data Network Overview, and a + **Related Alarms** tab that lists any active alarms associated with the + data network. + +.. _the-data-network-topology-view-section-N1009C-N1001C-N10001: + +--------------- +Alarm Reporting +--------------- + +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 +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 + +.. _the-data-network-topology-view-section-N100AD-N1001C-N10001: + +------------------------------ +Labels for Network Connections +------------------------------ + +Network connections in the topology window may be labeled with the data +interface name \(displayed above the connection line\) and LLDP neighbor +information \(displayed below the connection line\). You can show or hide the labels using a button above the lists \(**Show Labels** or **Hide Labels**\). \ No newline at end of file diff --git a/doc/source/datanet/vxlan-data-networks.rst b/doc/source/datanet/kubernetes/vxlan-data-networks.rst similarity index 96% rename from doc/source/datanet/vxlan-data-networks.rst rename to doc/source/datanet/kubernetes/vxlan-data-networks.rst index d801021fb..633fd8439 100644 --- a/doc/source/datanet/vxlan-data-networks.rst +++ b/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 ` - :ref:`Differences Between Dynamic and Static VXLAN Modes ` - - diff --git a/doc/source/datanet/adding-a-static-ip-address-to-a-data-interface.rst b/doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst similarity index 93% rename from doc/source/datanet/adding-a-static-ip-address-to-a-data-interface.rst rename to doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst index e850cfc5a..d0db4cb80 100644 --- a/doc/source/datanet/adding-a-static-ip-address-to-a-data-interface.rst +++ b/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**. diff --git a/doc/source/datanet/adding-and-maintaining-routes-for-a-vxlan-network.rst b/doc/source/datanet/openstack/adding-and-maintaining-routes-for-a-vxlan-network.rst similarity index 100% rename from doc/source/datanet/adding-and-maintaining-routes-for-a-vxlan-network.rst rename to doc/source/datanet/openstack/adding-and-maintaining-routes-for-a-vxlan-network.rst diff --git a/doc/source/datanet/adding-segmentation-ranges-using-the-cli.rst b/doc/source/datanet/openstack/adding-segmentation-ranges-using-the-cli.rst similarity index 100% rename from doc/source/datanet/adding-segmentation-ranges-using-the-cli.rst rename to doc/source/datanet/openstack/adding-segmentation-ranges-using-the-cli.rst diff --git a/doc/source/datanet/changing-the-mtu-of-a-data-interface-using-the-cli.rst b/doc/source/datanet/openstack/changing-the-mtu-of-a-data-interface-using-the-cli.rst similarity index 98% rename from doc/source/datanet/changing-the-mtu-of-a-data-interface-using-the-cli.rst rename to doc/source/datanet/openstack/changing-the-mtu-of-a-data-interface-using-the-cli.rst index 1956b03b3..fc45e952b 100644 --- a/doc/source/datanet/changing-the-mtu-of-a-data-interface-using-the-cli.rst +++ b/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. \ No newline at end of file diff --git a/doc/source/datanet/changing-the-mtu-of-a-data-interface.rst b/doc/source/datanet/openstack/changing-the-mtu-of-a-data-interface.rst similarity index 100% rename from doc/source/datanet/changing-the-mtu-of-a-data-interface.rst rename to doc/source/datanet/openstack/changing-the-mtu-of-a-data-interface.rst diff --git a/doc/source/datanet/configuring-data-interfaces-for-vxlans.rst b/doc/source/datanet/openstack/configuring-data-interfaces-for-vxlans.rst similarity index 100% rename from doc/source/datanet/configuring-data-interfaces-for-vxlans.rst rename to doc/source/datanet/openstack/configuring-data-interfaces-for-vxlans.rst diff --git a/doc/source/datanet/configuring-data-interfaces.rst b/doc/source/datanet/openstack/configuring-data-interfaces.rst similarity index 100% rename from doc/source/datanet/configuring-data-interfaces.rst rename to doc/source/datanet/openstack/configuring-data-interfaces.rst diff --git a/doc/source/datanet/data-networks-overview.rst b/doc/source/datanet/openstack/data-networks-overview.rst similarity index 96% rename from doc/source/datanet/data-networks-overview.rst rename to doc/source/datanet/openstack/data-networks-overview.rst index 90e10b819..b9e04bb02 100644 --- a/doc/source/datanet/data-networks-overview.rst +++ b/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 \ No newline at end of file + .. include:: ../../_includes/data-networks-overview.rest \ No newline at end of file diff --git a/doc/source/datanet/differences-between-dynamic-and-static-vxlan-modes.rst b/doc/source/datanet/openstack/differences-between-dynamic-and-static-vxlan-modes.rst similarity index 100% rename from doc/source/datanet/differences-between-dynamic-and-static-vxlan-modes.rst rename to doc/source/datanet/openstack/differences-between-dynamic-and-static-vxlan-modes.rst diff --git a/doc/source/datanet/dynamic-vxlan.rst b/doc/source/datanet/openstack/dynamic-vxlan.rst similarity index 94% rename from doc/source/datanet/dynamic-vxlan.rst rename to doc/source/datanet/openstack/dynamic-vxlan.rst index dea4d302b..ef0ed1827 100644 --- a/doc/source/datanet/dynamic-vxlan.rst +++ b/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 diff --git a/doc/source/datanet/openstack/index.rst b/doc/source/datanet/openstack/index.rst new file mode 100644 index 000000000..6ab8b1b55 --- /dev/null +++ b/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 diff --git a/doc/source/datanet/managing-data-interface-static-ip-addresses-using-the-cli.rst b/doc/source/datanet/openstack/managing-data-interface-static-ip-addresses-using-the-cli.rst similarity index 100% rename from doc/source/datanet/managing-data-interface-static-ip-addresses-using-the-cli.rst rename to doc/source/datanet/openstack/managing-data-interface-static-ip-addresses-using-the-cli.rst diff --git a/doc/source/datanet/managing-ip-address-pools-using-the-cli.rst b/doc/source/datanet/openstack/managing-ip-address-pools-using-the-cli.rst similarity index 89% rename from doc/source/datanet/managing-ip-address-pools-using-the-cli.rst rename to doc/source/datanet/openstack/managing-ip-address-pools-using-the-cli.rst index 0b4146b1b..e685df2fe 100644 --- a/doc/source/datanet/managing-ip-address-pools-using-the-cli.rst +++ b/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 **** 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: diff --git a/doc/source/datanet/static-vxlan.rst b/doc/source/datanet/openstack/static-vxlan.rst similarity index 93% rename from doc/source/datanet/static-vxlan.rst rename to doc/source/datanet/openstack/static-vxlan.rst index 5f5c6b825..9231cc794 100644 --- a/doc/source/datanet/static-vxlan.rst +++ b/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` diff --git a/doc/source/datanet/using-ip-address-pools-for-data-interfaces.rst b/doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst similarity index 94% rename from doc/source/datanet/using-ip-address-pools-for-data-interfaces.rst rename to doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst index 66fdd0eda..4514c6c9b 100644 --- a/doc/source/datanet/using-ip-address-pools-for-data-interfaces.rst +++ b/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. diff --git a/doc/source/datanet/vxlan-data-network-setup-completion.rst b/doc/source/datanet/openstack/vxlan-data-network-setup-completion.rst similarity index 100% rename from doc/source/datanet/vxlan-data-network-setup-completion.rst rename to doc/source/datanet/openstack/vxlan-data-network-setup-completion.rst