Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add platform support page #25

Merged
merged 1 commit into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
# Visual Studio Code config
.vscode/

# Jetbrains IDE config
.idea

# automatically generated folders
_*/

Expand Down
1 change: 1 addition & 0 deletions docs/common/vars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@
.. |sriovnetop-sriov-cni-image-tag| replace:: v2.7.0
.. |sriovnetop-ib-sriov-cni-image-tag| replace:: v1.0.3
.. |sriovnetop-sriov-device-plugin-image-tag| replace:: v3.6.2
.. |node-feature-discovery-version| replace:: v0.13.2
114 changes: 112 additions & 2 deletions docs/platform-support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,118 @@
limitations under the License.

.. headings # #, * *, =, -, ^, "

.. include:: ./common/vars.rst

****************
Platform Support
****************
****************

killianmuldoon marked this conversation as resolved.
Show resolved Hide resolved
.. contents:: On this page
:depth: 4
:local:
:backlinks: none

*******************
System Requirements
*******************

* NVIDIA RDMA-capable network adapters:
* NVIDIA ConnectX NICs
* ConnectX-5 or newer
* NVIDIA BlueField Network Platforms
* BlueField-2 DPU (NIC mode)
* BlueField-3 DPU (NIC mode)
* BlueField-3 SuperNIC (NIC mode)
* NVIDIA GPU Operator Version 23.9.x or newer (required for the workloads using NVIDIA GPUs and GPUDirect RDMA technology)
* Operating Systems:
* Ubuntu: v22.04, v20.04
* OpenShift Container Platform (OCP): v 4.14, v4.13, v4.12
* RHEL: v9.2, v9.1, v8.8, v8.6
* Container runtime: containerd, CRI-O

***********************
Tested Network Adapters
***********************
The following network adapters have been tested with the Network Operator:

* ConnectX-6 Dx
* ConnectX-7
* BlueField-2 NIC Mode
* BlueField-3 NIC Mode

killianmuldoon marked this conversation as resolved.
Show resolved Hide resolved
*****************************
Supported ARM Based Platforms
*****************************
The following ARM based systems has been tested with Network Operator:

.. list-table::
:header-rows: 1

* - System
- Network Adapters
- OS
- Notes
* - NVIDIA IGX Orin
- ConnectX-7
- Ubuntu 22.04 (ARM64)
- Tech Preview (RoCE only, without GPUDirect RDMA)

*************
Prerequisites
*************

.. list-table::
:header-rows: 1

* - Component
killianmuldoon marked this conversation as resolved.
Show resolved Hide resolved
- Version
- Notes
* - Kubernetes
- >=1.24 and <=1.27
- -
* - Helm
- v3.5+
- For information and methods of Helm installation, please refer to the official Helm Website.

******************
Component Versions
******************
The following component versions are deployed by the Network Operator:


.. list-table::
:header-rows: 1

* - Component
- Version
- Notes
* - Node Feature Discovery
- |node-feature-discovery-version|
- Optionally deployed. May already be present in the cluster with proper configuration.
* - NVIDIA MLNX_OFED driver container
- |mofed-version|
- -
* - k8s-rdma-shared-device-plugin
- |k8s-rdma-shared-dev-plugin-version|
- -
* - sriov-network-device-plugin
- |sriov-device-plugin-version|
- -
* - containernetworking CNI plugins
- |cni-plugins-version|
- -
* - whereabouts CNI
- |whereabouts-version|
- -
* - multus CNI
- |multus-version|
- -
* - IPoIB CNI
- |ipoib-cni-version|
- -
* - IB Kubernetes
- |ib-kubernetes-version|
- -
* - NV IPAM Plugin
- |nvidia-ipam-version|
- -
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These is a long list of open source components in the original.
Do we need it? I think that Nadav worked on this list some time ago.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure which list you're referring to - could you link it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me take this as a follow-up. Seems impossible for us to keep this up to date.