starlingx/docs
Code Issues Proposed changes

Merge "Installation menus still reference low latency (dsR10, r10)"

Browse Source
This commit is contained in:
Zuul 2025-01-27 19:28:22 +00:00 committed by Gerrit Code Review
commit 2730eac04c
7 changed files with 88 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/deploy_install_guides/release/bare_metal/pxe-boot-controller-0-d5da025c2524.rst
View File

@ -66,8 +66,7 @@ Use a Linux workstation as the |PXE| Boot server.
.. begin-pxeboot-grub-setup .. begin-pxeboot-grub-setup
There is a single install menu |deb-install-step-change| to choose between a There is a single install menu |deb-install-step-change| to choose between a
*Standard*, an *AIO-Controller with the Standard Kernel* installation, and an *Standard*, and an *AIO-Controller with the Standard Kernel* installation.
*AIO-Controller with the Low-Latency Kernel* installation. .
.. _deb-grub-deltas: .. _deb-grub-deltas:
@ -151,12 +150,11 @@ Copy ISO contents method
drwxr-xr-x 7 someuser users 4096 Jun 13 10:33 starlingx-20220612220558_feed drwxr-xr-x 7 someuser users 4096 Jun 13 10:33 starlingx-20220612220558_feed
lrwxrwxrwx 1 someuser users 58 Jun 13 10:35 feed -> starlingx-20220612220558_feed lrwxrwxrwx 1 someuser users 58 Jun 13 10:35 feed -> starlingx-20220612220558_feed
.. The 'feed' directory structure should be as follows: The 'feed' directory structure should be as follows:
.. .. code-block:: none .. code-block:: none
.. feed .. feed
.. ├── bzImage-rt ... Lowlatency kernel
.. ├── bzImage-std ... Standard kernel .. ├── bzImage-std ... Standard kernel
.. ├── initrd ... Installer initramfs image .. ├── initrd ... Installer initramfs image
.. ├── kickstart .. ├── kickstart
@ -174,7 +172,7 @@ Copy ISO contents method
.. ├── pxeboot_setup.sh ... script used to tailor the above samples .. ├── pxeboot_setup.sh ... script used to tailor the above samples
.. └── README ... info file .. └── README ... info file
.. Note that many files and directories have been omitted for clarity. Note that many files and directories have been omitted for clarity.
#. Set up the PXEboot grub menus. #. Set up the PXEboot grub menus.
@ -222,10 +220,6 @@ Copy ISO contents method
aio>graphical = All-in-one Install - Graphical Console aio>graphical = All-in-one Install - Graphical Console
aio-lowlat>serial = All-in-one (lowlatency) Install - Serial Console
aio-lowlat>graphical = All-in-one (lowlatency) Install - Graphical Console
The ISO also contains the ``pxeboot/samples/pxeboot_setup.sh`` script that The ISO also contains the ``pxeboot/samples/pxeboot_setup.sh`` script that
can be used to automatically setup both the BIOS and |UEFI| grub files for a can be used to automatically setup both the BIOS and |UEFI| grub files for a
specific install. specific install.
@ -256,8 +250,6 @@ Copy ISO contents method
2 = Controller Install - Graphical Console 2 = Controller Install - Graphical Console
3 = All-in-one Install - Serial Console (default) 3 = All-in-one Install - Serial Console (default)
4 = All-in-one Install - Graphical Console 4 = All-in-one Install - Graphical Console
5 = All-in-one (lowlatency) Install - Serial Console
6 = All-in-one (lowlatency) Install - Graphical Console
Example: Example:
@ -267,6 +259,6 @@ Copy ISO contents method
-f pxeboot/offset/to/target_feed -f pxeboot/offset/to/target_feed
-u http://###.###.###.### -u http://###.###.###.###
-d /dev/sde -d /dev/sde
-s 5 -s 4

10
doc/source/dist_cloud/kubernetes/deploy-restore-and-manage-subclouds-of-previous-release-5e986615cb4b.rst
View File

