From 2b62f49a9d14222ed794dc088254ce090ab60017 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Wed, 25 Aug 2021 09:07:26 -0400 Subject: [PATCH] Fix symlinks 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 Change-Id: Ia38f4205c5803b3d1fc043e6c59617c34a4e5cbd Signed-off-by: Ron Stone --- .../ansible_install_time_only.txt | 14 ++-- doc/source/_includes/docker-proxy-config.rest | 2 +- .../kubernetes_install_next.txt | 14 ++-- .../r5_kubernetes_install_next.txt} | 14 ++-- .../_includes/set-proxy-at-bootstrap.rest | 2 +- .../contributor/doc_contribute_guide.rst | 2 + doc/source/contributor/index.rst | 4 +- .../the-data-network-topology-view.rst | 4 +- ...-static-ip-address-to-a-data-interface.rst | 6 +- .../datanet/openstack/dynamic-vxlan.rst | 2 +- doc/source/datanet/openstack/static-vxlan.rst | 2 +- ...g-ip-address-pools-for-data-interfaces.rst | 4 +- .../deploy_install_guides/nvme_config.rst | 2 + .../r5_release/bare_metal/aio_duplex.rst | 4 +- .../bare_metal/aio_duplex_hardware.rst | 2 +- .../aio_duplex_install_kubernetes.rst | 6 +- .../r5_release/bare_metal/aio_simplex.rst | 4 +- .../bare_metal/aio_simplex_hardware.rst | 68 +++++++++--------- .../aio_simplex_install_kubernetes.rst | 6 +- .../bare_metal/controller_storage.rst | 4 +- .../controller_storage_hardware.rst | 2 +- .../controller_storage_install_kubernetes.rst | 6 +- .../bare_metal/dedicated_storage.rst | 4 +- .../bare_metal/dedicated_storage_hardware.rst | 2 +- .../dedicated_storage_install_kubernetes.rst | 4 +- .../r5_release/bare_metal/ironic.rst | 4 +- .../r5_release/bare_metal/rook_storage.rst | 4 +- .../bare_metal/rook_storage_hardware.rst | 2 +- .../rook_storage_install_kubernetes.rst | 12 ++-- .../r5_release/distributed_cloud/index.rst | 2 +- .../r5_release/kubernetes_access.rst | 2 + .../r5_release/openstack/access.rst | 4 +- .../r5_release/virtual/aio_duplex.rst | 4 +- .../virtual/aio_duplex_install_kubernetes.rst | 8 +-- .../r5_release/virtual/aio_simplex.rst | 4 +- .../aio_simplex_install_kubernetes.rst | 8 +-- .../r5_release/virtual/controller_storage.rst | 4 +- .../controller_storage_install_kubernetes.rst | 8 +-- .../r5_release/virtual/dedicated_storage.rst | 4 +- .../dedicated_storage_install_kubernetes.rst | 2 +- .../r5_release/virtual/install_virtualbox.rst | 4 +- .../r5_release/virtual/rook_storage.rst | 4 +- .../rook_storage_install_kubernetes.rst | 2 +- .../r6_release/bare_metal/aio_duplex.rst | 4 +- .../bare_metal/aio_duplex_hardware.rst | 2 +- .../aio_duplex_install_kubernetes.rst | 6 +- .../r6_release/bare_metal/aio_simplex.rst | 4 +- .../bare_metal/aio_simplex_hardware.rst | 2 +- .../aio_simplex_install_kubernetes.rst | 6 +- .../bare_metal/controller_storage.rst | 4 +- .../controller_storage_hardware.rst | 2 +- .../controller_storage_install_kubernetes.rst | 6 +- .../bare_metal/dedicated_storage.rst | 4 +- .../bare_metal/dedicated_storage_hardware.rst | 2 +- .../dedicated_storage_install_kubernetes.rst | 4 +- .../r6_release/bare_metal/ironic.rst | 4 +- .../r6_release/bare_metal/rook_storage.rst | 4 +- .../bare_metal/rook_storage_hardware.rst | 2 +- .../rook_storage_install_kubernetes.rst | 6 +- .../r6_release/distributed_cloud/index.rst | 2 +- .../r6_release/openstack/access.rst | 4 +- .../r6_release/virtual/aio_duplex.rst | 4 +- .../virtual/aio_duplex_install_kubernetes.rst | 6 +- .../r6_release/virtual/aio_simplex.rst | 4 +- .../aio_simplex_install_kubernetes.rst | 6 +- .../r6_release/virtual/controller_storage.rst | 4 +- .../controller_storage_install_kubernetes.rst | 6 +- .../r6_release/virtual/dedicated_storage.rst | 4 +- .../dedicated_storage_install_kubernetes.rst | 2 +- .../r6_release/virtual/install_virtualbox.rst | 4 +- .../r6_release/virtual/rook_storage.rst | 4 +- .../rook_storage_install_kubernetes.rst | 2 +- .../developer_resources/backup_restore.rst | 2 +- .../developer_resources/debug_issues.rst | 2 +- .../starlingx_patching.rst | 2 + .../stx_ipv6_deployment.rst | 2 + .../kubernetes/100-series-alarm-messages.rst | 2 +- .../kubernetes/200-series-alarm-messages.rst | 2 +- .../kubernetes/300-series-alarm-messages.rst | 2 +- .../kubernetes/400-series-alarm-messages.rst | 2 +- .../kubernetes/500-series-alarm-messages.rst | 2 +- .../kubernetes/750-series-alarm-messages.rst | 2 +- .../kubernetes/800-series-alarm-messages.rst | 2 +- .../kubernetes/900-series-alarm-messages.rst | 2 +- .../events-suppression-overview.rst | 2 +- .../suppressing-and-unsuppressing-events.rst | 2 +- .../kubernetes/the-global-alarm-banner.rst | 2 +- .../troubleshooting-log-collection.rst | 2 +- .../viewing-the-event-log-using-horizon.rst | 2 +- .../deleting-a-host-using-horizon.rst | 2 +- .../force-locking-a-host-using-horizon.rst | 2 +- .../locking-a-host-using-horizon.rst | 2 +- .../rebooting-a-host-using-horizon.rst | 2 +- .../reinstalling-a-host-using-horizon.rst | 2 +- ...ting-a-master-controller-using-horizon.rst | 2 +- .../unlocking-a-host-using-horizon.rst | 2 +- .../configuring-cpu-core-assignments.rst | 6 +- .../configuring-node-labels-using-horizon.rst | 2 +- .../configuring-heartbeat-failure-action.rst | 2 +- ...nfiguring-multi-node-failure-avoidance.rst | 2 +- ...ing-sensor-actions-and-audit-intervals.rst | 2 +- .../relearning-sensor-models.rst | 2 +- .../suppressing-sensor-actions.rst | 4 +- .../kubernetes/host_inventory/devices-tab.rst | 2 +- .../host_inventory/filesystems-tab.rst | 2 +- .../kubernetes/host_inventory/hosts-tab.rst | 4 +- .../host_inventory/interfaces-tab.rst | 2 +- .../kubernetes/host_inventory/labels-tab.rst | 2 +- .../kubernetes/host_inventory/lldp-tab.rst | 2 +- .../kubernetes/host_inventory/memory-tab.rst | 2 +- .../host_inventory/overview-tab.rst | 2 +- .../kubernetes/host_inventory/ports-tab.rst | 2 +- .../host_inventory/processor-tab.rst | 2 +- .../kubernetes/host_inventory/sensors-tab.rst | 2 +- .../kubernetes/host_inventory/storage-tab.rst | 8 +-- .../allocating-host-memory-using-horizon.rst | 8 +-- ...ated-ethernet-interfaces-using-horizon.rst | 6 +- ...ated-ethernet-interfaces-using-the-cli.rst | 2 +- ...rfaces-on-sriov-interface-from-horizon.rst | 6 +- ...ring-ethernet-interfaces-using-horizon.rst | 4 +- ...figuring-vlan-interfaces-using-horizon.rst | 4 +- ...-or-disabling-interfaces-using-horizon.rst | 4 +- .../editing-interface-settings.rst | 4 +- ...ing-sr-iov-vf-interfaces-using-the-cli.rst | 2 +- .../starting-starlingx.rst | 2 +- ...-board-management-control-from-horizon.rst | 2 +- ...-board-management-control-from-horizon.rst | 2 +- ...ute-nodes-to-an-existing-duplex-system.rst | 2 +- ...g-a-flavor-to-use-a-generic-pci-device.rst | 2 +- ...ng-pci-passthrough-ethernet-interfaces.rst | 14 ++-- ...ng-a-generic-pci-device-for-use-by-vms.rst | 2 +- ...passthrough-ethernet-interface-devices.rst | 4 +- ...ing-labels-to-identify-openstack-nodes.rst | 4 +- doc/source/operations/app_management.rst | 2 +- .../operations/controller_service_manage.rst | 2 +- .../operations/dedicate_cpu_container.rst | 2 +- doc/source/operations/fault_management.rst | 2 +- .../operations/k8s_persistent_vol_claims.rst | 2 +- doc/source/operations/lldp_monitor.rst | 2 +- .../operations/openstack_vm_pci_config.rst | 2 +- .../operations/storage_util_display.rst | 2 +- doc/source/operations/tsn.rst | 2 +- .../internal-management-network-planning.rst | 2 +- .../network-planning-the-pxe-boot-network.rst | 2 +- .../kubernetes/oam-network-planning.rst | 2 +- ...-rack-switch-deployment-considerations.rst | 2 +- .../kubernetes/the-cluster-host-network.rst | 2 +- .../verified-commercial-hardware.rst | 2 +- .../ethernet-interface-configuration.rst | 2 +- ...-planning-verified-commercial-hardware.rst | 2 +- .../openstack/os-data-networks-overview.rst | 2 +- .../openstack/port-security-extension.rst | 2 +- .../openstack/project-network-planning.rst | 2 +- .../planning/openstack/project-networks.rst | 4 +- .../planning/openstack/storage-resources.rst | 2 +- .../planning/openstack/the-ethernet-mtu.rst | 2 +- .../vm-network-interface-options.rst | 4 +- .../_includes}/desc_aio_duplex.txt | 56 +++++++-------- .../_includes}/desc_aio_simplex.txt | 46 ++++++------ .../_includes}/desc_controller_storage.txt | 53 +++++++------- .../_includes}/desc_dedicated_storage.txt | 45 ++++++------ .../_includes}/desc_rook_storage.txt | 4 +- .../inc-install-software-on-controller.rest | 0 .../inc-openstack-specific-host-config.rest | 0 .../_includes}/ipv6_note.txt | 27 ++++--- .../r5_ansible_install_time_only.txt} | 14 ++-- .../_includes/r5_desc_aio_duplex.txt} | 56 +++++++-------- .../_includes/r5_desc_aio_simplex.txt} | 46 ++++++------ .../_includes/r5_desc_controller_storage.txt} | 54 +++++++------- .../_includes/r5_desc_dedicated_storage.txt} | 46 ++++++------ .../_includes/r5_desc_rook_storage.txt} | 4 +- ...5_inc-install-software-on-controller.rest} | 0 ...5_inc-openstack-specific-host-config.rest} | 0 .../_includes/r5_ipv6_note.txt} | 28 ++++---- .../figures/datanet}/bju1538154656153.png | Bin .../figures/datanet}/eal1475518780745.png | Bin .../figures/datanet}/eol1510005391750.png | Bin .../figures/datanet}/jow1442607685238.png | Bin .../figures/datanet}/jow1443041105867.png | Bin .../figures/datanet}/jow1445971002260.png | Bin .../figures/datanet}/jow1445971475692.png | Bin .../figures/datanet}/oeg1510005898965.png | Bin .../figures/fault-mgmt}/nlc1463584178366.png | Bin .../figures/fault-mgmt}/psa1567524091300.png | Bin .../figures/fault-mgmt}/uty1463514747661.png | Bin .../figures/fault-mgmt}/xyj1558447807645.png | Bin .../figures/planning}/jow1438030468959.png | Bin .../figures/storage}/bse1464884816923.png | Bin .../figures/storage}/caf1464886132887.png | Bin .../figures/storage}/eew1464963403075.png | Bin .../figures/storage}/ele1569534467005.jpeg | Bin .../figures/storage}/gzf1569521230362.png | Bin .../figures/storage}/ngh1569534630524.jpeg | Bin .../figures/storage}/pzu1464883037926.png | Bin .../figures/storage}/qgh1567533283603.png | Bin .../figures/storage}/qig1590585618135.png | Bin .../figures/storage}/wlx1464876289283.png | Bin .../figures/storage}/yts1496238000598.png | Bin .../figures/storage}/zfd1464884207881.png | Bin .../figures/storage}/zpk1486667625575.png | Bin .../jow1413850386429.png | Bin .../jow1413850406811.png | Bin .../jow1413850481192.png | Bin .../jow1413850497887.png | Bin .../psa1420751608971.png | Bin .../rst1442611298701.png | Bin .../add-ssd-backed-journals-using-horizon.rst | 10 +-- ...tapp-deployment-as-the-storage-backend.rst | 2 +- ...ystem-storage-allotments-using-horizon.rst | 4 +- ...ntroller-or-storage-host-using-horizon.rst | 6 +- ...view-storage-utilization-using-horizon.rst | 2 +- .../work-with-local-volume-groups.rst | 2 +- ...ation-and-management-storage-resources.rst | 2 +- ...-mtu-of-an-oam-interface-using-horizon.rst | 4 +- ...the-oam-ip-configuration-using-horizon.rst | 4 +- ...ntp-servers-and-services-using-horizon.rst | 2 +- .../specifying-dns-servers-using-horizon.rst | 2 +- ...guring-kubernetes-update-orchestration.rst | 2 +- ...bernetes-update-orchestration-failures.rst | 2 +- ...ntainer-backed-remote-clis-and-clients.rst | 2 +- .../nodeport-usage-restrictions.rst | 2 +- ...-attachment-definitions-in-a-container.rst | 2 +- 222 files changed, 571 insertions(+), 564 deletions(-) rename doc/source/{deploy_install_guides/r5_release => _includes}/ansible_install_time_only.txt (89%) rename doc/source/{deploy_install_guides/r5_release => _includes}/kubernetes_install_next.txt (68%) rename doc/source/{deploy_install_guides/r6_release/kubernetes_install_next.txt => _includes/r5_kubernetes_install_next.txt} (68%) rename doc/source/{deploy_install_guides/r6_release => shared/_includes}/desc_aio_duplex.txt (83%) rename doc/source/{deploy_install_guides/r5_release => shared/_includes}/desc_aio_simplex.txt (80%) rename doc/source/{deploy_install_guides/r5_release => shared/_includes}/desc_controller_storage.txt (83%) rename doc/source/{deploy_install_guides/r6_release => shared/_includes}/desc_dedicated_storage.txt (81%) rename doc/source/{deploy_install_guides/r5_release => shared/_includes}/desc_rook_storage.txt (82%) rename doc/source/{deploy_install_guides/r5_release/bare_metal => shared/_includes}/inc-install-software-on-controller.rest (100%) rename doc/source/{deploy_install_guides/r6_release/bare_metal => shared/_includes}/inc-openstack-specific-host-config.rest (100%) rename doc/source/{deploy_install_guides/r6_release => shared/_includes}/ipv6_note.txt (70%) rename doc/source/{deploy_install_guides/r6_release/ansible_install_time_only.txt => shared/_includes/r5_ansible_install_time_only.txt} (89%) rename doc/source/{deploy_install_guides/r5_release/desc_aio_duplex.txt => shared/_includes/r5_desc_aio_duplex.txt} (83%) rename doc/source/{deploy_install_guides/r6_release/desc_aio_simplex.txt => shared/_includes/r5_desc_aio_simplex.txt} (80%) rename doc/source/{deploy_install_guides/r6_release/desc_controller_storage.txt => shared/_includes/r5_desc_controller_storage.txt} (84%) rename doc/source/{deploy_install_guides/r5_release/desc_dedicated_storage.txt => shared/_includes/r5_desc_dedicated_storage.txt} (82%) rename doc/source/{deploy_install_guides/r6_release/desc_rook_storage.txt => shared/_includes/r5_desc_rook_storage.txt} (81%) rename doc/source/{deploy_install_guides/r6_release/bare_metal/inc-install-software-on-controller.rest => shared/_includes/r5_inc-install-software-on-controller.rest} (100%) rename doc/source/{deploy_install_guides/r5_release/bare_metal/inc-openstack-specific-host-config.rest => shared/_includes/r5_inc-openstack-specific-host-config.rest} (100%) rename doc/source/{deploy_install_guides/r5_release/ipv6_note.txt => shared/_includes/r5_ipv6_note.txt} (85%) rename doc/source/{datanet/figures => shared/figures/datanet}/bju1538154656153.png (100%) rename doc/source/{datanet/figures => shared/figures/datanet}/eal1475518780745.png (100%) rename doc/source/{datanet/figures => shared/figures/datanet}/eol1510005391750.png (100%) rename doc/source/{datanet/figures => shared/figures/datanet}/jow1442607685238.png (100%) rename doc/source/{datanet/figures => shared/figures/datanet}/jow1443041105867.png (100%) rename doc/source/{datanet/figures => shared/figures/datanet}/jow1445971002260.png (100%) rename doc/source/{datanet/figures => shared/figures/datanet}/jow1445971475692.png (100%) rename doc/source/{datanet/figures => shared/figures/datanet}/oeg1510005898965.png (100%) rename doc/source/{fault-mgmt/figures => shared/figures/fault-mgmt}/nlc1463584178366.png (100%) rename doc/source/{fault-mgmt/figures => shared/figures/fault-mgmt}/psa1567524091300.png (100%) rename doc/source/{fault-mgmt/figures => shared/figures/fault-mgmt}/uty1463514747661.png (100%) rename doc/source/{fault-mgmt/figures => shared/figures/fault-mgmt}/xyj1558447807645.png (100%) rename doc/source/{planning/figures => shared/figures/planning}/jow1438030468959.png (100%) mode change 100755 => 100644 rename doc/source/{storage/figures => shared/figures/storage}/bse1464884816923.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/caf1464886132887.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/eew1464963403075.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/ele1569534467005.jpeg (100%) rename doc/source/{storage/figures => shared/figures/storage}/gzf1569521230362.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/ngh1569534630524.jpeg (100%) rename doc/source/{storage/figures => shared/figures/storage}/pzu1464883037926.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/qgh1567533283603.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/qig1590585618135.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/wlx1464876289283.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/yts1496238000598.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/zfd1464884207881.png (100%) rename doc/source/{storage/figures => shared/figures/storage}/zpk1486667625575.png (100%) mode change 100755 => 100644 rename doc/source/{system_configuration/figures => shared/figures/system_configuration}/jow1413850386429.png (100%) rename doc/source/{system_configuration/figures => shared/figures/system_configuration}/jow1413850406811.png (100%) rename doc/source/{system_configuration/figures => shared/figures/system_configuration}/jow1413850481192.png (100%) rename doc/source/{system_configuration/figures => shared/figures/system_configuration}/jow1413850497887.png (100%) rename doc/source/{system_configuration/figures => shared/figures/system_configuration}/psa1420751608971.png (100%) rename doc/source/{system_configuration/figures => shared/figures/system_configuration}/rst1442611298701.png (100%) diff --git a/doc/source/deploy_install_guides/r5_release/ansible_install_time_only.txt b/doc/source/_includes/ansible_install_time_only.txt similarity index 89% rename from doc/source/deploy_install_guides/r5_release/ansible_install_time_only.txt rename to doc/source/_includes/ansible_install_time_only.txt index a6cacd159..768ee04dc 100644 --- a/doc/source/deploy_install_guides/r5_release/ansible_install_time_only.txt +++ b/doc/source/_includes/ansible_install_time_only.txt @@ -1,7 +1,7 @@ -.. important:: - - Some Ansible bootstrap parameters cannot be changed or are very difficult to change after installation is complete. - - 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 ` for details. \ No newline at end of file +.. important:: + + Some Ansible bootstrap parameters cannot be changed or are very difficult to change after installation is complete. + + 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 ` for details. \ No newline at end of file diff --git a/doc/source/_includes/docker-proxy-config.rest b/doc/source/_includes/docker-proxy-config.rest index 2609a24bc..fd78f570a 100644 --- a/doc/source/_includes/docker-proxy-config.rest +++ b/doc/source/_includes/docker-proxy-config.rest @@ -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>`. +`. .. r3_end diff --git a/doc/source/deploy_install_guides/r5_release/kubernetes_install_next.txt b/doc/source/_includes/kubernetes_install_next.txt similarity index 68% rename from doc/source/deploy_install_guides/r5_release/kubernetes_install_next.txt rename to doc/source/_includes/kubernetes_install_next.txt index 877c4a9a6..17f621ff1 100644 --- a/doc/source/deploy_install_guides/r5_release/kubernetes_install_next.txt +++ b/doc/source/_includes/kubernetes_install_next.txt @@ -1,7 +1,7 @@ -Your Kubernetes cluster is now up and running. - -For instructions on how to access StarlingX Kubernetes see -:doc:`../kubernetes_access`. - -For instructions on how to install and access StarlingX OpenStack see -:doc:`../openstack/index`. \ No newline at end of file +Your Kubernetes cluster is now up and running. + +For instructions on how to access StarlingX Kubernetes see +:ref:`kubernetes_access`. + +For instructions on how to install and access StarlingX OpenStack see +:doc:`/deploy_install_guides/r6_release/openstack/index`. \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r6_release/kubernetes_install_next.txt b/doc/source/_includes/r5_kubernetes_install_next.txt similarity index 68% rename from doc/source/deploy_install_guides/r6_release/kubernetes_install_next.txt rename to doc/source/_includes/r5_kubernetes_install_next.txt index 877c4a9a6..65944e54e 100644 --- a/doc/source/deploy_install_guides/r6_release/kubernetes_install_next.txt +++ b/doc/source/_includes/r5_kubernetes_install_next.txt @@ -1,7 +1,7 @@ -Your Kubernetes cluster is now up and running. - -For instructions on how to access StarlingX Kubernetes see -:doc:`../kubernetes_access`. - -For instructions on how to install and access StarlingX OpenStack see -:doc:`../openstack/index`. \ No newline at end of file +Your Kubernetes cluster is now up and running. + +For instructions on how to access StarlingX Kubernetes see +:ref:`kubernetes_access`. + +For instructions on how to install and access StarlingX OpenStack see +:doc:`/deploy_install_guides/r5_release/openstack/index`. \ No newline at end of file diff --git a/doc/source/_includes/set-proxy-at-bootstrap.rest b/doc/source/_includes/set-proxy-at-bootstrap.rest index fc7c021d6..663074e16 100644 --- a/doc/source/_includes/set-proxy-at-bootstrap.rest +++ b/doc/source/_includes/set-proxy-at-bootstrap.rest @@ -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>`. \ No newline at end of file +:doc:`Ansible Bootstrap Configurations `. \ No newline at end of file diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index 20c4c029d..8abb3d675 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -1,3 +1,5 @@ +.. _doc_contribute_guide: + =============================== Documentation Contributor Guide =============================== diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 291fb6553..003654802 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -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 diff --git a/doc/source/datanet/kubernetes/the-data-network-topology-view.rst b/doc/source/datanet/kubernetes/the-data-network-topology-view.rst index 5c35eaa2c..e1f0cc32e 100644 --- a/doc/source/datanet/kubernetes/the-data-network-topology-view.rst +++ b/doc/source/datanet/kubernetes/the-data-network-topology-view.rst @@ -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: diff --git a/doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst b/doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst index d0db4cb80..028c08695 100644 --- a/doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst +++ b/doc/source/datanet/openstack/adding-a-static-ip-address-to-a-data-interface.rst @@ -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**. diff --git a/doc/source/datanet/openstack/dynamic-vxlan.rst b/doc/source/datanet/openstack/dynamic-vxlan.rst index f76a9c094..9b266ab42 100644 --- a/doc/source/datanet/openstack/dynamic-vxlan.rst +++ b/doc/source/datanet/openstack/dynamic-vxlan.rst @@ -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 diff --git a/doc/source/datanet/openstack/static-vxlan.rst b/doc/source/datanet/openstack/static-vxlan.rst index 5dc59b223..6ccdb0821 100644 --- a/doc/source/datanet/openstack/static-vxlan.rst +++ b/doc/source/datanet/openstack/static-vxlan.rst @@ -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` diff --git a/doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst b/doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst index 4514c6c9b..d14d5bb83 100644 --- a/doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst +++ b/doc/source/datanet/openstack/using-ip-address-pools-for-data-interfaces.rst @@ -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. diff --git a/doc/source/deploy_install_guides/nvme_config.rst b/doc/source/deploy_install_guides/nvme_config.rst index 11f39aadd..b98e57939 100644 --- a/doc/source/deploy_install_guides/nvme_config.rst +++ b/doc/source/deploy_install_guides/nvme_config.rst @@ -1,3 +1,5 @@ +.. _nvme_config: + ==================================== Configure NVMe Drive as Primary Disk ==================================== diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex.rst index 376decf6f..49320eba7 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_hardware.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_hardware.rst index 5b8f062d9..92c4d595c 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_hardware.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_hardware.rst @@ -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 | diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst index 957647e5a..634dd9c29 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex.rst index b704e0316..60a37eaaf 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_hardware.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_hardware.rst index 18b6cec54..6812b1c39 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_hardware.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_hardware.rst @@ -16,40 +16,40 @@ 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 | -| | | -| | or | -| | | -| | - 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`) | -+-------------------------+-----------------------------------------------------------+ -| 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 | -+-------------------------+-----------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------+ +| 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 | +| | | +| | or | +| | | +| | - 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 :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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst index aec7e3f8a..33427041b 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage.rst index 8139e3e95..6a22900b2 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage.rst @@ -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 ------------ diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_hardware.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_hardware.rst index c79456547..f3a1065fd 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_hardware.rst @@ -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. | diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst index cf8f44d30..6a17ee349 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage.rst index 11cb22c39..23672a898 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_hardware.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_hardware.rst index 6866f3b85..b85924554 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_hardware.rst @@ -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 | diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst index 83d992bac..fd64dc3ca 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/ironic.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/ironic.rst index adb0e9edc..e79211626 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/ironic.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/ironic.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage.rst index f3f377863..ac0435d54 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage.rst @@ -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 ------------ diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_hardware.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_hardware.rst index 0ee2dd69d..a2b1d56dd 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_hardware.rst @@ -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 | diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst index ab64aab32..9bea0e9dd 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst index 0c27e4655..8368d7fc5 100644 --- a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst +++ b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/kubernetes_access.rst b/doc/source/deploy_install_guides/r5_release/kubernetes_access.rst index cd06f32a2..9b57fb801 100644 --- a/doc/source/deploy_install_guides/r5_release/kubernetes_access.rst +++ b/doc/source/deploy_install_guides/r5_release/kubernetes_access.rst @@ -1,3 +1,5 @@ +.. _kubernetes_access: + ================================ Access StarlingX Kubernetes R5.0 ================================ diff --git a/doc/source/deploy_install_guides/r5_release/openstack/access.rst b/doc/source/deploy_install_guides/r5_release/openstack/access.rst index 369611019..fceab08e1 100644 --- a/doc/source/deploy_install_guides/r5_release/openstack/access.rst +++ b/doc/source/deploy_install_guides/r5_release/openstack/access.rst @@ -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% diff --git a/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex.rst b/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex.rst index 173ceff87..6ec742e39 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst index 98c5688e0..4bb56eb6b 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex.rst b/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex.rst index f7ba41260..ea79ce044 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst index c54d58ad8..ad2f413b6 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/controller_storage.rst b/doc/source/deploy_install_guides/r5_release/virtual/controller_storage.rst index 10247f394..9e08e99e1 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/controller_storage.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/controller_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst index c3f574e1d..3410b298d 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage.rst b/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage.rst index e58e6c9eb..22c9b8dd2 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage_install_kubernetes.rst index 053346f12..8ad164c94 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage_install_kubernetes.rst @@ -399,4 +399,4 @@ Unlock worker nodes Next steps ---------- -.. include:: ../kubernetes_install_next.txt +.. include:: /_includes/r5_kubernetes_install_next.txt diff --git a/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst b/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst index 702cb8eb4..ca1e9de98 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/rook_storage.rst b/doc/source/deploy_install_guides/r5_release/virtual/rook_storage.rst index 9982438c4..acb35a6c9 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/rook_storage.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/rook_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r5_release/virtual/rook_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/virtual/rook_storage_install_kubernetes.rst index 9e0479cab..3729e8738 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/rook_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/rook_storage_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex.rst index 388e68b54..fd013f4b9 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_hardware.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_hardware.rst index ca4ee4c3b..a5f99b997 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_hardware.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_hardware.rst @@ -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 | diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst index 7e2495a81..c87dc2411 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex.rst index f24ad7548..ee4cedda3 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_hardware.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_hardware.rst index 9b89b83f1..6a3ca6c42 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_hardware.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_hardware.rst @@ -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 | diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst index 52dc19715..81936e9d4 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage.rst index ad301d382..322398436 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage.rst @@ -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 ------------ diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_hardware.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_hardware.rst index f54122b16..47c6c6b5c 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_hardware.rst @@ -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. | diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_install_kubernetes.rst index 453383785..afd6f392f 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage.rst index 8be908d09..7a0a68cdd 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_hardware.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_hardware.rst index ac9dbc9d2..2a80e4fc0 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_hardware.rst @@ -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 | diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_install_kubernetes.rst index 8f69685fa..2d3e2a5f8 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_install_kubernetes.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/ironic.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/ironic.rst index fdd2878bd..6bd094e4b 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/ironic.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/ironic.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage.rst index 04bdb645e..4e85600fe 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage.rst @@ -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 ------------ diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_hardware.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_hardware.rst index be4df18e8..82a26815b 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_hardware.rst @@ -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 | diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_install_kubernetes.rst index 12aeade0b..4735ab280 100644 --- a/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r6_release/distributed_cloud/index.rst b/doc/source/deploy_install_guides/r6_release/distributed_cloud/index.rst index aff2a5fdb..e6bc078b3 100644 --- a/doc/source/deploy_install_guides/r6_release/distributed_cloud/index.rst +++ b/doc/source/deploy_install_guides/r6_release/distributed_cloud/index.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/openstack/access.rst b/doc/source/deploy_install_guides/r6_release/openstack/access.rst index 369611019..deeea031b 100644 --- a/doc/source/deploy_install_guides/r6_release/openstack/access.rst +++ b/doc/source/deploy_install_guides/r6_release/openstack/access.rst @@ -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% diff --git a/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex.rst b/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex.rst index e03bb551f..edc96c54c 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst index 122ccb73d..23d1d07fe 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex.rst b/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex.rst index 9f6004797..cbc6b98bc 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst index af5850e0c..72c68b830 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/controller_storage.rst b/doc/source/deploy_install_guides/r6_release/virtual/controller_storage.rst index 1fd962f56..33a6730fa 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/controller_storage.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/controller_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst index f58d9a832..4e3bcb0ef 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst @@ -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/.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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage.rst b/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage.rst index 5cdb0a908..0b3862953 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage_install_kubernetes.rst index 866b0b5c8..38f166f3c 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage_install_kubernetes.rst @@ -399,4 +399,4 @@ Unlock worker nodes Next steps ---------- -.. include:: ../kubernetes_install_next.txt +.. include:: /_includes/kubernetes_install_next.txt diff --git a/doc/source/deploy_install_guides/r6_release/virtual/install_virtualbox.rst b/doc/source/deploy_install_guides/r6_release/virtual/install_virtualbox.rst index d7864dfec..a352af8ee 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/install_virtualbox.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/install_virtualbox.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/rook_storage.rst b/doc/source/deploy_install_guides/r6_release/virtual/rook_storage.rst index 3b27dd974..473570a07 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/rook_storage.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/rook_storage.rst @@ -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 diff --git a/doc/source/deploy_install_guides/r6_release/virtual/rook_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r6_release/virtual/rook_storage_install_kubernetes.rst index 267408f12..0d2826722 100644 --- a/doc/source/deploy_install_guides/r6_release/virtual/rook_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r6_release/virtual/rook_storage_install_kubernetes.rst @@ -543,4 +543,4 @@ On virtual storage-0 and storage-1: Next steps ---------- -.. include:: ../kubernetes_install_next.txt +.. include:: /_includes/kubernetes_install_next.txt diff --git a/doc/source/developer_resources/backup_restore.rst b/doc/source/developer_resources/backup_restore.rst index e5e434115..15344db60 100644 --- a/doc/source/developer_resources/backup_restore.rst +++ b/doc/source/developer_resources/backup_restore.rst @@ -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: diff --git a/doc/source/developer_resources/debug_issues.rst b/doc/source/developer_resources/debug_issues.rst index 7a7c7b031..a5485af27 100644 --- a/doc/source/developer_resources/debug_issues.rst +++ b/doc/source/developer_resources/debug_issues.rst @@ -111,7 +111,7 @@ Implement fixes * Make the changes in your *development workspace* with the StarlingX codebase. * Build the related packages using ``build-pkgs ``. - * 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. diff --git a/doc/source/developer_resources/starlingx_patching.rst b/doc/source/developer_resources/starlingx_patching.rst index a07dc756a..0d1bc5b1b 100644 --- a/doc/source/developer_resources/starlingx_patching.rst +++ b/doc/source/developer_resources/starlingx_patching.rst @@ -1,3 +1,5 @@ +.. _starlingx_patching: + ================== StarlingX patching ================== diff --git a/doc/source/developer_resources/stx_ipv6_deployment.rst b/doc/source/developer_resources/stx_ipv6_deployment.rst index e98061401..3422fa142 100644 --- a/doc/source/developer_resources/stx_ipv6_deployment.rst +++ b/doc/source/developer_resources/stx_ipv6_deployment.rst @@ -1,3 +1,5 @@ +.. _stx_ipv6_deployment: + ========================= StarlingX IPv6 Deployment ========================= diff --git a/doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst index 78969aa9c..34f8c7c58 100644 --- a/doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst index 0c8a17aa1..014912a56 100644 --- a/doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst index 5836a1136..cf4326917 100644 --- a/doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst index 36640cc21..c35191bb9 100644 --- a/doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst index 70cf92774..caf014ba9 100644 --- a/doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst index fcc62921e..ec6d3c228 100644 --- a/doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst index 034aa2ee1..dd126d03e 100644 --- a/doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst index 9c6b30367..f02ef39fc 100644 --- a/doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst @@ -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: diff --git a/doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst b/doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst index 0753000f0..3ae2b217f 100644 --- a/doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst +++ b/doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst @@ -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 \ No newline at end of file diff --git a/doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst b/doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst index e6d4f67e6..91a3440f9 100644 --- a/doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst +++ b/doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst @@ -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 \ No newline at end of file + .. image:: /shared/figures/fault-mgmt/nlc1463584178366.png \ No newline at end of file diff --git a/doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst b/doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst index f7db34047..c82c7ccb3 100644 --- a/doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst +++ b/doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst @@ -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 diff --git a/doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst b/doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst index 70df06f94..9c93524f5 100644 --- a/doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst +++ b/doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst @@ -96,4 +96,4 @@ Collect Tool Caveats and Usage .. only:: partner - .. include:: ../../_includes/troubleshooting-log-collection.rest \ No newline at end of file + .. include:: /_includes/troubleshooting-log-collection.rest \ No newline at end of file diff --git a/doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst b/doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst index 00ac760d0..6dfa49e1e 100644 --- a/doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst +++ b/doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst @@ -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 diff --git a/doc/source/node_management/kubernetes/common_host_tasks/deleting-a-host-using-horizon.rst b/doc/source/node_management/kubernetes/common_host_tasks/deleting-a-host-using-horizon.rst index 589c01fcf..2fc4bf59e 100644 --- a/doc/source/node_management/kubernetes/common_host_tasks/deleting-a-host-using-horizon.rst +++ b/doc/source/node_management/kubernetes/common_host_tasks/deleting-a-host-using-horizon.rst @@ -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% diff --git a/doc/source/node_management/kubernetes/common_host_tasks/force-locking-a-host-using-horizon.rst b/doc/source/node_management/kubernetes/common_host_tasks/force-locking-a-host-using-horizon.rst index 0f2c57410..0f4eceb68 100644 --- a/doc/source/node_management/kubernetes/common_host_tasks/force-locking-a-host-using-horizon.rst +++ b/doc/source/node_management/kubernetes/common_host_tasks/force-locking-a-host-using-horizon.rst @@ -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 diff --git a/doc/source/node_management/kubernetes/common_host_tasks/locking-a-host-using-horizon.rst b/doc/source/node_management/kubernetes/common_host_tasks/locking-a-host-using-horizon.rst index 69e6b4c1c..0554a48be 100644 --- a/doc/source/node_management/kubernetes/common_host_tasks/locking-a-host-using-horizon.rst +++ b/doc/source/node_management/kubernetes/common_host_tasks/locking-a-host-using-horizon.rst @@ -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% diff --git a/doc/source/node_management/kubernetes/common_host_tasks/rebooting-a-host-using-horizon.rst b/doc/source/node_management/kubernetes/common_host_tasks/rebooting-a-host-using-horizon.rst index 027c18e31..d69910348 100644 --- a/doc/source/node_management/kubernetes/common_host_tasks/rebooting-a-host-using-horizon.rst +++ b/doc/source/node_management/kubernetes/common_host_tasks/rebooting-a-host-using-horizon.rst @@ -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% diff --git a/doc/source/node_management/kubernetes/common_host_tasks/reinstalling-a-host-using-horizon.rst b/doc/source/node_management/kubernetes/common_host_tasks/reinstalling-a-host-using-horizon.rst index 30cbafadb..a3bf314a0 100644 --- a/doc/source/node_management/kubernetes/common_host_tasks/reinstalling-a-host-using-horizon.rst +++ b/doc/source/node_management/kubernetes/common_host_tasks/reinstalling-a-host-using-horizon.rst @@ -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% diff --git a/doc/source/node_management/kubernetes/common_host_tasks/swacting-a-master-controller-using-horizon.rst b/doc/source/node_management/kubernetes/common_host_tasks/swacting-a-master-controller-using-horizon.rst index 1e9383887..cabb7e07b 100644 --- a/doc/source/node_management/kubernetes/common_host_tasks/swacting-a-master-controller-using-horizon.rst +++ b/doc/source/node_management/kubernetes/common_host_tasks/swacting-a-master-controller-using-horizon.rst @@ -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% diff --git a/doc/source/node_management/kubernetes/common_host_tasks/unlocking-a-host-using-horizon.rst b/doc/source/node_management/kubernetes/common_host_tasks/unlocking-a-host-using-horizon.rst index dc1b0c144..477e9dff2 100644 --- a/doc/source/node_management/kubernetes/common_host_tasks/unlocking-a-host-using-horizon.rst +++ b/doc/source/node_management/kubernetes/common_host_tasks/unlocking-a-host-using-horizon.rst @@ -34,5 +34,5 @@ see :ref:`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% diff --git a/doc/source/node_management/kubernetes/configuring_cpu_core_assignments/configuring-cpu-core-assignments.rst b/doc/source/node_management/kubernetes/configuring_cpu_core_assignments/configuring-cpu-core-assignments.rst index be352b245..dc407d9d1 100644 --- a/doc/source/node_management/kubernetes/configuring_cpu_core_assignments/configuring-cpu-core-assignments.rst +++ b/doc/source/node_management/kubernetes/configuring_cpu_core_assignments/configuring-cpu-core-assignments.rst @@ -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% diff --git a/doc/source/node_management/kubernetes/configuring_node_labels/configuring-node-labels-using-horizon.rst b/doc/source/node_management/kubernetes/configuring_node_labels/configuring-node-labels-using-horizon.rst index 69f426941..bb2e41414 100644 --- a/doc/source/node_management/kubernetes/configuring_node_labels/configuring-node-labels-using-horizon.rst +++ b/doc/source/node_management/kubernetes/configuring_node_labels/configuring-node-labels-using-horizon.rst @@ -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 diff --git a/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-heartbeat-failure-action.rst b/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-heartbeat-failure-action.rst index 27a67ac24..18da8fe83 100644 --- a/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-heartbeat-failure-action.rst +++ b/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-heartbeat-failure-action.rst @@ -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 to 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: diff --git a/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-multi-node-failure-avoidance.rst b/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-multi-node-failure-avoidance.rst index e9994ec4e..7b0dff5fd 100644 --- a/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-multi-node-failure-avoidance.rst +++ b/doc/source/node_management/kubernetes/customizing_the_host_life_cycles/configuring-multi-node-failure-avoidance.rst @@ -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. diff --git a/doc/source/node_management/kubernetes/host_hardware_sensors/adjusting-sensor-actions-and-audit-intervals.rst b/doc/source/node_management/kubernetes/host_hardware_sensors/adjusting-sensor-actions-and-audit-intervals.rst index 3dcb69cd7..d6c14fbae 100644 --- a/doc/source/node_management/kubernetes/host_hardware_sensors/adjusting-sensor-actions-and-audit-intervals.rst +++ b/doc/source/node_management/kubernetes/host_hardware_sensors/adjusting-sensor-actions-and-audit-intervals.rst @@ -31,7 +31,7 @@ To use the command-line interface, see :ref:`CLI Commands for Managing Sensors #. In the **Sensor Groups** list, click **Edit SensorGroup** for the group you want to configure. - .. figure:: ../figures/jow1443885204993.png + .. figure:: /node_management/kubernetes/figures/jow1443885204993.png :scale: 100% In the Edit SensorGroup dialog box, change the settings as required. diff --git a/doc/source/node_management/kubernetes/host_hardware_sensors/relearning-sensor-models.rst b/doc/source/node_management/kubernetes/host_hardware_sensors/relearning-sensor-models.rst index 966f552bd..62bf4f3cb 100644 --- a/doc/source/node_management/kubernetes/host_hardware_sensors/relearning-sensor-models.rst +++ b/doc/source/node_management/kubernetes/host_hardware_sensors/relearning-sensor-models.rst @@ -50,7 +50,7 @@ for your system. #. On the Sensors page, click **Relearn Sensor Model**. - .. figure:: ../figures/eoc1497190198018.png + .. figure:: /node_management/kubernetes/figures/eoc1497190198018.png :scale: 100% Allow about two minutes for the sensor information to be updated. diff --git a/doc/source/node_management/kubernetes/host_hardware_sensors/suppressing-sensor-actions.rst b/doc/source/node_management/kubernetes/host_hardware_sensors/suppressing-sensor-actions.rst index db3271140..625b3c88f 100644 --- a/doc/source/node_management/kubernetes/host_hardware_sensors/suppressing-sensor-actions.rst +++ b/doc/source/node_management/kubernetes/host_hardware_sensors/suppressing-sensor-actions.rst @@ -43,11 +43,11 @@ see :ref:`CLI Commands for Managing Sensors ` +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | **For a group of sensors** | To suppress actions for a group of sensors, open the **Actions** menu for the group, and then select **Suppress SensorGroup**. | | | | - | | .. figure:: ../figures/jow1443890971677.png | + | | .. figure:: /node_management/kubernetes/figures/jow1443890971677.png | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | **For an individual sensor** | To suppress actions for an individual sensor, locate the sensor in the **Sensors** list, and click **Suppress Sensor**. | | | | - | | .. figure:: ../figures/jow1443890898358.png | + | | .. figure:: /node_management/kubernetes/figures/jow1443890898358.png | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. rubric:: |result| diff --git a/doc/source/node_management/kubernetes/host_inventory/devices-tab.rst b/doc/source/node_management/kubernetes/host_inventory/devices-tab.rst index 11e474be5..8de2b5a00 100644 --- a/doc/source/node_management/kubernetes/host_inventory/devices-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/devices-tab.rst @@ -14,7 +14,7 @@ All non-|NIC| |PCI| devices that can be exposed to a guest application are listed. They are automatically detected by the system, and cannot be manually added or deleted. -.. figure:: ../figures/szv1567164542479.png +.. figure:: /node_management/kubernetes/figures/szv1567164542479.png :scale: 100% .. note:: diff --git a/doc/source/node_management/kubernetes/host_inventory/filesystems-tab.rst b/doc/source/node_management/kubernetes/host_inventory/filesystems-tab.rst index 782b93e56..09ac81963 100644 --- a/doc/source/node_management/kubernetes/host_inventory/filesystems-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/filesystems-tab.rst @@ -9,7 +9,7 @@ Filesystems Tab The **Filesystems** tab on the Host Detail page presents file system details for a host. -.. figure:: ../figures/mov1566319898101.png +.. figure:: /node_management/kubernetes/figures/mov1566319898101.png :scale: 100% The **Filesystems** tab includes the following items: diff --git a/doc/source/node_management/kubernetes/host_inventory/hosts-tab.rst b/doc/source/node_management/kubernetes/host_inventory/hosts-tab.rst index 44af06637..0bd6cd5a4 100644 --- a/doc/source/node_management/kubernetes/host_inventory/hosts-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/hosts-tab.rst @@ -12,7 +12,7 @@ detailed information about the hosts, and execute maintenance operations. A sample **Hosts** tab is illustrated below: -.. figure:: ../figures/jpx1567098739405.png +.. figure:: /node_management/kubernetes/figures/jpx1567098739405.png :scale: 100% **Host Name** @@ -139,7 +139,7 @@ A sample **Hosts** tab is illustrated below: The **Edit Host** button displays the Edit Host window, as illustrated below for a worker node: - .. figure:: ../figures/gkb1569351598356.png + .. figure:: /node_management/kubernetes/figures/gkb1569351598356.png :scale: 100% This is the same window you use to assign the host's personality when diff --git a/doc/source/node_management/kubernetes/host_inventory/interfaces-tab.rst b/doc/source/node_management/kubernetes/host_inventory/interfaces-tab.rst index b7c76b03e..f92aa0284 100644 --- a/doc/source/node_management/kubernetes/host_inventory/interfaces-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/interfaces-tab.rst @@ -11,7 +11,7 @@ logical L2 network interfaces on a node. The following example is for an unlocked controller node: -.. figure:: ../figures/hxu1567097201027.png +.. figure:: /node_management/kubernetes/figures/hxu1567097201027.png :scale: 100% On a configured worker node, the Interfaces tab may include additional diff --git a/doc/source/node_management/kubernetes/host_inventory/labels-tab.rst b/doc/source/node_management/kubernetes/host_inventory/labels-tab.rst index 3bab7b42b..2feb4bfe3 100644 --- a/doc/source/node_management/kubernetes/host_inventory/labels-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/labels-tab.rst @@ -12,7 +12,7 @@ review the labels attached to a host. The Labels tab displays the list of Kubernetes labels and their values assigned to the current host. -.. figure:: ../figures/qes1567103095290.png +.. figure:: /node_management/kubernetes/figures/qes1567103095290.png :scale: 100% Use the **Assign Kube Label** button to select additional host labels. diff --git a/doc/source/node_management/kubernetes/host_inventory/lldp-tab.rst b/doc/source/node_management/kubernetes/host_inventory/lldp-tab.rst index dd9916761..8bb2d66bd 100644 --- a/doc/source/node_management/kubernetes/host_inventory/lldp-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/lldp-tab.rst @@ -12,7 +12,7 @@ neighbors' ports though the Link Layer Discovery Protocol. The **LLDP** tab provides the following information about each LLDP-enabled neighbor device: -.. figure:: ../figures/blp1567103635948.png +.. figure:: /node_management/kubernetes/figures/blp1567103635948.png :scale: 100% ------------ diff --git a/doc/source/node_management/kubernetes/host_inventory/memory-tab.rst b/doc/source/node_management/kubernetes/host_inventory/memory-tab.rst index 0c6839e9c..8bd36529e 100644 --- a/doc/source/node_management/kubernetes/host_inventory/memory-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/memory-tab.rst @@ -8,7 +8,7 @@ Memory Tab The **Memory** tab on the Host Detail page displays host memory details. -.. figure:: ../figures/qjh1567165597148.png +.. figure:: /node_management/kubernetes/figures/qjh1567165597148.png :scale: 100% The information is presented in three columns, as follows: diff --git a/doc/source/node_management/kubernetes/host_inventory/overview-tab.rst b/doc/source/node_management/kubernetes/host_inventory/overview-tab.rst index 3f6eec64c..dc6dfa2b0 100644 --- a/doc/source/node_management/kubernetes/host_inventory/overview-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/overview-tab.rst @@ -9,7 +9,7 @@ Overview Tab The **Overview** tab on the Host Detail page summarizes essential information about a host object. -.. figure:: ../figures/pcd1567096217474.png +.. figure:: /node_management/kubernetes/figures/pcd1567096217474.png :scale: 100% diff --git a/doc/source/node_management/kubernetes/host_inventory/ports-tab.rst b/doc/source/node_management/kubernetes/host_inventory/ports-tab.rst index 6c4379073..5041d002c 100644 --- a/doc/source/node_management/kubernetes/host_inventory/ports-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/ports-tab.rst @@ -9,7 +9,7 @@ Ports Tab The **Ports** tab on the Host Detail page presents information about the physical ports on a host. -.. figure:: ../figures/iln1567164165572.png +.. figure:: /node_management/kubernetes/figures/iln1567164165572.png :scale: 100% Currently none of the port attributes is configurable; they are all read diff --git a/doc/source/node_management/kubernetes/host_inventory/processor-tab.rst b/doc/source/node_management/kubernetes/host_inventory/processor-tab.rst index f019c69ed..d63cdc79f 100644 --- a/doc/source/node_management/kubernetes/host_inventory/processor-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/processor-tab.rst @@ -9,7 +9,7 @@ Processor Tab The **Processor** tab on the Host Detail page presents processor details for a host. -.. figure:: ../figures/ldv1567165392491.png +.. figure:: /node_management/kubernetes/figures/ldv1567165392491.png :scale: 100% diff --git a/doc/source/node_management/kubernetes/host_inventory/sensors-tab.rst b/doc/source/node_management/kubernetes/host_inventory/sensors-tab.rst index 76306f00e..a6eb9865f 100644 --- a/doc/source/node_management/kubernetes/host_inventory/sensors-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/sensors-tab.rst @@ -13,7 +13,7 @@ This tab lists the available |BMC| sensors and shows their status. It also lists sensor groups that have been defined for the sensors. -.. figure:: ../figures/jow1443825878164.png +.. figure:: /node_management/kubernetes/figures/jow1443825878164.png :scale: 100% .. _sensors-tab-section-N1006C-N10029-N10001: diff --git a/doc/source/node_management/kubernetes/host_inventory/storage-tab.rst b/doc/source/node_management/kubernetes/host_inventory/storage-tab.rst index 1f5b3d411..7dec2323b 100644 --- a/doc/source/node_management/kubernetes/host_inventory/storage-tab.rst +++ b/doc/source/node_management/kubernetes/host_inventory/storage-tab.rst @@ -21,7 +21,7 @@ Disks This list is presented for all host types. It lists all available hardware devices used for storage. -.. figure:: ../figures/bsa1464962126609.png +.. figure:: /node_management/kubernetes/figures/bsa1464962126609.png :scale: 100% For each device, the following information is included: @@ -58,7 +58,7 @@ Partitions For all host types, this list shows user-created disk partitions. -.. figure:: ../figures/lci1515513441685.png +.. figure:: /node_management/kubernetes/figures/lci1515513441685.png :scale: 100% **UUID** @@ -88,7 +88,7 @@ Physical Volumes On controller and worker hosts, this list shows physical volumes \(disk or partitions\) assigned to local volume groups. -.. figure:: ../figures/fph1515514594885.png +.. figure:: /node_management/kubernetes/figures/fph1515514594885.png :scale: 100% **Name** @@ -123,7 +123,7 @@ Storage Functions This list is presented for storage hosts. It shows a list of logical storage functions \(OSDs and Ceph journal functions\) defined on available disks. -.. figure:: ../figures/caf1464886132887.png +.. figure:: /shared/figures/storage/caf1464886132887.png :scale: 100% For each volume, the following information is included: diff --git a/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst b/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst index 1bfbd4ff9..baf749a7c 100644 --- a/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst +++ b/doc/source/node_management/kubernetes/host_memory_provisioning/allocating-host-memory-using-horizon.rst @@ -41,7 +41,7 @@ from the available memory, an informative message is displayed. #. On the **Memory** tab, click **Update Memory**. - .. figure:: ../figures/esy1567176125909.png + .. figure:: /node_management/kubernetes/figures/esy1567176125909.png :scale: 100% #. Use the Update Memory Allocation dialog box to set the memory allocations @@ -54,7 +54,7 @@ from the available memory, an informative message is displayed. in Kubernetes, only a single huge page size can be used per host, across Application memory. - .. figure:: ../figures/yfv1567176747837.png + .. figure:: /node_management/kubernetes/figures/yfv1567176747837.png :scale: 100% .. only:: partner @@ -70,7 +70,7 @@ from the available memory, an informative message is displayed. minimum requirement, hover over the information icon next to the field. - .. figure:: ../figures/jow1436294915672.png + .. figure:: /node_management/kubernetes/figures/jow1436294915672.png :scale: 100% **\# of Application 2M Hugepages Node n** @@ -119,7 +119,7 @@ from the available memory, an informative message is displayed. on a node \(assuming that pages of another size are not also requested\), hover over the information icon next to the field. - .. figure:: ../figures/jow1432129731308.png + .. figure:: /node_management/kubernetes/figures/jow1432129731308.png :scale: 100% Any unused memory is automatically allocated as 4 KiB pages of regular diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst index 5ad7bb09e..b34a612f4 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-horizon.rst @@ -29,12 +29,12 @@ for different types of interface, see :ref:`Interface Settings #. Select the **Interfaces** tab. - .. figure:: ../figures/zbl1538147657952.png + .. figure:: /node_management/kubernetes/figures/zbl1538147657952.png :scale: 100% #. Click **Create Interface**. - .. figure:: ../figures/bpw1538149046903.png + .. figure:: /node_management/kubernetes/figures/bpw1538149046903.png :scale: 100% #. Select the class of the interface, from the **Interface Class** drop-down @@ -69,4 +69,4 @@ The interface is created and attached to the network. .. only:: partner - .. include:: ../../../_includes/configuring-aggregated-ethernet-interfaces-using-horizon.rest + .. include:: /_includes/configuring-aggregated-ethernet-interfaces-using-horizon.rest diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst index ee10037a6..6d8b66ddc 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst @@ -13,7 +13,7 @@ Ethernet interfaces to networks. .. only:: partner - ../../../_includes/configuring-aggregated-ethernet-interfaces-using-the-cli.rest + /_includes/configuring-aggregated-ethernet-interfaces-using-the-cli.rest For more about link aggregation modes and policies, see :ref:`Link Aggregation Settings `. diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-on-sriov-interface-from-horizon.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-on-sriov-interface-from-horizon.rst index cf6d98a2a..bbb3e0285 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-on-sriov-interface-from-horizon.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-on-sriov-interface-from-horizon.rst @@ -21,7 +21,7 @@ the CLI `. \> **Host Inventory** in the left-hand panel, under **Actions** click on the down arrow button on "Edit Host" and select "Lock Host". - .. image:: ../figures/rst1442611298701.png + .. image:: /shared/figures/system_configuration/rst1442611298701.png :width: 550 #. Open the Host Detail page for the host. @@ -36,7 +36,7 @@ the CLI `. #. Select the **Interfaces** tab. - .. image:: ../figures/vpw1612788524636.png + .. image:: /node_management/kubernetes/figures/vpw1612788524636.png #. Open the **Host Inventory** page, available from **Admin** \> **Platform** \> **Host Inventory** in the left-hand panel, under **Actions** click on the @@ -56,4 +56,4 @@ the CLI `. #. Click **Create Interface** to save your changes and close the dialog box. - .. image:: ../figures/qes1612788640104.png + .. image:: /node_management/kubernetes/figures/qes1612788640104.png diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-using-horizon.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-using-horizon.rst index bef5f1028..97e322544 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-using-horizon.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-ethernet-interfaces-using-horizon.rst @@ -46,13 +46,13 @@ see :ref:`Interface Settings `. #. Select the **Interfaces** tab. - .. figure:: ../figures/zbl1538147657952.png + .. figure:: /node_management/kubernetes/figures/zbl1538147657952.png :scale: 100% #. Click **Edit Interface** for the interface you want to attach to a network. - .. figure:: ../figures/bvb1538146331222.png + .. figure:: /node_management/kubernetes/figures/bvb1538146331222.png :scale: 100% For an Ethernet interface, the **Port** is already selected. diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-vlan-interfaces-using-horizon.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-vlan-interfaces-using-horizon.rst index 70cc9015d..acfa594cd 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-vlan-interfaces-using-horizon.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-vlan-interfaces-using-horizon.rst @@ -32,12 +32,12 @@ can do this using the Horizon Web interface or the CLI. #. Select the **Interfaces** tab. - .. figure:: ../figures/zbl1538147657952.png + .. figure:: /node_management/kubernetes/figures/zbl1538147657952.png :scale: 100% #. Click **Create Interface**. - .. figure:: ../figures/bpw1538149046903.png + .. figure:: /node_management/kubernetes/figures/bpw1538149046903.png :scale: 100% #. Select the type of network for the interface. diff --git a/doc/source/node_management/kubernetes/node_interfaces/deleting-or-disabling-interfaces-using-horizon.rst b/doc/source/node_management/kubernetes/node_interfaces/deleting-or-disabling-interfaces-using-horizon.rst index 6bf4996bd..85880c96d 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/deleting-or-disabling-interfaces-using-horizon.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/deleting-or-disabling-interfaces-using-horizon.rst @@ -26,12 +26,12 @@ You can delete an interface using the Horizon Web interface. +-------------------------------------------+--------------------------------------------------------------------------------------------+ | **To delete a non-Ethernet Interface** | Select **Delete Interface** from the **Actions** menu for the interface. | | | | - | | .. figure:: ../figures/wuq1538163902474.png | + | | .. figure:: /node_management/kubernetes/figures/wuq1538163902474.png | | | :scale: 60% | +-------------------------------------------+--------------------------------------------------------------------------------------------+ | **To disable an Ethernet Interface** | #. Select **Edit Interface** from the **Actions** menu for the interface. | | | | | | #. In the Edit Interface pop-up, set **Interface Class** to None and select **Save**. | | | | - | | .. figure:: ../figures/juc1579524423575.png | + | | .. figure:: /node_management/kubernetes/figures/juc1579524423575.png | +-------------------------------------------+--------------------------------------------------------------------------------------------+ diff --git a/doc/source/node_management/kubernetes/node_interfaces/editing-interface-settings.rst b/doc/source/node_management/kubernetes/node_interfaces/editing-interface-settings.rst index 5f2a6ec5a..5b438636d 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/editing-interface-settings.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/editing-interface-settings.rst @@ -35,12 +35,12 @@ management network, you must update this manually to **aggregated ethernet**. #. Select the **Interfaces** tab to display the existing interfaces. - .. figure:: ../figures/zbl1538147657952.png + .. figure:: /node_management/kubernetes/figures/zbl1538147657952.png :scale: 100% #. Click **Edit Interface** for the interface you want to change. - .. figure:: ../figures/bvb1538146331222.png + .. figure:: /node_management/kubernetes/figures/bvb1538146331222.png :scale: 100% #. Make the required changes and then click **Save**. diff --git a/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst b/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst index 50c1990a8..be17afba8 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/provisioning-sr-iov-vf-interfaces-using-the-cli.rst @@ -113,7 +113,7 @@ For more information, see :ref:`Provision SR-IOV Interfaces using the CLI .. only:: partner - .. include:: ../../../_includes/provisioning-sr-iov-vf-interfaces-using-the-cli.rest + .. include:: /_includes/provisioning-sr-iov-vf-interfaces-using-the-cli.rest **networks** A list of data networks that are attached to the interface, delimited diff --git a/doc/source/node_management/kubernetes/node_inventory_tasks/starting-starlingx.rst b/doc/source/node_management/kubernetes/node_inventory_tasks/starting-starlingx.rst index 153f0306c..90ea1ddd2 100644 --- a/doc/source/node_management/kubernetes/node_inventory_tasks/starting-starlingx.rst +++ b/doc/source/node_management/kubernetes/node_inventory_tasks/starting-starlingx.rst @@ -69,5 +69,5 @@ shut down and physically moved. #. On the Hosts tab of the **Admin** \> **Platform** \> **Host Inventory** page, select **Edit Host** \> **Unlock Host**. - .. figure:: ../figures/rst1446643548268.png + .. figure:: /node_management/kubernetes/figures/rst1446643548268.png :scale: 100% diff --git a/doc/source/node_management/kubernetes/provisioning_bmc/deprovisioning-board-management-control-from-horizon.rst b/doc/source/node_management/kubernetes/provisioning_bmc/deprovisioning-board-management-control-from-horizon.rst index 348dd29e1..f212cd948 100644 --- a/doc/source/node_management/kubernetes/provisioning_bmc/deprovisioning-board-management-control-from-horizon.rst +++ b/doc/source/node_management/kubernetes/provisioning_bmc/deprovisioning-board-management-control-from-horizon.rst @@ -26,7 +26,7 @@ For more information about |IPMI|, see: #. Switch to the Board Management tab. - .. figure:: ../figures/sxl1575923501137.jpeg + .. figure:: /node_management/kubernetes/figures/sxl1575923501137.jpeg :scale: 80% #. From the **Board Management Controller Type** drop-down list, select diff --git a/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-board-management-control-from-horizon.rst b/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-board-management-control-from-horizon.rst index 17940000b..29e8de68c 100644 --- a/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-board-management-control-from-horizon.rst +++ b/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-board-management-control-from-horizon.rst @@ -32,7 +32,7 @@ Management Control from Horizon #. Switch to the Board Management tab. - .. figure:: ../figures/sxl1575923501137.jpeg + .. figure:: /node_management/kubernetes/figures/sxl1575923501137.jpeg :scale: 80% #. From the **Board Management Controller Type** drop-down list, select diff --git a/doc/source/node_management/openstack/adding-compute-nodes-to-an-existing-duplex-system.rst b/doc/source/node_management/openstack/adding-compute-nodes-to-an-existing-duplex-system.rst index 3b8a204db..7f5ea5c1b 100644 --- a/doc/source/node_management/openstack/adding-compute-nodes-to-an-existing-duplex-system.rst +++ b/doc/source/node_management/openstack/adding-compute-nodes-to-an-existing-duplex-system.rst @@ -13,7 +13,7 @@ the standard procedures for adding compute nodes to a system. .. only:: partner - .. include:: ../../_includes/adding-compute-nodes-to-an-existing-duplex-system.rest + .. include:: /_includes/adding-compute-nodes-to-an-existing-duplex-system.rest Before adding compute nodes to a duplex system, you can either add and provision platform RAM and CPU cores on the controllers or reallocate RAM and diff --git a/doc/source/node_management/openstack/configuring-a-flavor-to-use-a-generic-pci-device.rst b/doc/source/node_management/openstack/configuring-a-flavor-to-use-a-generic-pci-device.rst index db032fba2..f9a34a57e 100644 --- a/doc/source/node_management/openstack/configuring-a-flavor-to-use-a-generic-pci-device.rst +++ b/doc/source/node_management/openstack/configuring-a-flavor-to-use-a-generic-pci-device.rst @@ -27,7 +27,7 @@ extra specification. From the |os-prod-hor| interface, use the **Custom Extra Spec** selection in the **Create Flavor Extra Spec** drop-down menu. For the **Key**, use **pci\_passthrough:alias**. -.. image:: ../figures/kho1513370501907.png +.. image:: /node_management/figures/kho1513370501907.png diff --git a/doc/source/node_management/openstack/configuring-pci-passthrough-ethernet-interfaces.rst b/doc/source/node_management/openstack/configuring-pci-passthrough-ethernet-interfaces.rst index 54635b17d..85465e33e 100644 --- a/doc/source/node_management/openstack/configuring-pci-passthrough-ethernet-interfaces.rst +++ b/doc/source/node_management/openstack/configuring-pci-passthrough-ethernet-interfaces.rst @@ -44,12 +44,12 @@ already, and that |VLAN| ID 10 is a valid segmentation ID assigned to #. Select the **Interfaces** tab. #. Click the **Edit Interface** button associated with the interface you - want to configure. + want to configure. The Edit Interface dialog appears. - .. image:: ../figures/ptj1538163621289.png + .. image:: /node_management/figures/ptj1538163621289.png @@ -77,7 +77,7 @@ already, and that |VLAN| ID 10 is a valid segmentation ID assigned to - The segmentation ID is set to 10. - .. image:: ../figures/bek1516655307871.png + .. image:: /node_management/figures/bek1516655307871.png @@ -141,7 +141,7 @@ to the **net0** project network identified with |VLAN| ID 10. .. only:: partner - .. include:: ../../_includes/configuring-pci-passthrough-ethernet-interfaces.rest + .. include:: /_includes/configuring-pci-passthrough-ethernet-interfaces.rest :start-after: warning-text-begin :end-before: warning-text-end @@ -164,7 +164,7 @@ virtual machines in the same |prod-os| cluster. In this case: .. only:: partner - .. include:: ../../_includes/configuring-pci-passthrough-ethernet-interfaces.rest + .. include:: /_includes/configuring-pci-passthrough-ethernet-interfaces.rest :start-after: vlan-bullet-1-begin :end-before: vlan-bullet-1-end @@ -188,14 +188,14 @@ following configuration is also required: .. only:: partner - .. include:: ../../_includes/configuring-pci-passthrough-ethernet-interfaces.rest + .. include:: /_includes/configuring-pci-passthrough-ethernet-interfaces.rest :start-after: vlan-bullet-2-begin :end-before: vlan-bullet-2-end .. only:: partner - .. include:: ../../_includes/configuring-pci-passthrough-ethernet-interfaces.rest + .. include:: /_includes/configuring-pci-passthrough-ethernet-interfaces.rest :start-after: vlan-bullet-3-begin :end-before: vlan-bullet-3-end diff --git a/doc/source/node_management/openstack/exposing-a-generic-pci-device-for-use-by-vms.rst b/doc/source/node_management/openstack/exposing-a-generic-pci-device-for-use-by-vms.rst index 6908881b2..1091f8685 100644 --- a/doc/source/node_management/openstack/exposing-a-generic-pci-device-for-use-by-vms.rst +++ b/doc/source/node_management/openstack/exposing-a-generic-pci-device-for-use-by-vms.rst @@ -44,7 +44,7 @@ To edit a device, you must first lock the host. #. Click **Edit Device**. - .. image:: ../figures/jow1452530556357.png + .. image:: /node_management/figures/jow1452530556357.png #. Update the information as required. diff --git a/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst b/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst index 45cafda2e..3ddc95231 100644 --- a/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst +++ b/doc/source/node_management/openstack/pci-passthrough-ethernet-interface-devices.rst @@ -24,7 +24,7 @@ taken into consideration. They include: .. only:: partner - .. include:: ../../_includes/pci-passthrough-ethernet-interface-devices.rest + .. include:: /_includes/pci-passthrough-ethernet-interface-devices.rest :start-after: avs-bullet-3-begin :end-before: avs-bullet-3-end @@ -39,7 +39,7 @@ taken into consideration. They include: .. only:: partner - .. include:: ../../_includes/pci-passthrough-ethernet-interface-devices.rest + .. include:: /_includes/pci-passthrough-ethernet-interface-devices.rest :start-after: avs-text-begin :end-before: avs-text-end diff --git a/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst b/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst index de6368b1f..44cdf5539 100644 --- a/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst +++ b/doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst @@ -43,7 +43,7 @@ OpenStack role. .. only:: partner - .. include:: ../../_includes/using-labels-to-identify-openstack-nodes.rest + .. include:: /_includes/using-labels-to-identify-openstack-nodes.rest :start-after: table-1-of-contents-begin :end-before: table-1-of-contents-end @@ -90,6 +90,6 @@ Nodes must be locked before labels can be assigned or removed. .. only:: partner - .. include:: ../../_includes/using-labels-to-identify-openstack-nodes.rest + .. include:: /_includes/using-labels-to-identify-openstack-nodes.rest :start-after: table-1-of-contents-end diff --git a/doc/source/operations/app_management.rst b/doc/source/operations/app_management.rst index 378e2668c..4cf6746ae 100644 --- a/doc/source/operations/app_management.rst +++ b/doc/source/operations/app_management.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add Application Management Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/controller_service_manage.rst b/doc/source/operations/controller_service_manage.rst index 8afd29d0c..9330c7bb7 100644 --- a/doc/source/operations/controller_service_manage.rst +++ b/doc/source/operations/controller_service_manage.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add Controller Services Management Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/dedicate_cpu_container.rst b/doc/source/operations/dedicate_cpu_container.rst index fa923be02..3b4e16a2f 100644 --- a/doc/source/operations/dedicate_cpu_container.rst +++ b/doc/source/operations/dedicate_cpu_container.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add Kubernetes Dedicate CPUs to Container Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/fault_management.rst b/doc/source/operations/fault_management.rst index 70034644e..5e920a206 100644 --- a/doc/source/operations/fault_management.rst +++ b/doc/source/operations/fault_management.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add Fault Management Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/k8s_persistent_vol_claims.rst b/doc/source/operations/k8s_persistent_vol_claims.rst index 65f774755..73de1c3e1 100644 --- a/doc/source/operations/k8s_persistent_vol_claims.rst +++ b/doc/source/operations/k8s_persistent_vol_claims.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add Kubernetes Persistent Volume Claims in Containers Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/lldp_monitor.rst b/doc/source/operations/lldp_monitor.rst index 100bdfda8..7f44404d9 100644 --- a/doc/source/operations/lldp_monitor.rst +++ b/doc/source/operations/lldp_monitor.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add LLDP Monitoring and Display Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/openstack_vm_pci_config.rst b/doc/source/operations/openstack_vm_pci_config.rst index 8110c6544..f32141217 100644 --- a/doc/source/operations/openstack_vm_pci_config.rst +++ b/doc/source/operations/openstack_vm_pci_config.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add VM Generic PCI Device Configuration Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/storage_util_display.rst b/doc/source/operations/storage_util_display.rst index 277daa136..d5df1e941 100644 --- a/doc/source/operations/storage_util_display.rst +++ b/doc/source/operations/storage_util_display.rst @@ -9,7 +9,7 @@ See the story for additional information about what is needed: `Add Storage Utilization Display Guide `_ For information about contributing to the StarlingX documentation, see the -:doc:`/contributor/doc_contribute_guide`. +:ref:`doc_contribute_guide`. .. contents:: :local: diff --git a/doc/source/operations/tsn.rst b/doc/source/operations/tsn.rst index 643fa5fd2..0af2478e4 100644 --- a/doc/source/operations/tsn.rst +++ b/doc/source/operations/tsn.rst @@ -111,7 +111,7 @@ Edge cloud platform ******************* #. Install STX environment: follow the instructions from the - :doc:`Installation Guides <../deploy_install_guides/index>` to install one + :doc:`Installation Guides ` to install one STX environment (for example STX AIO). #. Prepare a :abbr:`VM (Virtual Machine)` image. Create image ``tsn_ubuntu_19_04.img`` diff --git a/doc/source/planning/kubernetes/internal-management-network-planning.rst b/doc/source/planning/kubernetes/internal-management-network-planning.rst index b5b07a4c3..aa36e6952 100755 --- a/doc/source/planning/kubernetes/internal-management-network-planning.rst +++ b/doc/source/planning/kubernetes/internal-management-network-planning.rst @@ -58,4 +58,4 @@ You must consider the following guidelines: .. only:: partner - .. include:: ../../_includes/subnet-sizing-restrictions.rest \ No newline at end of file + .. include:: /_includes/subnet-sizing-restrictions.rest \ No newline at end of file diff --git a/doc/source/planning/kubernetes/network-planning-the-pxe-boot-network.rst b/doc/source/planning/kubernetes/network-planning-the-pxe-boot-network.rst index 8e18d3950..6133cbe1b 100755 --- a/doc/source/planning/kubernetes/network-planning-the-pxe-boot-network.rst +++ b/doc/source/planning/kubernetes/network-planning-the-pxe-boot-network.rst @@ -19,7 +19,7 @@ IPv4. .. only:: partner - .. include:: ../../_includes/subnet-sizing-restrictions.rest + .. include:: /_includes/subnet-sizing-restrictions.rest .. note:: |prod| does not support IPv6 |PXE| booting. diff --git a/doc/source/planning/kubernetes/oam-network-planning.rst b/doc/source/planning/kubernetes/oam-network-planning.rst index bc7775ad8..989ae5911 100755 --- a/doc/source/planning/kubernetes/oam-network-planning.rst +++ b/doc/source/planning/kubernetes/oam-network-planning.rst @@ -73,4 +73,4 @@ guidelines: .. only:: partner - .. include:: ../../_includes/subnet-sizing-restrictions.rest \ No newline at end of file + .. include:: /_includes/subnet-sizing-restrictions.rest \ No newline at end of file diff --git a/doc/source/planning/kubernetes/redundant-top-of-rack-switch-deployment-considerations.rst b/doc/source/planning/kubernetes/redundant-top-of-rack-switch-deployment-considerations.rst index 732fdd1f2..606964ac4 100755 --- a/doc/source/planning/kubernetes/redundant-top-of-rack-switch-deployment-considerations.rst +++ b/doc/source/planning/kubernetes/redundant-top-of-rack-switch-deployment-considerations.rst @@ -13,7 +13,7 @@ In a redundant |ToR| switch configuration, each link in a link aggregate is connected to a different switch, as shown in the accompanying figure. If one switch fails, another is available to service the link aggregate. -.. figure:: ../figures/jow1438030468959.png +.. figure:: /shared/figures/planning/jow1438030468959.png *Redundant Top-of-Rack Switches* diff --git a/doc/source/planning/kubernetes/the-cluster-host-network.rst b/doc/source/planning/kubernetes/the-cluster-host-network.rst index 2d72fd9f6..7c9adfbb7 100755 --- a/doc/source/planning/kubernetes/the-cluster-host-network.rst +++ b/doc/source/planning/kubernetes/the-cluster-host-network.rst @@ -48,4 +48,4 @@ available next hop controller and/or worker nodes' cluster host IP Addresses. .. only:: partner - .. include:: ../../_includes/subnet-sizing-restrictions.rest \ No newline at end of file + .. include:: /_includes/subnet-sizing-restrictions.rest \ No newline at end of file diff --git a/doc/source/planning/kubernetes/verified-commercial-hardware.rst b/doc/source/planning/kubernetes/verified-commercial-hardware.rst index c739b655f..e1f41d7f2 100755 --- a/doc/source/planning/kubernetes/verified-commercial-hardware.rst +++ b/doc/source/planning/kubernetes/verified-commercial-hardware.rst @@ -188,4 +188,4 @@ Verified and approved hardware components for use with |prod| are listed here. | | - Quanta | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. include:: ../../_includes/release-notes-overview-footnote.rest \ No newline at end of file +.. include:: /_includes/release-notes-overview-footnote.rest \ No newline at end of file diff --git a/doc/source/planning/openstack/ethernet-interface-configuration.rst b/doc/source/planning/openstack/ethernet-interface-configuration.rst index 007a67c9b..655db96b4 100755 --- a/doc/source/planning/openstack/ethernet-interface-configuration.rst +++ b/doc/source/planning/openstack/ethernet-interface-configuration.rst @@ -91,4 +91,4 @@ accelerator from Intel. |prod-os| manages the allocation of |SRIOV| VFs to .. only:: partner - .. include:: ../../_includes/ethernet-interface-configuration.rest + .. include:: /_includes/ethernet-interface-configuration.rest diff --git a/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst b/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst index c467d349d..50f2de700 100755 --- a/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst +++ b/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst @@ -191,6 +191,6 @@ here. To configure PCI-Passthrough Interface to NVIDIA GPU in a |VM|, see the :ref:`Configure PCI-Passthrough Interface to NVIDIA GPU in a VM ` for more details. -.. include:: ../../_includes/installation-and-resource-planning-verified-commercial-hardware.rest +.. include:: /_includes/installation-and-resource-planning-verified-commercial-hardware.rest diff --git a/doc/source/planning/openstack/os-data-networks-overview.rst b/doc/source/planning/openstack/os-data-networks-overview.rst index 89a3d98ef..f65a848b5 100755 --- a/doc/source/planning/openstack/os-data-networks-overview.rst +++ b/doc/source/planning/openstack/os-data-networks-overview.rst @@ -40,4 +40,4 @@ see the |datanet-doc| documentation: .. only:: partner - .. include:: ../../_includes/os-data-networks-overview.rest + .. include:: /_includes/os-data-networks-overview.rest diff --git a/doc/source/planning/openstack/port-security-extension.rst b/doc/source/planning/openstack/port-security-extension.rst index c96e3734e..8b808fc3d 100755 --- a/doc/source/planning/openstack/port-security-extension.rst +++ b/doc/source/planning/openstack/port-security-extension.rst @@ -24,4 +24,4 @@ By default, the port security extension driver is disabled. .. only:: partner - .. include:: ../../_includes/port-security-extension.rest + .. include:: /_includes/port-security-extension.rest diff --git a/doc/source/planning/openstack/project-network-planning.rst b/doc/source/planning/openstack/project-network-planning.rst index 64f700d4c..60f6c0cca 100755 --- a/doc/source/planning/openstack/project-network-planning.rst +++ b/doc/source/planning/openstack/project-network-planning.rst @@ -10,4 +10,4 @@ In addition to the standard features for OpenStack project networks, project network planning on an |prod-os| system can take advantage of extended capabilities offered by |prod-os|. -.. include:: ../../_includes/project-network-planning.rest +.. include:: /_includes/project-network-planning.rest diff --git a/doc/source/planning/openstack/project-networks.rst b/doc/source/planning/openstack/project-networks.rst index a8a9e5a39..2f2e86f53 100755 --- a/doc/source/planning/openstack/project-networks.rst +++ b/doc/source/planning/openstack/project-networks.rst @@ -27,7 +27,7 @@ For data networks of the |VLAN| type, consider the following guidelines: .. only:: partner - .. include:: ../../_includes/project-networks.rest + .. include:: /_includes/project-networks.rest :start-after: vlan-begin :end-before: vxlan-begin @@ -56,7 +56,7 @@ For data networks of the |VXLAN| type, consider the following guidelines: - Layer 3 routers used to interconnect compute nodes must be multicast-enabled, as required by the |VXLAN| protocol. -.. include:: ../../_includes/project-networks.rest +.. include:: /_includes/project-networks.rest :start-after: vxlan-begin - To support |IGMP| and |MLD| snooping, Layer 3 routers must be configured diff --git a/doc/source/planning/openstack/storage-resources.rst b/doc/source/planning/openstack/storage-resources.rst index cb81dbe01..5250bee92 100755 --- a/doc/source/planning/openstack/storage-resources.rst +++ b/doc/source/planning/openstack/storage-resources.rst @@ -21,7 +21,7 @@ Storage Services and Backends The figure below shows the storage options and backends for |prod-os|. -.. figure:: ../figures/zpk1486667625575.png +.. figure:: /shared/figures/storage/zpk1486667625575.png |prod-os| Storage Options and Backends diff --git a/doc/source/planning/openstack/the-ethernet-mtu.rst b/doc/source/planning/openstack/the-ethernet-mtu.rst index 2d25a530a..ec423bdd9 100755 --- a/doc/source/planning/openstack/the-ethernet-mtu.rst +++ b/doc/source/planning/openstack/the-ethernet-mtu.rst @@ -103,4 +103,4 @@ default |MTU| size: .. .. only:: partner -.. include:: ../../_includes/the-ethernet-mtu.rest +.. include:: /_includes/the-ethernet-mtu.rest diff --git a/doc/source/planning/openstack/vm-network-interface-options.rst b/doc/source/planning/openstack/vm-network-interface-options.rst index ef4d300e9..7acd96978 100755 --- a/doc/source/planning/openstack/vm-network-interface-options.rst +++ b/doc/source/planning/openstack/vm-network-interface-options.rst @@ -17,7 +17,7 @@ interface drivers in addition to the standard OpenStack choices. .. only:: partner - .. include:: ../../_includes/vm-network-interface-options.rest + .. include:: /_includes/vm-network-interface-options.rest :start-after: unmodified-guests-virtio-begin :end-before: highest-performance-begin @@ -34,7 +34,7 @@ interface drivers in addition to the standard OpenStack choices. .. only:: partner - .. include:: ../../_includes/vm-network-interface-options.rest + .. include:: /_includes/vm-network-interface-options.rest :start-after: highest-performance-begin .. xbooklink For more information about |AVP| drivers, see OpenStack VNF Integration: :ref:`Accelerated Virtual Interfaces `. diff --git a/doc/source/deploy_install_guides/r6_release/desc_aio_duplex.txt b/doc/source/shared/_includes/desc_aio_duplex.txt similarity index 83% rename from doc/source/deploy_install_guides/r6_release/desc_aio_duplex.txt rename to doc/source/shared/_includes/desc_aio_duplex.txt index ec00437cf..a8f981dff 100644 --- a/doc/source/deploy_install_guides/r6_release/desc_aio_duplex.txt +++ b/doc/source/shared/_includes/desc_aio_duplex.txt @@ -1,29 +1,29 @@ -The All-in-one Duplex (AIO-DX) deployment option provides a pair of high -availability (HA) servers with each server providing all three cloud functions -(controller, worker, and storage). - -An AIO-DX configuration provides the following benefits: - -* Only a small amount of cloud processing and storage power is required -* Application consolidation using multiple containers or virtual machines on a - single pair of physical servers -* High availability (HA) services run on the controller function across two - physical servers in either active/active or active/standby mode -* A storage back end solution using a two-node CEPH deployment across two servers -* Containers or virtual machines scheduled on both worker functions -* Protection against overall server hardware fault, where - - * All controller HA services go active on the remaining healthy server - * All virtual machines are recovered on the remaining healthy server - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-duplex.png - :scale: 50% - :alt: All-in-one Duplex deployment configuration - +The All-in-one Duplex (AIO-DX) deployment option provides a pair of high +availability (HA) servers with each server providing all three cloud functions +(controller, worker, and storage). + +An AIO-DX configuration provides the following benefits: + +* Only a small amount of cloud processing and storage power is required +* Application consolidation using multiple containers or virtual machines on a + single pair of physical servers +* High availability (HA) services run on the controller function across two + physical servers in either active/active or active/standby mode +* A storage back end solution using a two-node CEPH deployment across two servers +* Containers or virtual machines scheduled on both worker functions +* Protection against overall server hardware fault, where + + * All controller HA services go active on the remaining healthy server + * All virtual machines are recovered on the remaining healthy server + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :ref:`docker_proxy_config` for + details. + +.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-duplex.png + :scale: 50% + :alt: All-in-one Duplex deployment configuration + *Figure 1: All-in-one Duplex deployment configuration* \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r5_release/desc_aio_simplex.txt b/doc/source/shared/_includes/desc_aio_simplex.txt similarity index 80% rename from doc/source/deploy_install_guides/r5_release/desc_aio_simplex.txt rename to doc/source/shared/_includes/desc_aio_simplex.txt index 56b22e94b..41ac5172b 100644 --- a/doc/source/deploy_install_guides/r5_release/desc_aio_simplex.txt +++ b/doc/source/shared/_includes/desc_aio_simplex.txt @@ -1,24 +1,24 @@ -The All-in-one Simplex (AIO-SX) deployment option provides all three cloud -functions (controller, worker, and storage) on a single server with the -following benefits: - -* Requires only a small amount of cloud processing and storage power -* Application consolidation using multiple containers or virtual machines on a - single pair of physical servers -* A storage backend solution using a single-node CEPH deployment - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-simplex.png - :scale: 50% - :alt: All-in-one Simplex deployment configuration - - *Figure 1: All-in-one Simplex deployment configuration* - -An AIO-SX deployment gives no protection against overall server hardware fault. -Hardware component protection can be enabled with, for example, a hardware RAID +The All-in-one Simplex (AIO-SX) deployment option provides all three cloud +functions (controller, worker, and storage) on a single server with the +following benefits: + +* Requires only a small amount of cloud processing and storage power +* Application consolidation using multiple containers or virtual machines on a + single pair of physical servers +* A storage backend solution using a single-node CEPH deployment + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :ref:`docker_proxy_config` for + details. + +.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-simplex.png + :scale: 50% + :alt: All-in-one Simplex deployment configuration + + *Figure 1: All-in-one Simplex deployment configuration* + +An AIO-SX deployment gives no protection against overall server hardware fault. +Hardware component protection can be enabled with, for example, a hardware RAID or 2x Port LAG in the deployment. \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r5_release/desc_controller_storage.txt b/doc/source/shared/_includes/desc_controller_storage.txt similarity index 83% rename from doc/source/deploy_install_guides/r5_release/desc_controller_storage.txt rename to doc/source/shared/_includes/desc_controller_storage.txt index 3d606d532..5111df9c0 100644 --- a/doc/source/deploy_install_guides/r5_release/desc_controller_storage.txt +++ b/doc/source/shared/_includes/desc_controller_storage.txt @@ -1,28 +1,27 @@ -The Standard with Controller Storage deployment option provides two high -availability (HA) controller nodes and a pool of up to 10 worker nodes. - -A Standard with Controller Storage configuration provides the following benefits: - -* A pool of up to 10 worker nodes -* High availability (HA) services run across the controller nodes in either - active/active or active/standby mode -* A storage back end solution using a two-node CEPH deployment across two - controller servers -* Protection against overall controller and worker node failure, where - - * On overall controller node failure, all controller HA services go active on - the remaining healthy controller node - * On overall worker node failure, virtual machines and containers are - recovered on the remaining healthy worker nodes - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-controller-storage.png - :scale: 50% - :alt: Standard with Controller Storage deployment configuration - +The Standard with Controller Storage deployment option provides two high +availability (HA) controller nodes and a pool of up to 10 worker nodes. + +A Standard with Controller Storage configuration provides the following benefits: + +* A pool of up to 10 worker nodes +* High availability (HA) services run across the controller nodes in either + active/active or active/standby mode +* A storage back end solution using a two-node CEPH deployment across two + controller servers +* Protection against overall controller and worker node failure, where + + * On overall controller node failure, all controller HA services go active on + the remaining healthy controller node + * On overall worker node failure, virtual machines and containers are + recovered on the remaining healthy worker nodes + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :ref:`docker_proxy_config` for details. + +.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-controller-storage.png + :scale: 50% + :alt: Standard with Controller Storage deployment configuration + *Figure 1: Standard with Controller Storage deployment configuration* \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r6_release/desc_dedicated_storage.txt b/doc/source/shared/_includes/desc_dedicated_storage.txt similarity index 81% rename from doc/source/deploy_install_guides/r6_release/desc_dedicated_storage.txt rename to doc/source/shared/_includes/desc_dedicated_storage.txt index 79371f446..c6742f957 100644 --- a/doc/source/deploy_install_guides/r6_release/desc_dedicated_storage.txt +++ b/doc/source/shared/_includes/desc_dedicated_storage.txt @@ -1,24 +1,23 @@ -The Standard with Dedicated Storage deployment option is a standard installation -with independent controller, worker, and storage nodes. - -A Standard with Dedicated Storage configuration provides the following benefits: - -* A pool of up to 100 worker nodes -* A 2x node high availability (HA) controller cluster with HA services running - across the controller nodes in either active/active or active/standby mode -* A storage back end solution using a two-to-9x node HA CEPH storage cluster - that supports a replication factor of two or three -* Up to four groups of 2x storage nodes, or up to three groups of 3x storage - nodes - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-dedicated-storage.png - :scale: 50% - :alt: Standard with Dedicated Storage deployment configuration - +The Standard with Dedicated Storage deployment option is a standard installation +with independent controller, worker, and storage nodes. + +A Standard with Dedicated Storage configuration provides the following benefits: + +* A pool of up to 100 worker nodes +* A 2x node high availability (HA) controller cluster with HA services running + across the controller nodes in either active/active or active/standby mode +* A storage back end solution using a two-to-9x node HA CEPH storage cluster + that supports a replication factor of two or three +* Up to four groups of 2x storage nodes, or up to three groups of 3x storage + nodes + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :ref:`docker_proxy_config` for details. + +.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-dedicated-storage.png + :scale: 50% + :alt: Standard with Dedicated Storage deployment configuration + *Figure 1: Standard with Dedicated Storage deployment configuration* \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r5_release/desc_rook_storage.txt b/doc/source/shared/_includes/desc_rook_storage.txt similarity index 82% rename from doc/source/deploy_install_guides/r5_release/desc_rook_storage.txt rename to doc/source/shared/_includes/desc_rook_storage.txt index eb5ebc287..9d8ac9a07 100644 --- a/doc/source/deploy_install_guides/r5_release/desc_rook_storage.txt +++ b/doc/source/shared/_includes/desc_rook_storage.txt @@ -12,10 +12,10 @@ A Standard with Rook Storage configuration provides the following benefits: .. 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-controller-storage.png +.. figure:: /deploy_install_guides/r6_release/figures/starlingx-deployment-options-controller-storage.png :scale: 50% :alt: Standard with Rook Storage deployment configuration diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/inc-install-software-on-controller.rest b/doc/source/shared/_includes/inc-install-software-on-controller.rest similarity index 100% rename from doc/source/deploy_install_guides/r5_release/bare_metal/inc-install-software-on-controller.rest rename to doc/source/shared/_includes/inc-install-software-on-controller.rest diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/inc-openstack-specific-host-config.rest b/doc/source/shared/_includes/inc-openstack-specific-host-config.rest similarity index 100% rename from doc/source/deploy_install_guides/r6_release/bare_metal/inc-openstack-specific-host-config.rest rename to doc/source/shared/_includes/inc-openstack-specific-host-config.rest diff --git a/doc/source/deploy_install_guides/r6_release/ipv6_note.txt b/doc/source/shared/_includes/ipv6_note.txt similarity index 70% rename from doc/source/deploy_install_guides/r6_release/ipv6_note.txt rename to doc/source/shared/_includes/ipv6_note.txt index 1605f30f1..53f4ced8b 100644 --- a/doc/source/deploy_install_guides/r6_release/ipv6_note.txt +++ b/doc/source/shared/_includes/ipv6_note.txt @@ -1,14 +1,13 @@ -.. note:: - - By default, StarlingX uses IPv4. To use StarlingX with IPv6: - - * The entire infrastructure and cluster configuration must be IPv6, with the - exception of the PXE boot network. - - * Not all external servers are reachable via IPv6 addresses (for example - Docker registries). Depending on your infrastructure, it may be necessary - to deploy a NAT64/DNS64 gateway to translate the IPv4 addresses to IPv6. - - * Refer to the :doc:`/../developer_resources/stx_ipv6_deployment` guide - for details on how to deploy a NAT64/DNS64 gateway to use StarlingX - with IPv6. +.. note:: + + By default, StarlingX uses IPv4. To use StarlingX with IPv6: + + * The entire infrastructure and cluster configuration must be IPv6, with the + exception of the PXE boot network. + + * Not all external servers are reachable via IPv6 addresses (for example + Docker registries). Depending on your infrastructure, it may be necessary + to deploy a NAT64/DNS64 gateway to translate the IPv4 addresses to IPv6. + + * Refer to :ref:`stx_ipv6_deployment` for details on how to deploy a + NAT64/DNS64 gateway to use StarlingX with IPv6. diff --git a/doc/source/deploy_install_guides/r6_release/ansible_install_time_only.txt b/doc/source/shared/_includes/r5_ansible_install_time_only.txt similarity index 89% rename from doc/source/deploy_install_guides/r6_release/ansible_install_time_only.txt rename to doc/source/shared/_includes/r5_ansible_install_time_only.txt index 008aa91f7..499cd29e6 100644 --- a/doc/source/deploy_install_guides/r6_release/ansible_install_time_only.txt +++ b/doc/source/shared/_includes/r5_ansible_install_time_only.txt @@ -1,7 +1,7 @@ -.. important:: - - Some Ansible bootstrap parameters cannot be changed or are very difficult to change after installation is complete. - - 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 ` for details. \ No newline at end of file +.. important:: + + Some Ansible bootstrap parameters cannot be changed or are very difficult to change after installation is complete. + + 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 ` for details. \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r5_release/desc_aio_duplex.txt b/doc/source/shared/_includes/r5_desc_aio_duplex.txt similarity index 83% rename from doc/source/deploy_install_guides/r5_release/desc_aio_duplex.txt rename to doc/source/shared/_includes/r5_desc_aio_duplex.txt index ec00437cf..b0d9f5aa5 100644 --- a/doc/source/deploy_install_guides/r5_release/desc_aio_duplex.txt +++ b/doc/source/shared/_includes/r5_desc_aio_duplex.txt @@ -1,29 +1,29 @@ -The All-in-one Duplex (AIO-DX) deployment option provides a pair of high -availability (HA) servers with each server providing all three cloud functions -(controller, worker, and storage). - -An AIO-DX configuration provides the following benefits: - -* Only a small amount of cloud processing and storage power is required -* Application consolidation using multiple containers or virtual machines on a - single pair of physical servers -* High availability (HA) services run on the controller function across two - physical servers in either active/active or active/standby mode -* A storage back end solution using a two-node CEPH deployment across two servers -* Containers or virtual machines scheduled on both worker functions -* Protection against overall server hardware fault, where - - * All controller HA services go active on the remaining healthy server - * All virtual machines are recovered on the remaining healthy server - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-duplex.png - :scale: 50% - :alt: All-in-one Duplex deployment configuration - +The All-in-one Duplex (AIO-DX) deployment option provides a pair of high +availability (HA) servers with each server providing all three cloud functions +(controller, worker, and storage). + +An AIO-DX configuration provides the following benefits: + +* Only a small amount of cloud processing and storage power is required +* Application consolidation using multiple containers or virtual machines on a + single pair of physical servers +* High availability (HA) services run on the controller function across two + physical servers in either active/active or active/standby mode +* A storage back end solution using a two-node CEPH deployment across two servers +* Containers or virtual machines scheduled on both worker functions +* Protection against overall server hardware fault, where + + * All controller HA services go active on the remaining healthy server + * All virtual machines are recovered on the remaining healthy server + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :doc:`/configuration/docker_proxy_config` for + details. + +.. figure:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-duplex.png + :scale: 50% + :alt: All-in-one Duplex deployment configuration + *Figure 1: All-in-one Duplex deployment configuration* \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r6_release/desc_aio_simplex.txt b/doc/source/shared/_includes/r5_desc_aio_simplex.txt similarity index 80% rename from doc/source/deploy_install_guides/r6_release/desc_aio_simplex.txt rename to doc/source/shared/_includes/r5_desc_aio_simplex.txt index 56b22e94b..d83fea851 100644 --- a/doc/source/deploy_install_guides/r6_release/desc_aio_simplex.txt +++ b/doc/source/shared/_includes/r5_desc_aio_simplex.txt @@ -1,24 +1,24 @@ -The All-in-one Simplex (AIO-SX) deployment option provides all three cloud -functions (controller, worker, and storage) on a single server with the -following benefits: - -* Requires only a small amount of cloud processing and storage power -* Application consolidation using multiple containers or virtual machines on a - single pair of physical servers -* A storage backend solution using a single-node CEPH deployment - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-simplex.png - :scale: 50% - :alt: All-in-one Simplex deployment configuration - - *Figure 1: All-in-one Simplex deployment configuration* - -An AIO-SX deployment gives no protection against overall server hardware fault. -Hardware component protection can be enabled with, for example, a hardware RAID +The All-in-one Simplex (AIO-SX) deployment option provides all three cloud +functions (controller, worker, and storage) on a single server with the +following benefits: + +* Requires only a small amount of cloud processing and storage power +* Application consolidation using multiple containers or virtual machines on a + single pair of physical servers +* A storage backend solution using a single-node CEPH deployment + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :doc:`/configuration/docker_proxy_config` for + details. + +.. figure:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-simplex.png + :scale: 50% + :alt: All-in-one Simplex deployment configuration + + *Figure 1: All-in-one Simplex deployment configuration* + +An AIO-SX deployment gives no protection against overall server hardware fault. +Hardware component protection can be enabled with, for example, a hardware RAID or 2x Port LAG in the deployment. \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r6_release/desc_controller_storage.txt b/doc/source/shared/_includes/r5_desc_controller_storage.txt similarity index 84% rename from doc/source/deploy_install_guides/r6_release/desc_controller_storage.txt rename to doc/source/shared/_includes/r5_desc_controller_storage.txt index 3d606d532..cddc5a1c6 100644 --- a/doc/source/deploy_install_guides/r6_release/desc_controller_storage.txt +++ b/doc/source/shared/_includes/r5_desc_controller_storage.txt @@ -1,28 +1,28 @@ -The Standard with Controller Storage deployment option provides two high -availability (HA) controller nodes and a pool of up to 10 worker nodes. - -A Standard with Controller Storage configuration provides the following benefits: - -* A pool of up to 10 worker nodes -* High availability (HA) services run across the controller nodes in either - active/active or active/standby mode -* A storage back end solution using a two-node CEPH deployment across two - controller servers -* Protection against overall controller and worker node failure, where - - * On overall controller node failure, all controller HA services go active on - the remaining healthy controller node - * On overall worker node failure, virtual machines and containers are - recovered on the remaining healthy worker nodes - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-controller-storage.png - :scale: 50% - :alt: Standard with Controller Storage deployment configuration - +The Standard with Controller Storage deployment option provides two high +availability (HA) controller nodes and a pool of up to 10 worker nodes. + +A Standard with Controller Storage configuration provides the following benefits: + +* A pool of up to 10 worker nodes +* High availability (HA) services run across the controller nodes in either + active/active or active/standby mode +* A storage back end solution using a two-node CEPH deployment across two + controller servers +* Protection against overall controller and worker node failure, where + + * On overall controller node failure, all controller HA services go active on + the remaining healthy controller node + * On overall worker node failure, virtual machines and containers are + recovered on the remaining healthy worker nodes + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :doc:`/configuration/docker_proxy_config` for + details. + +.. figure:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png + :scale: 50% + :alt: Standard with Controller Storage deployment configuration + *Figure 1: Standard with Controller Storage deployment configuration* \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r5_release/desc_dedicated_storage.txt b/doc/source/shared/_includes/r5_desc_dedicated_storage.txt similarity index 82% rename from doc/source/deploy_install_guides/r5_release/desc_dedicated_storage.txt rename to doc/source/shared/_includes/r5_desc_dedicated_storage.txt index 79371f446..1226521d5 100644 --- a/doc/source/deploy_install_guides/r5_release/desc_dedicated_storage.txt +++ b/doc/source/shared/_includes/r5_desc_dedicated_storage.txt @@ -1,24 +1,24 @@ -The Standard with Dedicated Storage deployment option is a standard installation -with independent controller, worker, and storage nodes. - -A Standard with Dedicated Storage configuration provides the following benefits: - -* A pool of up to 100 worker nodes -* A 2x node high availability (HA) controller cluster with HA services running - across the controller nodes in either active/active or active/standby mode -* A storage back end solution using a two-to-9x node HA CEPH storage cluster - that supports a replication factor of two or three -* Up to four groups of 2x storage nodes, or up to three groups of 3x storage - nodes - -.. note:: - - If you are behind a corporate firewall or proxy, you need to set proxy - settings. Refer to :doc:`/../../configuration/docker_proxy_config` for - details. - -.. figure:: ../figures/starlingx-deployment-options-dedicated-storage.png - :scale: 50% - :alt: Standard with Dedicated Storage deployment configuration - +The Standard with Dedicated Storage deployment option is a standard installation +with independent controller, worker, and storage nodes. + +A Standard with Dedicated Storage configuration provides the following benefits: + +* A pool of up to 100 worker nodes +* A 2x node high availability (HA) controller cluster with HA services running + across the controller nodes in either active/active or active/standby mode +* A storage back end solution using a two-to-9x node HA CEPH storage cluster + that supports a replication factor of two or three +* Up to four groups of 2x storage nodes, or up to three groups of 3x storage + nodes + +.. note:: + + If you are behind a corporate firewall or proxy, you need to set proxy + settings. Refer to :doc:`/configuration/docker_proxy_config` for + details. + +.. figure:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-dedicated-storage.png + :scale: 50% + :alt: Standard with Dedicated Storage deployment configuration + *Figure 1: Standard with Dedicated Storage deployment configuration* \ No newline at end of file diff --git a/doc/source/deploy_install_guides/r6_release/desc_rook_storage.txt b/doc/source/shared/_includes/r5_desc_rook_storage.txt similarity index 81% rename from doc/source/deploy_install_guides/r6_release/desc_rook_storage.txt rename to doc/source/shared/_includes/r5_desc_rook_storage.txt index eb5ebc287..8c26ae060 100644 --- a/doc/source/deploy_install_guides/r6_release/desc_rook_storage.txt +++ b/doc/source/shared/_includes/r5_desc_rook_storage.txt @@ -12,10 +12,10 @@ A Standard with Rook Storage configuration provides the following benefits: .. 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 :doc:`/configuration/docker_proxy_config` for details. -.. figure:: ../figures/starlingx-deployment-options-controller-storage.png +.. figure:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png :scale: 50% :alt: Standard with Rook Storage deployment configuration diff --git a/doc/source/deploy_install_guides/r6_release/bare_metal/inc-install-software-on-controller.rest b/doc/source/shared/_includes/r5_inc-install-software-on-controller.rest similarity index 100% rename from doc/source/deploy_install_guides/r6_release/bare_metal/inc-install-software-on-controller.rest rename to doc/source/shared/_includes/r5_inc-install-software-on-controller.rest diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/inc-openstack-specific-host-config.rest b/doc/source/shared/_includes/r5_inc-openstack-specific-host-config.rest similarity index 100% rename from doc/source/deploy_install_guides/r5_release/bare_metal/inc-openstack-specific-host-config.rest rename to doc/source/shared/_includes/r5_inc-openstack-specific-host-config.rest diff --git a/doc/source/deploy_install_guides/r5_release/ipv6_note.txt b/doc/source/shared/_includes/r5_ipv6_note.txt similarity index 85% rename from doc/source/deploy_install_guides/r5_release/ipv6_note.txt rename to doc/source/shared/_includes/r5_ipv6_note.txt index 1605f30f1..f1b23967e 100644 --- a/doc/source/deploy_install_guides/r5_release/ipv6_note.txt +++ b/doc/source/shared/_includes/r5_ipv6_note.txt @@ -1,14 +1,14 @@ -.. note:: - - By default, StarlingX uses IPv4. To use StarlingX with IPv6: - - * The entire infrastructure and cluster configuration must be IPv6, with the - exception of the PXE boot network. - - * Not all external servers are reachable via IPv6 addresses (for example - Docker registries). Depending on your infrastructure, it may be necessary - to deploy a NAT64/DNS64 gateway to translate the IPv4 addresses to IPv6. - - * Refer to the :doc:`/../developer_resources/stx_ipv6_deployment` guide - for details on how to deploy a NAT64/DNS64 gateway to use StarlingX - with IPv6. +.. note:: + + By default, StarlingX uses IPv4. To use StarlingX with IPv6: + + * The entire infrastructure and cluster configuration must be IPv6, with the + exception of the PXE boot network. + + * Not all external servers are reachable via IPv6 addresses (for example + Docker registries). Depending on your infrastructure, it may be necessary + to deploy a NAT64/DNS64 gateway to translate the IPv4 addresses to IPv6. + + * Refer to the :doc:`/developer_resources/stx_ipv6_deployment` guide + for details on how to deploy a NAT64/DNS64 gateway to use StarlingX + with IPv6. diff --git a/doc/source/datanet/figures/bju1538154656153.png b/doc/source/shared/figures/datanet/bju1538154656153.png similarity index 100% rename from doc/source/datanet/figures/bju1538154656153.png rename to doc/source/shared/figures/datanet/bju1538154656153.png diff --git a/doc/source/datanet/figures/eal1475518780745.png b/doc/source/shared/figures/datanet/eal1475518780745.png similarity index 100% rename from doc/source/datanet/figures/eal1475518780745.png rename to doc/source/shared/figures/datanet/eal1475518780745.png diff --git a/doc/source/datanet/figures/eol1510005391750.png b/doc/source/shared/figures/datanet/eol1510005391750.png similarity index 100% rename from doc/source/datanet/figures/eol1510005391750.png rename to doc/source/shared/figures/datanet/eol1510005391750.png diff --git a/doc/source/datanet/figures/jow1442607685238.png b/doc/source/shared/figures/datanet/jow1442607685238.png similarity index 100% rename from doc/source/datanet/figures/jow1442607685238.png rename to doc/source/shared/figures/datanet/jow1442607685238.png diff --git a/doc/source/datanet/figures/jow1443041105867.png b/doc/source/shared/figures/datanet/jow1443041105867.png similarity index 100% rename from doc/source/datanet/figures/jow1443041105867.png rename to doc/source/shared/figures/datanet/jow1443041105867.png diff --git a/doc/source/datanet/figures/jow1445971002260.png b/doc/source/shared/figures/datanet/jow1445971002260.png similarity index 100% rename from doc/source/datanet/figures/jow1445971002260.png rename to doc/source/shared/figures/datanet/jow1445971002260.png diff --git a/doc/source/datanet/figures/jow1445971475692.png b/doc/source/shared/figures/datanet/jow1445971475692.png similarity index 100% rename from doc/source/datanet/figures/jow1445971475692.png rename to doc/source/shared/figures/datanet/jow1445971475692.png diff --git a/doc/source/datanet/figures/oeg1510005898965.png b/doc/source/shared/figures/datanet/oeg1510005898965.png similarity index 100% rename from doc/source/datanet/figures/oeg1510005898965.png rename to doc/source/shared/figures/datanet/oeg1510005898965.png diff --git a/doc/source/fault-mgmt/figures/nlc1463584178366.png b/doc/source/shared/figures/fault-mgmt/nlc1463584178366.png similarity index 100% rename from doc/source/fault-mgmt/figures/nlc1463584178366.png rename to doc/source/shared/figures/fault-mgmt/nlc1463584178366.png diff --git a/doc/source/fault-mgmt/figures/psa1567524091300.png b/doc/source/shared/figures/fault-mgmt/psa1567524091300.png similarity index 100% rename from doc/source/fault-mgmt/figures/psa1567524091300.png rename to doc/source/shared/figures/fault-mgmt/psa1567524091300.png diff --git a/doc/source/fault-mgmt/figures/uty1463514747661.png b/doc/source/shared/figures/fault-mgmt/uty1463514747661.png similarity index 100% rename from doc/source/fault-mgmt/figures/uty1463514747661.png rename to doc/source/shared/figures/fault-mgmt/uty1463514747661.png diff --git a/doc/source/fault-mgmt/figures/xyj1558447807645.png b/doc/source/shared/figures/fault-mgmt/xyj1558447807645.png similarity index 100% rename from doc/source/fault-mgmt/figures/xyj1558447807645.png rename to doc/source/shared/figures/fault-mgmt/xyj1558447807645.png diff --git a/doc/source/planning/figures/jow1438030468959.png b/doc/source/shared/figures/planning/jow1438030468959.png old mode 100755 new mode 100644 similarity index 100% rename from doc/source/planning/figures/jow1438030468959.png rename to doc/source/shared/figures/planning/jow1438030468959.png diff --git a/doc/source/storage/figures/bse1464884816923.png b/doc/source/shared/figures/storage/bse1464884816923.png similarity index 100% rename from doc/source/storage/figures/bse1464884816923.png rename to doc/source/shared/figures/storage/bse1464884816923.png diff --git a/doc/source/storage/figures/caf1464886132887.png b/doc/source/shared/figures/storage/caf1464886132887.png similarity index 100% rename from doc/source/storage/figures/caf1464886132887.png rename to doc/source/shared/figures/storage/caf1464886132887.png diff --git a/doc/source/storage/figures/eew1464963403075.png b/doc/source/shared/figures/storage/eew1464963403075.png similarity index 100% rename from doc/source/storage/figures/eew1464963403075.png rename to doc/source/shared/figures/storage/eew1464963403075.png diff --git a/doc/source/storage/figures/ele1569534467005.jpeg b/doc/source/shared/figures/storage/ele1569534467005.jpeg similarity index 100% rename from doc/source/storage/figures/ele1569534467005.jpeg rename to doc/source/shared/figures/storage/ele1569534467005.jpeg diff --git a/doc/source/storage/figures/gzf1569521230362.png b/doc/source/shared/figures/storage/gzf1569521230362.png similarity index 100% rename from doc/source/storage/figures/gzf1569521230362.png rename to doc/source/shared/figures/storage/gzf1569521230362.png diff --git a/doc/source/storage/figures/ngh1569534630524.jpeg b/doc/source/shared/figures/storage/ngh1569534630524.jpeg similarity index 100% rename from doc/source/storage/figures/ngh1569534630524.jpeg rename to doc/source/shared/figures/storage/ngh1569534630524.jpeg diff --git a/doc/source/storage/figures/pzu1464883037926.png b/doc/source/shared/figures/storage/pzu1464883037926.png similarity index 100% rename from doc/source/storage/figures/pzu1464883037926.png rename to doc/source/shared/figures/storage/pzu1464883037926.png diff --git a/doc/source/storage/figures/qgh1567533283603.png b/doc/source/shared/figures/storage/qgh1567533283603.png similarity index 100% rename from doc/source/storage/figures/qgh1567533283603.png rename to doc/source/shared/figures/storage/qgh1567533283603.png diff --git a/doc/source/storage/figures/qig1590585618135.png b/doc/source/shared/figures/storage/qig1590585618135.png similarity index 100% rename from doc/source/storage/figures/qig1590585618135.png rename to doc/source/shared/figures/storage/qig1590585618135.png diff --git a/doc/source/storage/figures/wlx1464876289283.png b/doc/source/shared/figures/storage/wlx1464876289283.png similarity index 100% rename from doc/source/storage/figures/wlx1464876289283.png rename to doc/source/shared/figures/storage/wlx1464876289283.png diff --git a/doc/source/storage/figures/yts1496238000598.png b/doc/source/shared/figures/storage/yts1496238000598.png similarity index 100% rename from doc/source/storage/figures/yts1496238000598.png rename to doc/source/shared/figures/storage/yts1496238000598.png diff --git a/doc/source/storage/figures/zfd1464884207881.png b/doc/source/shared/figures/storage/zfd1464884207881.png similarity index 100% rename from doc/source/storage/figures/zfd1464884207881.png rename to doc/source/shared/figures/storage/zfd1464884207881.png diff --git a/doc/source/storage/figures/zpk1486667625575.png b/doc/source/shared/figures/storage/zpk1486667625575.png old mode 100755 new mode 100644 similarity index 100% rename from doc/source/storage/figures/zpk1486667625575.png rename to doc/source/shared/figures/storage/zpk1486667625575.png diff --git a/doc/source/system_configuration/figures/jow1413850386429.png b/doc/source/shared/figures/system_configuration/jow1413850386429.png similarity index 100% rename from doc/source/system_configuration/figures/jow1413850386429.png rename to doc/source/shared/figures/system_configuration/jow1413850386429.png diff --git a/doc/source/system_configuration/figures/jow1413850406811.png b/doc/source/shared/figures/system_configuration/jow1413850406811.png similarity index 100% rename from doc/source/system_configuration/figures/jow1413850406811.png rename to doc/source/shared/figures/system_configuration/jow1413850406811.png diff --git a/doc/source/system_configuration/figures/jow1413850481192.png b/doc/source/shared/figures/system_configuration/jow1413850481192.png similarity index 100% rename from doc/source/system_configuration/figures/jow1413850481192.png rename to doc/source/shared/figures/system_configuration/jow1413850481192.png diff --git a/doc/source/system_configuration/figures/jow1413850497887.png b/doc/source/shared/figures/system_configuration/jow1413850497887.png similarity index 100% rename from doc/source/system_configuration/figures/jow1413850497887.png rename to doc/source/shared/figures/system_configuration/jow1413850497887.png diff --git a/doc/source/system_configuration/figures/psa1420751608971.png b/doc/source/shared/figures/system_configuration/psa1420751608971.png similarity index 100% rename from doc/source/system_configuration/figures/psa1420751608971.png rename to doc/source/shared/figures/system_configuration/psa1420751608971.png diff --git a/doc/source/system_configuration/figures/rst1442611298701.png b/doc/source/shared/figures/system_configuration/rst1442611298701.png similarity index 100% rename from doc/source/system_configuration/figures/rst1442611298701.png rename to doc/source/shared/figures/system_configuration/rst1442611298701.png diff --git a/doc/source/storage/kubernetes/add-ssd-backed-journals-using-horizon.rst b/doc/source/storage/kubernetes/add-ssd-backed-journals-using-horizon.rst index 06a48477d..356a874de 100644 --- a/doc/source/storage/kubernetes/add-ssd-backed-journals-using-horizon.rst +++ b/doc/source/storage/kubernetes/add-ssd-backed-journals-using-horizon.rst @@ -44,7 +44,7 @@ monitors run on **controller-0**, **controller-1**, and **storage-0** only\). #. Select the **Storage** tab to view the **Disks** and **Storage Functions** for the host. - .. image:: ../figures/yts1496238000598.png + .. image:: /shared/figures/storage/yts1496238000598.png #. Assign the SSD to use for Ceph journals. @@ -54,14 +54,14 @@ monitors run on **controller-0**, **controller-1**, and **storage-0** only\). #. Click **Assign Storage Function** to open the Assign Storage Function dialog box. - .. image:: ../figures/wlx1464876289283.png + .. image:: /shared/figures/storage/wlx1464876289283.png #. In the **Function** field, select Journal. A simplified dialog is displayed. - .. image:: ../figures/pzu1464883037926.png + .. image:: /shared/figures/storage/pzu1464883037926.png #. In the **Disks** field, select the SSD device. @@ -70,14 +70,14 @@ monitors run on **controller-0**, **controller-1**, and **storage-0** only\). The journal function is assigned to the SSD. - .. image:: ../figures/zfd1464884207881.png + .. image:: /shared/figures/storage/zfd1464884207881.png #. Assign the journal function for use by one or more OSDs. Use the **Edit** button for the OSD to open the Edit Storage Volume dialog box, and then select the **Journal** to use with the OSD. - .. image:: ../figures/eew1464963403075.png + .. image:: /shared/figures/storage/eew1464963403075.png #. Unlock the host to make it available for use. diff --git a/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst b/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst index 17c2f9887..d1ae460dc 100644 --- a/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst +++ b/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst @@ -27,7 +27,7 @@ procedure. .. only:: partner - .. include:: ../../_includes/configure-external-netapp.rest + .. include:: /_includes/configure-external-netapp.rest #. If you have not done so already, create an address pool for the diff --git a/doc/source/storage/kubernetes/increase-controller-filesystem-storage-allotments-using-horizon.rst b/doc/source/storage/kubernetes/increase-controller-filesystem-storage-allotments-using-horizon.rst index 75dc2bd7d..8624b7f5b 100644 --- a/doc/source/storage/kubernetes/increase-controller-filesystem-storage-allotments-using-horizon.rst +++ b/doc/source/storage/kubernetes/increase-controller-filesystem-storage-allotments-using-horizon.rst @@ -74,14 +74,14 @@ Before changing storage allotments, prepare as follows: The Controller Filesystem page appears, showing the currently defined storage allotments. - .. image:: ../figures/ele1569534467005.jpeg + .. image:: /shared/figures/storage/ele1569534467005.jpeg #. Click **Edit Filesystem**. The Edit Controller Filesystem dialog box appears. - .. image:: ../figures/ngh1569534630524.jpeg + .. image:: /shared/figures/storage/ngh1569534630524.jpeg #. Replace the storage allotments as required. diff --git a/doc/source/storage/kubernetes/provision-storage-on-a-controller-or-storage-host-using-horizon.rst b/doc/source/storage/kubernetes/provision-storage-on-a-controller-or-storage-host-using-horizon.rst index 3f2ea5d42..4b345f4e2 100644 --- a/doc/source/storage/kubernetes/provision-storage-on-a-controller-or-storage-host-using-horizon.rst +++ b/doc/source/storage/kubernetes/provision-storage-on-a-controller-or-storage-host-using-horizon.rst @@ -70,7 +70,7 @@ must add the storage tier first. For more about storage tiers, see #. Select the **Storage** tab to view the disks and storage functions for the node. - .. image:: ../figures/qgh1567533283603.png + .. image:: /shared/figures/storage/qgh1567533283603.png .. note:: User-defined partitions are not supported on storage hosts. @@ -80,7 +80,7 @@ must add the storage tier first. For more about storage tiers, see #. Click **Assign Storage Function** to open the Assign Storage Function dialog box. - .. image:: ../figures/bse1464884816923.png + .. image:: /shared/figures/storage/bse1464884816923.png #. In the **Disks** field, select the OSD to use for storage. @@ -104,7 +104,7 @@ must add the storage tier first. For more about storage tiers, see The storage function is added. - .. image:: ../figures/caf1464886132887.png + .. image:: /shared/figures/storage/caf1464886132887.png #. Unlock the host to make it available for use. diff --git a/doc/source/storage/kubernetes/view-storage-utilization-using-horizon.rst b/doc/source/storage/kubernetes/view-storage-utilization-using-horizon.rst index a007163e1..210f98887 100644 --- a/doc/source/storage/kubernetes/view-storage-utilization-using-horizon.rst +++ b/doc/source/storage/kubernetes/view-storage-utilization-using-horizon.rst @@ -24,7 +24,7 @@ For more information on per-host storage, see |node-doc|: :ref:`Storage Tab system are configured with storage with Ceph OSDs **osd.0** through **osd.5**. - .. image:: ../figures/gzf1569521230362.png + .. image:: /shared/figures/storage/gzf1569521230362.png Rank is evaluated and assigned when a monitor is added to the cluster. It is based on the IP address and port assigned. diff --git a/doc/source/storage/kubernetes/work-with-local-volume-groups.rst b/doc/source/storage/kubernetes/work-with-local-volume-groups.rst index d7c6a9435..ceb570adc 100644 --- a/doc/source/storage/kubernetes/work-with-local-volume-groups.rst +++ b/doc/source/storage/kubernetes/work-with-local-volume-groups.rst @@ -39,7 +39,7 @@ To manage the physical volumes that support local volume groups, see You can now review and modify the parameters for the local volume group. - .. image:: ../figures/qig1590585618135.png + .. image:: /shared/figures/storage/qig1590585618135.png :width: 550 diff --git a/doc/source/storage/openstack/storage-configuration-and-management-storage-resources.rst b/doc/source/storage/openstack/storage-configuration-and-management-storage-resources.rst index f7fdd2a0b..081ce564e 100644 --- a/doc/source/storage/openstack/storage-configuration-and-management-storage-resources.rst +++ b/doc/source/storage/openstack/storage-configuration-and-management-storage-resources.rst @@ -26,7 +26,7 @@ Storage Services and Backends The figure below shows the storage options and backends for |prod-os|. -.. image:: ../figures/zpk1486667625575.png +.. image:: /shared/figures/storage/zpk1486667625575.png diff --git a/doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-horizon.rst b/doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-horizon.rst index 88e9a49a9..012c3434c 100644 --- a/doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-horizon.rst @@ -23,7 +23,7 @@ locked. This requires a swact during the procedure. #. From the **Edit** menu for the standby controller, select **Lock Host**. - .. figure:: ../figures/rst1442611298701.png + .. figure:: /shared/figures/system_configuration/rst1442611298701.png :scale: 100% #. Edit the |OAM| interface to change the |MTU| value. @@ -42,7 +42,7 @@ locked. This requires a swact during the procedure. From the **Edit** menu for the active controller, select **Swact Host**. - .. figure:: ../figures/psa1420751608971.png + .. figure:: /shared/figures/system_configuration/psa1420751608971.png :scale: 100% #. Lock the new standby controller. diff --git a/doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst b/doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst index a51b9d001..68f514cd4 100644 --- a/doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst @@ -47,14 +47,14 @@ and ensure that any existing system alarms are cleared. The |OAM| IP page appears, showing the currently defined |OAM| network configuration. - .. figure:: ../figures/jow1413850481192.png + .. figure:: /shared/figures/system_configuration/jow1413850481192.png :scale: 100% #. Click **Edit OAM IP**. The Edit OAM IP dialog box appears. - .. figure:: ../figures/jow1413850497887.png + .. figure:: /shared/figures/system_configuration/jow1413850497887.png :scale: 100% #. Replace the IP Subnet and/or IP addresses with different ones as required. diff --git a/doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-horizon.rst b/doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-horizon.rst index 4e31bee8f..aec2d30ce 100644 --- a/doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-horizon.rst @@ -53,7 +53,7 @@ page and ensure that any existing system alarms are cleared. The NTP page appears, showing the currently defined |NTP| servers. - .. figure:: ../figures/jow1413850406811.png + .. figure:: /shared/figures/system_configuration/jow1413850406811.png :scale: 100% #. Click **Edit NTP**. diff --git a/doc/source/system_configuration/kubernetes/specifying-dns-servers-using-horizon.rst b/doc/source/system_configuration/kubernetes/specifying-dns-servers-using-horizon.rst index 5e9efa874..68b2d9ec6 100644 --- a/doc/source/system_configuration/kubernetes/specifying-dns-servers-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/specifying-dns-servers-using-horizon.rst @@ -28,5 +28,5 @@ You can specify up to three DNS servers using the Horizon Web interface. #. In the Edit DNS dialog box, add or edit the IP addresses, and then click **Save**. - .. figure:: ../figures/jow1413850386429.png + .. figure:: /shared/figures/system_configuration/jow1413850386429.png :scale: 100% \ No newline at end of file diff --git a/doc/source/updates/kubernetes/configuring-kubernetes-update-orchestration.rst b/doc/source/updates/kubernetes/configuring-kubernetes-update-orchestration.rst index a6d666315..f4d07e185 100644 --- a/doc/source/updates/kubernetes/configuring-kubernetes-update-orchestration.rst +++ b/doc/source/updates/kubernetes/configuring-kubernetes-update-orchestration.rst @@ -76,7 +76,7 @@ For example: .. only:: partner - .. include:: ../../_includes/configuring-kubernetes-update-orchestration.rest + .. include:: /_includes/configuring-kubernetes-update-orchestration.rest .. rubric:: |proc| diff --git a/doc/source/updates/kubernetes/handling-kubernetes-update-orchestration-failures.rst b/doc/source/updates/kubernetes/handling-kubernetes-update-orchestration-failures.rst index 05f28fdf5..9ee2f1e59 100644 --- a/doc/source/updates/kubernetes/handling-kubernetes-update-orchestration-failures.rst +++ b/doc/source/updates/kubernetes/handling-kubernetes-update-orchestration-failures.rst @@ -89,7 +89,7 @@ Strategy Apply Failure .. only:: partner - .. include:: ../../_includes/handling-kubernetes-update-orchestration-failures.rest + .. include:: /_includes/handling-kubernetes-update-orchestration-failures.rest - **Reason**: lock host failed. diff --git a/doc/source/usertasks/kubernetes/kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients.rst b/doc/source/usertasks/kubernetes/kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients.rst index 045aae2f8..15f18f732 100644 --- a/doc/source/usertasks/kubernetes/kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients.rst +++ b/doc/source/usertasks/kubernetes/kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients.rst @@ -129,7 +129,7 @@ and clients for a non-admin user. .. only:: partner - .. include:: ../../_includes/kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients.rest + .. include:: /_includes/kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients.rest If you specify repositories that require authentication, as shown above, you must remember to perform a :command:`docker login` to diff --git a/doc/source/usertasks/kubernetes/nodeport-usage-restrictions.rst b/doc/source/usertasks/kubernetes/nodeport-usage-restrictions.rst index 5a0b9abe3..87eca0a8c 100644 --- a/doc/source/usertasks/kubernetes/nodeport-usage-restrictions.rst +++ b/doc/source/usertasks/kubernetes/nodeport-usage-restrictions.rst @@ -20,4 +20,4 @@ The following usage restrictions apply when using NodePorts: .. only:: partner - .. include:: ../../_includes/nodeport-usage-restrictions.rest + .. include:: /_includes/nodeport-usage-restrictions.rest diff --git a/doc/source/usertasks/kubernetes/using-network-attachment-definitions-in-a-container.rst b/doc/source/usertasks/kubernetes/using-network-attachment-definitions-in-a-container.rst index 3e3053f3d..a76b4ff5b 100644 --- a/doc/source/usertasks/kubernetes/using-network-attachment-definitions-in-a-container.rst +++ b/doc/source/usertasks/kubernetes/using-network-attachment-definitions-in-a-container.rst @@ -21,7 +21,7 @@ devices as you have network annotations. .. only:: partner - .. include:: ../../_includes/using-network-attachment-definitions-in-a-container.rest + .. include:: /_includes/using-network-attachment-definitions-in-a-container.rest .. xreflink For information about PCI-SRIOV Interface Support, see the :ref:`|datanet-doc| ` guide.