From c192d4cb13c0225ef8f2b0fc3583e70d1e985932 Mon Sep 17 00:00:00 2001
From: killianmuldoon <cilliancapi@gmail.com>
Date: Tue, 12 Mar 2024 17:25:53 +0200
Subject: [PATCH] docs: Add platform support page

Signed-off-by: killianmuldoon <cilliancapi@gmail.com>
---
 .gitignore                |   3 +
 docs/common/vars.rst      |   1 +
 docs/platform-support.rst | 114 +++++++++++++++++++++++++++++++++++++-
 3 files changed, 116 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 4a3fa72..89cb592 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,9 @@
 # Visual Studio Code config
 .vscode/
 
+# Jetbrains IDE config
+.idea
+
 # automatically generated folders
 _*/
 
diff --git a/docs/common/vars.rst b/docs/common/vars.rst
index 51fde17..71806f2 100644
--- a/docs/common/vars.rst
+++ b/docs/common/vars.rst
@@ -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
diff --git a/docs/platform-support.rst b/docs/platform-support.rst
index 8ba744e..a69d4ed 100644
--- a/docs/platform-support.rst
+++ b/docs/platform-support.rst
@@ -15,8 +15,118 @@
   limitations under the License.
 
 .. headings # #, * *, =, -, ^, "
-
+.. include:: ./common/vars.rst
 
 ****************
 Platform Support
-****************
\ No newline at end of file
+****************
+
+.. 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
+
+*****************************
+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
+     - 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|
+     - -
\ No newline at end of file