summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-02-13 21:30:36 +0000
committerGerrit Code Review <review@openstack.org>2018-02-13 21:30:36 +0000
commit42b220803a25f6a13220447badc96687e4b2979e (patch)
tree8759825166ea3779a6f64772b56efa7b0f8b9951
parentdbdb6213cbfc23210c6a7b7b8bdb18de0de5e017 (diff)
parent7ecd7e6e331221e0390da5cb1ea041b05283ef49 (diff)
Merge "doc: merge numa.rst to cpu-topologies.rst"
-rw-r--r--doc/source/_extra/.htaccess1
-rw-r--r--doc/source/admin/cpu-topologies.rst24
-rw-r--r--doc/source/admin/index.rst1
-rw-r--r--doc/source/admin/numa.rst26
-rw-r--r--doc/test/redirect-tests.txt1
5 files changed, 22 insertions, 31 deletions
diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess
index f142f89..24cbe59 100644
--- a/doc/source/_extra/.htaccess
+++ b/doc/source/_extra/.htaccess
@@ -7,6 +7,7 @@
7 7
8redirectmatch 301 ^/nova/([^/]+)/addmethod.openstackapi.html$ /nova/$1/contributor/api-2.html 8redirectmatch 301 ^/nova/([^/]+)/addmethod.openstackapi.html$ /nova/$1/contributor/api-2.html
9redirectmatch 301 ^/nova/([^/]+)/admin/flavors2.html$ /nova/$1/admin/flavors.html 9redirectmatch 301 ^/nova/([^/]+)/admin/flavors2.html$ /nova/$1/admin/flavors.html
10redirectmatch 301 ^/nova/([^/]+)/admin/numa.html$ /nova/$1/admin/cpu-topologies.html
10redirectmatch 301 ^/nova/([^/]+)/aggregates.html$ /nova/$1/user/aggregates.html 11redirectmatch 301 ^/nova/([^/]+)/aggregates.html$ /nova/$1/user/aggregates.html
11redirectmatch 301 ^/nova/([^/]+)/api_microversion_dev.html$ /nova/$1/contributor/microversions.html 12redirectmatch 301 ^/nova/([^/]+)/api_microversion_dev.html$ /nova/$1/contributor/microversions.html
12redirectmatch 301 ^/nova/([^/]+)/api_microversion_history.html$ /nova/$1/reference/api-microversion-history.html 13redirectmatch 301 ^/nova/([^/]+)/api_microversion_history.html$ /nova/$1/reference/api-microversion-history.html
diff --git a/doc/source/admin/cpu-topologies.rst b/doc/source/admin/cpu-topologies.rst
index e3c60d4..aec245f 100644
--- a/doc/source/admin/cpu-topologies.rst
+++ b/doc/source/admin/cpu-topologies.rst
@@ -96,12 +96,28 @@ also should be local. Finally, PCI devices are directly associated with
96specific NUMA nodes for the purposes of DMA. Instances that use PCI or SR-IOV 96specific NUMA nodes for the purposes of DMA. Instances that use PCI or SR-IOV
97devices should be placed on the NUMA node associated with these devices. 97devices should be placed on the NUMA node associated with these devices.
98 98
99NUMA topology can exist on both the physical hardware of the host and the
100virtual hardware of the instance. In OpenStack, when booting a process, the
101hypervisor driver looks at the NUMA topology field of both the instance and
102the host it is being booted on, and uses that information to generate an
103appropriate configuration.
104
99By default, an instance floats across all NUMA nodes on a host. NUMA awareness 105By default, an instance floats across all NUMA nodes on a host. NUMA awareness
100can be enabled implicitly through the use of huge pages or pinned CPUs or 106can be enabled implicitly through the use of huge pages or pinned CPUs or
101explicitly through the use of flavor extra specs or image metadata. In all 107explicitly through the use of flavor extra specs or image metadata. If the
102cases, the ``NUMATopologyFilter`` filter must be enabled. Details on this 108instance has requested a specific NUMA topology, compute will try to pin the
103filter are provided in :doc:`/admin/configuration/schedulers` in Nova 109vCPUs of different NUMA cells on the instance to the corresponding NUMA cells
104configuration guide. 110on the host. It will also expose the NUMA topology of the instance to the
111guest OS.
112
113If you want compute to pin a particular vCPU as part of this process,
114set the ``vcpu_pin_set`` parameter in the ``nova.conf`` configuration
115file. For more information about the ``vcpu_pin_set`` parameter, see the
116:doc:`/configuration/config`.
117
118In all cases where NUMA awareness is used, the ``NUMATopologyFilter``
119filter must be enabled. Details on this filter are provided in
120:doc:`/admin/configuration/schedulers`.
105 121
106.. caution:: 122.. caution::
107 123
diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst
index 831252d..01a7775 100644
--- a/doc/source/admin/index.rst
+++ b/doc/source/admin/index.rst
@@ -32,7 +32,6 @@ operating system, and exposes functionality over a web-based API.
32 migration.rst 32 migration.rst
33 networking-nova.rst 33 networking-nova.rst
34 node-down.rst 34 node-down.rst
35 numa.rst
36 pci-passthrough.rst 35 pci-passthrough.rst
37 quotas2.rst 36 quotas2.rst
38 quotas.rst 37 quotas.rst
diff --git a/doc/source/admin/numa.rst b/doc/source/admin/numa.rst
deleted file mode 100644
index 2118738..0000000
--- a/doc/source/admin/numa.rst
+++ /dev/null
@@ -1,26 +0,0 @@
1=============================================
2Consider NUMA topology when booting instances
3=============================================
4
5.. todo:: Merge this into 'cpu-topologies.rst'
6
7NUMA topology can exist on both the physical hardware of the host, and the
8virtual hardware of the instance. OpenStack Compute uses libvirt to tune
9instances to take advantage of NUMA topologies. The libvirt driver boot
10process looks at the NUMA topology field of both the instance and the host it
11is being booted on, and uses that information to generate an appropriate
12configuration.
13
14If the host is NUMA capable, but the instance has not requested a NUMA
15topology, Compute attempts to pack the instance into a single cell.
16If this fails, though, Compute will not continue to try.
17
18If the host is NUMA capable, and the instance has requested a specific NUMA
19topology, Compute will try to pin the vCPUs of different NUMA cells
20on the instance to the corresponding NUMA cells on the host. It will also
21expose the NUMA topology of the instance to the guest OS.
22
23If you want Compute to pin a particular vCPU as part of this process,
24set the ``vcpu_pin_set`` parameter in the ``nova.conf`` configuration
25file. For more information about the ``vcpu_pin_set`` parameter, see the
26Configuration Reference Guide.
diff --git a/doc/test/redirect-tests.txt b/doc/test/redirect-tests.txt
index 4393dd1..3cfcf82 100644
--- a/doc/test/redirect-tests.txt
+++ b/doc/test/redirect-tests.txt
@@ -1,5 +1,6 @@
1/nova/latest/addmethod.openstackapi.html 301 /nova/latest/contributor/api-2.html 1/nova/latest/addmethod.openstackapi.html 301 /nova/latest/contributor/api-2.html
2/nova/latest/admin/flavors2.html 301 /nova/latest/admin/flavors.html 2/nova/latest/admin/flavors2.html 301 /nova/latest/admin/flavors.html
3/nova/latest/admin/numa.html 301 /nova/latest/admin/cpu-topologies.html
3/nova/latest/aggregates.html 301 /nova/latest/user/aggregates.html 4/nova/latest/aggregates.html 301 /nova/latest/user/aggregates.html
4/nova/latest/api_microversion_dev.html 301 /nova/latest/contributor/microversions.html 5/nova/latest/api_microversion_dev.html 301 /nova/latest/contributor/microversions.html
5/nova/latest/api_microversion_history.html 301 /nova/latest/reference/api-microversion-history.html 6/nova/latest/api_microversion_history.html 301 /nova/latest/reference/api-microversion-history.html