Skip to content

Commit e28a297

Browse files
committed
fixup! config-linux: Refined JSON definitions for RDMA limits
Signed-off-by: W. Trevor King <[email protected]>
1 parent 60c82b2 commit e28a297

File tree

2 files changed

+20
-28
lines changed

2 files changed

+20
-28
lines changed

config-linux.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -460,37 +460,29 @@ The following parameters can be specified to set up the controller:
460460
**`rdma`** (object, OPTIONAL) represents the cgroup subsystem `rdma`.
461461
For more information, see the kernel cgroups documentation about [rdma][cgroup-v1-rdma].
462462

463-
The following parameters can be specified to set up the controller:
463+
The name of the device to limit is the entry key.
464+
Entry values are objects with the following properties:
465+
466+
* **`hca_handles`** *(uint32, OPTIONAL)* - specifies the maximum number of hca_objects in the cgroup
467+
* **`hca_objects`** *(uint32, OPTIONAL)* - specifies the maximum number of hca_handles in the cgroup
464468

465-
* **`rdmaLimits`** *(list of objects, OPTIONAL)* - specifies a list of limit objects applicable to processes in the group.
466-
Limit object is a key value pair that defines limits of a device.
467-
* **`hca_device`** *(string, REQUIRED)* - specifies the device name whose resources limit to be configured
468-
The following parameters can be specified per-device:
469-
* **`hca_handles`** *(uint32, OPTIONAL)* - specifies the maximum number of hca_objects in the cgroup
470-
* **`hca_objects`** *(uint32, OPTIONAL)* - specifies the maximum number of hca_handles in the cgroup
471-
You MUST specify at least one of the `hca_handles` or `hca_objects` in a given entry, and MAY specify both.
469+
You MUST specify at least one of the `hca_handles` or `hca_objects` in a given entry, and MAY specify both.
472470

473471
#### Example
474472

475473
```json
476-
"rdma": [
477-
{
478-
"mlx5_1": {
479-
"hca_handles": 3,
480-
"hca_objects": 10000
481-
}
482-
},
483-
{
484-
"mlx4_0": {
485-
"hca_objects": 1000
486-
}
487-
},
488-
{
489-
"rxe3": {
490-
"hca_objects": 10000
491-
}
492-
}
493-
]
474+
"rdma": {
475+
"mlx5_1": {
476+
"hca_handles": 3,
477+
"hca_objects": 10000
478+
},
479+
"mlx4_0": {
480+
"hca_objects": 1000
481+
},
482+
"rxe3": {
483+
"hca_objects": 10000
484+
}
485+
}
494486
```
495487

496488
## <a name="configLinuxIntelRdt" />IntelRdt

specs-go/config.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,10 +344,10 @@ type LinuxResources struct {
344344
HugepageLimits []LinuxHugepageLimit `json:"hugepageLimits,omitempty"`
345345
// Network restriction configuration
346346
Network *LinuxNetwork `json:"network,omitempty"`
347-
// Rdma resource restriction configuration
347+
// Rdma resource restriction configuration.
348348
// Limits are a set of key value pairs that define RDMA resource limits,
349349
// where the key is device name and value is resource limits.
350-
RdmaLimits map[string]LinuxRdmaLimit `json:"rdmaLimits,omitempty"`
350+
Rdma map[string]LinuxRdmaLimit `json:"rdma,omitempty"`
351351
}
352352

353353
// LinuxDevice represents the mknod information for a Linux special device file

0 commit comments

Comments
 (0)