Merge "doc: merge numa.rst to cpu-topologies.rst"

doc/source/_extra/.htaccess

@@ -7,6 +7,7 @@
 
 redirectmatch 301 ^/nova/([^/]+)/addmethod.openstackapi.html$ /nova/$1/contributor/api-2.html
 redirectmatch 301 ^/nova/([^/]+)/admin/flavors2.html$ /nova/$1/admin/flavors.html
+redirectmatch 301 ^/nova/([^/]+)/admin/numa.html$ /nova/$1/admin/cpu-topologies.html
 redirectmatch 301 ^/nova/([^/]+)/aggregates.html$ /nova/$1/user/aggregates.html
 redirectmatch 301 ^/nova/([^/]+)/api_microversion_dev.html$ /nova/$1/contributor/microversions.html
 redirectmatch 301 ^/nova/([^/]+)/api_microversion_history.html$ /nova/$1/reference/api-microversion-history.html

doc/source/admin/cpu-topologies.rst

@@ -96,12 +96,28 @@ also should be local. Finally, PCI devices are directly associated with
 specific NUMA nodes for the purposes of DMA. Instances that use PCI or SR-IOV
 devices should be placed on the NUMA node associated with these devices.
 
+NUMA topology can exist on both the physical hardware of the host and the
+virtual hardware of the instance. In OpenStack, when booting a process, the
+hypervisor driver looks at the NUMA topology field of both the instance and
+the host it is being booted on, and uses that information to generate an
+appropriate configuration.
+
 By default, an instance floats across all NUMA nodes on a host. NUMA awareness
 can be enabled implicitly through the use of huge pages or pinned CPUs or
-explicitly through the use of flavor extra specs or image metadata.  In all
+explicitly through the use of flavor extra specs or image metadata. If the
-cases, the ``NUMATopologyFilter`` filter must be enabled. Details on this
+instance has requested a specific NUMA topology, compute will try to pin the
-filter are provided in :doc:`/admin/configuration/schedulers` in Nova
+vCPUs of different NUMA cells on the instance to the corresponding NUMA cells
-configuration guide.
+on the host. It will also expose the NUMA topology of the instance to the
+guest OS.
+
+If you want compute to pin a particular vCPU as part of this process,
+set the ``vcpu_pin_set`` parameter in the ``nova.conf`` configuration
+file. For more information about the ``vcpu_pin_set`` parameter, see the
+:doc:`/configuration/config`.
+
+In all cases where NUMA awareness is used, the ``NUMATopologyFilter``
+filter must be enabled. Details on this filter are provided in
+:doc:`/admin/configuration/schedulers`.
 
 .. caution::
 

doc/source/admin/index.rst

@@ -32,7 +32,6 @@ operating system, and exposes functionality over a web-based API.
    migration.rst
    networking-nova.rst
    node-down.rst
-   numa.rst
    pci-passthrough.rst
    quotas2.rst
    quotas.rst

doc/source/admin/numa.rst

@@ -1,26 +0,0 @@
-=============================================
-Consider NUMA topology when booting instances
-=============================================
-
-.. todo:: Merge this into 'cpu-topologies.rst'
-
-NUMA topology can exist on both the physical hardware of the host, and the
-virtual hardware of the instance. OpenStack Compute uses libvirt to tune
-instances to take advantage of NUMA topologies. The libvirt driver boot
-process looks at the NUMA topology field of both the instance and the host it
-is being booted on, and uses that information to generate an appropriate
-configuration.
-
-If the host is NUMA capable, but the instance has not requested a NUMA
-topology, Compute attempts to pack the instance into a single cell.
-If this fails, though, Compute will not continue to try.
-
-If the host is NUMA capable, and the instance has requested a specific NUMA
-topology, Compute will try to pin the vCPUs of different NUMA cells
-on the instance to the corresponding NUMA cells on the host. It will also
-expose the NUMA topology of the instance to the guest OS.
-
-If you want Compute to pin a particular vCPU as part of this process,
-set the ``vcpu_pin_set`` parameter in the ``nova.conf`` configuration
-file. For more information about the ``vcpu_pin_set`` parameter, see the
-Configuration Reference Guide.

doc/test/redirect-tests.txt

@@ -1,5 +1,6 @@
 /nova/latest/addmethod.openstackapi.html 301 /nova/latest/contributor/api-2.html
 /nova/latest/admin/flavors2.html 301 /nova/latest/admin/flavors.html
+/nova/latest/admin/numa.html 301 /nova/latest/admin/cpu-topologies.html
 /nova/latest/aggregates.html 301 /nova/latest/user/aggregates.html
 /nova/latest/api_microversion_dev.html 301 /nova/latest/contributor/microversions.html
 /nova/latest/api_microversion_history.html 301 /nova/latest/reference/api-microversion-history.html