@ -121,11 +121,11 @@ subclouds of the previous release.
To support subcloud install or subcloud restore to either the current (N) or To support subcloud install or subcloud restore to either the current (N) or
previous (N-1) release, ensure that the following prerequisites are met: previous (N-1) release, ensure that the following prerequisites are met:
- The N load (pre-patched ISO) containing this capability must be imported to - The N load (pre-patched ISO) containing this capability must be uploaded to
the system controller using the ``--active`` option. The ISO imported via the system controller. The ISO uploaded via :command:`software upload` should
``load-import --active`` should be at the same patch level as the system be at the same patch level as the system controller. This requirement ensures
controller. This requirement ensures that the subcloud boot image is that the subcloud boot image is aligned with the patch level of the load to
aligned with the patch level of the load to be installed on the subcloud. be installed on the subcloud.
.. note:: .. note::

92
doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst
View File

@ -29,7 +29,7 @@ subcloud, the subcloud installation has these phases:
.. note:: .. note::
Remove all removable USB storage devices from subcloud servers before Remove all removable USB storage devices from the subcloud servers before
starting a Redfish remote subcloud install. starting a Redfish remote subcloud install.
.. rubric:: |prereq| .. rubric:: |prereq|
@ -37,44 +37,41 @@ subcloud, the subcloud installation has these phases:
.. _installing-a-subcloud-using-redfish-platform-management-service-ul-g5j-3f3-qjb: .. _installing-a-subcloud-using-redfish-platform-management-service-ul-g5j-3f3-qjb:
- A new system CLI option ``--active`` is added to the - The :command:`software upload` CLI command, executed in the System Controller region,
:command:`load-import` command to allow the import into the uploads and stores the ISO to be used to install subclouds in a single
system controller ``/opt/dc-vault/loads``. The purpose of this is to allow location, i.e. internally on the System Controller in ``/opt/dc-vault/software``.
Redfish install of subclouds referencing a single full copy of the You can upload a separate ISO for each major release.
``bootimage.iso`` at ``/opt/dc-vault/loads``. (Previously, the full
``bootimage.iso`` was duplicated for each :command:`subcloud add`
command).
.. note:: .. note::
- This is required only once and does not have to be done for every - This is required only once and does not have to be done for every
subcloud install. subcloud install.
:command:`dcmanager` recognizes bootimage names ending in ``.iso`` and :command:`dcmanager` recognizes boot image files ending in ``.iso``
``.sig``. and signature files ending in ``.sig``.
For example, For example,
.. parsed-literal:: .. parsed-literal::
~(keystone_admin)]$ system --os-region-name SystemController load-import --active |installer-image-name|.iso |installer-image-name|.sig ~(keystone_admin)]$ software --os-region-name SystemController upload |installer-image-name|.iso |installer-image-name|.sig
- The ISO imported via ``load-import --active`` must be at the same - The uploaded subcloud ISO for the current release (i.e. the release
patch level as the system controller. This ensures that the subcloud running on the System Controller), must be at the same patch level as
boot image aligns with the patch level of the load to be installed on the System Controller. This ensures that the subcloud boot image
the subcloud. aligns with the patch level of the load to be installed on the
subcloud.
- There is no support using the option ``--active`` together with
``--local``.
.. warning:: .. warning::
If the patch level of load-imported ISO does not match the system controller If the patch level of the uploaded subcloud ISO does not match the
patch level, the subcloud patch state may not align with the system System Controller patch level, the resulting subcloud patch state may
controller patch state. not align with the System Controller patch state.
- Run the :command:`load-import` command on controller-0 to import - Run the following command on controller-0 to upload the subcloud ISO for the
the new release. new release.
You can specify either the full file path or relative paths to the ``*.iso`` You can specify either the full file path or relative paths to the ``*.iso``
bootimage file and to the ``*.sig`` bootimage signature file. bootimage file and to the ``*.sig`` bootimage signature file.
@ -82,30 +79,18 @@ subcloud, the subcloud installation has these phases:
.. code-block:: none .. code-block:: none
$ source /etc/platform/openrc $ source /etc/platform/openrc
~(keystone_admin)]$ system load-import [--local] /home/sysadmin/<bootimage>.iso <bootimage>.sig ~(keystone_admin)]$ software --os-region-name SystemController upload <bootimage>.iso <bootimage>.sig
+--------------------+-----------+ This operation will take a while. Please wait.
| Property | Value | .....
+--------------------+-----------+ Uploaded release nn.nn.n is the same as current release on the controller
| id | 2 | +----------------------------+--------------+
| state | importing | | Uploaded File | Release |
| software_version | nn.nn | +----------------------------+--------------+
| compatible_version | nn.nn | | bootimage.iso | nn.nn.n |
| required_patches | | +----------------------------+--------------+
+--------------------+-----------+
The :command:`load-import` must be done on controller-0. This command must be done on controller-0.
(Optional) If ``--local`` is specified, the ISO and sig files are
uploaded directly from the active controller, where `<local_iso_file_path>`
and `<local_sig_file_path>` are paths on the active controller to load
ISO files and sig files respectively.
.. note::
If ``--local`` is specified, the ISO and sig files are transferred
directly from the active controller filesystem to the load directory,
if it is not specified, the files are transferred via the API.
.. note:: .. note::
This will take a few minutes to complete. This will take a few minutes to complete.
@ -143,13 +128,13 @@ logs.
4: Outputs JSON of all command responses. 4: Outputs JSON of all command responses.
**Automatic Serial Console capture (for ``rvmc_debug_level`` > 1)** **Automatic Serial Console capture (for rvmc_debug_level > 0)**
When the ``rvmc_debug_level`` is enabled (``rvmc_debug_level`` > 0), the full serial When the ``rvmc_debug_level`` is enabled (``rvmc_debug_level`` > 0), the full serial
console output can be automatically captured, provided the serial console is console output can be automatically captured, provided the serial console is
configured in the ``install_type`` install value. configured in the ``install_type`` install value.
.. note:: Capturing graphical console output is not supported. .. note:: Capturing the graphical console output is not supported.
The ``install_type`` in the subcloud install_values YAML file must correspond The ``install_type`` in the subcloud install_values YAML file must correspond
to one of the serial console types: to one of the serial console types:
@ -158,9 +143,10 @@ to one of the serial console types:
2: AIO, Serial Console 2: AIO, Serial Console
4: AIO Low-latency, Serial Console .. note::
You can install |v_r8| subclouds with a |this-ver| System Controller.
The |v_r8| subclouds still support menu 4.
**Automatic Serial Console capture (for ``rvmc_debug_level`` > 1)**
Automatic Serial Console capture is based on the global ``CONF.ipmi_capture`` Automatic Serial Console capture is based on the global ``CONF.ipmi_capture``
value and the given ``rvmc_debug_level``. The global ``CONF.ipmi_capture`` value and the given ``rvmc_debug_level``. The global ``CONF.ipmi_capture``
@ -171,7 +157,9 @@ value defaults to 1, which defers the configuration to the per-subcloud
CONF.ipmi_capture options: CONF.ipmi_capture options:
0: globally disabled 0: globally disabled
1: enabled based on rvmc_debug_level 1: enabled based on rvmc_debug_level
2: globally enabled 2: globally enabled
.. rubric:: |proc| .. rubric:: |proc|
@ -204,7 +192,7 @@ CONF.ipmi_capture options:
.. note:: .. note::
If your controller is on a ZTSystems Triton server that requires a If your controller is on ZTSystems Triton server that requires a
longer timeout value, you can now use the ``rd.net.timeout.ipv6dad`` longer timeout value, you can now use the ``rd.net.timeout.ipv6dad``
dracut parameter to specify an increased timeout value for dracut to dracut parameter to specify an increased timeout value for dracut to
wait for the interface to have carrier, and complete IPv6 duplicate wait for the interface to have carrier, and complete IPv6 duplicate
@ -260,8 +248,6 @@ CONF.ipmi_capture options:
#1 - Standard Controller, Graphical Console #1 - Standard Controller, Graphical Console
#2 - AIO, Serial Console #2 - AIO, Serial Console
#3 - AIO, Graphical Console #3 - AIO, Graphical Console
#4 - AIO Low-latency, Serial Console
#5 - AIO Low-latency, Graphical Console
install_type: 3 install_type: 3
# Optional parameters defaults can be modified by uncommenting the option with a modified value. # Optional parameters defaults can be modified by uncommenting the option with a modified value.
@ -449,6 +435,10 @@ CONF.ipmi_capture options:
:start-after: begin-subcloud-1 :start-after: begin-subcloud-1
:end-before: end-subcloud-1 :end-before: end-subcloud-1
.. note::
To modify the kernel using the ansible bootstrap, see :ref:`modify-the-kernel-in-the-cli-39f25220ec1b`
#. Add the subcloud using dcmanager. #. Add the subcloud using dcmanager.
When calling the :command:`subcloud add` command, specify the install When calling the :command:`subcloud add` command, specify the install

