summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorWang Huaqiang <huaqiang.wang@intel.com>2020-05-15 19:42:31 +0800
committerWang Huaqiang <huaqiang.wang@intel.com>2020-07-21 15:18:41 +0800
commit275ea2de368629485ba6e9a5159300d3b9232ed4 (patch)
treec7014462af39f952d2d35fbf1f787ee6453b1da7 /doc/source
parent5c71ac5e02acfbcc45f904a359a02d2a204e709e (diff)
downloadnova-275ea2de368629485ba6e9a5159300d3b9232ed4.tar.gz
hardware: create 'mixed' instance for realtime CPUs
Before, realtime CPUs could only be combined with dedicated CPUs in a 'dedicated' policy instance. This patch supports to create a type of instance that makes realtime CPUs be mixed with shared CPUs under the 'mixed' CPU allocation policy. Part of blueprint use-pcpu-and-vcpu-in-one-instance Change-Id: Iad7864bf375341ef065bfec229a059e444c910e2 Signed-off-by: Wang Huaqiang <huaqiang.wang@intel.com>
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/admin/cpu-topologies.rst26
-rw-r--r--doc/source/user/flavors.rst3
2 files changed, 20 insertions, 9 deletions
diff --git a/doc/source/admin/cpu-topologies.rst b/doc/source/admin/cpu-topologies.rst
index fdb2d7b59e..07d8e400d9 100644
--- a/doc/source/admin/cpu-topologies.rst
+++ b/doc/source/admin/cpu-topologies.rst
@@ -221,10 +221,12 @@ use pinned CPUs. To configure a flavor to use the ``shared`` CPU policy, run:
$ openstack flavor set [FLAVOR_ID] --property hw:cpu_policy=shared
The ``mixed`` CPU policy is used to specify that an instance use pinned CPUs
-along with unpinned CPUs. The instance pinned CPU is specified in the
-``hw:cpu_dedicated_mask`` extra spec. For example, to configure a flavor to
-use the ``mixed`` CPU policy with 4 vCPUs in total and the first 2 vCPUs as
-pinned CPUs:
+along with unpinned CPUs. The instance pinned CPU could be specified in the
+``hw:cpu_dedicated_mask`` or, if real-time is enabled
+(``hw:cpu_realtime``\ = yes), in the ``hw:cpu_realtime_mask`` extra spec. For
+example, to configure a flavor to use the ``mixed`` CPU policy with 4 vCPUs in
+total and the first 2 vCPUs as pinned CPUs, with the ``hw:cpu_realtime_mask``
+extra spec, run:
.. code-block:: console
@@ -233,13 +235,21 @@ pinned CPUs:
--property hw:cpu_policy=mixed \
--property hw:cpu_dedicated_mask=0-1
-For more information about the syntax for ``hw:cpu_dedicated_mask``, refer
-to the :doc:`/user/flavors` guide.
+To create the mixed instance with the real-time extra specs, run:
+
+.. code-block:: console
+
+ $ openstack flavor set [FLAVOR_ID] \
+ --vcpus=4 \
+ --property hw:cpu_policy=mixed \
+ --property hw:cpu_realtime=yes \
+ --property hw:cpu_realtime_mask=0-1
.. note::
- For more information about the syntax for ``hw:cpu_policy``, refer to the
- :doc:`/admin/flavors` guide.
+ For more information about the syntax for ``hw:cpu_policy``,
+ ``hw:cpu_dedicated_mask``, ``hw:realtime_cpu`` and ``hw:cpu_realtime_mask``,
+ refer to the :doc:`/user/flavors` guide.
It is also possible to configure the CPU policy via image metadata. This can
be useful when packaging applications that require real-time or near real-time
diff --git a/doc/source/user/flavors.rst b/doc/source/user/flavors.rst
index 55b976b815..8faea47eaa 100644
--- a/doc/source/user/flavors.rst
+++ b/doc/source/user/flavors.rst
@@ -467,7 +467,8 @@ CPU pinning policy
.. note::
The ``hw:cpu_dedicated_mask`` option is only valid if ``hw:cpu_policy``
- is set to ``mixed``.
+ is set to ``mixed`` and cannot be configured with ``hw:cpu_realtime_mask``
+ at the same time.
Valid CPU-THREAD-POLICY values are: