starlingx/docs
Code Issues Proposed changes

Fix links and titles in Openstack

Browse Source 
Fix broken links and changed generic "Overview" titles.

Change-Id: I6a44190a39c9ffa231f1c4b80a0e051ea352e677
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
This commit is contained in:
Elisamara Aoki Gonçalves 2025-03-31 19:23:18 +00:00
parent d9215298a9
commit 2722ae6615
9 changed files with 32 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/_vendor/rl-strings.txt
View File

@ -100,7 +100,7 @@
.. |exposing-a-generic-pci-device-using-the-cli| replace:: :ref:`Expose a Generic PCI Device Using the CLI <exposing-a-generic-pci-device-using-the-cli>`
.. |sr-iov-encryption-acceleration| replace:: :ref:`SR-IOV Encryption Acceleration <sr-iov-encryption-acceleration>`
.. |generic-pci-passthrough| replace:: :ref:`Generic PCI Passthrough <generic-pci-passthrough>`
.. |node-management-overview| replace:: :ref:`Overview <node-management-overview>`
.. |node-management-overview| replace:: :ref:`Add OpenStack Compute Node Overview <node-management-overview>`
.. |configure-pci-passthrough-ethernet-interfaces| replace:: :ref:`Configure PCI Passthrough Ethernet Interfaces <configure-pci-passthrough-ethernet-interfaces>`
.. |pci-sr-iov-ethernet-interface-devices| replace:: :ref:`Configure PCI SR-IOV Ethernet Interface Devices <pci-sr-iov-ethernet-interface-devices>`
.. |pci-passthrough-ethernet-interface-devices| replace:: :ref:`PCI Passthrough Ethernet Interface Devices <pci-passthrough-ethernet-interface-devices>`
@ -227,7 +227,7 @@
.. |configuring-cpu-core-assignments| replace:: :ref:`Configure CPU Core Assignments Using Horizon <configuring-cpu-core-assignments>`
.. |changing-the-hyper-threading-status| replace:: :ref:`Change the Hyper-threading Status <changing-the-hyper-threading-status>`
.. |configure-intel-e810-nics-using-intel-ethernet-operator| replace:: :ref:`Configure Intel E810 NICs using Intel Ethernet Operator <configure-intel-e810-nics-using-intel-ethernet-operator>`
.. |security-overview| replace:: :ref:`Overview <security-overview>`
.. |security-overview| replace:: :ref:`Security Overview <security-overview>`
.. |install-a-trusted-ca-certificate| replace:: :ref:`Install a Trusted CA Certificate <install-a-trusted-ca-certificate>`
.. |config-and-management-using-container-backed-remote-clis-and-clients| replace:: :ref:`Use Container-backed Remote CLIs and Clients <config-and-management-using-container-backed-remote-clis-and-clients>`
.. |update-the-domain-name| replace:: :ref:`Update the Domain Name <update-the-domain-name>`
@ -517,7 +517,7 @@
.. |index-sample-flexran-62d77cbb2ed0| replace:: :ref:`Deploy FlexRAN on StarlingX <index-sample-flexran-62d77cbb2ed0>`
.. |deploy-flexran-2203-on-starlingx-1d1b15ecb16f| replace:: :ref:`Deploy FlexRAN 22.03 on StarlingX <deploy-flexran-2203-on-starlingx-1d1b15ecb16f>`
.. |apply-update-to-the-openstack-application| replace:: :ref:`Apply Update to the OpenStack Application <apply-update-to-the-openstack-application>`
.. |software-updates-and-upgrades-overview| replace:: :ref:`Overview <software-updates-and-upgrades-overview>`
.. |software-updates-and-upgrades-overview| replace:: :ref:`Software Updates Overview <software-updates-and-upgrades-overview>`
.. |index-updates-e3b970bb69ce| replace:: :ref:`Updates and Upgrades <index-updates-e3b970bb69ce>`
.. |about-kubernetes-orchestrated-upgrades| replace:: :ref:`About Kubernetes Version Upgrade Cloud Orchestration <about-kubernetes-orchestrated-upgrades>`
.. |the-kubernetes-update-orchestration-process| replace:: :ref:`Kubernetes Version Upgrade Cloud Orchestration Overview <the-kubernetes-update-orchestration-process>`
@ -536,7 +536,7 @@
.. |configure-an-optional-cinder-file-system| replace:: :ref:`Configure the Optional Image Conversion File System <configure-an-optional-cinder-file-system>`
.. |nova-ephemeral-storage| replace:: :ref:`Nova Ephemeral Storage <nova-ephemeral-storage>`
.. |configuration-and-management-storage-on-controller-hosts| replace:: :ref:`Storage on Controller Hosts <configuration-and-management-storage-on-controller-hosts>`
.. |storage-configuration-and-management-overview| replace:: :ref:`Overview <storage-configuration-and-management-overview>`
.. |storage-configuration-and-management-overview| replace:: :ref:`Storage Overview <storage-configuration-and-management-overview>`
.. |storage-configuration-and-management-storage-utilization-display| replace:: :ref:`Storage Utilization Display <storage-configuration-and-management-storage-utilization-display>`
.. |storage-on-compute-hosts| replace:: :ref:`Storage on Compute Hosts <storage-on-compute-hosts>`
.. |storage-configuration-and-management-storage-resources| replace:: :ref:`Storage Resources <storage-configuration-and-management-storage-resources>`

