openstack
/
nova
Code Issues Proposed changes

Merge "docs: Clarify value for 'hw:cpu_realtime' extra spec"

This commit is contained in:
Zuul 2021-03-31 07:23:55 +00:00 committed by Gerrit Code Review
parent 16074287c0 e89125a422
commit fbcfc3e544
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/admin/real-time.rst
View File

@ -74,9 +74,8 @@ Configuring a flavor or image
.. versionchanged:: 22.0.0 (Victoria) .. versionchanged:: 22.0.0 (Victoria)
Previously, it was necessary to specify Previously, it was necessary to specify
:nova:extra-spec:`hw:cpu_realtime_mask` when :nova:extra-spec:`hw:cpu_realtime_mask` when realtime mode was enabled via
:nova:extra-spec:`hw:cpu_realtime` was set to ``true``. :nova:extra-spec:`hw:cpu_realtime`. Starting in Victoria, it is possible
Starting in Victoria, it is possible
to omit this when an emulator thread policy is configured using the to omit this when an emulator thread policy is configured using the
:nova:extra-spec:`hw:emulator_threads_policy` extra spec, thus allowing all :nova:extra-spec:`hw:emulator_threads_policy` extra spec, thus allowing all
guest cores to be be allocated as real-time cores. guest cores to be be allocated as real-time cores.
@ -92,14 +91,14 @@ and merely requires a combination of flavor extra specs and image metadata
properties, along with a suitable real-time guest OS. properties, along with a suitable real-time guest OS.
Enable real-time by setting the :nova:extra-spec:`hw:cpu_realtime` flavor extra Enable real-time by setting the :nova:extra-spec:`hw:cpu_realtime` flavor extra
spec to ``true``. When this is configured, it is necessary to specify where spec to ``yes`` or a truthy value. When this is configured, it is necessary to
guest overhead processes should be scheduled to. This can be accomplished in specify where guest overhead processes should be scheduled to. This can be
one of three ways. Firstly, the :nova:extra-spec:`hw:cpu_realtime_mask` extra accomplished in one of three ways. Firstly, the
spec or equivalent image metadata property can be used to indicate which guest :nova:extra-spec:`hw:cpu_realtime_mask` extra spec or equivalent image metadata
cores should be scheduled as real-time cores, leaving the remainder to be property can be used to indicate which guest cores should be scheduled as
scheduled as non-real-time cores and to handle overhead processes. For example, real-time cores, leaving the remainder to be scheduled as non-real-time cores
to allocate the first two cores of an 8 core instance as the non-real-time and to handle overhead processes. For example, to allocate the first two cores
cores: of an 8 core instance as the non-real-time cores:
.. code-block:: console .. code-block:: console