update documentation with new field

Signed-off-by: Sebastian Sch <[email protected]>
k8snetworkplumbingwg · Jan 9, 2023 · 3fe60a8 · 3fe60a8
1 parent 6231d9d
commit 3fe60a8
Showing 1 changed file with 20 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -201,23 +201,35 @@ This plugin creates device plugin endpoints based on the configurations given in
                     "vendors": ["8086"],
                     "devices": ["0d90"]
             }
+        },
+      {
+        "resourceName": "intel_sriov_netdevice_additional_env",
+        "selectors": {
+          "vendors": ["8086"],
+          "devices": ["154c", "10ed", "1889"],
+          "drivers": ["i40evf", "ixgbevf", "iavf"]
+        },
+        "additionalEnvVariables": {
+           "*": {
+             "token": "3e49019f-412f-4f02-824e-4cd195944205"
+           }
         }
-
+      }
     ]
 }
 ```
 
 `"resourceList"` should contain a list of config objects. Each config object may consist of following fields:
 
 
-|      Field       | Required |                                                    Description                                                    |                     Type/Defaults                     |                     Example/Accepted values                     |
-|------------------|----------|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|-----------------------------------------------------------------|
+|      Field       | Required | Description                                                                                                                            |                     Type/Defaults                     |                     Example/Accepted values                     |
+|------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|-----------------------------------------------------------------|
 | "resourceName"   | Y        | Endpoint resource name. Should not contain special characters including hyphens and must be unique in the scope of the resource prefix | string                                                | "sriov_net_A"                                                   |
-| "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"          |
-| "excludeTopology" | N       | Exclude advertising of device's NUMA topology          | bool Default: "false"    | "excludeTopology": true          |
-| "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"]} |
-
+| "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"          |
+| "excludeTopology" | N       | Exclude advertising of device's NUMA topology                                                                                          | bool Default: "false"    | "excludeTopology": true          |
+| "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"]} |
+| "additionalEnvVariables" | N | A map of map to add additional environment variables to devices                                                                        | json object as string Default: null  | Example: "additionalEnvVariables": {"*": {"token": "3e49019f-412f-4f02-824e-4cd195944205"}} |
 
 
 Note: "resourceName" must be unique only in the scope of a given prefix, including the one specified globally in the CLI params, e.g. "example.com/10G", "acme.com/10G" and "acme.com/40G" are perfectly valid names.