Skip to content

Commit c50a867

Browse files
committed
config-linux: Add documentation for Linux RDMA cgroup
Add documentation, example and link to kernel documentation for Linux RDMA cgroup. Signed-off-by: Parav Pandit <[email protected]>
1 parent fa6bff4 commit c50a867

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

config-linux.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ In addition to any devices configured with this setting, the runtime MUST also s
169169
## <a name="configLinuxControlGroups" />Control groups
170170

171171
Also known as cgroups, they are used to restrict resource usage for a container and handle device access.
172-
cgroups provide controls (through controllers) to restrict cpu, memory, IO, pids and network for the container.
172+
cgroups provide controls (through controllers) to restrict cpu, memory, IO, pids, network and rdma resources for the container.
173173
For more information, see the [kernel cgroups documentation][cgroup-v1].
174174

175175
### <a name="configLinuxCgroupsPath" />Cgroups Path
@@ -455,6 +455,34 @@ The following parameters can be specified to set up the controller:
455455
}
456456
```
457457

458+
### <a name="configLinuxRDMA" />RDMA
459+
460+
**`rdma`** (object, OPTIONAL) represents the cgroup subsystem `rdma`.
461+
For more information, see the kernel cgroups documentation about [rdma][cgroup-v1-rdma].
462+
463+
The following parameters can be specified to set up the controller:
464+
465+
* **`hca_device`** *(string, REQUIRED)* - specifies the device name whose resources limit to be configured
466+
* **`hca_handles`** *(uint32, REQUIRED)* - specifies the maximum number of hca_objects in the cgroup for a specified device
467+
* **`hca_objects`** *(uint32, REQUIRED)* - specifies the maximum number of hca_handles in the cgroup for a specified device
468+
469+
#### Example
470+
471+
```json
472+
"rdma": [
473+
{
474+
"hca_device": "mlx5_1",
475+
"hca_handles": 1,
476+
"hca_objects": 10000,
477+
},
478+
{
479+
"hca_device": "rxe4",
480+
"hca_handles": 100,
481+
"hca_objects": 50000,
482+
}
483+
]
484+
```
485+
458486
## <a name="configLinuxIntelRdt" />IntelRdt
459487

460488
**`intelRdt`** (object, OPTIONAL) represents the [Intel Resource Director Technology][intel-rdt-cat-kernel-interface].
@@ -647,6 +675,7 @@ The following parameters can be specified to set up seccomp:
647675
[cgroup-v1-net-cls]: https://www.kernel.org/doc/Documentation/cgroup-v1/net_cls.txt
648676
[cgroup-v1-net-prio]: https://www.kernel.org/doc/Documentation/cgroup-v1/net_prio.txt
649677
[cgroup-v1-pids]: https://www.kernel.org/doc/Documentation/cgroup-v1/pids.txt
678+
[cgroup-v1-rdma]: https://www.kernel.org/doc/Documentation/cgroup-v1/rdma.txt
650679
[cgroup-v2]: https://www.kernel.org/doc/Documentation/cgroup-v2.txt
651680
[devices]: https://www.kernel.org/doc/Documentation/admin-guide/devices.txt
652681
[devpts]: https://www.kernel.org/doc/Documentation/filesystems/devpts.txt

0 commit comments

Comments
 (0)