6
doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst
View File

@ -95,8 +95,6 @@ subcloud, the subcloud installation process has two phases:
1 - Standard Controller, Graphical Console 1 - Standard Controller, Graphical Console
2 - AIO, Serial Console 2 - AIO, Serial Console
3 - AIO, Graphical Console 3 - AIO, Graphical Console
4 - AIO Low-latency, Serial Console
5 - AIO Low-latency, Graphical Console
NULL - Clear default selection NULL - Clear default selection
-t <menu timeout>: -t <menu timeout>:
Specify boot menu timeout, in seconds Specify boot menu timeout, in seconds
@ -268,6 +266,10 @@ subcloud, the subcloud installation process has two phases:
If you have a reason not to use the Central Cloud's local registry you If you have a reason not to use the Central Cloud's local registry you
can pull the images from another local private docker registry. can pull the images from another local private docker registry.
.. note::
To modify the kernel using the ansible bootstrap, see :ref:`modify-the-kernel-in-the-cli-39f25220ec1b`
#. You can use the Central Cloud's local registry to pull images on subclouds. #. You can use the Central Cloud's local registry to pull images on subclouds.
The Central Cloud's local registry's HTTPS certificate must have the The Central Cloud's local registry's HTTPS certificate must have the
Central Cloud's |OAM| IP, ``registry.local`` and ``registry.central`` in the Central Cloud's |OAM| IP, ``registry.local`` and ``registry.central`` in the

