diff --git a/doc/source/_includes/release-notes-overview-footnote.rest b/doc/source/_includes/release-notes-overview-footnote.rest new file mode 100644 index 000000000..2e643ce78 --- /dev/null +++ b/doc/source/_includes/release-notes-overview-footnote.rest @@ -0,0 +1 @@ +.. [#] See :ref:`Data Network Planning ` for more information. diff --git a/doc/source/_includes/subnet-sizing-restrictions.rest b/doc/source/_includes/subnet-sizing-restrictions.rest new file mode 100644 index 000000000..e69de29bb diff --git a/doc/source/planning/kubernetes/internal-management-network-planning.rst b/doc/source/planning/kubernetes/internal-management-network-planning.rst index bd6a9a6d4..b5b07a4c3 100755 --- a/doc/source/planning/kubernetes/internal-management-network-planning.rst +++ b/doc/source/planning/kubernetes/internal-management-network-planning.rst @@ -55,3 +55,7 @@ You must consider the following guidelines: internal management network. To prevent loss of controller synchronization, ensure that the switches and other devices on these networks are configured with appropriate settings. + +.. only:: partner + + .. 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 84c741619..8e18d3950 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 @@ -17,5 +17,9 @@ network for deployment reasons, or if it must support IPv6, you must configure the optional untagged |PXE| boot network for |PXE| booting of new hosts using IPv4. +.. only:: partner + + .. include:: ../../_includes/subnet-sizing-restrictions.rest + .. note:: |prod| does not support IPv6 |PXE| booting. diff --git a/doc/source/planning/kubernetes/network-requirements-ip-support.rst b/doc/source/planning/kubernetes/network-requirements-ip-support.rst index a5613ea44..e1d46f9a8 100755 --- a/doc/source/planning/kubernetes/network-requirements-ip-support.rst +++ b/doc/source/planning/kubernetes/network-requirements-ip-support.rst @@ -8,7 +8,9 @@ IP Support |prod| supports IPv4 and IPv6 versions for various networks. -The following table lists IPv4 and IPv6 support for different networks: +All networks must be a single address family, either IPv4 or IPv6, with the +exception of the |PXE| boot network which must always use IPv4. The following +table lists IPv4 and IPv6 support for different networks: .. _network-requirements-ip-support-table-xqy-3cj-4cb: @@ -29,18 +31,12 @@ The following table lists IPv4 and IPv6 support for different networks: * - 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 `. - * - Cluster Host Network + - - + * - Cluster Host - Y - Y - The Cluster Host network supports IPv4 or IPv6 addressing. diff --git a/doc/source/planning/kubernetes/oam-network-planning.rst b/doc/source/planning/kubernetes/oam-network-planning.rst index 542c2788a..bc7775ad8 100755 --- a/doc/source/planning/kubernetes/oam-network-planning.rst +++ b/doc/source/planning/kubernetes/oam-network-planning.rst @@ -70,3 +70,7 @@ guidelines: internal management network. To prevent loss of controller synchronization, ensure that the switches and other devices on these networks are configured with appropriate settings. + +.. only:: partner + + .. include:: ../../_includes/subnet-sizing-restrictions.rest \ No newline at end of file diff --git a/doc/source/planning/kubernetes/starlingx-hardware-requirements.rst b/doc/source/planning/kubernetes/starlingx-hardware-requirements.rst index d360e942f..384ef50ff 100755 --- a/doc/source/planning/kubernetes/starlingx-hardware-requirements.rst +++ b/doc/source/planning/kubernetes/starlingx-hardware-requirements.rst @@ -117,8 +117,23 @@ in the following table. Single-CPU Intel Xeon D-15xx Family, 8 cores \(low-power/low-cost option for Simplex deployments\) + + Platform: 2x physical cores \(4x logical cores if hyper-threading\), \(by default, configurable\) + Application: Remaining cores * - Minimum Memory - - 64 GB + - - 64 GB + + - Platform: + + * Socket 0: 7GB \(by default, configurable\) + + * Socket 1: 1GB \(by default, configurable\) + + - Application: + + * Socket 0: Remaining memory + + * Socket 1: Remaining memory * - Minimum Primary Disk - 500 GB - |SSD| or |NVMe| * - Additional Disks diff --git a/doc/source/planning/kubernetes/the-cluster-host-network.rst b/doc/source/planning/kubernetes/the-cluster-host-network.rst index 1b4c6b4d8..2d72fd9f6 100755 --- a/doc/source/planning/kubernetes/the-cluster-host-network.rst +++ b/doc/source/planning/kubernetes/the-cluster-host-network.rst @@ -45,3 +45,7 @@ exposed through |BGP| within the Calico |CNI| service. Calico |BGP| configuration could be modified to advertise selected Application Container services or the ingress controller service to a |BGP| Peer, specifying the 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 diff --git a/doc/source/planning/kubernetes/verified-commercial-hardware.rst b/doc/source/planning/kubernetes/verified-commercial-hardware.rst index 6cca61e83..936c84a7f 100755 --- a/doc/source/planning/kubernetes/verified-commercial-hardware.rst +++ b/doc/source/planning/kubernetes/verified-commercial-hardware.rst @@ -6,178 +6,182 @@ Kubernetes Verified Commercial Hardware ======================================= -Verified and approved hardware components for use with |prod| are listed -here. +Verified and approved hardware components for use with |prod| are listed here. .. _verified-commercial-hardware-verified-components: .. table:: Table 1. Verified Components - :widths: 100, 200 + :widths: auto - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Component | Approved Hardware | - +==========================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | Hardware Platforms | - Hewlett Packard Enterprise | - | | | - | | | - | | - HPE ProLiant DL360p Gen8 Server | - | | | - | | - HPE ProLiant DL360p Gen9 Server | - | | | - | | - HPE ProLiant DL360 Gen10 Server | - | | | - | | - HPE ProLiant DL380p Gen8 Server | - | | | - | | - HPE ProLiant DL380p Gen9 Server | - | | | - | | - HPE ProLiant ML350 Gen10 Server | - | | | - | | - c7000 Enclosure with HPE ProLiant BL460 Gen9 Server | - | | | - | | .. caution:: | - | | LAG support is dependent on the switch cards deployed with the c7000 enclosure. To determine whether LAG can be configured, consult the switch card documentation. | - | | | - | | | - | | - Dell | - | | | - | | | - | | - Dell PowerEdge R430 | - | | | - | | - Dell PowerEdge R630 | - | | | - | | - Dell PowerEdge R640 | - | | | - | | - Dell PowerEdge R720 | - | | | - | | - Dell PowerEdge R730 | - | | | - | | - Dell PowerEdge R740 | - | | | - | | | - | | - Kontron Symkloud MS2920 | - | | | - | | .. note:: | - | | The Kontron platform does not support power ON/OFF or reset through the BMC interface on |prod|. As a result, it is not possible for the system to properly fence a node in the event of a management network isolation event. In order to mitigate this, hosted application auto recovery needs to be disabled. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Supported Reference Platforms | - Intel Iron Pass | - | | | - | | - Intel Canoe Pass | - | | | - | | - Intel Grizzly Pass | - | | | - | | - Intel Wildcat Pass | - | | | - | | - Intel Wolf Pass | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Disk Controllers | - Dell | - | | | - | | | - | | - PERC H310 Mini | - | | | - | | - PERC H730 Mini | - | | | - | | - PERC H740P | - | | | - | | - PERC H330 | - | | | - | | - PERC HBA330 | - | | | - | | | - | | | - | | - HPE Smart Array | - | | | - | | | - | | - P440ar | - | | | - | | - P420i | - | | | - | | - P408i-a | - | | | - | | - P816i-a | - | | | - | | | - | | - LSI 2308 | - | | | - | | - LSI 3008 | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NICs Verified for PXE Boot, Management, and OAM Networks | - Intel I210 \(Springville\) 1G | - | | | - | | - Intel I350 \(Powerville\) 1G | - | | | - | | - Intel 82599 \(Niantic\) 10G | - | | | - | | - Intel X540 10G | - | | | - | | - Intel X710/XL710 \(Fortville\) 10G | - | | | - | | - Intel X722 \(Fortville\) 10G | - | | | - | | - Emulex XE102 10G | - | | | - | | - Broadcom BCM5719 1G | - | | | - | | - Broadcom BCM57810 10G | - | | | - | | - Mellanox MT27710 Family \(ConnectX-4 Lx\) 10G/25G | - | | | - | | - Mellanox MT27700 Family \(ConnectX-4\) 40G | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NICs Verified for Data Interfaces [#]_ | The following NICs are supported: | - | | | - | | - Intel I350 \(Powerville\) 1G | - | | | - | | - Intel 82599 \(Niantic\) 10G | - | | | - | | - Intel X710/XL710 \(Fortville\) 10 G | - | | | - | | - Intel X552 \(Xeon-D\) 10G | - | | | - | | - Mellanox Technologies | - | | | - | | | - | | - MT27710 Family \(ConnectX-4\) 10G/25G | - | | | - | | - MT27700 Family \(ConnectX-4\) 40G | - | | | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | PCI passthrough or PCI SR-IOV NICs | - Intel 82599 \(Niantic\) 10 G | - | | | - | | - Intel X710/XL710 \(Fortville\) 10G | - | | | - | | - Mellanox Technologies | - | | | - | | | - | | - MT27500 Family \(ConnectX-3\) 10G \(support for PCI passthrough only\) [#]_ | - | | | - | | | - | | | - | | | - | | - MT27710 Family \(ConnectX-4\) 10G/25G | - | | | - | | - MT27700 Family \(ConnectX-4\) 40G | - | | | - | | | - | | .. note:: | - | | For a Mellanox CX3 using PCI passthrough or a CX4 using PCI passthrough or SR-IOV, SR-IOV must be enabled in the CX3/CX4 firmware. For more information, see `How To Configure SR-IOV for ConnectX-3 with KVM (Ethernet): Enable SR-IOV on the Firmware `__. | - | | | - | | | - | | .. note:: | - | | The maximum number of VFs per hosted application instance, across all PCI devices, is 32. | - | | | - | | For example, a hardware encryption hosted application can be launched with virtio interfaces and 32 QAT VFs. However, a hardware encryption hosted application with an SR-IOV network interface \(with 1 VF\) can only be launched with 31 VFs. | - | | | - | | .. note:: | - | | Dual-use configuration \(PCI passthrough or PCI SR-IOV on the same interface\) is supported for Fortville NICs only. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | PCI SR-IOV Hardware Accelerators | - Intel AV-ICE02 VPN Acceleration Card, based on the Intel Coleto Creek 8925/8950, and C62x device with QuickAssist ®. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | GPUs Verified for PCI Passthrough | - NVIDIA Corporation: VGA compatible controller - GM204GL \(Tesla M60 rev a1\) | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Board Management Controllers | - HPE iLO3 | - | | | - | | - HPE iLO4 | - | | | - | | - Quanta | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Component | Approved Hardware | + +================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | Hardware Platforms | - Hewlett Packard Enterprise | + | | | + | | | + | | - HPE ProLiant DL360p Gen8 Server | + | | | + | | - HPE ProLiant DL360p Gen9 Server | + | | | + | | - HPE ProLiant DL360 Gen10 Server | + | | | + | | - HPE ProLiant DL380p Gen8 Server | + | | | + | | - HPE ProLiant DL380p Gen9 Server | + | | | + | | - HPE ProLiant ML350 Gen10 Server | + | | | + | | - c7000 Enclosure with HPE ProLiant BL460 Gen9 Server | + | | | + | | .. caution:: | + | | LAG support is dependent on the switch cards deployed with the c7000 enclosure. To determine whether LAG can be configured, consult the switch card documentation. | + | | | + | | - HPE ProLiant e910t Server Blade | + | | | + | | | + | | - Dell | + | | | + | | | + | | - Dell PowerEdge R430 | + | | | + | | - Dell PowerEdge R630 | + | | | + | | - Dell PowerEdge R640 | + | | | + | | - Dell PowerEdge R720 | + | | | + | | - Dell PowerEdge R730 | + | | | + | | - Dell PowerEdge R740 | + | | | + | | | + | | - Kontron Symkloud MS2920 | + | | | + | | .. note:: | + | | The Kontron platform does not support power ON/OFF or reset through the BMC interface on |prod|. As a result, it is not possible for the system to properly fence a node in the event of a management network isolation event. In order to mitigate this, hosted application auto recovery needs to be disabled. | + | | | + | | - ZTSystems Triton | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Supported Reference Platforms | - Intel Iron Pass | + | | | + | | - Intel Canoe Pass | + | | | + | | - Intel Grizzly Pass | + | | | + | | - Intel Wildcat Pass | + | | | + | | - Intel Wolf Pass | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Disk Controllers | - Dell | + | | | + | | | + | | - PERC H310 Mini | + | | | + | | - PERC H730 Mini | + | | | + | | - PERC H740P | + | | | + | | - PERC H330 | + | | | + | | - PERC HBA330 | + | | | + | | | + | | | + | | - HPE Smart Array | + | | | + | | | + | | - P440ar | + | | | + | | - P420i | + | | | + | | - P408i-a | + | | | + | | - P816i-a | + | | | + | | | + | | - LSI 2308 | + | | | + | | - LSI 3008 | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | NICs Verified for PXE Boot, Management, and OAM Networks | - Intel I210 \(Springville\) 1G | + | | | + | | - Intel I350 \(Powerville\) 1G | + | | | + | | - Intel 82599 \(Niantic\) 10G | + | | | + | | - Intel X540 10G | + | | | + | | - Intel X710/XL710 \(Fortville\) 10G | + | | | + | | - Intel X722 \(Fortville\) 10G | + | | | + | | - Intel E810 25G Columbiaville \(Salem Channel\) NIC \(for management and OAM networks only\) | + | | | + | | - Emulex XE102 10G | + | | | + | | - Broadcom BCM5719 1G | + | | | + | | - Broadcom BCM57810 10G | + | | | + | | - Mellanox MT27710 Family \(ConnectX-4 Lx\) 10G/25G | + | | | + | | - Mellanox MT27700 Family \(ConnectX-4\) 40G | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | NICs Verified for Data Interfaces [#]_ | The following NICs are supported: | + | | | + | | - Intel I350 \(Powerville\) 1G | + | | | + | | - Intel 82599 \(Niantic\) 10G | + | | | + | | - Intel X710/XL710 \(Fortville\) 10 G | + | | | + | | - Intel X552 \(Xeon-D\) 10G | + | | | + | | - Mellanox Technologies | + | | | + | | | + | | - MT27710 Family \(ConnectX-4\) 10G/25G | + | | | + | | - MT27700 Family \(ConnectX-4\) 40G | + | | | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PCI-Passthrough or PCI SR-IOV NICs | - Intel E810 25G Columbiaville \(Salem Channel\) NIC \(SR-IOV only\) | + | | | + | | - Intel 82599 \(Niantic\) 10 G | + | | | + | | - Intel X710/XL710 \(Fortville\) 10G | + | | | + | | - Mellanox Technologies | + | | | + | | | + | | - MT27710 Family \(ConnectX-4\) 10G/25G | + | | | + | | - MT27700 Family \(ConnectX-4\) 40G | + | | | + | | | + | | .. note:: | + | | For a Mellanox using PCI passthrough or a CX4 using PCI passthrough or SR-IOV, SR-IOV must be enabled in the CX4 firmware. For more information, see, `HowTo Configure SR-IOV for ConnectX-4/ConnectX-5/ConnectX-6 with KVM (Ethernet) `__. | + | | | + | | | + | | .. note:: | + | | The maximum number of VFs per hosted application instance, across all PCI devices, is 32. | + | | | + | | For example, a hardware encryption hosted application can be launched with virtio interfaces and 32 QAT VFs. However, a hardware encryption hosted application with an SR-IOV network interface \(with 1 VF\) can only be launched with 31 VFs. | + | | | + | | .. note:: | + | | Dual-use configuration \(PCI passthrough or PCI SR-IOV on the same interface\) is supported for Fortville NICs only. | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PCI SR-IOV Hardware Accelerators | - Intel AV-ICE02 VPN Acceleration Card, based on the Intel Coleto Creek 8925/8950, and C62x device with QuickAssist ®. | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Hardware Accelerator Devices Verified for PCI-Passthrough or PCI SR-IOV Access | - ACC100 Adapter \(Mount Bryce\) - SRIOV only | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | GPUs Verified for PCI Passthrough | - NVIDIA Corporation: VGA compatible controller - GM204GL \(Tesla M60 rev a1\) | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Board Management Controllers | - HPE iLO3 | + | | | + | | - HPE iLO4 | + | | | + | | - Quanta | + +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. include:: ../../_includes/verified-commercial-hardware.rest +.. include:: ../../_includes/release-notes-overview-footnote.rest \ No newline at end of file