6
doc/source/node_management/openstack/node-management-overview.rst
View File

@ -2,9 +2,9 @@
.. zmd1590003300772
.. _node-management-overview:
========
Overview
========
===================================
Add OpenStack Compute Node Overview
===================================
You can add OpenStack compute nodes to an existing |AIO| Duplex system, and use
labels to identify OpenStack Nodes.

2
doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst
View File

@ -138,6 +138,8 @@ Security Features
security-hardening-firewall-options
isolate-starlingx-internal-cloud-management-network
.. _installation-and-resource-planning:
**********************************
Installation and resource planning
**********************************

7
doc/source/planning/openstack/ethernet-interfaces.rst
View File

@ -24,10 +24,9 @@ in a |LAG| group.
Ethernet interfaces in a |LAG| group can be attached either to the same L2
switch, or to multiple switches in a redundant configuration. For more
information about L2 switch configurations, see :ref:`L2 Access Switches
<network-planning-l2-access-switches>`. For information about the different
|LAG| modes, see |node-doc|: :ref:`Link Aggregation Settings
<link-aggregation-settings>`.
information about L2 switch configurations, see
:ref:`network-planning-l2-access-switches`. For information about the different
|LAG| modes, see |node-doc|: :ref:`link-aggregation-settings`.
.. seealso::

6
doc/source/planning/openstack/network-planning-shared-vlan-or-multi-netted-ethernet-interfaces.rst
View File

@ -34,9 +34,7 @@ The following arrangements are possible:
cluster host networks also implemented on the interface using |VLAN|
tagging, and additional interfaces for data networks .
For some typical interface scenarios, see :ref:`Managed Kubernetes Cluster
Hardware Requirements <hardware-requirements>`.
For some typical interface scenarios, see :ref:`hardware-requirements`.
For more information about configuring |VLAN| interfaces, see |node-doc|:
:ref:`Configure VLAN Interfaces Using the CLI
<configuring-vlan-interfaces-using-the-cli>`.
:ref:`configuring-vlan-interfaces-using-the-cli`.

20
doc/source/planning/openstack/os-data-networks-overview.rst
View File

@ -2,11 +2,11 @@
.. include:: /_stx-related-links/os-data-networks-overview.rln
.. wdq1463583173409
.. _os-planning-data-networks-overview:
.. _os-data-networks-overview:
========
Overview
========
==================================
Virtual or Cloud Networks Overview
==================================
Data networks are used to model the L2 Networks that nodes' data, pci-sriov and
pci-passthrough interfaces attach to.
@ -26,19 +26,17 @@ Data networks are created at the |prod| level.
.. xbooklink VXLAN Data Networks are specific to |prod-os| application and are described in detail in :ref:`VXLAN Data Networks <vxlan-data-networks>` .
Segmentation ID ranges, for |VLAN| and |VXLAN| data networks, are defined
through OpenStack Neutron commands, see :ref:`Add Segmentation Ranges Using
the CLI <adding-segmentation-ranges-using-the-cli>`.
through OpenStack Neutron commands, see
:ref:`adding-segmentation-ranges-using-the-cli`.
For details on creating data networks and assigning them to node interfaces,
see the |datanet-doc| documentation:
- :ref:`Add Data Networks Using the CLI <adding-data-networks-using-the-cli>`
- :ref:`adding-data-networks-using-the-cli`
- :ref:`Assign a Data Network to an Interface
<assigning-a-data-network-to-an-interface>`
- :ref:`assigning-a-data-network-to-an-interface`
- :ref:`Remove a Data Network Using the CLI
<removing-a-data-network-using-the-cli>`
- :ref:`removing-a-data-network-using-the-cli`
.. only:: partner

6
doc/source/security/openstack/security-overview.rst
View File

@ -2,9 +2,9 @@
.. iad1589999522755
.. _security-overview:
========
Overview
========
=================
Security Overview
=================
|prod-os| is a containerized application running on top of |prod-long|.

6
doc/source/storage/openstack/storage-configuration-and-management-overview.rst
View File

@ -2,9 +2,9 @@
.. fxm1589998951395
.. _storage-configuration-and-management-overview:
========
Overview
========
================
Storage Overview
================
|prod-os| is a containerized application running on top of the |prod-long|.

6
doc/source/updates/openstack/software-updates-and-upgrades-overview.rst
View File

@ -2,9 +2,9 @@
.. dqn1590002648435
.. _software-updates-and-upgrades-overview:
========
Overview
========
=========================
Software Updates Overview
=========================
The ``system application-update -n |prefix|-openstack -v <new-app-version>``
command is used for: