Table conversions

Two tables converted to list-table format
Cross ref in one table with spans moved to footnote
Changes per patchset 1 review

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: I837b539e3cb0646f312c0c6c9ae1f337ab6fe165
Signed-off-by: Stone <ronald.stone@windriver.com>
This commit is contained in:
Stone 2021-02-18 10:52:21 -05:00
parent 5a7ec8c408
commit 41244d72d8
3 changed files with 101 additions and 85 deletions

View File

@ -12,17 +12,35 @@ The following table lists IPv4 and IPv6 support for different networks:
.. _network-requirements-ip-support-table-xqy-3cj-4cb:
.. table:: Table 1. IPv4 and IPv6 Support
:widths: auto
.. list-table:: Table 1. IPv4 and IPv6 Support
:header-rows: 1
+----------------------+--------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Networks | IPv4 Support | IPv6 Support | Comment |
+======================+==============+==============+========================================================================================================================================================================================================================================================================================================================================================================================+
| PXE boot | Y | N | If present, the PXE boot network is used for PXE booting of new hosts \(instead of using the internal management network\), and must be untagged. It is limited to IPv4, because the |prod| installer does not support IPv6 UEFI booting. |
+----------------------+--------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Internal Management | Y | Y | By default \(when PXE boot network is not present\), internal management is used for PXE booting of new hosts. It must be untagged and it must be IPv4. If, for deployment reasons, the internal management network needs to be on a VLAN-tagged network, or if it needs to be IPv6, you can configure the optional untagged PXE boot network for PXE booting of new hosts using IPv4. |
+----------------------+--------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| OAM | Y | Y | The OAM network supports IPv4 or IPv6 addressing. For more information, see :ref:`OAM Network Planning <oam-network-planning>`. |
+----------------------+--------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Cluster Host Network | Y | Y | The Cluster Host network supports IPv4 or IPv6 addressing. |
+----------------------+--------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
* - Networks
- IPv4 Support
- IPv6 Support
- Comment
* - |PXE| boot
- Y
- N
- If present, the |PXE| boot network is used for |PXE| booting of new
hosts \(instead of using the internal management network\), and must be
untagged. It is limited to IPv4, because the |prod| installer does not
support IPv6 |UEFI| booting.
* - Internal Management
- Y
- Y
- By default \(when |PXE| boot network is not present\), internal
management is used for |PXE| booting of new hosts. It must be untagged
and it must be IPv4. If, for deployment reasons, the internal management
network needs to be on a VLAN-tagged network, or if it needs to be IPv6,
you can configure the optional untagged |PXE| boot network for |PXE|
booting of new hosts using IPv4.
* - OAM
- Y
- Y
- The OAM network supports IPv4 or IPv6 addressing. For more information,
see :ref:`OAM Network Planning <oam-network-planning>`.
* - Cluster Host Network
- Y
- Y
- The Cluster Host network supports IPv4 or IPv6 addressing.

View File

@ -100,73 +100,69 @@ in the following table.
.. _starlingx-hardware-requirements-table-cb2-lfx-p5:
.. list-table:: Table 2. Hardware Requirements — |prod| Simplex or Duplex Configuration
:header-rows: 1
.. table:: Table 2. Hardware Requirements — |prod| Simplex or Duplex Configuration
:widths: auto
* - Minimum Requirement
- Controller + Worker
\(Combined Server\)
* - Minimum Qty of Servers
- Simplex―1
Duplex―2
* - Minimum Processor Class
- Dual-CPU Intel® Xeon® E5 26xx Family \(SandyBridge\) 8 cores/socket
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Minimum Requirement | Controller + Worker |
| | |
| | \(Combined Server\) |
+===================================+==================================================================================================================================================================================================================================================================+
| Minimum Qty of Servers | Simplex―1 |
| | |
| | Duplex―2 |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 for Simplex deployments\) |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Minimum Memory | 64 GB |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Minimum Primary Disk | 500 GB - SSD or NVMe |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Additional Disks | - Single-disk system: N/A |
| | |
| | - Two-disk system: |
| | |
| | |
| | - 1 x 500 GB SSD or NVMe for Persistent Volume Claim storage |
| | |
| | |
| | - Three-disk system: |
| | |
| | |
| | - 1 x 500 GB \(min 10K RPM\) for Persistent Volume Claim storage |
| | |
| | - 1 or more x 500 GB \(min. 10K RPM\) for Container ephemeral disk storage |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Network Ports | \(Typical deployment.\) |
| | |
| | - Mgmt and Cluster Host: 2 x 10GE LAG \(shared interface\) |
| | |
| | .. note:: |
| | Mgmt / Cluster Host ports are required for Duplex systems only |
| | |
| | - OAM: 2 x 1GE LAG |
| | |
| | - Optionally external network ports 2 x 10GE LAG |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| USB Interface | 1 |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Power Profile | Max Performance |
| | |
| | Min Proc Idle Power:No C States |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Boot Order | HD, PXE, USB |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| BIOS Mode | BIOS or UEFI |
| | |
| | .. note:: |
| | 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 network for PXE boot. For more information, see :ref:`PXE Boot Network <network-planning-the-pxe-boot-network>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Intel Hyperthreading | Disabled or Enabled |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Intel Virtualization \(VTD, VTX\) | Enabled |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
or
Single-CPU Intel Xeon D-15xx Family, 8 cores \(low-power/low-cost
option for Simplex deployments\)
* - Minimum Memory
- 64 GB
* - Minimum Primary Disk
- 500 GB - |SSD| or |NVMe|
* - Additional Disks
- - Single-disk system: N/A
- Two-disk system:
* 1 x 500 GB SSD or |NVMe| for Persistent Volume Claim storage
- Three-disk system:
* 1 x 500 GB \(min 10K RPM\) for Persistent Volume Claim storage
* 1 or more x 500 GB \(min. 10K RPM\) for Container ephemeral
disk storage
* - Network Ports
- \(Typical deployment.\)
- Mgmt and Cluster Host: 2 x 10GE |LAG| \(shared interface\)
.. note::
Mgmt / Cluster Host ports are required for Duplex systems only.
- OAM: 2 x 1GE LAG
- Optionally external network ports 2 x 10GE LAG
* - USB Interface
- 1
* - Power Profile
- Max Performance
Min Proc Idle Power:No C States
* - Boot Order
- HD, |PXE|, USB
* - BIOS Mode
- BIOS or |UEFI|
.. note::
|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 network for |PXE| boot. For more information, see :ref:`PXE Boot
Network <network-planning-the-pxe-boot-network>`.
* - Intel Hyperthreading
- Disabled or Enabled
* - Intel Virtualization \(VTD, VTX\)
- Enabled
.. _starlingx-hardware-requirements-section-if-scenarios:

View File

@ -11,9 +11,9 @@ Hardware Requirements
If the minimum hardware requirements are not met, system performance cannot be
guaranteed.
See :ref:`StarlingX Hardware Requirements <starlingx-hardware-requirements>`
for the |prod-long| Hardware Requirements. In the table below, only the
Interface sections are modified for |prod-os|.
See :ref:`StarlingX Hardware Requirements <starlingx-hardware-requirements>` to
review the |prod-long| Kubernetes hardware requirements. In the table below,
only the Interface sections are modified for |prod-os|.
.. _hardware-requirements-section-N10044-N10024-N10001:
@ -101,13 +101,14 @@ Controller, Compute, and Storage Hosts
| BIOS Mode | BIOS or UEFI |
| | |
| | .. note:: |
| | 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 network for PXE boot. For more information, see :ref:`The PXE Boot Network <the-pxe-boot-network>`. |
| | 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 network for PXE boot. [#]_ |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Intel Hyperthreading | Disabled or Enabled |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Intel Virtualization \(VTD, VTX\) | Disabled | Enabled |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. [#] For more information, see :ref:`The PXE Boot Network <the-pxe-boot-network>`.
.. _hardware-requirements-section-N102D0-N10024-N10001:
@ -118,9 +119,9 @@ Combined Controller-Compute Hosts
Hardware requirements for a |prod-os| Simplex or Duplex configuration are
listed in the following table.
See :ref:`StarlingX Hardware Requirements <starlingx-hardware-requirements>`
for the |prod-long| Hardware Requirements. In the table below, only the
Interface sections are modified for |prod-os|.
See :ref:`StarlingX Hardware Requirements <starlingx-hardware-requirements>` to
review the |prod-long| Kubernetes hardware requirements. In the table below,
only the Interface sections are modified for |prod-os|.
.. _hardware-requirements-table-cb2-lfx-p5:
@ -212,13 +213,14 @@ Interface sections are modified for |prod-os|.
| BIOS Mode | BIOS or UEFI |
| | |
| | .. note:: |
| | 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 network for PXE boot. For more information, see :ref:`The PXE Boot Network <the-pxe-boot-network>`. |
| | 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 network for PXE boot. [#]_ |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Intel Hyperthreading | Disabled or Enabled |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Intel Virtualization \(VTD, VTX\) | Enabled |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. [#] For more information, see :ref:`The PXE Boot Network <the-pxe-boot-network>`.
.. _hardware-requirements-section-if-scenarios: