cleanup: Simple NAD example and standarise on bond0 interface

Author: pcolledg-amd

README.md

@@ -82,7 +82,7 @@ To accelerate a pod:
 
 * Configure the [Onload Operator](#onload-operator)
 * Configure an [Onload Custom Resource (CR)](#onload-custom-resource-cr)
-* Configure a pod network with AMD Solarflare interfaces, ie. Multus IPVLAN or MACVAN
+* Configure a pod network with AMD Solarflare interfaces, ie. Multus [IPVLAN or MACVAN](docs/nad.md)
 * Configure the [out-of-tree `sfc` module](#out-of-tree-sfc-kernel-module)
 * [Configure your pods](#run-onloaded-applications) to use the resource provided by
   the [Onload Device Plugin](#onload-device-plugin) and the network
@@ -246,14 +246,14 @@ An easy test to verify everything is correctly configured is the
 
 ### Run Onloaded applications
 
-To accelerate your workload, configure a pod with a AMD Solarflare network interface and
+To accelerate your workload, configure a pod with a AMD Solarflare [network interface](docs/nad.md) and
 [`amd.com/onload` resource](#resource-amdcomonload):
 
 ```yaml
 kind: Pod
 metadata:
   annotations:
-    k8s.v1.cni.cncf.io/networks: ipvlan-sf0
+    k8s.v1.cni.cncf.io/networks: ipvlan-bond0
 spec:
   ...
   containers:

config/samples/sfnettest/README.md

@@ -17,7 +17,7 @@ Obtain the SFC interface's IP address of the `onload-sfnettest-server` pod:
 ```sh
 $ kubectl describe pod onload-sfnettest-server | grep AddedInterface
   Normal  AddedInterface  24s   multus   Add eth0 [192.168.8.114/23] from openshift-sdn
-  Normal  AddedInterface  24s   multus   Add net1 [198.19.0.1/16] from default/ipvlan-sf0
+  Normal  AddedInterface  24s   multus   Add net1 [198.19.0.1/16] from default/ipvlan-bond0
 ```
 
 The server pod is already running the accelerated `sfnt-pingpong` instance.

config/samples/sfnettest/client-server.yaml

@@ -6,7 +6,7 @@ metadata:
   name: onload-sfnettest-server
   namespace: default
   annotations:
-    k8s.v1.cni.cncf.io/networks: ipvlan-sf0
+    k8s.v1.cni.cncf.io/networks: ipvlan-bond0
 spec:
   restartPolicy: Always
   securityContext:
@@ -34,7 +34,7 @@ metadata:
   name: onload-sfnettest-client
   namespace: default
   annotations:
-    k8s.v1.cni.cncf.io/networks: ipvlan-sf0
+    k8s.v1.cni.cncf.io/networks: ipvlan-bond0
 spec:
   restartPolicy: Never
   securityContext:

docs/nad.md

@@ -0,0 +1,60 @@
+# Network Attachment Definitions (NADs)
+
+KubernetesOnload's recommended CNI is Multus, which is configured through a `NetworkAttachmentDefinition` *kind* of CR.
+
+## Simple examples
+
+The following examples presume an interface name of `bond0` and address allocation of `whereabouts` but
+neither bonding nor a specific address allocation method are required.
+
+Ensure the NAD's `metadata.namespace` matches that of workload pods if Multus namespace isolation is configured.
+
+### IPVLAN
+
+```yaml
+apiVersion: k8s.cni.cncf.io/v1
+kind: NetworkAttachmentDefinition
+metadata:
+  name: ipvlan-bond0
+spec:
+  config: |
+    {
+      "cniVersion": "0.3.1",
+      "type": "ipvlan",
+      "name": "ipvlan-bond0",
+      "master": "bond0",
+      "ipam": {
+        "type": "whereabouts",
+        "range": "198.19.0.0/16"
+      }
+    }
+```
+
+### MACVLAN
+
+```yaml
+apiVersion: k8s.cni.cncf.io/v1
+kind: NetworkAttachmentDefinition
+metadata:
+  name: macvlan-bond0
+spec:
+  config: |
+    {
+      "cniVersion": "0.3.1",
+      "type": "macvlan",
+      "name": "macvlan-bond0",
+      "master": "bond0",
+      "mode": "bridge",
+      "ipam": {
+          "type": "whereabouts",
+          "range": "198.18.0.0/16"
+      }
+    }
+```
+
+## Footnotes
+
+```yaml
+SPDX-License-Identifier: MIT
+SPDX-FileCopyrightText: (c) Copyright 2023 Advanced Micro Devices, Inc.
+```