starlingx/docs
Code Issues Proposed changes

Fix symlinks

Browse Source 
Changed paths to avoid '..', which breaks symlinks in newer versions of sphinx.
Consolidated installation include files under /_includes. Prefixed r5 versions with 'r5_'
Moved files that are used up/down, but at different paths under /shared/_includes
and /shared/figures
Move two include files to /_includes
Moved addtional images to /shared/figures/... Required for DS platform builds.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia38f4205c5803b3d1fc043e6c59617c34a4e5cbd
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2021-08-25 09:07:26 -04:00 committed by Juanita-Balaraj
parent ab3ddbb30c
commit 2b62f49a9d
222 changed files with 571 additions and 564 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/deploy_install_guides/r5_release/ansible_install_time_only.txt → doc/source/_includes/ansible_install_time_only.txt
View File

@ -4,4 +4,4 @@
Review the set of install-time-only parameters before installation and confirm that your values for these parameters are correct for the desired installation.
Refer to :ref:`Ansible install-time-only parameters <install-time-only-params-r5>` for details.
Refer to :ref:`Ansible install-time-only parameters <install-time-only-params-r6>` for details.

2
doc/source/_includes/docker-proxy-config.rest
View File

@ -16,7 +16,7 @@ Set proxy at bootstrap
To set the Docker proxy at bootstrap time, refer to :doc:`Ansible Bootstrap
Configurations
<../deploy_install_guides/r6_release/ansible_bootstrap_configs>`.
</deploy_install_guides/r6_release/ansible_bootstrap_configs>`.
.. r3_end

4
doc/source/deploy_install_guides/r5_release/kubernetes_install_next.txt → doc/source/_includes/kubernetes_install_next.txt
View File

@ -1,7 +1,7 @@
Your Kubernetes cluster is now up and running.
For instructions on how to access StarlingX Kubernetes see
:doc:`../kubernetes_access`.
:ref:`kubernetes_access`.
For instructions on how to install and access StarlingX OpenStack see
:doc:`../openstack/index`.
:doc:`/deploy_install_guides/r6_release/openstack/index`.

4
doc/source/deploy_install_guides/r6_release/kubernetes_install_next.txt → doc/source/_includes/r5_kubernetes_install_next.txt
View File

@ -1,7 +1,7 @@
Your Kubernetes cluster is now up and running.
For instructions on how to access StarlingX Kubernetes see
:doc:`../kubernetes_access`.
:ref:`kubernetes_access`.
For instructions on how to install and access StarlingX OpenStack see
:doc:`../openstack/index`.
:doc:`/deploy_install_guides/r5_release/openstack/index`.

2
doc/source/_includes/set-proxy-at-bootstrap.rest
View File

@ -3,4 +3,4 @@ Set proxy at bootstrap
----------------------
To set the Docker proxy at bootstrap time, refer to
:doc:`Ansible Bootstrap Configurations <../deploy_install_guides/r3_release/ansible_bootstrap_configs>`.
:doc:`Ansible Bootstrap Configurations </deploy_install_guides/r3_release/ansible_bootstrap_configs>`.

2
doc/source/contributor/doc_contribute_guide.rst
View File

@ -1,3 +1,5 @@
.. _doc_contribute_guide:
===============================
Documentation Contributor Guide
===============================

4
doc/source/contributor/index.rst
View File

@ -32,8 +32,8 @@ Additional StarlingX-specific resources are listed below.
:maxdepth: 1
development_process
../developer_resources/code-submission-guide
../developer_resources/debug_issues
/developer_resources/code-submission-guide
/developer_resources/debug_issues
--------------------
Additional resources

4
doc/source/datanet/kubernetes/the-data-network-topology-view.rst
View File

@ -18,7 +18,7 @@ hosts or networks to highlight their connections and obtain more details.
To display this view, select **Admin** \> **Platform** \> **Data Network
Topology**.
.. image:: ../figures/sqw1475425312420.png
.. image:: /datanet/figures/sqw1475425312420.png
:height: 365px
.. _the-data-network-topology-view-section-N1002F-N1001C-N10001:
@ -75,7 +75,7 @@ using icons superimposed on the entities. The alarms are color-coded for
severity using the same colors as the Global Alarm Banner. Details for the
alarms are listed in the **Related Alarms** tab for the entity.
.. image:: ../figures/eal1475518780745.png
.. image:: /shared/figures/datanet/eal1475518780745.png
.. _the-data-network-topology-view-section-N100AD-N1001C-N10001:

6
doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst
View File

@ -45,18 +45,18 @@ To make interface changes, you must lock the compute host first.
#. In the Edit Interface dialog box, set the **IPv4 Addressing Mode** or
the **IPv6 Addressing Mode** to **Static**.
.. image:: ../figures/bju1538154656153.png
.. image:: /shared/figures/datanet/bju1538154656153.png
#. Add an IPv4 or IPv6 address to the interface.
#. On the Host Detail page, click the **Name** of the interface to open
the Interface Detail page.
.. image:: ../figures/jow1443041105867.png
.. image:: /shared/figures/datanet/jow1443041105867.png
#. Click **Create Address** to open the Create Address dialog box.
.. image:: ../figures/jow1442607685238.png
.. image:: /shared/figures/datanet/jow1442607685238.png
#. Enter the IPv4 or IPv6 address and netmask \(for example,
192.168.1.3/24\), and then click **Create Address**.

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

@ -37,7 +37,7 @@ for more complex routing requirements but requires IP multicast enabled routers.
:start-after: vswitch-text-1-begin
:end-before: vswitch-text-1-end
.. figure:: ../figures/eol1510005391750.png
.. figure:: /shared/figures/datanet/eol1510005391750.png
Multicast Endpoint Distribution

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

@ -28,7 +28,7 @@ to receive the packet in order to reach the |VM|.
Static |VXLAN| is limited to use on one data network. If configured, it must be
enabled on all OpenStack compute nodes.
.. figure:: ../figures/oeg1510005898965.png
.. figure:: /shared/figures/datanet/oeg1510005898965.png
`Static Endpoint Distribution`

4
doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst
View File

@ -37,7 +37,7 @@ To make interface changes, you must lock the compute node first.
#. Select the **Address Pools** tab.
.. image:: ../figures/jow1445971002260.png
.. image:: /shared/figures/datanet/jow1445971002260.png
You can use the controls on the Address Pools page to create, update, or
delete address pools.
@ -45,7 +45,7 @@ To make interface changes, you must lock the compute node first.
#. To create an address pool, click **Create Address Pool** and complete the
dialog box.
.. image:: ../figures/jow1445971475692.png
.. image:: /shared/figures/datanet/jow1445971475692.png
**Name**
A name used for selecting the pool during data interface setup.

2
doc/source/deploy_install_guides/nvme_config.rst
View File

@ -1,3 +1,5 @@
.. _nvme_config:
====================================
Configure NVMe Drive as Primary Disk
====================================

4
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex.rst
View File

@ -6,13 +6,13 @@ Bare metal All-in-one Duplex Installation R5.0
Overview
--------
.. include:: ../desc_aio_duplex.txt
.. include:: /shared/_includes/r5_desc_aio_duplex.txt
The bare metal AIO-DX deployment configuration may be extended with up to four
worker nodes (not shown in the diagram). Installation instructions for
these additional nodes are described in :doc:`aio_duplex_extend`.
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_hardware.rst
View File

@ -31,7 +31,7 @@ host types are:
+-------------------------+-----------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SSD or NVMe (see :doc:`../../nvme_config`) |
| Primary disk | 500 GB SSD or NVMe (see :ref:`nvme_config`) |
+-------------------------+-----------------------------------------------------------+
| Additional disks | - 1 or more 500 GB (min. 10K RPM) for Ceph OSD |
| | - Recommended, but not required: 1 or more SSDs or NVMe |

6
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -30,7 +30,7 @@ Install Kubernetes Platform on All-in-one Duplex
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/r5_inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-start
:end-before: incl-install-software-controller-0-aio-end
@ -91,7 +91,7 @@ Bootstrap system on controller-0
.. only:: starlingx
.. include:: ../ansible_install_time_only.txt
.. include:: /shared/_includes/r5_ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -1101,7 +1101,7 @@ machine.
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex.rst
View File

@ -6,9 +6,9 @@ Bare metal All-in-one Simplex Installation R5.0
Overview
--------
.. include:: ../desc_aio_simplex.txt
.. include:: /shared/_includes/r5_desc_aio_simplex.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

20
doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_hardware.rst
View File

@ -16,11 +16,11 @@ Minimum hardware requirements
The recommended minimum hardware requirements for bare metal servers for various
host types are:
+-------------------------+-----------------------------------------------------------+
+-------------------------+--------------------------------------------------------------------+
| Minimum Requirement | All-in-one Controller Node |
+=========================+===========================================================+
+=========================+====================================================================+
| Number of servers | 1 |
+-------------------------+-----------------------------------------------------------+
+-------------------------+--------------------------------------------------------------------+
| Minimum processor class | - Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) |
| | 8 cores/socket |
| | |
@ -28,28 +28,28 @@ host types are:
| | |
| | - Single-CPU Intel® Xeon® D-15xx family, 8 cores |
| | (low-power/low-cost option) |
+-------------------------+-----------------------------------------------------------+
+-------------------------+--------------------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SSD or NVMe (see :doc:`../../nvme_config`) |
+-------------------------+-----------------------------------------------------------+
+-------------------------+--------------------------------------------------------------------+
| Primary disk | 500 GB SSD or NVMe (see :ref:`nvme_config`) |
+-------------------------+--------------------------------------------------------------------+
| Additional disks | - 1 or more 500 GB (min. 10K RPM) for Ceph OSD |
| | - Recommended, but not required: 1 or more SSDs or NVMe |
| | drives for Ceph journals (min. 1024 MiB per OSD |
| | journal) |
| | - For OpenStack, recommend 1 or more 500 GB (min. 10K |
| | RPM) for VM local ephemeral storage |
+-------------------------+-----------------------------------------------------------+
+-------------------------+--------------------------------------------------------------------+
| Minimum network ports | - OAM: 1x1GE |
| | - Data: 1 or more x 10GE |
+-------------------------+-----------------------------------------------------------+
+-------------------------+--------------------------------------------------------------------+
| BIOS settings | - Hyper-Threading technology enabled |
| | - Virtualization technology enabled |
| | - VT for directed I/O enabled |
| | - CPU power and performance policy set to performance |
| | - CPU C state control disabled |
| | - Plug & play BMC detection disabled |
+-------------------------+-----------------------------------------------------------+
+-------------------------+--------------------------------------------------------------------+
--------------------------
Prepare bare metal servers

6
doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -30,7 +30,7 @@ Install Kubernetes Platform on All-in-one Simplex
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/r5_inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-start
:end-before: incl-install-software-controller-0-aio-end
@ -91,7 +91,7 @@ Bootstrap system on controller-0
.. only:: starlingx
.. include:: ../ansible_install_time_only.txt
.. include:: /shared/_includes/r5_ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -687,7 +687,7 @@ machine.
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include::/_includes/r5_kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage.rst
View File

@ -6,9 +6,9 @@ Bare metal Standard with Controller Storage Installation R5.0
Overview
--------
.. include:: ../desc_controller_storage.txt
.. include:: /shared/_includes/r5_desc_controller_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------

2
doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_hardware.rst
View File

@ -28,7 +28,7 @@ host types are:
| Minimum memory | 64 GB | 32 GB |
+-------------------------+-----------------------------+-----------------------------+
| Primary disk | 500 GB SSD or NVMe (see | 120 GB (Minimum 10k RPM) |
| | :doc:`../../nvme_config`) | |
| | :ref:`nvme_config`) | |
+-------------------------+-----------------------------+-----------------------------+
| Additional disks | - 1 or more 500 GB (min. | - For OpenStack, recommend |
| | 10K RPM) for Ceph OSD | 1 or more 500 GB (min. |

6
doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -26,7 +26,7 @@ Install Kubernetes Platform on Standard with Controller Storage
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/r5_inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-standard-start
:end-before: incl-install-software-controller-0-standard-end
@ -90,7 +90,7 @@ Bootstrap system on controller-0
.. only:: starlingx
.. include:: ../ansible_install_time_only.txt
.. include:: /shared/_includes/r5_ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -909,7 +909,7 @@ If configuring Ceph Storage Backend, Add Ceph OSDs to controllers
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage.rst
View File

@ -7,9 +7,9 @@ Bare metal Standard with Dedicated Storage Installation R5.0
Overview
--------
.. include:: ../desc_dedicated_storage.txt
.. include:: /shared/_includes/r5_desc_dedicated_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_hardware.rst
View File

@ -28,7 +28,7 @@ host types are:
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+---------------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SSD or NVMe (see | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
| | :doc:`../../nvme_config`) | | |
| | :ref:`nvme_config`) | | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |

4
doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -30,7 +30,7 @@ This section describes the steps to install the |prod| Kubernetes platform on a
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/r5_inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-standard-start
:end-before: incl-install-software-controller-0-standard-end
@ -525,7 +525,7 @@ host machine.
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r5_release/bare_metal/ironic.rst
View File

@ -17,10 +17,10 @@ more bare metal servers.
.. note::
If you are behind a corporate firewall or proxy, you need to set proxy
settings. Refer to :doc:`/../../configuration/docker_proxy_config` for
settings. Refer to :ref:`docker_proxy_config` for
details.
.. figure:: ../figures/starlingx-deployment-options-ironic.png
.. figure:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-ironic.png
:scale: 50%
:alt: Standard with Ironic deployment configuration

4
doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage.rst
View File

@ -6,9 +6,9 @@ Bare metal Standard with Rook Storage Installation R5.0
Overview
--------
.. include:: ../desc_rook_storage.txt
.. include:: /shared/_includes/r5_desc_rook_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------

2
doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_hardware.rst
View File

@ -29,7 +29,7 @@ host types are:
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+---------------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SSD or NVMe (see | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
| | :doc:`../../nvme_config`) | | |
| | :ref:`nvme_config`) | | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |

12
doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst
View File

@ -16,8 +16,8 @@ configuration.
Create bootable USB
-------------------
Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to
create a bootable USB with the StarlingX ISO on your system.
Refer to :ref:`bootable_usb` for instructions on how to create a bootable USB
with the StarlingX ISO on your system.
--------------------------------
Install software on controller-0
@ -100,7 +100,7 @@ Bootstrap system on controller-0
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /shared/_includes/r5_ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -151,7 +151,7 @@ Bootstrap system on controller-0
Refer to :doc:`/deploy_install_guides/r5_release/ansible_bootstrap_configs`
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a
firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for
firewall, etc. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
#. Run the Ansible bootstrap playbook:
@ -212,7 +212,7 @@ Configure controller-0
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -749,4 +749,4 @@ On host storage-0 and storage-1:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt

2
doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst
View File

@ -85,7 +85,7 @@ networks, as shown in Figure 1.
Alarms raised at the subclouds are sent to the SystemController for
central reporting.
.. figure:: ../figures/starlingx-deployment-options-distributed-cloud.png
.. figure:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-distributed-cloud.png
:scale: 45%
:alt: Distributed cloud deployment configuration

2
doc/source/deploy_install_guides/r5_release/kubernetes_access.rst
View File

@ -1,3 +1,5 @@
.. _kubernetes_access:
================================
Access StarlingX Kubernetes R5.0
================================

4
doc/source/deploy_install_guides/r5_release/openstack/access.rst
View File

@ -157,14 +157,14 @@ using the :command:`openstack` command. For example:
The image below shows a typical successful run.
.. figure:: ../figures/starlingx-access-openstack-flavorlist.png
.. figure:: /deploy_install_guides/r5_release/figures/starlingx-access-openstack-flavorlist.png
:alt: starlingx-access-openstack-flavorlist
:scale: 50%
*Figure 1: StarlingX OpenStack Flavorlist*
.. figure:: ../figures/starlingx-access-openstack-command.png
.. figure:: /deploy_install_guides/r5_release/figures/starlingx-access-openstack-command.png
:alt: starlingx-access-openstack-command
:scale: 50%

4
doc/source/deploy_install_guides/r5_release/virtual/aio_duplex.rst
View File

@ -6,9 +6,9 @@ Virtual All-in-one Duplex Installation R5.0
Overview
--------
.. include:: ../desc_aio_duplex.txt
.. include:: /shared/_includes/r5_desc_aio_duplex.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

8
doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst
View File

@ -84,7 +84,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /shared/_includes/r5_ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -129,7 +129,7 @@ On virtual controller-0:
Refer to :doc:`/deploy_install_guides/r5_release/ansible_bootstrap_configs`
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a
firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for
firewall, etc. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
#. Run the Ansible bootstrap playbook:
@ -288,7 +288,7 @@ For Rook container-based Ceph:
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -579,4 +579,4 @@ On **virtual** controller-0 and controller-1:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r5_release/virtual/aio_simplex.rst
View File

@ -6,9 +6,9 @@ Virtual All-in-one Simplex Installation R5.0
Overview
--------
.. include:: ../desc_aio_simplex.txt
.. include:: /shared/_includes/r5_desc_aio_simplex.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

8
doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst
View File

@ -85,7 +85,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /shared/_includes/r5_ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -128,7 +128,7 @@ On virtual controller-0:
Refer to :doc:`/deploy_install_guides/r5_release/ansible_bootstrap_configs`
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a
firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for
firewall, etc. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
#. Run the Ansible bootstrap playbook:
@ -279,7 +279,7 @@ For Rook container-based Ceph:
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -415,4 +415,4 @@ On **virtual** controller-0:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r5_release/virtual/controller_storage.rst
View File

@ -6,9 +6,9 @@ Virtual Standard with Controller Storage Installation R5.0
Overview
--------
.. include:: ../desc_controller_storage.txt
.. include:: /shared/_includes/r5_desc_controller_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

8
doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst
View File

@ -89,7 +89,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /shared/_includes/r5_ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -134,7 +134,7 @@ On virtual controller-0:
Refer to :doc:`/deploy_install_guides/r5_release/ansible_bootstrap_configs`
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a
firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for
firewall, etc. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
#. Run the Ansible bootstrap playbook:
@ -215,7 +215,7 @@ On virtual controller-0:
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -597,4 +597,4 @@ On virtual controller-0:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage.rst
View File

@ -6,9 +6,9 @@ Virtual Standard with Dedicated Storage Installation R5.0
Overview
--------
.. include:: ../desc_dedicated_storage.txt
.. include:: /shared/_includes/r5_desc_dedicated_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage_install_kubernetes.rst
View File

@ -399,4 +399,4 @@ Unlock worker nodes
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst
View File

@ -324,7 +324,7 @@ Controller Node Install vs Graphics Controller Node Install), and hitting the
tab key to allow command line modification. The example below shows how to
modify the ``rootfs_device`` specification.
.. figure:: ../figures/install_virtualbox_configparms.png
.. figure:: /deploy_install_guides/r5_release/figures/install_virtualbox_configparms.png
:scale: 100%
:alt: Install controller-0
@ -361,6 +361,6 @@ If you’d prefer to install to the second disk on your node, use the command:
Alternatively, these values can be set from the GUI via the ``Edit Host``
option.
.. figure:: ../figures/install_virtualbox_guiscreen.png
.. figure:: /deploy_install_guides/r5_release/figures/install_virtualbox_guiscreen.png
:scale: 100%
:alt: Install controller-0

4
doc/source/deploy_install_guides/r5_release/virtual/rook_storage.rst
View File

@ -6,9 +6,9 @@ Virtual Standard with Rook Storage Installation R5.0
Overview
--------
.. include:: ../desc_rook_storage.txt
.. include:: /shared/_includes/r5_desc_rook_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/r5_ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r5_release/virtual/rook_storage_install_kubernetes.rst
View File

@ -543,4 +543,4 @@ On virtual storage-0 and storage-1:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/r5_kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex.rst
View File

@ -6,13 +6,13 @@ Bare metal All-in-one Duplex Installation R6.0
Overview
--------
.. include:: ../desc_aio_duplex.txt
.. include:: /shared/_includes/desc_aio_duplex.txt
The bare metal AIO-DX deployment configuration may be extended with up to four
worker nodes (not shown in the diagram). Installation instructions for
these additional nodes are described in :doc:`aio_duplex_extend`.
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_hardware.rst
View File

@ -31,7 +31,7 @@ host types are:
+-------------------------+-----------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SSD or NVMe (see :doc:`../../nvme_config`) |
| Primary disk | 500 GB SSD or NVMe (see :ref:`nvme_config`) |
+-------------------------+-----------------------------------------------------------+
| Additional disks | - 1 or more 500 GB (min. 10K RPM) for Ceph OSD |
| | - Recommended, but not required: 1 or more SSDs or NVMe |

6
doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -30,7 +30,7 @@ Install Kubernetes Platform on All-in-one Duplex
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-start
:end-before: incl-install-software-controller-0-aio-end
@ -91,7 +91,7 @@ Bootstrap system on controller-0
.. only:: starlingx
.. include:: ../ansible_install_time_only.txt
.. include:: /_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -1133,7 +1133,7 @@ machine.
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex.rst
View File

@ -6,9 +6,9 @@ Bare metal All-in-one Simplex Installation R6.0
Overview
--------
.. include:: ../desc_aio_simplex.txt
.. include:: /shared/_includes/desc_aio_simplex.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_hardware.rst
View File

@ -31,7 +31,7 @@ host types are:
+-------------------------+-----------------------------------------------------------+
| Minimum memory | 64 GB |
+-------------------------+-----------------------------------------------------------+
| Primary disk | 500 GB SSD or NVMe (see :doc:`../../nvme_config`) |
| Primary disk | 500 GB SSD or NVMe (see :ref:`nvme_config`) |
+-------------------------+-----------------------------------------------------------+
| Additional disks | - 1 or more 500 GB (min. 10K RPM) for Ceph OSD |
| | - Recommended, but not required: 1 or more SSDs or NVMe |

6
doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -30,7 +30,7 @@ Install Kubernetes Platform on All-in-one Simplex
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-aio-start
:end-before: incl-install-software-controller-0-aio-end
@ -91,7 +91,7 @@ Bootstrap system on controller-0
.. only:: starlingx
.. include:: ../ansible_install_time_only.txt
.. include:: /_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -700,7 +700,7 @@ machine.
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage.rst
View File

@ -6,9 +6,9 @@ Bare metal Standard with Controller Storage Installation R6.0
Overview
--------
.. include:: ../desc_controller_storage.txt
.. include:: /shared/_includes/desc_controller_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------

2
doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_hardware.rst
View File

@ -28,7 +28,7 @@ host types are:
| Minimum memory | 64 GB | 32 GB |
+-------------------------+-----------------------------+-----------------------------+
| Primary disk | 500 GB SSD or NVMe (see | 120 GB (Minimum 10k RPM) |
| | :doc:`../../nvme_config`) | |
| | :ref:`nvme_config`) | |
+-------------------------+-----------------------------+-----------------------------+
| Additional disks | - 1 or more 500 GB (min. | - For OpenStack, recommend |
| | 10K RPM) for Ceph OSD | 1 or more 500 GB (min. |

6
doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -26,7 +26,7 @@ Install Kubernetes Platform on Standard with Controller Storage
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-standard-start
:end-before: incl-install-software-controller-0-standard-end
@ -90,7 +90,7 @@ Bootstrap system on controller-0
.. only:: starlingx
.. include:: ../ansible_install_time_only.txt
.. include:: /_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -929,7 +929,7 @@ If configuring Ceph Storage Backend, Add Ceph OSDs to controllers
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage.rst
View File

@ -7,9 +7,9 @@ Bare metal Standard with Dedicated Storage Installation R6.0
Overview
--------
.. include:: ../desc_dedicated_storage.txt
.. include:: /shared/_includes/desc_dedicated_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_hardware.rst
View File

@ -28,7 +28,7 @@ host types are:
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+---------------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SSD or NVMe (see | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
| | :doc:`../../nvme_config`) | | |
| | :ref:`nvme_config`) | | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |

4
doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -30,7 +30,7 @@ This section describes the steps to install the |prod| Kubernetes platform on a
Install software on controller-0
--------------------------------
.. include:: inc-install-software-on-controller.rest
.. include:: /shared/_includes/inc-install-software-on-controller.rest
:start-after: incl-install-software-controller-0-standard-start
:end-before: incl-install-software-controller-0-standard-end
@ -547,7 +547,7 @@ host machine.
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt
.. only:: partner

4
doc/source/deploy_install_guides/r6_release/bare_metal/ironic.rst
View File

@ -17,10 +17,10 @@ more bare metal servers.
.. note::
If you are behind a corporate firewall or proxy, you need to set proxy
settings. Refer to :doc:`/../../configuration/docker_proxy_config` for
settings. Refer to :ref:`docker_proxy_config` for
details.
.. figure:: ../figures/starlingx-deployment-options-ironic.png
.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-ironic.png
:scale: 50%
:alt: Standard with Ironic deployment configuration

4
doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage.rst
View File

@ -6,9 +6,9 @@ Bare metal Standard with Rook Storage Installation R6.0
Overview
--------
.. include:: ../desc_rook_storage.txt
.. include:: /shared/_includes/desc_rook_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------

2
doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_hardware.rst
View File

@ -29,7 +29,7 @@ host types are:
| Minimum memory | 64 GB | 64 GB | 32 GB |
+---------------------+---------------------------+-----------------------+-----------------------+
| Primary disk | 500 GB SSD or NVMe (see | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) |
| | :doc:`../../nvme_config`) | | |
| | :ref:`nvme_config`) | | |
+---------------------+---------------------------+-----------------------+-----------------------+
| Additional disks | None | - 1 or more 500 GB | - For OpenStack, |
| | | (min. 10K RPM) for | recommend 1 or more |

6
doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_install_kubernetes.rst
View File

@ -98,7 +98,7 @@ Bootstrap system on controller-0
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -210,7 +210,7 @@ Configure controller-0
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -748,4 +748,4 @@ On host storage-0 and storage-1:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt

2
doc/source/deploy_install_guides/r6_release/distributed_cloud/index.rst
View File

@ -87,7 +87,7 @@ networks, as shown in Figure 1.
Alarms raised at the subclouds are sent to the System Controller for
central reporting.
.. figure:: ../figures/starlingx-deployment-options-distributed-cloud.png
.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-distributed-cloud.png
:scale: 45%
:alt: Distributed cloud deployment configuration

4
doc/source/deploy_install_guides/r6_release/openstack/access.rst
View File

@ -157,14 +157,14 @@ using the :command:`openstack` command. For example:
The image below shows a typical successful run.
.. figure:: ../figures/starlingx-access-openstack-flavorlist.png
.. figure:: /deploy_install_guides/r6_release/figures/starlingx-access-openstack-flavorlist.png
:alt: starlingx-access-openstack-flavorlist
:scale: 50%
*Figure 1: StarlingX OpenStack Flavorlist*
.. figure:: ../figures/starlingx-access-openstack-command.png
.. figure:: /deploy_install_guides/r6_release/figures/starlingx-access-openstack-command.png
:alt: starlingx-access-openstack-command
:scale: 50%

4
doc/source/deploy_install_guides/r6_release/virtual/aio_duplex.rst
View File

@ -6,9 +6,9 @@ Virtual All-in-one Duplex Installation R6.0
Overview
--------
.. include:: ../desc_aio_duplex.txt
.. include:: /shared/_includes/desc_aio_duplex.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

6
doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst
View File

@ -84,7 +84,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -288,7 +288,7 @@ For Rook container-based Ceph:
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -579,4 +579,4 @@ On **virtual** controller-0 and controller-1:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r6_release/virtual/aio_simplex.rst
View File

@ -6,9 +6,9 @@ Virtual All-in-one Simplex Installation R6.0
Overview
--------
.. include:: ../desc_aio_simplex.txt
.. include:: /shared/_includes/desc_aio_simplex.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

6
doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst
View File

@ -85,7 +85,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -279,7 +279,7 @@ For Rook container-based Ceph:
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -415,4 +415,4 @@ On **virtual** controller-0:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r6_release/virtual/controller_storage.rst
View File

@ -6,9 +6,9 @@ Virtual Standard with Controller Storage Installation R6.0
Overview
--------
.. include:: ../desc_controller_storage.txt
.. include:: /shared/_includes/desc_controller_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

6
doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst
View File

@ -89,7 +89,7 @@ On virtual controller-0:
The default location where Ansible looks for and imports user
configuration override files for hosts. For example: ``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
.. include:: /_includes/ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods:
@ -215,7 +215,7 @@ On virtual controller-0:
system service-parameter-list platform docker
#. Refer to :doc:`/../../configuration/docker_proxy_config` for
#. Refer to :ref:`docker_proxy_config` for
details about Docker proxy settings.
*************************************
@ -597,4 +597,4 @@ On virtual controller-0:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage.rst
View File

@ -6,9 +6,9 @@ Virtual Standard with Dedicated Storage Installation R6.0
Overview
--------
.. include:: ../desc_dedicated_storage.txt
.. include:: /shared/_includes/desc_dedicated_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage_install_kubernetes.rst
View File

@ -399,4 +399,4 @@ Unlock worker nodes
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt

4
doc/source/deploy_install_guides/r6_release/virtual/install_virtualbox.rst
View File

@ -324,7 +324,7 @@ Controller Node Install vs Graphics Controller Node Install), and hitting the
tab key to allow command line modification. The example below shows how to
modify the ``rootfs_device`` specification.
.. figure:: ../figures/install_virtualbox_configparms.png
.. figure:: /deploy_install_guides/r6_release/figures/install_virtualbox_configparms.png
:scale: 100%
:alt: Install controller-0
@ -361,6 +361,6 @@ If you’d prefer to install to the second disk on your node, use the command:
Alternatively, these values can be set from the GUI via the ``Edit Host``
option.
.. figure:: ../figures/install_virtualbox_guiscreen.png
.. figure:: /deploy_install_guides/r6_release/figures/install_virtualbox_guiscreen.png
:scale: 100%
:alt: Install controller-0

4
doc/source/deploy_install_guides/r6_release/virtual/rook_storage.rst
View File

@ -6,9 +6,9 @@ Virtual Standard with Rook Storage Installation R6.0
Overview
--------
.. include:: ../desc_rook_storage.txt
.. include:: /shared/_includes/desc_rook_storage.txt
.. include:: ../ipv6_note.txt
.. include:: /shared/_includes/ipv6_note.txt
------------
Installation

2
doc/source/deploy_install_guides/r6_release/virtual/rook_storage_install_kubernetes.rst
View File

@ -543,4 +543,4 @@ On virtual storage-0 and storage-1:
Next steps
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/kubernetes_install_next.txt

2
doc/source/developer_resources/backup_restore.rst
View File

@ -182,7 +182,7 @@ The backup contains the following:
* Docker registries on controller
* Docker proxy (See :doc:`../configuration/docker_proxy_config` for details.)
* Docker proxy (See :ref:`docker_proxy_config` for details.)
* Backup data:

2
doc/source/developer_resources/debug_issues.rst
View File

@ -111,7 +111,7 @@ Implement fixes
* Make the changes in your *development workspace* with the StarlingX
codebase.
* Build the related packages using ``build-pkgs <package_name>``.
* Create and apply the patch using the :doc:`starlingx_patching` guide.
* Create and apply the patch using the :ref:`starlingx_patching` guide.
* Restart the services using the ``systemctl`` command or the StarlingX
``sm`` (service management) command.

2
doc/source/developer_resources/starlingx_patching.rst
View File

@ -1,3 +1,5 @@
.. _starlingx_patching:
==================
StarlingX patching
==================

2
doc/source/developer_resources/stx_ipv6_deployment.rst
View File

@ -1,3 +1,5 @@
.. _stx_ipv6_deployment:
=========================
StarlingX IPv6 Deployment
=========================

2
doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall
health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _100-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall
health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _200-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the
overall health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _300-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall
health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _400-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall
health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _500-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall
health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _750-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall
health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _800-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst
View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall
health of the system.
.. include:: ../../_includes/x00-series-alarm-messages.rest
.. include:: /_includes/x00-series-alarm-messages.rest
.. _900-series-alarm-messages-table-zrd-tg5-v5:

2
doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst
View File

@ -28,6 +28,6 @@ You can sort events by clicking the **Event ID**, **Description**, and
**Status** column headers. You can also use these as filtering criteria
from the **Search** field.
.. figure:: ../figures/uty1463514747661.png
.. figure:: /shared/figures/fault-mgmt/uty1463514747661.png
:scale: 70 %
:alt: Event Suppression

2
doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst
View File

@ -34,4 +34,4 @@ You can set events to a suppressed state and toggle them back to unsuppressed.
replaced by **Unsuppress Event**, providing a way to toggle the event back
to unsuppressed.
.. image:: ../figures/nlc1463584178366.png
.. image:: /shared/figures/fault-mgmt/nlc1463584178366.png

2
doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst
View File

@ -14,7 +14,7 @@ that is always visible, regardless of what page you are on in the GUI. The
banner provides a color-coded snapshot of current active alarm counts for each
alarm severity.
.. image:: ../figures/xyj1558447807645.png
.. image:: /shared/figures/fault-mgmt/xyj1558447807645.png
.. note::
Suppressed alarms are not shown. For more about suppressed alarms, see

2
doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst
View File

@ -96,4 +96,4 @@ Collect Tool Caveats and Usage
.. only:: partner
.. include:: ../../_includes/troubleshooting-log-collection.rest
.. include:: /_includes/troubleshooting-log-collection.rest

2
doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst
View File

@ -45,7 +45,7 @@ buffer, with older entries discarded as needed to release logging space.
The **Suppression Status** column is only shown in the table when
**Show Suppressed** filter button is selected.
.. image:: ../figures/psa1567524091300.png
.. image:: /shared/figures/fault-mgmt/psa1567524091300.png
You can sort the entries by clicking on the column titles. For example, to
sort the view of the entries by severity, click **Severity**; the entries

2
doc/source/node_management/kubernetes/common_host_tasks/deleting-a-host-using-horizon.rst
View File

@ -22,5 +22,5 @@ hard drive.
#. From the **Edit** menu for the host, select **Delete Host**.
.. figure:: ../figures/mwl1579716430090.png
.. figure:: /node_management/kubernetes/figures/mwl1579716430090.png
:scale: 100%

2
doc/source/node_management/kubernetes/common_host_tasks/force-locking-a-host-using-horizon.rst
View File

@ -30,7 +30,7 @@ configuration and maintenance purposes.
#. From the **Edit** menu for the host, select **Force Lock Host**.
.. figure:: ../figures/xwu1579713699282.png
.. figure:: /node_management/kubernetes/figures/xwu1579713699282.png
:scale: 100%
The system displays a warning message appropriate to the

2
doc/source/node_management/kubernetes/common_host_tasks/locking-a-host-using-horizon.rst
View File

@ -37,5 +37,5 @@ the host, causing any containers on that host to be evicted.
#. From the **Edit** menu for the host, select **Lock Host**.
.. figure:: ../figures/rst1442611298701.png
.. figure:: /shared/figures/system_configuration/rst1442611298701.png
:scale: 100%

2
doc/source/node_management/kubernetes/common_host_tasks/rebooting-a-host-using-horizon.rst
View File

@ -23,5 +23,5 @@ The host then reboots automatically.
#. From the **Edit** menu for the host, select **Reboot Host**.
.. figure:: ../figures/mwl1579716430090.png
.. figure:: /node_management/kubernetes/figures/mwl1579716430090.png
:scale: 100%

2
doc/source/node_management/kubernetes/common_host_tasks/reinstalling-a-host-using-horizon.rst
View File

@ -54,5 +54,5 @@ the network interfaces through the BIOS boot option.
#. From the **Edit** menu for the host, select **Reinstall Host**.
.. figure:: ../figures/mwl1579716430090.png
.. figure:: /node_management/kubernetes/figures/mwl1579716430090.png
:scale: 100%

2
doc/source/node_management/kubernetes/common_host_tasks/swacting-a-master-controller-using-horizon.rst
View File

@ -26,5 +26,5 @@ when updating hardware or replacing faulty components.
#. From the **Edit** menu for the standby controller, select **Swact Host**.
.. figure:: ../figures/wwd1579715313055.png
.. figure:: /node_management/kubernetes/figures/wwd1579715313055.png
:scale: 100%

2
doc/source/node_management/kubernetes/common_host_tasks/unlocking-a-host-using-horizon.rst
View File

@ -34,5 +34,5 @@ see :ref:`Reboot Limits for Host Unlock <reboot-limits-for-host-unlock>`.
#. From the **Edit** menu for the host, select **Unlock Host**.
.. figure:: ../figures/mwl1579716430090.png
.. figure:: /node_management/kubernetes/figures/mwl1579716430090.png
:scale: 100%

6
doc/source/node_management/kubernetes/configuring_cpu_core_assignments/configuring-cpu-core-assignments.rst
View File

@ -33,7 +33,7 @@ them more CPU cores from the Horizon Web interface.
The Edit CPU Assignments dialog appears.
.. figure:: ../figures/tku1572941730454.png
.. figure:: /node_management/kubernetes/figures/tku1572941730454.png
:scale: 100%
#. Make CPU allocation changes.
@ -88,7 +88,7 @@ them more CPU cores from the Horizon Web interface.
.. only:: partner
../../_includes/configure-cpu-core-vswitch.rest
/_includes/configure-cpu-core-vswitch.rest
**Shared**
Not currently supported.
@ -96,5 +96,5 @@ them more CPU cores from the Horizon Web interface.
To see how many cores a processor contains, hover over the
**Information** icon.
.. figure:: ../figures/jow1436300231676.png
.. figure:: /node_management/kubernetes/figures/jow1436300231676.png
:scale: 100%

2
doc/source/node_management/kubernetes/configuring_node_labels/configuring-node-labels-using-horizon.rst
View File

@ -20,7 +20,7 @@ You can assign and remove labels to modify node functionality using Horizon.
#. Select the Labels tab.
.. figure:: ../figures/qes1567103095290.png
.. figure:: /node_management/kubernetes/figures/qes1567103095290.png
:scale: 100%
#. To delete a label, select the **Delete Label** button for the label key

2
doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-heartbeat-failure-action.rst
View File

@ -101,7 +101,7 @@ Customer logs are created. The customer can change from one action to any
other action at any time and the log reflects the from <action> to <action>
change in the log text. For example,
.. figure:: ../figures/wnz1537822287984.jpeg
.. figure:: /node_management/kubernetes/figures/wnz1537822287984.jpeg
:scale: 65%
The heartbeat alarms, such as Management Network can be viewed. For example:

2
doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-multi-node-failure-avoidance.rst
View File

@ -76,7 +76,7 @@ heartbeat failures.
Customer logs are created. The customer logs record **from** and **to**
changes in the log text. For example:
.. figure:: ../figures/oio1537823446860.jpeg
.. figure:: /node_management/kubernetes/figures/oio1537823446860.jpeg
:scale: 65%
#. Apply the service parameter change.

Some files were not shown because too many files have changed in this diff Show More