72
doc/source/dist_cloud/kubernetes/subcloud-deployment-phases-0ce5f6fbf696.rst
View File

@ -49,67 +49,55 @@ central cloud:
.. rubric:: |prereq| .. rubric:: |prereq|
- A new system CLI option ``--active`` is added to the :command:`load-import` - The :command:`software upload` CLI command, executed in the system controller region,
command to allow the import into the system controller uploads and stores the ISO to be used to install subclouds in a single
``/opt/dc-vault/loads``. The purpose of this is to allow Redfish install of location, i.e. internally on the system controller in ``/opt/dc-vault/software``.
subclouds referencing a single full copy of the ``bootimage.iso`` at You can upload a separate ISO for each major release.
``/opt/dc-vault/loads``. (Previously, the full ``bootimage.iso`` was
duplicated for each :command:`subcloud add` command).
.. note:: .. note::
This is required only once and does not have to be done for every subcloud install. This is required only once and does not have to be done for every subcloud install.
The :command:`dcmanager` command recognizes bootimage names that end with The :command:`dcmanager` command recognizes boot image files ending in
``.iso`` and ``.sig``. For example: ``.iso`` and signature files ending in ``.sig``. For example:
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system --os-region-name SystemController load-import --active |installer-image-name|.iso |installer-image-name|.sig ~(keystone_admin)]$ software --os-region-name SystemController upload |installer-image-name|.iso |installer-image-name|.sig
The ISO imported via ``load-import --active`` must be at the same patch The uploaded subcloud ISO must be at the same patch level as the system
level as the system controller. This ensures that the subcloud boot image controller. This ensures that the subcloud boot image aligns with the
aligns with the patch level of the load to be installed on the subcloud. patch level of the load to be installed on the subcloud.
.. warning:: .. warning::
If the patch level of load-imported ISO does not match the system If the patch level of the uploaded subcloud ISO does not match the system
controller patch level, the subcloud patch state may not align with the controller patch level, the resulting subcloud patch state may not align
system controller patch state. with the system controller patch state.
- Run the :command:`load-import` command on controller-0 to import the new - Run the following command on controller-0 to upload the subcloud ISO for the
release. You can specify either the full file path or relative paths to the new release. You can specify either the full file path or relative paths to
``*.iso`` bootimage file and to the ``*.sig`` bootimage signature file. the ``*.iso`` bootimage file and to the ``*.sig`` bootimage signature file.
.. code-block:: none .. code-block:: none
$ source /etc/platform/openrc $ source /etc/platform/openrc
~(keystone_admin)]$ system load-import [--local] /home/sysadmin/<bootimage>.iso <bootimage>.sig ~(keystone_admin)]$ software --os-region-name SystemController upload <bootimage>.iso <bootimage>.sig
+--------------------+-----------+ This operation will take a while. Please wait.
| Property | Value | .....
+--------------------+-----------+ Uploaded release nn.nn.n is the same as current release on the controller
| id | 2 | +----------------------------+--------------+
| state | importing | | Uploaded File | Release |
| software_version | nn.nn | +----------------------------+--------------+
| compatible_version | nn.nn | | bootimage.iso | nn.nn.n |
| required_patches | | +----------------------------+--------------+
+--------------------+-----------+
The :command:`load-import` must be done on controller-0. This command must be done on controller-0.
(Optional) If ``--local`` is specified, the ISO and sig files are uploaded
directly from the active controller, where `<local_iso_file_path>` and
`<local_sig_file_path>` are paths on the active controller to load ISO files
and sig files, respectively.
.. note:: .. note::
- If ``--local`` is specified, the ISO and sig files are transferred This may take a few minutes to complete.
directly from the active controller filesystem to the load directory,
otherwise the files are transferred via the API.
- This may take a few minutes to complete.
In order to deploy subclouds from either controller, all local files that are In order to deploy subclouds from either controller, all local files that are
referenced in the ``subcloud-bootstrap-values.yaml`` file must exist on both referenced in the ``subcloud-bootstrap-values.yaml`` file must exist on both
@ -205,8 +193,6 @@ controllers (for example, ``/home/sysadmin/docker-registry-ca-cert.pem``).
#1 - Standard Controller, Graphical Console #1 - Standard Controller, Graphical Console
#2 - AIO, Serial Console #2 - AIO, Serial Console
#3 - AIO, Graphical Console #3 - AIO, Graphical Console
#4 - AIO Low-latency, Serial Console
#5 - AIO Low-latency, Graphical Console
install_type: 3 install_type: 3
# Optional parameters defaults can be modified by uncommenting the option with a modified value. # Optional parameters defaults can be modified by uncommenting the option with a modified value.
@ -361,6 +347,10 @@ controllers (for example, ``/home/sysadmin/docker-registry-ca-cert.pem``).
:start-after: begin-subcloud-1 :start-after: begin-subcloud-1
:end-before: end-subcloud-1 :end-before: end-subcloud-1
.. note::
To modify the kernel using the ansible bootstrap, see :ref:`modify-the-kernel-in-the-cli-39f25220ec1b`
#. Create the subcloud using :command:`dcmanager`. #. Create the subcloud using :command:`dcmanager`.
When calling the :command:`subcloud deploy create` command, specify the install When calling the :command:`subcloud deploy create` command, specify the install

