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

Adding rdma support documentation for intel vf's #482

Merged
merged 2 commits into from
May 22, 2023
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
5 changes: 4 additions & 1 deletion docs/rdma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@ RDMA supports zero-copy networking by enabling the network adapter to transfer d
## Supported NICs:
* Mellanox ConnectX®-4 Lx Adapter
* Mellanox ConnectX®-5 Adapter
* Intel E810-C Adapter

## RDMA Capable Hardware:
* Mellanox ConnectX®-4 Lx Adapter
* Mellanox ConnectX®-5 Adapter
* Intel E810-C Adapter

## RDMA modules:
* Mellanox ConnectX®-4 Lx, ConnectX®-5 Adapters mlx5_core or mlx5_ib
* Intel E810-C Adapter ice and iavf

## Privileges
IPC_LOCK capability privilege is required for RMA application to function properly in Kubernetes Pod.
Copy link
Contributor

@adrianchiris adrianchiris May 17, 2023

Choose a reason for hiding this comment

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

under Rdma Mounts sectrion, can you add a note:

Note: rdma character devices mounted under /dev/infiniband may vary depending on the vendor and loaded kernel modules.

and while at it, if you can also remove the line:

The digit after the file name is the index of the VF

it would be great, as these numbers are just a "char device index" which gets incremented as new devices added, its not correlated to VF inde

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

thanks for the feedback @adrianchiris , I've addressed this now.

Expand All @@ -22,4 +25,4 @@ Using Rdma requires mounting special files from `/dev/infiniband` in the contain
# ls /dev/infiniband
issm2 rdma_cm ucm2 umad1 uverbs2
```
The digit after the file name is the index of the VF
__Note__: rdma character devices mounted under `/dev/infiniband` may vary depending on the vendor and loaded kernel modules.
9 changes: 9 additions & 0 deletions docs/rdma/configMap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ data:
"drivers": ["mlx5_core"],
"isRdma": true
}
},
{
"resourceName": "intel_rdma",
"selectors": {
"vendors": ["8086"],
"devices": ["1889"],
"drivers": ["iavf"],
"isRdma": true
}
}
]
}
11 changes: 11 additions & 0 deletions docs/rdma/crd-rdma-intel.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: "k8s.cni.cncf.io/v1"
kind: NetworkAttachmentDefinition
metadata:
name: sriov-rdma-intel
annotations:
k8s.v1.cni.cncf.io/resourceName: intel.com/intel_rdma
spec:
config: '{
"type": "sriov",
"name": "sriov-rdma"
}'
21 changes: 21 additions & 0 deletions docs/rdma/pod_intel_rdma_test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
apiVersion: v1
kind: Pod
metadata:
name: rdma-app
annotations:
k8s.v1.cni.cncf.io/networks: sriov-rdma-intel
spec:
containers:
- name: test-rdma
image: <RDMA image>
imagePullPolicy: Never
securityContext:
capabilities:
add: ["IPC_LOCK"]
resources:
requests:
intel.com/intel_rdma: 1
limits:
intel.com/intel_rdma: 1
command: ["sleep", "infinity"]

File renamed without changes.