Node Mgmt _include fixes
Include statement formatting corrected and added start-before, end-after labels to include files. Updates for patchset 1. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0b2cd72197111ec2c64914dbd2af44aafaedd43d Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
parent
37ef706610
commit
fa52950fba
@ -0,0 +1,6 @@
|
||||
.. introduction-text-begin
|
||||
.. introduction-text-end
|
||||
|
||||
.. memory-text-begin
|
||||
.. memory-text-end
|
||||
|
@ -0,0 +1,15 @@
|
||||
.. limitation-text-begin
|
||||
.. limitation-text-end
|
||||
|
||||
.. application-2m-text-begin
|
||||
.. application-2m-text-end
|
||||
|
||||
.. application-1g-text-begin
|
||||
.. application-1g-text-end
|
||||
|
||||
.. vswitch-hugepage-1g-text-begin
|
||||
.. vswitch-hugepage-1g-text-end
|
||||
|
||||
.. vswitch-hugepage-size-node-text-begin
|
||||
.. vswitch-hugepage-size-node-text-end
|
||||
|
@ -0,0 +1,20 @@
|
||||
.. introduction-text-begin
|
||||
.. introduction-text-end
|
||||
|
||||
.. function-text-begin
|
||||
.. function-text-end
|
||||
|
||||
.. memory-table-begin
|
||||
.. memory-table-end
|
||||
|
||||
.. usage-text-begin
|
||||
.. usage-text-end
|
||||
|
||||
.. 2m-pages-text-begin
|
||||
.. 2m-pages-text-end
|
||||
|
||||
.. 1g-pages-text-begin
|
||||
.. 1g-pages-text-end
|
||||
|
||||
.. recommended-size-text-begin
|
||||
.. recommended-size-text-end
|
@ -0,0 +1,5 @@
|
||||
.. introduction-text-begin
|
||||
.. introduction-text-end
|
||||
|
||||
.. usage-text-begin
|
||||
.. usage-text-end
|
@ -14,10 +14,9 @@ About Host Memory Provisioning
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/about-host-memory-provisioning.rest
|
||||
|
||||
:start-after: introduction-text-begin
|
||||
:end-before: introduction-text-end
|
||||
.. include:: /_includes/about-host-memory-provisioning.rest
|
||||
:start-after: introduction-text-begin
|
||||
:end-before: introduction-text-end
|
||||
|
||||
Due to limitations in Kubernetes, only a single huge page size can be used
|
||||
per host.
|
||||
@ -43,10 +42,9 @@ configurations.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/about-host-memory-provisioning.rest
|
||||
|
||||
:start-after: memory-text-begin
|
||||
:end-before: memory-text-end
|
||||
.. include:: /_includes/about-host-memory-provisioning.rest
|
||||
:start-after: memory-text-begin
|
||||
:end-before: memory-text-end
|
||||
|
||||
You can use the :command:`system host-memory-list` and
|
||||
:command:`system host-memory-show` commands to see how much memory is
|
||||
@ -58,6 +56,5 @@ OpenStack\), you can specify which page size is required.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/about-host-memory-provisioning.rest
|
||||
|
||||
:start-after: memory-text-end
|
||||
.. include:: /_includes/about-host-memory-provisioning.rest
|
||||
:start-after: memory-text-end
|
@ -14,10 +14,9 @@ Allocate Host Memory Using Horizon
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/avs-note.rest
|
||||
|
||||
:start-after: introduction-text-begin
|
||||
:end-before: introduction-text-end
|
||||
.. include:: /_includes/avs-note.rest
|
||||
:start-after: introduction-text-begin
|
||||
:end-before: introduction-text-end
|
||||
|
||||
Due to limitations in Kubernetes, only a single huge page size can be used
|
||||
per host.
|
||||
@ -28,10 +27,9 @@ per host.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/avs-note.rest
|
||||
|
||||
:start-after: usage-text-begin
|
||||
:end-before: usage-text-end
|
||||
.. include:: /_includes/avs-note.rest
|
||||
:start-after: usage-text-begin
|
||||
:end-before: usage-text-end
|
||||
|
||||
You must also provision one 1GiB huge page per |NUMA| node prior to unlocking a
|
||||
worker or an |AIO| controller.
|
||||
@ -39,10 +37,9 @@ worker or an |AIO| controller.
|
||||
.. rubric:: |prereq|
|
||||
|
||||
Before requesting huge pages on a host, ensure that the host has enough
|
||||
available memory. For details,
|
||||
see :ref:`About Host Memory Provisioning <about-host-memory-provisioning>`.
|
||||
If a huge page request cannot be allocated from the available memory, an
|
||||
informative message is displayed.
|
||||
available memory. For details, see :ref:`About Host Memory Provisioning
|
||||
<about-host-memory-provisioning>`. If a huge page request cannot be allocated
|
||||
from the available memory, an informative message is displayed.
|
||||
|
||||
.. rubric:: |proc|
|
||||
|
||||
@ -58,22 +55,22 @@ informative message is displayed.
|
||||
#. Use the Update Memory Allocation dialog box to set the memory allocations
|
||||
for each |NUMA| node.
|
||||
|
||||
.. only:: starlingx
|
||||
.. only:: starlingx
|
||||
|
||||
For each available |NUMA| node, five fields are available, as illustrated
|
||||
in the following example screen for two |NUMA| nodes. Due to limitations
|
||||
in Kubernetes, only a single huge page size can be used per host, across
|
||||
Application memory.
|
||||
For each available |NUMA| node, five fields are available, as illustrated
|
||||
in the following example screen for two |NUMA| nodes. Due to limitations
|
||||
in Kubernetes, only a single huge page size can be used per host, across
|
||||
Application memory.
|
||||
|
||||
.. only:: partner
|
||||
.. figure:: ../figures/yfv1567176747837.png
|
||||
:scale: 100%
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
|
||||
.. only:: partner
|
||||
|
||||
:start-after: limitation-text-begin
|
||||
:end-before: limitation-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-horizon.rest
|
||||
:start-after: limitation-text-begin
|
||||
:end-before: limitation-text-end
|
||||
|
||||
.. figure:: ../figures/yfv1567176747837.png
|
||||
:scale: 100%
|
||||
|
||||
**Platform Memory for Node n**
|
||||
The amount of memory to reserve for platform use on the
|
||||
@ -95,10 +92,9 @@ informative message is displayed.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
|
||||
|
||||
:start-after: application-2m-text-begin
|
||||
:end-before: application-2m-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-horizon.rest
|
||||
:start-after: application-2m-text-begin
|
||||
:end-before: application-2m-text-end
|
||||
|
||||
**\# of Application 1G Hugepages Node n**
|
||||
|
||||
@ -111,24 +107,21 @@ informative message is displayed.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
|
||||
|
||||
:start-after: application-1g-text-begin
|
||||
:end-before: application-1g-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-horizon.rest
|
||||
:start-after: application-1g-text-begin
|
||||
:end-before: application-1g-text-end
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
|
||||
|
||||
:start-after: vswitch-hugepage-1g-text-begin
|
||||
:end-before: vswitch-hugepage-1g-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-horizon.rest
|
||||
:start-after: vswitch-hugepage-1g-text-begin
|
||||
:end-before: vswitch-hugepage-1g-text-end
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
|
||||
|
||||
:start-after: vswitch-hugepage-size-node-text-begin
|
||||
:end-before: vswitch-hugepage-size-node-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-horizon.rest
|
||||
:start-after: vswitch-hugepage-size-node-text-begin
|
||||
:end-before: vswitch-hugepage-size-node-text-end
|
||||
|
||||
To see how many huge pages of a given size you can successfully request
|
||||
on a node \(assuming that pages of another size are not also requested\),
|
||||
@ -146,5 +139,5 @@ informative message is displayed.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/avs-note.rest
|
||||
.. include:: /_includes/avs-note.rest
|
||||
|
||||
|
@ -13,10 +13,9 @@ Allocate Host Memory Using the CLI
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
|
||||
|
||||
:start-after: introduction-text-begin
|
||||
:end-before: introduction-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
|
||||
:start-after: introduction-text-begin
|
||||
:end-before: introduction-text-end
|
||||
|
||||
Due to limitations in Kubernetes, only a single huge page size can be used
|
||||
per host.
|
||||
@ -27,10 +26,9 @@ per host.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
|
||||
|
||||
:start-after: usage-text-begin
|
||||
:end-before: usage-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
|
||||
:start-after: usage-text-begin
|
||||
:end-before: usage-text-end
|
||||
|
||||
You must also provision one 1GiB huge page per |NUMA| node prior to unlocking a
|
||||
worker or an |AIO| controller.
|
||||
@ -112,10 +110,9 @@ worker or an |AIO| controller.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
|
||||
|
||||
:start-after: memory-table-begin
|
||||
:end-before: memory-table-end
|
||||
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
|
||||
:start-after: memory-table-begin
|
||||
:end-before: memory-table-end
|
||||
|
||||
#. Lock the affected host.
|
||||
|
||||
@ -152,10 +149,9 @@ worker or an |AIO| controller.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
|
||||
|
||||
:start-after: function-text-begin
|
||||
:end-before: function-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
|
||||
:start-after: function-text-begin
|
||||
:end-before: function-text-end
|
||||
|
||||
The default function is **application**.
|
||||
|
||||
@ -170,10 +166,9 @@ worker or an |AIO| controller.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
|
||||
|
||||
:start-after: 2m-pages-text-begin
|
||||
:end-before: 2m-pages-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
|
||||
:start-after: 2m-pages-text-begin
|
||||
:end-before: 2m-pages-text-end
|
||||
|
||||
**1Gpages**
|
||||
|
||||
@ -186,10 +181,9 @@ worker or an |AIO| controller.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
|
||||
|
||||
:start-after: 1g-pages-text-begin
|
||||
:end-before: 1g-pages-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
|
||||
:start-after: 1g-pages-text-begin
|
||||
:end-before: 1g-pages-text-end
|
||||
|
||||
For example, to allocate four 2 MiB huge pages for use by hosted
|
||||
applications on |NUMA| node 1 of worker node **worker-0**:
|
||||
@ -207,10 +201,9 @@ worker or an |AIO| controller.
|
||||
|
||||
.. only:: partner
|
||||
|
||||
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
|
||||
|
||||
:start-after: recommended-size-text-begin
|
||||
:end-before: recommended-size-text-end
|
||||
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
|
||||
:start-after: recommended-size-text-begin
|
||||
:end-before: recommended-size-text-end
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user