starlingx/docs
Code Issues Proposed changes

Node Mgmt _include fixes

Browse Source 
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:
Ron Stone 2021-06-09 12:08:11 -04:00
parent 37ef706610
commit fa52950fba
7 changed files with 108 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/_includes/about-host-memory-provisioning.rest
View File

@ -0,0 +1,6 @@
.. introduction-text-begin
.. introduction-text-end
.. memory-text-begin
.. memory-text-end

15
doc/source/_includes/allocating-host-memory-using-horizon.rest
View File

@ -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

20
doc/source/_includes/allocating-host-memory-using-the-cli.rest
View File

@ -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

5
doc/source/_includes/avs-note.rest
View File

@ -0,0 +1,5 @@
.. introduction-text-begin
.. introduction-text-end
.. usage-text-begin
.. usage-text-end

9
doc/source/node_management/kubernetes/host_memory_provisioning/about-host-memory-provisioning.rst
View File

@ -14,8 +14,7 @@ About Host Memory Provisioning
.. only:: partner
.. include:: ../../../_includes/about-host-memory-provisioning.rest
.. include:: /_includes/about-host-memory-provisioning.rest
:start-after: introduction-text-begin
:end-before: introduction-text-end
@ -43,8 +42,7 @@ configurations.
.. only:: partner
.. include:: ../../../_includes/about-host-memory-provisioning.rest
.. include:: /_includes/about-host-memory-provisioning.rest
:start-after: memory-text-begin
:end-before: memory-text-end
@ -58,6 +56,5 @@ OpenStack\), you can specify which page size is required.
.. only:: partner
.. include:: ../../../_includes/about-host-memory-provisioning.rest
.. include:: /_includes/about-host-memory-provisioning.rest
:start-after: memory-text-end

35
doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst
View File

@ -14,8 +14,7 @@ Allocate Host Memory Using Horizon
.. only:: partner
.. include:: ../../../_includes/avs-note.rest
.. include:: /_includes/avs-note.rest
:start-after: introduction-text-begin
:end-before: introduction-text-end
@ -28,8 +27,7 @@ per host.
.. only:: partner
.. include:: ../../../_includes/avs-note.rest
.. include:: /_includes/avs-note.rest
:start-after: usage-text-begin
:end-before: usage-text-end
@ -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|
@ -65,15 +62,15 @@ informative message is displayed.
in Kubernetes, only a single huge page size can be used per host, across
Application memory.
.. figure:: ../figures/yfv1567176747837.png
:scale: 100%
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
.. 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,8 +92,7 @@ informative message is displayed.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
.. include:: /_includes/allocating-host-memory-using-horizon.rest
:start-after: application-2m-text-begin
:end-before: application-2m-text-end
@ -111,22 +107,19 @@ informative message is displayed.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-horizon.rest
.. 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
.. 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
.. include:: /_includes/allocating-host-memory-using-horizon.rest
:start-after: vswitch-hugepage-size-node-text-begin
:end-before: vswitch-hugepage-size-node-text-end
@ -146,5 +139,5 @@ informative message is displayed.
.. only:: partner
.. include:: ../../../_includes/avs-note.rest
.. include:: /_includes/avs-note.rest

21
doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-the-cli.rst
View File

@ -13,8 +13,7 @@ Allocate Host Memory Using the CLI
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
:start-after: introduction-text-begin
:end-before: introduction-text-end
@ -27,8 +26,7 @@ per host.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
:start-after: usage-text-begin
:end-before: usage-text-end
@ -112,8 +110,7 @@ worker or an |AIO| controller.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
:start-after: memory-table-begin
:end-before: memory-table-end
@ -152,8 +149,7 @@ worker or an |AIO| controller.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
:start-after: function-text-begin
:end-before: function-text-end
@ -170,8 +166,7 @@ worker or an |AIO| controller.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
:start-after: 2m-pages-text-begin
:end-before: 2m-pages-text-end
@ -186,8 +181,7 @@ worker or an |AIO| controller.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
:start-after: 1g-pages-text-begin
:end-before: 1g-pages-text-end
@ -207,8 +201,7 @@ worker or an |AIO| controller.
.. only:: partner
.. include:: ../../../_includes/allocating-host-memory-using-the-cli.rest
.. include:: /_includes/allocating-host-memory-using-the-cli.rest
:start-after: recommended-size-text-begin
:end-before: recommended-size-text-end