15
doc/source/shared/_includes/inc-install-software-on-controller.rest
View File

@ -45,18 +45,12 @@
#. Select the appropriate deployment option for your scenario. #. Select the appropriate deployment option for your scenario.
For All-in-one deployments, choose one of the All-in-One Configurations, **Debian Controller Install**
either standard kernel or real-time/low-latency kernel.
**Standard Controller Configuration**
For a standard configuration with controller or dedicated storage. For a standard configuration with controller or dedicated storage.
**All-in-one Controller Configuration** **Debian All-in-one Install**
For an |AIO| Simplex or Duplex configuration. For an |AIO| Simplex or Duplex configuration.
**All-in-one Controller Configuration (Low Latency)**
For an AIO Simplex or Duplex configuration with Low Latency Kernel.
#. Choose **Graphical Console** or **Serial Console** depending on your #. Choose **Graphical Console** or **Serial Console** depending on your
terminal access to the console port. terminal access to the console port.
@ -68,11 +62,6 @@
the server to reboot. This can take 5-10 minutes, depending on the performance the server to reboot. This can take 5-10 minutes, depending on the performance
of the server. of the server.
.. warning::
When using the low latency kernel, you must use the serial console
instead of the graphics console, as it causes RT performance issues.
.. end-install-software-controller-0-aio-virtual .. end-install-software-controller-0-aio-virtual
.. include:: /_includes/install-patch-ctl-0.rest .. include:: /_includes/install-patch-ctl-0.rest

2
doc/source/shared/_includes/installation-prereqs.rest
View File

@ -46,8 +46,6 @@ Before attempting to install |prod|, ensure that you have the following:
1 - Standard Controller, Graphical Console 1 - Standard Controller, Graphical Console
2 - AIO, Serial Console 2 - AIO, Serial Console
3 - AIO, Graphical Console 3 - AIO, Graphical Console
4 - AIO Low-latency, Serial Console
5 - AIO Low-latency, Graphical Console
NULL - Clear default selection NULL - Clear default selection
-t <menu timeout>: -t <menu timeout>:
Specify boot menu timeout, in seconds Specify boot menu timeout, in seconds