From e46cd9a87b011da7253cf4ae3957b592f6848ea2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elisamara=20Aoki=20Gon=C3=A7alves?= Date: Tue, 24 Mar 2026 20:04:43 +0000 Subject: [PATCH] Replace instances of AVS with OVS / OVS-DPDK and OpenStack instances in the Docs (dsR11,r11) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Merging this review to see the Output file due to some .rest files. A new review will be opened to fix additional issues, if required. Remove mentions of AVS. Replace AVS for OVS when applicable. Change-Id: I411c39cac5b23b9bc58bb1c891b6e3a86bf00edf Signed-off-by: Elisamara Aoki Gonçalves --- .../_includes/common-openstack-labels.rest | 19 ------------------- .../_includes/data-networks-overview.rest | 3 ++- ...planning-verified-commercial-hardware.rest | 2 -- .../_includes/os-data-networks-overview.rest | 2 ++ ...assthrough-ethernet-interface-devices.rest | 5 +++++ .../_includes/port-security-extension.rest | 2 ++ .../_includes/project-network-planning.rest | 2 ++ doc/source/_includes/project-networks.rest | 7 ++++--- ...dard-virtio-backed-with-vhost-support.rest | 2 ++ ...ng-labels-to-identify-openstack-nodes.rest | 5 +++++ .../verified-commercial-hardware.rest | 2 -- .../vm-network-interface-options.rest | 3 +++ .../openstack/data-networks-overview.rst | 2 ++ ...ndard-virtio-backed-with-vhost-support.rst | 2 ++ .../about-host-memory-provisioning.rst | 7 +------ .../allocating-host-memory-using-horizon.rst | 11 +---------- .../allocating-host-memory-using-the-cli.rst | 6 +----- ...ated-ethernet-interfaces-using-horizon.rst | 6 +----- ...ated-ethernet-interfaces-using-the-cli.rst | 4 ---- ...ing-sr-iov-vf-interfaces-using-the-cli.rst | 4 ---- ...passthrough-ethernet-interface-devices.rst | 10 ++++------ ...ing-labels-to-identify-openstack-nodes.rst | 4 ++-- ...-planning-verified-commercial-hardware.rst | 4 +--- .../openstack/os-data-networks-overview.rst | 2 ++ .../openstack/port-security-extension.rst | 2 ++ .../openstack/project-network-planning.rst | 2 ++ .../planning/openstack/project-networks.rst | 16 ++++++++++++---- .../planning/openstack/the-ethernet-mtu.rst | 6 +----- .../vm-network-interface-options.rst | 5 +++-- 29 files changed, 64 insertions(+), 83 deletions(-) diff --git a/doc/source/_includes/common-openstack-labels.rest b/doc/source/_includes/common-openstack-labels.rest index 2c0d40f21..e69de29bb 100644 --- a/doc/source/_includes/common-openstack-labels.rest +++ b/doc/source/_includes/common-openstack-labels.rest @@ -1,19 +0,0 @@ -.. table:: Table 1. Common OpenStack Labels - :widths: auto - - +-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label | Worker/Controller | Description | - +=============================+===========================+==========================================================================================================================================================================================+ - | **openstack-control-plane** | - Controller | Identifies a node to deploy openstack controller services on. | - | | | | - | | - All-in-One Controller | | - +-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **openstack-compute-node** | Worker | Identifies a node to deploy openstack compute agents on. | - | | | | - | | | .. note:: | - | | | Adding or removing this label, or removing a node with this label from a cluster, triggers the regeneration and application of the helm chart override of the OpenStack application. | - +-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **sriov** | - Worker | Identifies a node as supporting sr-iov. | - | | | | - | | - All-in-One Controller | | - +-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/doc/source/_includes/data-networks-overview.rest b/doc/source/_includes/data-networks-overview.rest index 8b1378917..d0c74461e 100644 --- a/doc/source/_includes/data-networks-overview.rest +++ b/doc/source/_includes/data-networks-overview.rest @@ -1 +1,2 @@ - +.. data-network-begin +.. data-network-end diff --git a/doc/source/_includes/installation-and-resource-planning-verified-commercial-hardware.rest b/doc/source/_includes/installation-and-resource-planning-verified-commercial-hardware.rest index efd75f53f..a425c2c07 100644 --- a/doc/source/_includes/installation-and-resource-planning-verified-commercial-hardware.rest +++ b/doc/source/_includes/installation-and-resource-planning-verified-commercial-hardware.rest @@ -1,5 +1,3 @@ -.. [#]_ See :ref:`Data Network Planning ` for more information. - .. vgpu-content-1-begin .. vgpu-content-1-end diff --git a/doc/source/_includes/os-data-networks-overview.rest b/doc/source/_includes/os-data-networks-overview.rest index e69de29bb..41d14e058 100644 --- a/doc/source/_includes/os-data-networks-overview.rest +++ b/doc/source/_includes/os-data-networks-overview.rest @@ -0,0 +1,2 @@ +.. os-data-network-begin +.. os-data-network-end \ No newline at end of file diff --git a/doc/source/_includes/pci-passthrough-ethernet-interface-devices.rest b/doc/source/_includes/pci-passthrough-ethernet-interface-devices.rest index e69de29bb..da6a8aea3 100644 --- a/doc/source/_includes/pci-passthrough-ethernet-interface-devices.rest +++ b/doc/source/_includes/pci-passthrough-ethernet-interface-devices.rest @@ -0,0 +1,5 @@ +.. avs-bullet-3-begin +.. avs-bullet-3-end + +.. avs-text-begin +.. avs-text-end \ No newline at end of file diff --git a/doc/source/_includes/port-security-extension.rest b/doc/source/_includes/port-security-extension.rest index e69de29bb..8792c1d2c 100644 --- a/doc/source/_includes/port-security-extension.rest +++ b/doc/source/_includes/port-security-extension.rest @@ -0,0 +1,2 @@ +.. port-security-begin +.. port-security-end \ No newline at end of file diff --git a/doc/source/_includes/project-network-planning.rest b/doc/source/_includes/project-network-planning.rest index e69de29bb..2484fca2a 100644 --- a/doc/source/_includes/project-network-planning.rest +++ b/doc/source/_includes/project-network-planning.rest @@ -0,0 +1,2 @@ +.. capabilities-begin +.. capabilities-end \ No newline at end of file diff --git a/doc/source/_includes/project-networks.rest b/doc/source/_includes/project-networks.rest index 7dc0ceb34..789b61af8 100755 --- a/doc/source/_includes/project-networks.rest +++ b/doc/source/_includes/project-networks.rest @@ -1,4 +1,5 @@ -.. vxlan-begin +.. vlan-begin +.. vlan-end -- To minimize flooding of multicast packets, |IGMP| and |MLD| snooping is - recommended on all Layer 2 switches. \ No newline at end of file +.. minimize-flooding-begin +.. minimize-flooding-end \ No newline at end of file diff --git a/doc/source/_includes/standard-virtio-backed-with-vhost-support.rest b/doc/source/_includes/standard-virtio-backed-with-vhost-support.rest index e69de29bb..1287341dd 100644 --- a/doc/source/_includes/standard-virtio-backed-with-vhost-support.rest +++ b/doc/source/_includes/standard-virtio-backed-with-vhost-support.rest @@ -0,0 +1,2 @@ +.. virtio-begin +.. virtio-end \ No newline at end of file diff --git a/doc/source/_includes/using-labels-to-identify-openstack-nodes.rest b/doc/source/_includes/using-labels-to-identify-openstack-nodes.rest index e69de29bb..3bb1f84ce 100644 --- a/doc/source/_includes/using-labels-to-identify-openstack-nodes.rest +++ b/doc/source/_includes/using-labels-to-identify-openstack-nodes.rest @@ -0,0 +1,5 @@ +.. table-1-of-contents-begin +.. table-1-of-contents-end + +.. assign-kube-labels-begin +.. assign-kube-labels-end \ No newline at end of file diff --git a/doc/source/_includes/verified-commercial-hardware.rest b/doc/source/_includes/verified-commercial-hardware.rest index 62f502707..e69de29bb 100644 --- a/doc/source/_includes/verified-commercial-hardware.rest +++ b/doc/source/_includes/verified-commercial-hardware.rest @@ -1,2 +0,0 @@ -.. [#] See |datanet-doc| for addtional information. -.. [#] PCI passthrough support for Mellanox CX3 is deprecated. diff --git a/doc/source/_includes/vm-network-interface-options.rest b/doc/source/_includes/vm-network-interface-options.rest index 20dd7c4b3..deca9683e 100755 --- a/doc/source/_includes/vm-network-interface-options.rest +++ b/doc/source/_includes/vm-network-interface-options.rest @@ -1,2 +1,5 @@ .. unmodified-guests-virtio-begin +.. unmodified-guests-virtio-end + .. highest-performance-begin +.. highest-performance-end \ No newline at end of file diff --git a/doc/source/datanet/openstack/data-networks-overview.rst b/doc/source/datanet/openstack/data-networks-overview.rst index a13c8d534..cc3966b14 100644 --- a/doc/source/datanet/openstack/data-networks-overview.rst +++ b/doc/source/datanet/openstack/data-networks-overview.rst @@ -66,3 +66,5 @@ OpenStack Neutron commands, see :ref:`Adding Segmentation Ranges Using the CLI .. only:: partner .. include:: /_includes/data-networks-overview.rest + :start-after: data-network-begin + :end-before: data-network-end diff --git a/doc/source/guest_integration/openstack/standard-virtio-backed-with-vhost-support.rst b/doc/source/guest_integration/openstack/standard-virtio-backed-with-vhost-support.rst index f31487705..2f3c0dc8f 100644 --- a/doc/source/guest_integration/openstack/standard-virtio-backed-with-vhost-support.rst +++ b/doc/source/guest_integration/openstack/standard-virtio-backed-with-vhost-support.rst @@ -17,5 +17,7 @@ For virtio interfaces, |prod-os| supports vhost-user transparently by default. .. only:: partner .. include:: /_includes/standard-virtio-backed-with-vhost-support.rest + :start-after: virtio-begin + :end-before: virtio-end .. end-content diff --git a/doc/source/node_management/kubernetes/host_memory_provisioning/about-host-memory-provisioning.rst b/doc/source/node_management/kubernetes/host_memory_provisioning/about-host-memory-provisioning.rst index 55432247b..176bbdc49 100644 --- a/doc/source/node_management/kubernetes/host_memory_provisioning/about-host-memory-provisioning.rst +++ b/doc/source/node_management/kubernetes/host_memory_provisioning/about-host-memory-provisioning.rst @@ -52,9 +52,4 @@ available for applications. This information is also shown on the **Memory** tab of the Host Inventory page (see :ref:`Memory Tab `). For individual containers (or hosted applications if you are running -OpenStack), you can specify which page size is required. - -.. only:: partner - - .. include:: /_includes/about-host-memory-provisioning.rest - :start-after: memory-text-end \ No newline at end of file +OpenStack), you can specify which page size is required. \ No newline at end of file diff --git a/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst b/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst index 7b7243228..d84bb65b5 100644 --- a/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst +++ b/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst @@ -12,10 +12,6 @@ Allocate Host Memory Using Horizon |NUMA| node from the Horizon Web interface using the **Memory** tab on the Host Inventory pane. -.. only:: partner - - .. include:: /_includes/avs-note.rest - Due to limitations in Kubernetes, only a single huge page size can be used per host. @@ -127,9 +123,4 @@ from the available memory, an informative message is displayed. #. Click **Save**. -#. Unlock the host and wait for it to be reported as **Available**. - -.. only:: partner - - .. include:: /_includes/avs-note.rest - +#. Unlock the host and wait for it to be reported as **Available**. \ No newline at end of file diff --git a/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-the-cli.rst b/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-the-cli.rst index 2d76881c5..d3ad6fed8 100644 --- a/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-the-cli.rst +++ b/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-the-cli.rst @@ -227,8 +227,4 @@ worker or an |AIO| controller. | 1 | controller-0 | controller | unlocked | enabled | available | | 2 | controller-1 | controller | unlocked | enabled | available | | 3 | worker-0 | worker | unlocked | enabled | available | - +----+--------------+-------------+----------------+-------------+--------------+ - -.. only:: partner - - .. include:: /_includes/avs-note.rest + +----+--------------+-------------+----------------+-------------+--------------+ \ No newline at end of file diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst index b34a612f4..37e0c2250 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst @@ -65,8 +65,4 @@ for different types of interface, see :ref:`Interface Settings .. rubric:: |result| -The interface is created and attached to the network. - -.. only:: partner - - .. include:: /_includes/configuring-aggregated-ethernet-interfaces-using-horizon.rest +The interface is created and attached to the network. \ No newline at end of file diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst index c80fe7903..8fa16cc5f 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst @@ -11,10 +11,6 @@ Ethernet interfaces to networks. |prod| supports up to four ports in a |LAG|. -.. only:: partner - - /_includes/configuring-aggregated-ethernet-interfaces-using-the-cli.rest - For more about link aggregation modes and policies, see :ref:`Link Aggregation Settings `. diff --git a/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst b/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst index 5c09a46c3..8d0f96392 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst @@ -119,10 +119,6 @@ For more information, see :ref:`Provision SR-IOV Interfaces using the CLI interface differ, a separate data network should be created for each interface. - .. only:: partner - - .. include:: /_includes/provisioning-sr-iov-vf-interfaces-using-the-cli.rest - **networks** A list of data networks that are attached to the interface, delimited by quotes and separated by commas; for example, diff --git a/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst b/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst index 3ddc95231..8e6f2d447 100644 --- a/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst +++ b/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst @@ -25,9 +25,8 @@ taken into consideration. They include: .. only:: partner .. include:: /_includes/pci-passthrough-ethernet-interface-devices.rest - - :start-after: avs-bullet-3-begin - :end-before: avs-bullet-3-end + :start-after: avs-bullet-3-begin + :end-before: avs-bullet-3-end .. only:: starlingx @@ -40,9 +39,8 @@ taken into consideration. They include: .. only:: partner .. include:: /_includes/pci-passthrough-ethernet-interface-devices.rest - - :start-after: avs-text-begin - :end-before: avs-text-end + :start-after: avs-text-begin + :end-before: avs-text-end The access switch routes incoming traffic based on a |VLAN| ID, which ultimately diff --git a/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst b/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst index 14e84cee0..0625c0f51 100644 --- a/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst +++ b/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst @@ -93,5 +93,5 @@ Nodes must be locked before labels can be assigned or removed. .. only:: partner .. include:: /_includes/using-labels-to-identify-openstack-nodes.rest - - :start-after: table-1-of-contents-end + :start-after: assign-kube-labels-begin + :end-before: assign-kube-labels-end diff --git a/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst b/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst index 12cffd777..898438c19 100755 --- a/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst +++ b/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst @@ -96,6 +96,4 @@ refer to https://www.windriver.com/certified. .. seealso:: - :ref:`Kubernetes Verified Commercial Hardware ` - -.. include:: /_includes/installation-and-resource-planning-verified-commercial-hardware.rest + :ref:`Kubernetes Verified Commercial Hardware ` \ No newline at end of file diff --git a/doc/source/planning/openstack/os-data-networks-overview.rst b/doc/source/planning/openstack/os-data-networks-overview.rst index c5d459f55..fad0d24da 100755 --- a/doc/source/planning/openstack/os-data-networks-overview.rst +++ b/doc/source/planning/openstack/os-data-networks-overview.rst @@ -41,3 +41,5 @@ see the |datanet-doc| documentation: .. only:: partner .. include:: /_includes/os-data-networks-overview.rest + :start-after: os-data-network-begin + :end-before: os-data-network-end diff --git a/doc/source/planning/openstack/port-security-extension.rst b/doc/source/planning/openstack/port-security-extension.rst index 8b808fc3d..dfd0e6dc1 100755 --- a/doc/source/planning/openstack/port-security-extension.rst +++ b/doc/source/planning/openstack/port-security-extension.rst @@ -25,3 +25,5 @@ By default, the port security extension driver is disabled. .. only:: partner .. include:: /_includes/port-security-extension.rest + :start-after: port-security-begin + :end-before: port-security-end \ No newline at end of file diff --git a/doc/source/planning/openstack/project-network-planning.rst b/doc/source/planning/openstack/project-network-planning.rst index 60f6c0cca..43fc6c507 100755 --- a/doc/source/planning/openstack/project-network-planning.rst +++ b/doc/source/planning/openstack/project-network-planning.rst @@ -11,3 +11,5 @@ network planning on an |prod-os| system can take advantage of extended capabilities offered by |prod-os|. .. include:: /_includes/project-network-planning.rest + :start-after: capabilities-begin + :end-before: capabilities-end diff --git a/doc/source/planning/openstack/project-networks.rst b/doc/source/planning/openstack/project-networks.rst index 0b6c0398c..5f2517ed0 100755 --- a/doc/source/planning/openstack/project-networks.rst +++ b/doc/source/planning/openstack/project-networks.rst @@ -29,8 +29,8 @@ For data networks of the |VLAN| type, consider the following guidelines: .. only:: partner .. include:: /_includes/project-networks.rest - :start-after: vlan-begin - :end-before: vxlan-begin + :start-after: vlan-begin + :end-before: vlan-end - Configuring a project network to have access to external networks (not just providing local networking) requires the following elements: @@ -57,8 +57,16 @@ For data networks of the |VXLAN| type, consider the following guidelines: - Layer 3 routers used to interconnect compute nodes must be multicast-enabled, as required by the |VXLAN| protocol. -.. include:: /_includes/project-networks.rest - :start-after: vxlan-begin +.. only:: partner + + .. include:: /_includes/project-networks.rest + :start-after: minimize-flooding-begin + :end-before: minimize-flooding-end + +.. only:: starlingx + + - To minimize flooding of multicast packets, |IGMP| and |MLD| snooping is + recommended on all Layer 2 switches. - To support |IGMP| and |MLD| snooping, Layer 3 routers must be configured for |IGMP| and |MLD| querying. diff --git a/doc/source/planning/openstack/the-ethernet-mtu.rst b/doc/source/planning/openstack/the-ethernet-mtu.rst index 9be534de5..356d0d7fd 100755 --- a/doc/source/planning/openstack/the-ethernet-mtu.rst +++ b/doc/source/planning/openstack/the-ethernet-mtu.rst @@ -100,8 +100,4 @@ default |MTU| size: - The Neutron |DHCP| agent makes the option interface-mtu available to any |DHCP| client request from a virtual machine. The request response from the server is the current interface's |MTU| size, which can then be used by the - client to adjust its own interface |MTU| size. - -.. .. only:: partner - -.. include:: /_includes/the-ethernet-mtu.rest + client to adjust its own interface |MTU| size. \ No newline at end of file diff --git a/doc/source/planning/openstack/vm-network-interface-options.rst b/doc/source/planning/openstack/vm-network-interface-options.rst index 7acd96978..6b0f7b45f 100755 --- a/doc/source/planning/openstack/vm-network-interface-options.rst +++ b/doc/source/planning/openstack/vm-network-interface-options.rst @@ -19,7 +19,7 @@ interface drivers in addition to the standard OpenStack choices. .. include:: /_includes/vm-network-interface-options.rest :start-after: unmodified-guests-virtio-begin - :end-before: highest-performance-begin + :end-before: unmodified-guests-virtio-end .. note:: The virtio devices on a |VM| cannot use vhost-user for enhanced @@ -35,7 +35,8 @@ interface drivers in addition to the standard OpenStack choices. .. only:: partner .. include:: /_includes/vm-network-interface-options.rest - :start-after: highest-performance-begin + :start-after: highest-performance-begin + :end-before: highest-performance-end .. xbooklink For more information about |AVP| drivers, see OpenStack VNF Integration: :ref:`Accelerated Virtual Interfaces `.