From 1a4bc514dd088e84ed07cab728a65e351aabb03d Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Wed, 17 Jan 2024 16:24:46 +0000 Subject: [PATCH] Retire Virtual Install topics Virtual install material is now integrated as tabbed content on the 'bare metal' pages. This content duplicates that and risks updates being made in the wrong location. Upver r7 > r9 in BM Ironic topic Change-Id: Id02e79b710aae899119aec655bf80bfab6b99508 Signed-off-by: Ron Stone --- .../aio_duplex_install_kubernetes.rst | 2 + .../aio_simplex_install_kubernetes.rst | 2 + .../automated-install-note--09dff208a9c6.rst | 6 +++ .../controller_storage_install_kubernetes.rst | 2 + .../dedicated_storage_install_kubernetes.rst | 2 + .../release/bare_metal/ironic_install.rst | 12 +++--- .../release/index-install-r7-8966076f0e81.rst | 39 +++++++++++-------- .../{aio_duplex.rst => aio_duplex.txt} | 0 ....rst => aio_duplex_install_kubernetes.txt} | 0 .../{aio_simplex.rst => aio_simplex.txt} | 0 ...rst => aio_simplex_install_kubernetes.txt} | 0 ...ler_storage.rst => controller_storage.txt} | 0 ...ated_storage.rst => dedicated_storage.txt} | 0 ...iron.rst => dedicated_storage_environ.txt} | 0 ... dedicated_storage_install_kubernetes.txt} | 0 doc/source/index.rst | 6 +-- 16 files changed, 46 insertions(+), 25 deletions(-) create mode 100644 doc/source/deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst rename doc/source/deploy_install_guides/release/virtual/{aio_duplex.rst => aio_duplex.txt} (100%) rename doc/source/deploy_install_guides/release/virtual/{aio_duplex_install_kubernetes.rst => aio_duplex_install_kubernetes.txt} (100%) rename doc/source/deploy_install_guides/release/virtual/{aio_simplex.rst => aio_simplex.txt} (100%) rename doc/source/deploy_install_guides/release/virtual/{aio_simplex_install_kubernetes.rst => aio_simplex_install_kubernetes.txt} (100%) rename doc/source/deploy_install_guides/release/virtual/{controller_storage.rst => controller_storage.txt} (100%) rename doc/source/deploy_install_guides/release/virtual/{dedicated_storage.rst => dedicated_storage.txt} (100%) rename doc/source/deploy_install_guides/release/virtual/{dedicated_storage_environ.rst => dedicated_storage_environ.txt} (100%) rename doc/source/deploy_install_guides/release/virtual/{dedicated_storage_install_kubernetes.rst => dedicated_storage_install_kubernetes.txt} (100%) diff --git a/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst index 4ff67953a..f518a2907 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst @@ -24,6 +24,8 @@ Overview .. include:: /shared/_includes/desc_aio_duplex.txt +.. include:: /deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst + .. _installation-prereqs-dx: ----------------------------- diff --git a/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst index 4a30395da..471e36c59 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst @@ -21,6 +21,8 @@ Overview .. include:: /shared/_includes/desc_aio_simplex.txt +.. include:: /deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst + .. _installation-prereqs: .. _aio_simplex_hardware_r7: diff --git a/doc/source/deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst b/doc/source/deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst new file mode 100644 index 000000000..367ba4b46 --- /dev/null +++ b/doc/source/deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst @@ -0,0 +1,6 @@ +.. _bla-09dff208a9c6: + +.. only:: starlingx + + For information on getting started quicky using an automated virtual + installation, see :ref:`automated_install`. diff --git a/doc/source/deploy_install_guides/release/bare_metal/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/controller_storage_install_kubernetes.rst index 257eb4d57..53c97eb96 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/controller_storage_install_kubernetes.rst @@ -24,6 +24,8 @@ Overview .. include:: /shared/_includes/desc_controller_storage.txt +.. include:: /deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst + .. _installation-prereqs-std: ----------------------------- diff --git a/doc/source/deploy_install_guides/release/bare_metal/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/dedicated_storage_install_kubernetes.rst index cf35988c5..f0bc8d378 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/dedicated_storage_install_kubernetes.rst @@ -23,6 +23,8 @@ Overview .. include:: /shared/_includes/desc_dedicated_storage.txt +.. include:: /deploy_install_guides/release/bare_metal/automated-install-note--09dff208a9c6.rst + ----------------------------- Minimum hardware requirements ----------------------------- diff --git a/doc/source/deploy_install_guides/release/bare_metal/ironic_install.rst b/doc/source/deploy_install_guides/release/bare_metal/ironic_install.rst index d7e4e67eb..e4ec887c9 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/ironic_install.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/ironic_install.rst @@ -1,6 +1,6 @@ -================================ -Install Ironic on StarlingX R7.0 -================================ +============================== +Install Ironic on StarlingX r9 +============================== .. include:: /_includes/ironic.rest @@ -9,10 +9,10 @@ Install Ironic on StarlingX R7.0 This section describes the steps to install Ironic on a standard configuration, either: -* **StarlingX R7.0 bare metal Standard with Controller Storage** deployment +* **StarlingX R9.0 bare metal Standard with Controller Storage** deployment configuration -* **StarlingX R7.0 bare metal Standard with Dedicated Storage** deployment +* **StarlingX R9.0 bare metal Standard with Dedicated Storage** deployment configuration .. contents:: @@ -142,7 +142,7 @@ To enable Ironic, update the following Ironic Helm Chart attributes: --set network.pxe.neutron_subnet_gateway=10.10.20.1 \ --set network.pxe.neutron_provider_network=ironic-data -:command:`network.pxe.neutron_subnet_alloc_start` sets the DHCP start IP to +:command:`network.pxe.neutron_subnet_alloc_start` sets the |DHCP| start IP to Neutron for Ironic node provision, and reserves several IPs for the platform. If the data network name for Ironic is changed, modify diff --git a/doc/source/deploy_install_guides/release/index-install-r7-8966076f0e81.rst b/doc/source/deploy_install_guides/release/index-install-r7-8966076f0e81.rst index 40be0b620..82eb8d525 100644 --- a/doc/source/deploy_install_guides/release/index-install-r7-8966076f0e81.rst +++ b/doc/source/deploy_install_guides/release/index-install-r7-8966076f0e81.rst @@ -16,29 +16,34 @@ StarlingX provides a pre-defined set of standard :doc:`deployment configurations `. Most deployment options may be installed in a virtual environment or on bare metal. ------------------------------------------------------ -Install StarlingX Kubernetes in a virtual environment ------------------------------------------------------ - -.. toctree:: - :maxdepth: 1 - - virtual/automated_install - virtual/aio_simplex - virtual/aio_duplex - virtual/controller_storage - virtual/dedicated_storage - virtual/rook_storage +.. ----------------------------------------------------- +.. Install StarlingX Kubernetes in a virtual environment +.. ----------------------------------------------------- +.. +.. .. toctree:: +.. :maxdepth: 1 +.. +.. virtual/automated_install +.. virtual/aio_simplex +.. virtual/aio_duplex +.. virtual/controller_storage +.. virtual/dedicated_storage +.. virtual/rook_storage .. toctree:: :hidden: virtual/config_virtualbox_netwk virtual/install_virtualbox + virtual/aio_duplex_environ + virtual/aio_simplex_environ + virtual/controller_storage_install_kubernetes + virtual/controller_storage_environ ------------------------------------------- -Install StarlingX Kubernetes on bare metal ------------------------------------------- + +---------------------------- +Install StarlingX Kubernetes +---------------------------- .. toctree:: :maxdepth: 1 @@ -49,6 +54,8 @@ Install StarlingX Kubernetes on bare metal bare_metal/rook_storage_install_kubernetes bare_metal/dedicated_storage_install_kubernetes bare_metal/ironic_install + virtual/automated_install + virtual/rook_storage ----------------- Access Kubernetes diff --git a/doc/source/deploy_install_guides/release/virtual/aio_duplex.rst b/doc/source/deploy_install_guides/release/virtual/aio_duplex.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/aio_duplex.rst rename to doc/source/deploy_install_guides/release/virtual/aio_duplex.txt diff --git a/doc/source/deploy_install_guides/release/virtual/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/release/virtual/aio_duplex_install_kubernetes.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/aio_duplex_install_kubernetes.rst rename to doc/source/deploy_install_guides/release/virtual/aio_duplex_install_kubernetes.txt diff --git a/doc/source/deploy_install_guides/release/virtual/aio_simplex.rst b/doc/source/deploy_install_guides/release/virtual/aio_simplex.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/aio_simplex.rst rename to doc/source/deploy_install_guides/release/virtual/aio_simplex.txt diff --git a/doc/source/deploy_install_guides/release/virtual/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/release/virtual/aio_simplex_install_kubernetes.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/aio_simplex_install_kubernetes.rst rename to doc/source/deploy_install_guides/release/virtual/aio_simplex_install_kubernetes.txt diff --git a/doc/source/deploy_install_guides/release/virtual/controller_storage.rst b/doc/source/deploy_install_guides/release/virtual/controller_storage.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/controller_storage.rst rename to doc/source/deploy_install_guides/release/virtual/controller_storage.txt diff --git a/doc/source/deploy_install_guides/release/virtual/dedicated_storage.rst b/doc/source/deploy_install_guides/release/virtual/dedicated_storage.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/dedicated_storage.rst rename to doc/source/deploy_install_guides/release/virtual/dedicated_storage.txt diff --git a/doc/source/deploy_install_guides/release/virtual/dedicated_storage_environ.rst b/doc/source/deploy_install_guides/release/virtual/dedicated_storage_environ.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/dedicated_storage_environ.rst rename to doc/source/deploy_install_guides/release/virtual/dedicated_storage_environ.txt diff --git a/doc/source/deploy_install_guides/release/virtual/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/release/virtual/dedicated_storage_install_kubernetes.txt similarity index 100% rename from doc/source/deploy_install_guides/release/virtual/dedicated_storage_install_kubernetes.rst rename to doc/source/deploy_install_guides/release/virtual/dedicated_storage_install_kubernetes.txt diff --git a/doc/source/index.rst b/doc/source/index.rst index db52bd25b..a0b40e380 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,9 +28,9 @@ For more information about the StarlingX project, refer to the Introduction ------------ -To get started fast with StarlingX, try the -:ref:`Virtual All-in-one Simplex Installation `, which -requires a minimum of hardware and configuration. +To get started fast with StarlingX, try the :ref:`Virtual All-in-one Simplex +Installation `, which requires a minimum of +hardware and configuration. Learn more about StarlingX: