Skip to content

Commit

Permalink
Add doc for allocatePolicy resourceConfig
Browse files Browse the repository at this point in the history
  • Loading branch information
zshi-redhat committed Apr 1, 2021
1 parent be4e322 commit e6376b3
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ The SR-IOV network device plugin is Kubernetes device plugin for discovering and
- Supports devices with both Kernel and userspace (UIO and VFIO) drivers
- Allows resource grouping using "Selector"
- User configurable resourceName
- User configurable policy for preferred device allocation
- Detects Kubelet restarts and auto-re-register
- Detects Link status (for Linux network devices) and updates associated VFs health accordingly
- Extensible to support new device types with minimal effort if not already supported
Expand Down Expand Up @@ -181,6 +182,7 @@ This plugin creates device plugin endpoints based on the configurations given in
{
"resourceName": "intel_sriov_dpdk",
"resourcePrefix": "intel.com",
"allocatePolicy": "packed",
"selectors": {
"vendors": ["8086"],
"devices": ["154c", "10ed"],
Expand All @@ -192,6 +194,7 @@ This plugin creates device plugin endpoints based on the configurations given in
{
"resourceName": "mlnx_sriov_rdma",
"resourcePrefix": "mellanox.com",
"allocatePolicy": "packed",
"selectors": {
"vendors": ["15b3"],
"devices": ["1018"],
Expand Down Expand Up @@ -228,6 +231,7 @@ This plugin creates device plugin endpoints based on the configurations given in
| "resourcePrefix" | N | Endpoint resource prefix name override. Should not contain special characters | string Default : "intel.com" | "yourcompany.com" |
| "deviceType" | N | Device Type for a resource pool. | string value of supported types. Default: "netDevice" | Currently supported values: "accelerator", "netDevice" |
| "selectors" | N | A map of device selectors. The "deviceType" value determines the "selectors" options. | json object as string Default: null | Example: "selectors": {"vendors": ["8086"],"devices": ["154c"]} |
| "allocatePolicy" | N | Preferred device allocation policy for a resource pool. The "allocatePolicy" value determines which device in a resource pool is allocated first | string value of supported allocate policy. Default: "" | Example: "allocatePolicy": "packed" |



Expand Down Expand Up @@ -270,7 +274,7 @@ This selector is applicable when "deviceType" is "accelerator". The "accelerator
This plugin accepts the following optional run-time command line arguments:

```bash
./sriovdp --help
./sriovdp -h

Usage of ./sriovdp:
-alsologtostderr
Expand Down

0 comments on commit e6376b3

Please sign in to comment.