Prep Debian doc for GA

- Generic changes from preview to GA
- Remove Reduced Scope section
- Technical updates to install section based on
  Eric M. comments
- Release version updates
- Integrate install/pxe material in Install doc
- Comment out 'tree' output of pxe folder structure
- Incorporate patchset 4 review comments
- Removed operational-impacts. Moved to RNs.
- Removed technology-preview-known-issues. Was link to RNs.
- Patchset 6 updates

Story: 2010452

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: If2ef13583cec82bc0b85af180a45a825a24189bf
This commit is contained in:
Ron Stone 2022-11-28 07:49:46 -05:00
parent 1a7cc09e6f
commit 4bb5882a3c
21 changed files with 457 additions and 465 deletions

View File

@ -1,8 +1,8 @@
.. _index-debian-introduction-8eb59cf0a062: .. _index-debian-introduction-8eb59cf0a062:
============== ===============
Debian Preview Debian Overview
============== ===============
-------------------- --------------------
StarlingX Kubernetes StarlingX Kubernetes

View File

@ -4,7 +4,7 @@
Debian-based Solution Debian-based Solution
===================== =====================
Major features of Debian-based |prod| will include: Major features of Debian-based |prod| include:
* Linux 5.10 Yocto-based kernel ( https://www.yoctoproject.org/ ) * Linux 5.10 Yocto-based kernel ( https://www.yoctoproject.org/ )
@ -18,7 +18,7 @@ Major features of Debian-based |prod| will include:
* provides predictable and searchable |CVE| handling. * provides predictable and searchable |CVE| handling.
|org| will also leverage its existing relationships with the Yocto Project to |org| leverages its existing relationships with the Yocto Project to
enhance development, bug fixes and other activities in the Yocto Project kernel enhance development, bug fixes and other activities in the Yocto Project kernel
to drive |prod| quality and feature content. to drive |prod| quality and feature content.

View File

@ -1,16 +0,0 @@
.. _index-debian-introduction-kub-c3fa5e92e8d6:
.. include:: /_includes/toc-title-debian-kub.rest
.. toctree::
:maxdepth: 2
overview-234a36ffe9fb
debian-based-solution-75cd4fb6f023
operational-impacts-9cf2e610b5b3
technology-preview-reduced-scope-0008a139a4b9
technology-preview-installation-fa6f71e9737d
technology-preview-known-issues-899a77ad709c

View File

@ -0,0 +1,10 @@
.. _index-debian-introduction-kub-c3fa5e92e8d6:
.. include:: /_includes/toc-title-debian-kub.rest
.. toctree::
:maxdepth: 2
debian-based-solution-75cd4fb6f023

View File

@ -12,8 +12,7 @@ The operational impact of Debian-based |prod| is small:
* |prod| on Debian will provide the same CLIs and APIs as |prod| on CentOS. * |prod| on Debian will provide the same CLIs and APIs as |prod| on CentOS.
* |prod| on Debian will run the same 5.10 kernel version as |prod| on * |prod| on Debian will run on a 5.10 based kernel.
CentOS.
* |prod| on Debian will support the same set of Kubernetes APIs used in * |prod| on Debian will support the same set of Kubernetes APIs used in
|prod| on CentOS. |prod| on CentOS.
@ -46,7 +45,8 @@ The operational impact of Debian-based |prod| is small:
* The URL to expose keystone service does not have the version appended. * The URL to expose keystone service does not have the version appended.
* On Debian, interface and static routes need to be handled using system-API. * On Debian, interface and static routes need to be handled using system-API
(host-route-\*, host-if-\* and host-addr-\*).
* Do not edit configuration files in ``/etc/network/`` as they are * Do not edit configuration files in ``/etc/network/`` as they are
regenerated from sysinv database after a system reboot. Any changes regenerated from sysinv database after a system reboot. Any changes
@ -67,9 +67,6 @@ The operational impact of Debian-based |prod| is small:
You can see which packages are updated by ostree using the :command:`dpkg You can see which packages are updated by ostree using the :command:`dpkg
-l` instead of :command:`rpm -qa` used on CentOS. -l` instead of :command:`rpm -qa` used on CentOS.
* Patching is done via reboot required patches. In-service patching is not
supported in the Technology Preview release.
* The patching CLI commands and Horizon interactions are the same as for * The patching CLI commands and Horizon interactions are the same as for
CentOS. CentOS.

View File

@ -1,83 +0,0 @@
.. _overview-234a36ffe9fb:
========
Overview
========
With support for the CentOS Distribution being discontinued, |deb-prev-prods|
will move to the Debian OS Distribution. Debian is a well-established Linux
Distribution supported by a large and mature open-source community and used by
hundreds of commercial organizations, including Google. When fully transitioned
to Debian, |deb-prev-prods| will have full functional equivalence to the
current CentOS-based versions of |deb-prev-prods|.
The planned rollout for the transition to Debian is as follows:
.. rubric:: |prod| |deb-510-kernel-release| (RELEASED)
* General Availability (GA) Release of CentOS7 |prod| (for production
deployments)
* Moved to 5.10 kernel, which will be used by the upcoming Debian-based
release.
.. rubric:: |prod| |deb-eval-release|
|prod| |deb-eval-release| is a general Availability (GA) Release of CentOS7
|prod| for production deployments. It will be the last release of a CentOS7
based |prod|.
|prod| |deb-eval-release| inherits the 5.10 version of the Linux kernel
introduced in |prod| |deb-510-kernel-release|.
|prod| |deb-eval-release| is also a technology Preview Release of Debian |prod|
for evaluation purposes.
|prod| |deb-eval-release| release runs Debian Bullseye (11.3). It is limited in
scope to the |AIO-SX| configuration. |deb-dup-std-na|
See :ref:`technology-preview-reduced-scope-0008a139a4b9` for details.
.. rubric:: Debian |prod| General Availability
An upcoming release will make Debian |prod| generally available for
production deployments.
This upcoming release will run Debian Bullseye 11.3 or later with
full functional equivalence to the CentOS-based |prod|.
.. only:: partner
.. include:: /_includes/deb-tech-preview.rest
:start-after: begin-prod-an-1
:end-before: end-prod-an-1
.. rubric:: Planned in-service upgrade paths for |prod|
* |prod| |deb-510-kernel-release| running CentOS ==> |prod| |deb-eval-release| running CentOS ==> |prod| Debian general availability release
or
* |prod| |deb-510-kernel-release| running CentOS ==> |prod| Debian general availability release
.. note::
There will be no upgrade paths related to the |prod| |deb-eval-release|
Debian Technology Preview release.
The |prod-long| |deb-eval-release| Debian Technology Preview allows you to
evaluate and prepare for the upcoming Debian-based General Availability release
while continuing to run your production deployment
on CentOS-based |prod-long|. It is strongly recommended that you perform a
complete assessment of |prod| and your application running on |prod| in a lab
setting to fully understand and plan for any changes that may be required to
your application when you migrate to Debian-based |prod|
the |prod| Debian General Availability release in a production
environment.

View File

@ -0,0 +1,79 @@
.. _overview-234a36ffe9fb:
========
Overview
========
With support for the CentOS Distribution discontinued, |deb-prev-prods| has
moved to the Debian OS Distribution. Debian is a well-established Linux
Distribution supported by a large and mature open-source community and used by
hundreds of commercial organizations, including Google. |deb-prev-prods| has
full functional equivalence to the earlier CentOS-based versions of
|deb-prev-prods|.
The rollout for the transition to Debian is as follows:
.. rubric:: |prod| |deb-510-kernel-release| (RELEASED)
* General Availability (GA) Release of CentOS7 |prod| (for production
deployments)
* Moved to 5.10 kernel, which will be used by the upcoming Debian-based
release.
.. rubric:: |prod| |deb-eval-release|
|prod| |deb-eval-release| was a general Availability (GA) Release of CentOS7
|prod| for production deployments. It was the last release of a CentOS7
based |prod|.
|prod| |deb-eval-release| inherited the 5.10 version of the Linux kernel
introduced in |prod| |deb-510-kernel-release|.
|prod| |deb-eval-release| was also a technology Preview Release of Debian |prod|
for evaluation purposes.
|prod| |deb-eval-release| release ran Debian Bullseye (11.3). It was limited in
scope to the |AIO-SX| configuration. |deb-dup-std-na|
.. rubric:: Debian |prod| General Availability
|this-ver| makes Debian |prod| generally available for production deployments.
This release runs Debian Bullseye 11.3 or later with full functional equivalence
to the CentOS-based |prod|.
.. only:: partner
.. include:: /_includes/deb-tech-preview.rest
:start-after: begin-prod-an-1
:end-before: end-prod-an-1
.. rubric:: In-service upgrade paths for |prod|
* |prod| |deb-510-kernel-release| running CentOS ==> |prod| |deb-eval-release| running CentOS ==> |prod| Debian general availability release
or
* |prod| |deb-510-kernel-release| running CentOS ==> |prod| |this-ver| Debian general availability release
.. note::
There is no upgrade paths related to the |prod| |deb-eval-release|
Debian Technology Preview release.
The |prod-long| |deb-eval-release| Debian Technology Preview allows you to
evaluate and prepare for the Debian-based General Availability release while
continuing to run your production deployment on CentOS-based |prod-long|. It is
strongly recommended that you perform a complete assessment of |prod| and your
application running on |prod| in a lab setting to fully understand and plan for
any changes that may be required to your application when you migrate to
Debian-based |prod| the |prod| Debian General Availability release in a
production environment.

View File

@ -1,302 +0,0 @@
.. _technology-preview-installation-fa6f71e9737d:
===============================
Technology Preview Installation
===============================
In general, the installation of |prod| |deb-eval-release| Debian Technology
Preview on All-in-one Simplex is unchanged.
.. only:: partner
.. include:: /_includes/deb-tech-preview.rest
:start-after: begin-dec-and-imp
:end-before: end-dec-and-imp
There are no changes to:
* The overall installation workflow
.. only:: partner
.. include:: /_includes/deb-tech-preview.rest
:start-after: begin-install-prereqs
:end-before: end-install-prereqs
* The installation prerequisites, i.e. required files, boot mechanism
(bootable USB or pxeboot server), network connectivity, external DNS Server
and a Docker Registry:
.. only:: partner
.. include:: /_includes/deb-tech-preview.rest
:start-after: begin-install-prereqs
:end-before: end-install-prereqs
* The hardware requirements: :ref:`starlingx-hardware-requirements`, or
* The preparation of physical servers, i.e. BIOS setup, etc.
The only minor change in the installation is in the initial install of software
on controller-0. |deb-update-iso|
.. only:: partner
.. include:: /_includes/deb-tech-preview.rest
:start-after: begin-prep-servers
:end-before: end-prep-servers
There is a single install menu |deb-install-step-change| to choose between an
AIO-Controller with the Standard Kernel and an AIO-Controller with the
Low-Latency Kernel. Of course the actual console log output of the software
install will be different due to OSTree and Debian details.
.. _deb-grub-deltas:
The Debian installation requires configuration of the new pxeboot grub menus;
one for servers with Legacy BIOS support and another for servers with |UEFI|
firmware.
During |PXE| boot configuration setup, as described in
:ref:`configuring-a-pxe-boot-server-r7`, additional steps are required to
collect configuration information and create a grub menu to install |prod|
|deb-eval-release| AIO controller-0 function on the target server.
#. Wipe the install device prior to Debian installation.
.. code-block:: none
$ sudo wipedisk --force --include-backup
$ sudo sgdisk -o /dev/sda
Repeat the :command:`sudo sgdisk -o` command for all disks, such as ``dev/sdb``,
``/dev/sdc``, and so-on.
#. **Option 1:** Install controller-0 from a USB device containing the
Debian ISO image.
Use this method to install locally from a physical or virtual media USB
device/ISO.
#. Add the Debian ISO image to a USB device and make the target server
boot the ISO image from that USB device.
#. During installation, select the install type from the presented
menu. For a |UEFI| installation, the menu options are prefixed with
"UEFI ".
#. **Option 2:** Install controller-0 from a PXEboot install feed.
This method uses a network PXEboot install from a remote PXEboot server
and 'feed' directory.
* The 'feed' directory is a directory containing the mounted contents
of the Debian ISO.
* The 'feed' creation process for the Debian install differs from the
CentOS method.
* The 'feed' can be populated with either a **direct ISO mount**
or a **copy of the ISO content**.
**Direct ISO mount** method:
#. Mount the ISO at the feed directory location on the pxeboot server.
#. Copy the ISO to the 'feed' directory location pxeboot server.
.. note::
This can be a common location for installing many servers or a
unique location for a specific server.
#. Mount the ISO as the 'feed' directory.
.. note:: The mount requires root access. If you don't have root
access on the PXEboot server then use the **ISO copy** method.
.. code-block:: none
$ IMAGENAME=<debian_image>
$ sudo mount -o loop ${IMAGENAME}.iso ${IMAGENAME}_feed
**Copy ISO contents** method:
#. Create a tarball containing the mounted ISO content
#. Copy the Debian ISO to a location where the ISO can be mounted
#. Mount the ISO, tar it up and copy the feed tarball to the PXEboot
server
#. Untar the feed tarball at the feed directory location on your
PXEboot server.
An example of the above commands:
.. code-block:: none
$ IMAGENAME=<debian_image>
$ sudo mount -o loop ${IMAGENAME}.iso ${IMAGENAME}_feed
$ tar -czf ${IMAGENAME}_feed.tgz ${IMAGENAME}_feed
$ scp ${IMAGENAME}_feed.tgz <username>@<pxeboot_server>:<feed directory>
$ ssh <username>@<pxeboot_server>
$ cd <feed directory>
$ tar -xzf ${IMAGENAME}_feed.tgz
$ rm ${IMAGENAME}_feed.tgz
#. Optionally, link your new feed directory to the name the pxeboot
server translates the incoming MAC based |DHCP| request to.
.. code-block:: none
$ ln -s ${IMAGENAME}_feed feed
Your 'feed' directory or link should now list similarly to the
following example:
.. code-block:: none
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
The 'feed' directory structure should be as follows:
.. code-block:: none
feed
├── bzImage-rt ... Lowlatency kernel
├── bzImage-std ... Standard kernel
├── initrd ... Installer initramfs image
├── kickstart
│ └── kickstart.cfg ... Unified kickstart
├── ostree_repo ... OSTree Archive Repo
│ ├── config
│ ├── extensions
│ └── objects
├── pxeboot
└── samples
├── efi-pxeboot.cfg.debian ... controller-0 UEFI install menu sample
├── pxeboot.cfg.debian ... controller-0 BIOS install menu sample
├── pxeboot_setup.sh ... script used to tailor the above samples
└── README ... info file
Note that many files and directories have been omitted for clarity.
#. Set up the PXEboot grub menus.
The ISO contains a ``pxeboot/sample`` directory with controller-0
install grub menus.
* For BIOS: ``feed/pxeboot/samples/pxeboot.cfg.debian``
* For UEFI: ``feed/pxeboot/samples/efi-pxeboot.cfg.debian``
You must customize these grub menus for a specific server
install by modifying the following variable replacement strings
with path and other information that is specific to your pxeboot
server.
``xxxFEEDxxx``
The path between http server base and feed directory. For
example: ``/var/www/html/xxxFEED_xxx/<ISO content>``
``xxxPXEBOOTxxx``
The offset path between /pxeboot and the feed to find
``bzImage/initrd``. For example:
``/var/pxeboot/xxxPXEBOOTxxx/<ISO content>``
``xxxBASE_URLxxx``
The pxeboot server URL: ``http://###.###.###.###``
``xxxINSTDEVxxx``
The install device name. Default: ``/dev/sda`` Example:
``/dev/nvme01``
``xxxSYSTEMxxx``
The system install type index. Default: aio>aio-serial
(All-in-one Install - Serial; Console)
menu32 = no default system install type ; requires manual select
disk = Disk Boot
standard>serial = Controller Install - Serial Console
standard>graphical = Controller Install - Graphical Console
aio>serial = All-in-one Install - Serial 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 can be used to automatically setup both the BIOS and
|UEFI| grub files for a specific install.
.. code-block:: none
./feed/pxeboot/samples/pxeboot_setup.sh --help
Usage: ./pxeboot_setup.sh [Arguments Options]
Arguments:
-i | --input <input path> : Path to pxeboot.cfg.debian and efi-pxeboot.cfg.debian grub template files
-o | --output <output path> : Path to created pxeboot.cfg.debian and efi-pxeboot.cfg.debian grub files
-p | --pxeboot <pxeboot path> : Offset path between /pxeboot and bzImage/initrd
-f | --feed <feed path> : Offset path between http server base and mounted iso
-u | --url <pxe server url> : The pxeboot server's URL
Options:
-h | --help : Print this help info
-b | --backup : Create backup of updated grub files as .named files
-d | --device <install device> : Install device path ; default: /dev/sda
-s | --system <system install> : System install type ; default: 3
0 = Disk Boot
1 = Controller Install - Serial Console
2 = Controller Install - Graphical Console
3 = All-in-one Install - Serial Console (default)
4 = All-in-one Install - Graphical Console
5 = All-in-one (lowlatency) Install - Serial Console
6 = All-in-one (lowlatency) Install - Graphical Console
Example:
pxeboot_setup.sh -i /path/to/grub/template/dir
-o /path/to/target/iso/mount
-p pxeboot/offset/to/bzImage_initrd
-f pxeboot/offset/to/target_feed
-u http://###.###.###.###
-d /dev/sde
-s 5
The remaining install steps are also completely unchanged:
.. only:: partner
**Imperative mode**
:ref:`aio_simplex_install_kubernetes_r7`
.. only:: partner
.. include:: /_includes/deb-tech-preview.rest
:start-after: begin-declarative
:end-before: end-declarative

View File

@ -4,8 +4,8 @@
Technology Preview Known Issues Technology Preview Known Issues
=============================== ===============================
Known issues and workarounds with the |prod| |deb-eval-release| are the same Known issues and workarounds with the |prod| |this-ver| are the same
as those for |prod| |deb-eval-release| based on CentOS. as those for |prod| |this-ver| based on CentOS.
.. only:: partner .. only:: partner

View File

@ -1,22 +0,0 @@
.. _technology-preview-reduced-scope-0008a139a4b9:
================================
Technology Preview Reduced Scope
================================
The |prod| |deb-eval-release| Debian Technology Preview release will have
reduced scope:
* Only AIO-SX deployments are supported. Duplex, Standard and
Distributed Cloud configurations are not available in this release.
* Only Kubernetes version 1.23 is supported.
* Support for both standard and low-latency kernel.
* Only Reboot Patching is available. In-service patching is not supported.
* Upgrades to or from this release are not supported.
Full equivalency of configurations and features will be supported in the upcoming
|prod| Debian General Availability release.

View File

@ -0,0 +1,317 @@
.. _pxe-boot-controller-0-d5da025c2524:
=====================
PXE Boot Controller-0
=====================
You can optionally set up a |PXE| Boot Server to support **controller-0**
software installation.
.. contents:: |minitoc|
:local:
:depth: 1
.. rubric:: |context|
|prod| includes a setup script to simplify configuring a |PXE| boot server. The
|prod| setup script accepts a path to the root TFTP directory as a parameter,
and copies all required files for BIOS and |UEFI| clients into this directory.
The |PXE| boot server serves a boot loader file to the requesting client from a
specified path on the server. The path depends on whether the client uses BIOS
or |UEFI|. The appropriate path is selected by conditional logic in the |DHCP|
configuration file.
The file names and locations depend on the BIOS or |UEFI| implementation.
.. rubric:: |prereq|
Use a Linux workstation as the |PXE| Boot server.
.. _configuring-a-pxe-boot-server-ul-mrz-jlj-dt-r7:
- On the workstation, install the packages required to support |DHCP|, TFTP,
and Apache.
- Configure |DHCP|, TFTP, and Apache according to your system requirements.
For details, refer to the documentation included with the packages.
- Additionally, configure |DHCP| to support both BIOS and |UEFI| client
architectures. For example:
.. code-block:: none
option arch code 93 = unsigned integer 16; # ref RFC4578
# ...
subnet 192.168.1.0 netmask 255.255.255.0 {
if option arch = 00:07 {
filename "EFI/grubx64.efi";
# NOTE: substitute the full tftp-boot-dir specified in the setup script
}
else {
filename "pxelinux.0";
}
# ...
}
- Start the |DHCP|, TFTP, and Apache services.
- Connect the |PXE| boot server to the |prod| management or |PXE| boot
network.
.. In general, the installation of |prod| |this-ver| on a Debian kernel
.. is unchanged from previous CentOS based versions.
..
..
.. .. only:: partner
..
.. .. include:: /_includes/deb-tech-preview.rest
.. :start-after: begin-dec-and-imp
.. :end-before: end-dec-and-imp
..
..
.. There are no changes to:
..
.. * The overall installation workflow
..
.. .. only:: partner
..
.. .. include:: /_includes/deb-tech-preview.rest
.. :start-after: begin-install-prereqs
.. :end-before: end-install-prereqs
..
..
.. * The installation prerequisites, i.e. required files, boot mechanism
.. (bootable USB or pxeboot server), network connectivity, external DNS Server
.. and a Docker Registry:
..
.. .. only:: partner
..
.. .. include:: /_includes/deb-tech-preview.rest
.. :start-after: begin-install-prereqs
.. :end-before: end-install-prereqs
..
.. * The hardware requirements: :ref:`starlingx-hardware-requirements`, or
..
.. * The preparation of physical servers, i.e. BIOS setup, etc.
..
.. The only minor change in the installation is in the initial install of software
.. on controller-0. |deb-update-iso|
..
.. .. only:: partner
..
.. .. include:: /_includes/deb-tech-preview.rest
.. :start-after: begin-prep-servers
.. :end-before: end-prep-servers
.. begin-pxeboot-grub-setup
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
*AIO-Controller with the Low-Latency Kernel* installation. .
.. _deb-grub-deltas:
The Debian-based installation requires configuration of the new pxeboot grub
menus; one for servers with Legacy BIOS support and another for servers with
|UEFI| firmware.
.. rubric:: |proc|
Install controller-0 from a PXEboot install feed.
* The 'feed' directory on the remote PXEboot server is a directory containing
the mounted contents of the Debian ISO.
* The 'feed' can be populated with either a **direct ISO mount**
or a **copy of the ISO content**.
Direct ISO mount method
=======================
#. Mount the ISO at the feed directory location on the pxeboot server.
#. Copy the ISO to the 'feed' directory location pxeboot server.
.. note::
This can be a common location for installing many servers or a
unique location for a specific server.
#. Mount the ISO as the 'feed' directory.
.. note:: The mount requires root access. If you don't have root
access on the PXEboot server then use the **ISO copy** method.
.. code-block:: none
$ IMAGENAME=<debian_image>
$ sudo mount -o loop ${IMAGENAME}.iso ${IMAGENAME}_feed
Copy ISO contents method
========================
#. Create a tarball containing the mounted ISO content.
#. Copy the Debian ISO to a location where the ISO can be mounted.
#. Mount the ISO, tar it up and copy the feed tarball to the PXEboot
server.
#. Untar the feed tarball at the feed directory location on your
PXEboot server.
An example of the above commands:
.. code-block:: none
$ IMAGENAME=<debian_image>
$ sudo mount -o loop ${IMAGENAME}.iso ${IMAGENAME}_feed
$ tar -czf ${IMAGENAME}_feed.tgz ${IMAGENAME}_feed
$ scp ${IMAGENAME}_feed.tgz <username>@<pxeboot_server>:<feed directory>
$ ssh <username>@<pxeboot_server>
$ cd <feed directory>
$ tar -xzf ${IMAGENAME}_feed.tgz
$ rm ${IMAGENAME}_feed.tgz
#. Optionally, link your new feed directory to the name the pxeboot
server translates the incoming MAC based |DHCP| request to.
.. code-block:: none
$ ln -s ${IMAGENAME}_feed feed
Your 'feed' directory or link should now list similarly to the
following example:
.. code-block:: none
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
.. The 'feed' directory structure should be as follows:
.. .. code-block:: none
.. feed
.. ├── bzImage-rt ... Lowlatency kernel
.. ├── bzImage-std ... Standard kernel
.. ├── initrd ... Installer initramfs image
.. ├── kickstart
.. │ └── kickstart.cfg ... Unified kickstart
.. │
.. ├── ostree_repo ... OSTree Archive Repo
.. │ ├── config
.. │ ├── extensions
.. │ └── objects
.. │
.. ├── pxeboot
.. └── samples
.. ├── efi-pxeboot.cfg.debian ... controller-0 UEFI install menu sample
.. ├── pxeboot.cfg.debian ... controller-0 BIOS install menu sample
.. ├── pxeboot_setup.sh ... script used to tailor the above samples
.. └── README ... info file
.. Note that many files and directories have been omitted for clarity.
#. Set up the PXEboot grub menus.
The ISO contains a ``pxeboot/sample`` directory with controller-0
install grub menus.
* For BIOS: ``feed/pxeboot/samples/pxeboot.cfg.debian``
* For UEFI: ``feed/pxeboot/samples/efi-pxeboot.cfg.debian``
You must customize these grub menus for a specific server
install by modifying the following variable replacement strings
with path and other information that is specific to your pxeboot
server.
``xxxFEEDxxx``
The path between http server base and feed directory. For
example: ``/var/www/html/xxxFEED_xxx/<ISO content>``
``xxxPXEBOOTxxx``
The offset path between /pxeboot and the feed to find
``bzImage/initrd``. For example:
``/var/pxeboot/xxxPXEBOOTxxx/<ISO content>``
``xxxBASE_URLxxx``
The pxeboot server URL: ``http://###.###.###.###``
``xxxINSTDEVxxx``
The install device name. Default: ``/dev/sda`` Example:
``/dev/nvme01``
``xxxSYSTEMxxx``
The system install type index. Default: aio>aio-serial
(All-in-one Install - Serial; Console)
menu32 = no default system install type ; requires manual select
disk = Disk Boot
standard>serial = Controller Install - Serial Console
standard>graphical = Controller Install - Graphical Console
aio>serial = All-in-one Install - Serial 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
can be used to automatically setup both the BIOS and |UEFI| grub files for a
specific install.
.. code-block:: none
./feed/pxeboot/samples/pxeboot_setup.sh --help
Usage: ./pxeboot_setup.sh [Arguments Options]
Arguments:
-i | --input <input path> : Path to pxeboot.cfg.debian and efi-pxeboot.cfg.debian grub template files
-o | --output <output path> : Path to created pxeboot.cfg.debian and efi-pxeboot.cfg.debian grub files
-p | --pxeboot <pxeboot path> : Offset path between /pxeboot and bzImage/initrd
-f | --feed <feed path> : Offset path between http server base and mounted iso
-u | --url <pxe server url> : The pxeboot server's URL
Options:
-h | --help : Print this help info
-b | --backup : Create backup of updated grub files as .named files
-d | --device <install device> : Install device path ; default: /dev/sda
-s | --system <system install> : System install type ; default: 3
0 = Disk Boot
1 = Controller Install - Serial Console
2 = Controller Install - Graphical Console
3 = All-in-one Install - Serial Console (default)
4 = All-in-one Install - Graphical Console
5 = All-in-one (lowlatency) Install - Serial Console
6 = All-in-one (lowlatency) Install - Graphical Console
Example:
pxeboot_setup.sh -i /path/to/grub/template/dir
-o /path/to/target/iso/mount
-p pxeboot/offset/to/bzImage_initrd
-f pxeboot/offset/to/target_feed
-u http://###.###.###.###
-d /dev/sde
-s 5

View File

@ -106,8 +106,7 @@ Install controller-0 from a PXE boot server
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
bare_metal/configuring-a-pxe-boot-server bare_metal/pxe-boot-controller-0-d5da025c2524
bare_metal/accessing-pxe-boot-server-files-for-a-custom-configuration
Add and reinstall a host Add and reinstall a host

View File

@ -204,14 +204,6 @@ Sample Application Deployments
sample_apps/index-sample-apps-15fce86ad4bf sample_apps/index-sample-apps-15fce86ad4bf
--------------
Debian Preview
--------------
.. toctree::
:maxdepth: 2
debian/index-debian-introduction-8eb59cf0a062
----------------- -----------------
Deprecated guides Deprecated guides

View File

@ -17,8 +17,36 @@ Where:
.. _functional_overview-ul-izt-blh-s3b: .. _functional_overview-ul-izt-blh-s3b:
**Hardened Linux** **Hardened Linux**
A CentOS Linux Kernel and OS, tuned for performance and maintained with Linux 5.10 Yocto-based kernel ( https://www.yoctoproject.org/ )
security |CVE| patches.
The Yocto Project Kernel:
* tracks stable kernel updates very closely; staying very current with the
stable kernel,
* provides a reliable implementation of the pre-empt-rt patchset (see:
https://rt.wiki.kernel.org/index.php/Main_Page), and
* provides predictable and searchable |CVE| handling.
|org| leverages its existing relationships with the Yocto Project to
enhance development, bug fixes and other activities in the Yocto Project kernel
to drive |prod| quality and feature content.
* Debian Bullseye (11.3)
Debian is a well-established Linux Distribution supported by a large and
mature open-source community.
* OSTree ( https://ostree.readthedocs.io/en/stable/manual/introduction/ )
OSTree provides for robust and efficient versioning, packaging and
upgrading of Linux-based systems.
* An updated Installer to seamlessly adapt to Debian and OSTree
* Updated software patching and upgrades for Debian and OSTree.
**Variety of open-source software supporting StarlingX and/or Kubernetes** **Variety of open-source software supporting StarlingX and/or Kubernetes**
This includes packages such as Apache, Ceph, PostgreSql, Etcd, |IPMI|, This includes packages such as Apache, Ceph, PostgreSql, Etcd, |IPMI|,

View File

@ -64,11 +64,11 @@ for evaluation purposes.
scope to the |AIO-SX| configuration, |deb-dup-std-na|. It is also limited in scope to the |AIO-SX| configuration, |deb-dup-std-na|. It is also limited in
scope to Kubernetes apps and does not yet support running OpenStack on Debian. scope to Kubernetes apps and does not yet support running OpenStack on Debian.
**See**: .. .. **See**:
- :ref:`index-debian-introduction-8eb59cf0a062` .. .. - :ref:`index-debian-introduction-8eb59cf0a062`
- :ref:`operational-impacts-9cf2e610b5b3` .. .. - :ref:`operational-impacts-9cf2e610b5b3`
****************************** ******************************

View File

@ -66,12 +66,6 @@ for evaluation purposes.
scope to the |AIO-SX| configuration, |deb-dup-std-na|. It is also limited in scope to the |AIO-SX| configuration, |deb-dup-std-na|. It is also limited in
scope to Kubernetes apps and does not yet support running OpenStack on Debian. scope to Kubernetes apps and does not yet support running OpenStack on Debian.
**See**:
- :ref:`index-debian-introduction-8eb59cf0a062`
- :ref:`operational-impacts-9cf2e610b5b3`
****************************** ******************************
Istio Service Mesh Application Istio Service Mesh Application

View File

@ -25,7 +25,7 @@ installation procedure.
.. note:: .. note::
Alternatively one can PXEBOOT controller-0. See Alternatively one can PXEBOOT controller-0. See
:ref:`configuring-a-pxe-boot-server-r7` for details on how to setup a :ref:`pxe-boot-controller-0-d5da025c2524` for details on how to setup a
PXEBOOT Server and pxe-boot the |prod| load on controller-0 PXEBOOT Server and pxe-boot the |prod| load on controller-0
#. Power on the host. #. Power on the host.

View File

@ -59,7 +59,7 @@ Before attempting to install |prod|, ensure that you have the following:
-t <menu timeout>: -t <menu timeout>:
Specify boot menu timeout, in seconds Specify boot menu timeout, in seconds
The following example ks-addon.cfg file, used with the -a option, sets up The following example ``ks-addon.cfg`` file, used with the ``-a`` option, sets up
an initial IP interface at boot time by defining a VLAN on an Ethernet an initial IP interface at boot time by defining a VLAN on an Ethernet
interface and has it use DHCP to request an IP address: interface and has it use DHCP to request an IP address:
@ -98,8 +98,7 @@ Before attempting to install |prod|, ensure that you have the following:
- the ISO image on a |PXE| boot server on the same network as the server - the ISO image on a |PXE| boot server on the same network as the server
that will be used as the initial controller-0. See Appendix that will be used as the initial controller-0. See Appendix
:ref:`Installing Controller-0 from a PXE Boot Server :ref:`pxe-boot-controller-0-d5da025c2524` for details.
<configuring-a-pxe-boot-server-r7>` for details
- For all controller or AIO controller servers, |OAM| Network connectivity to: - For all controller or AIO controller servers, |OAM| Network connectivity to:

View File

@ -106,7 +106,7 @@ host types are:
|UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On |UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On
systems with an IPv6 management network, you can use a separate IPv4 systems with an IPv6 management network, you can use a separate IPv4
network for |PXE| boot. For more information, see network for |PXE| boot. For more information, see
:ref:`configuring-a-pxe-boot-server-r7`. :ref:`pxe-boot-controller-0-d5da025c2524`.
* - BIOS settings * - BIOS settings
- * Hyper-Threading technology enabled - * Hyper-Threading technology enabled
@ -239,7 +239,7 @@ host types are:
|UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On |UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On
systems with an IPv6 management network, you can use a separate IPv4 systems with an IPv6 management network, you can use a separate IPv4
network for |PXE| boot. For more information, see network for |PXE| boot. For more information, see
:ref:`configuring-a-pxe-boot-server-r7`. :ref:`pxe-boot-controller-0-d5da025c2524`.
- BIOS or UEFI - BIOS or UEFI
* - Bios settings * - Bios settings
- * Hyper-Threading technology enabled - * Hyper-Threading technology enabled
@ -346,7 +346,7 @@ host types are:
|UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On |UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On
systems with an IPv6 management network, you can use a separate IPv4 systems with an IPv6 management network, you can use a separate IPv4
network for |PXE| boot. For more information, see network for |PXE| boot. For more information, see
:ref:`configuring-a-pxe-boot-server-r7`. :ref:`pxe-boot-controller-0-d5da025c2524`.
- BIOS or UEFI - BIOS or UEFI
* - Bios settings * - Bios settings
- * Hyper-Threading technology enabled - * Hyper-Threading technology enabled
@ -470,7 +470,7 @@ host types are:
|UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On |UEFI| Secure Boot and |UEFI| |PXE| boot over IPv6 are not supported. On
systems with an IPv6 management network, you can use a separate IPv4 systems with an IPv6 management network, you can use a separate IPv4
network for |PXE| boot. For more information, see network for |PXE| boot. For more information, see
:ref:`configuring-a-pxe-boot-server-r7`. :ref:`pxe-boot-controller-0-d5da025c2524`.
- BIOS or UEFI - BIOS or UEFI
- BIOS or UEFI - BIOS or UEFI
* - Bios settings * - Bios settings