starlingx/docs
Code Issues Proposed changes

Openstack .. include changes

Browse Source 
Made paths to include files relative to doc source. This is needed for downstream builds
and is good practice for reusability.
Fixed some include statements with broken syntax.
Added missing section labels to include file.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I0423c2008445b49e0bb60b9690925041d7acd6f6
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2021-06-21 14:30:29 -04:00
parent 9f3b3bf1d1
commit 802aa99c1b
14 changed files with 41 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/_includes/resource-planning.rest
View File

@ -0,0 +1,10 @@
.. avs-text-1-begin
.. avs-text-2-end
.. avs-text-2-begin
.. avs-text-2-end
.. avs-text-1-end

2
doc/source/backup/openstack/restore-openstack-from-a-backup.rst
View File

@ -117,4 +117,4 @@ You can restore |prod-os| from a backup with or without Ceph.
| | backup_filename=wr-openstack_backup.tgz' |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. include:: ../../_includes/restore-openstack-from-a-backup.rest
.. include:: /_includes/restore-openstack-from-a-backup.rest

2
doc/source/datanet/openstack/data-networks-overview.rst
View File

@ -49,4 +49,4 @@ OpenStack Neutron commands, see :ref:`Adding Segmentation Ranges Using the CLI
.. only:: partner
.. include:: ../../_includes/data-networks-overview.rest
.. include:: /_includes/data-networks-overview.rest

16
doc/source/datanet/openstack/dynamic-vxlan.rst
View File

@ -33,10 +33,9 @@ for more complex routing requirements but requires IP multicast enabled routers.
.. only:: partner
.. include:: ../../_includes/dynamic-vxlan.rest
:start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end
.. include:: /_includes/dynamic-vxlan.rest
:start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end
.. figure:: ../figures/eol1510005391750.png
@ -52,10 +51,9 @@ Multicast Endpoint Distribution
.. only:: partner
.. include:: ../../_includes/dynamic-vxlan.rest
:start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end
.. include:: /_includes/dynamic-vxlan.rest
:start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end
.. _dynamic-vxlan-section-N10054-N1001F-N10001:
@ -94,4 +92,4 @@ segmentation ranges using the |CLI|.
For more information on the differences between the dynamic and static |VXLAN|
modes, see :ref:`Differences Between Dynamic and Static VXLAN Modes
<differences-between-dynamic-and-static-vxlan-modes>`.
<differences-between-dynamic-and-static-vxlan-modes>`.

4
doc/source/datanet/openstack/static-vxlan.rst
View File

@ -20,7 +20,7 @@ to receive the packet in order to reach the |VM|.
.. only:: partner
.. include:: ../../_includes/static-vxlan.rest
.. include:: /_includes/static-vxlan.rest
:start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end
@ -60,4 +60,4 @@ segmentation ranges using the |CLI|.
For more information on the differences between the dynamic and static |VXLAN|
modes, see :ref:`Differences Between Dynamic and Static VXLAN Modes
<differences-between-dynamic-and-static-vxlan-modes>`.
<differences-between-dynamic-and-static-vxlan-modes>`.

2
doc/source/datanet/openstack/vxlan-data-networks.rst
View File

@ -25,7 +25,7 @@ are included in the outer IP header.
.. only:: partner
.. include:: ../../_includes/vxlan-data-networks.rest
.. include:: /_includes/vxlan-data-networks.rest
.. _vxlan-data-networks-ul-rzs-kqf-zbb:

4
doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst
View File

@ -6,7 +6,7 @@
Alarm Messages - 400s
=====================
.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest
.. include:: /_includes/openstack-alarm-messages-xxxs.rest
.. list-table::
:widths: 6 15
@ -52,4 +52,4 @@ Alarm Messages - 400s
* - Severity:
- M\*
* - Proposed Repair Action
- Bring a controller node back in to service, otherwise contact next level of support.
- Bring a controller node back in to service, otherwise contact next level of support.

4
doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst
View File

@ -6,7 +6,7 @@
Alarm Messages - 700s
=====================
.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest
.. include:: /_includes/openstack-alarm-messages-xxxs.rest
.. _alarm-messages-700s-table-zrd-tg5-v5:
@ -272,4 +272,4 @@ Alarm Messages - 700s
- M
* - Proposed Repair Action
- Migrate instances in an attempt to satisfy the policy; if problem
persists contact next level of support.
persists contact next level of support.

2
doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst
View File

@ -6,7 +6,7 @@
Alarm Messages - 800s
=====================
.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest
.. include:: /_includes/openstack-alarm-messages-xxxs.rest
.. _alarm-messages-800s-table-zrd-tg5-v5:

4
doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst
View File

@ -6,7 +6,7 @@
Customer Log Messages 270s - Virtual Machines
=============================================
.. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest
.. include:: /_includes/openstack-customer-log-messages-xxxs.rest
.. _customer-log-messages-270s-virtual-machines-table-zgf-jvw-v5:
@ -35,4 +35,4 @@ Customer Log Messages 270s - Virtual Machines
| | tenant=<tenant-uuid>.instance=<instance-uuid> | |
+-----------+----------------------------------------------------------------------------------+----------+
See also :ref:`Customer Log Messages 700s - Virtual Machines <customer-log-messages-700s-virtual-machines>`
See also :ref:`Customer Log Messages 700s - Virtual Machines <customer-log-messages-700s-virtual-machines>`

2
doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst
View File

@ -6,7 +6,7 @@
Customer Log Messages 401s - Services
=====================================
.. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest
.. include:: /_includes/openstack-customer-log-messages-xxxs.rest
.. _customer-log-messages-401s-services-table-zgf-jvw-v5:

4
doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst
View File

@ -6,7 +6,7 @@
Customer Log Messages 700s - Virtual Machines
=============================================
.. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest
.. include:: /_includes/openstack-customer-log-messages-xxxs.rest
.. _customer-log-messages-700s-virtual-machines-table-zgf-jvw-v5:
@ -477,4 +477,4 @@ Customer Log Messages 700s - Virtual Machines
| | subsystem-vim | |
+----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+
See also :ref:`Customer Log Messages 270s - Virtual Machines <customer-log-messages-270s-virtual-machines>`
See also :ref:`Customer Log Messages 270s - Virtual Machines <customer-log-messages-270s-virtual-machines>`

2
doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst
View File

@ -21,4 +21,4 @@ Management Protocol)` are available on the |prod| REST APIs, :abbr:`CLIs
.. only:: partner
.. include:: ../../_includes/openstack-fault-management-overview.rest
.. include:: /_includes/openstack-fault-management-overview.rest

19
doc/source/planning/openstack/resource-planning.rst
View File

@ -28,26 +28,23 @@ Resource Placement
.. only:: partner
.. include:: ../../_includes/resource-planning.rest
:start-after: avs-text-1-begin
:end-before: avs-text-2-end
.. include:: /_includes/resource-planning.rest
:start-after: avs-text-1-begin
:end-before: avs-text-2-end
.. only:: partner
.. include:: ../../_includes/resource-planning.rest
:start-after: avs-text-2-begin
:end-before: avs-text-2-end
.. include:: /_includes/resource-planning.rest
:start-after: avs-text-2-begin
:end-before: avs-text-2-end
.. _resource-planning-ul-tcb-ssz-55:
.. only:: partner
.. include:: ../../_includes/resource-planning.rest
:start-after: avs-text-1-end
.. include:: /_includes/resource-planning.rest
:start-after: avs-text-1-end
If accessing |PCIe| devices directly from a |VM| using |PCI|-Passthrough or