Merge pull request #64 from almaslennikov/meta-plugins-fix

Add a note on PKEY management with RDMA isolation
Mellanox · Jul 9, 2024 · 5eda361 · 5eda361
2 parents b0c3fc8 + 9e8f0c9
commit 5eda361
Showing 1 changed file with 36 additions and 1 deletion.
diff --git a/docs/getting-started-kubernetes.rst b/docs/getting-started-kubernetes.rst
@@ -1237,7 +1237,42 @@ Wait for NVIDIA DOCA Driver to install and apply the following CRs:
           "range": "10.56.217.0/24",
           "log_file" : "/var/log/whereabouts.log",
           "log_level" : "info"
-        }
+      }
+    }'
+
+.. note::
+    To use the IB network with Pkey management feature with RDMA isolation, use the following ``sriov-ib-network.yaml``:
+
+.. code-block:: yaml
+
+    apiVersion: "k8s.cni.cncf.io/v1"
+    kind: NetworkAttachmentDefinition
+    metadata:
+      name: ib-sriov-network
+      annotations:
+        k8s.v1.cni.cncf.io/resourceName: nvidia.com/mlnxnics
+    spec:
+      config: '{
+      "type": "ib-sriov",
+      "cniVersion": "0.3.1",
+      "name": "ib-sriov-network",
+      "metaPluginsConfigured": true,
+      "metaPlugins": {
+          "type": "rdma"
+      },
+      "pkey": "0x6",
+      "link_state": "enable",
+      "ibKubernetesEnabled": true,
+      "ipam": {
+          "type": "whereabouts",
+          "datastore": "kubernetes",
+          "kubernetes": {
+            "kubeconfig": "/etc/cni/net.d/whereabouts.d/whereabouts.kubeconfig"
+          },
+          "range": "10.56.217.0/24",
+          "log_file" : "/var/log/whereabouts.log",
+          "log_level" : "info"
+      }
     }'
 
 ``sriov-ib-network-pod.yaml``