created helm docs/readme

sriov/README.md

@@ -0,0 +1,43 @@
+# sriov
+
+![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.7.0](https://img.shields.io/badge/AppVersion-3.7.0-informational?style=flat-square)
+
+SR-IOV CNI Helm chart for Kubernetes
+
+**Homepage:** <https://github.com/intel/sriov-network-device-plugin>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Network Plumbing Group |  |  |
+
+## Source Code
+
+* <https://github.com/intel/sriov-network-device-plugin>
+* <https://github.com/intel/sriov-cni>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| args | list | `["--log-dir=sriovdp","--log-level=10"]` | Arguments for the sriov-device-plugin |
+| config.scMountPaths.cnibin | string | `"/host/opt/cni/bin"` |  |
+| config.sdpMountPaths.configVolume | string | `"/etc/pcidp/config.json"` |  |
+| config.sdpMountPaths.deviceSock | string | `"/var/lib/kubelet/device-plugins/"` |  |
+| config.sdpMountPaths.log | string | `"/var/log"` |  |
+| config.sriov_device_plugin | string | `"{\n  \"resourceList\": [\n    {\n      \"resourceName\": \"intel_sriov_netdevice\",\n      \"selectors\": {\n        \"vendors\": [\n          \"8086\"\n        ],\n        \"devices\": [\n          154c,\n          10ed\n        ],\n        \"drivers\": [\n          \"i40evf\",\n          \"ixgbevf\"\n        ]\n      }\n    },\n    {\n      \"resourceName\": \"intel_sriov_dpdk\",\n      \"selectors\": {\n        \"vendors\": [\n          \"8086\"\n        ],\n        \"devices\": [\n          154c,\n          10ed\n        ],\n        \"drivers\": [\n          \"vfio-pci\"\n        ]\n      },\n      \"pfNames\": [\n        \"enp67s0f1#8-31\",\n        \"enp68s0f0#8-31\"\n      ]\n    },\n    {\n      \"resourceName\": \"mlnx_sriov_rdma\",\n      \"isRdma\": true,\n      \"selectors\": {\n        \"vendors\": [\n          15b3\n        ],\n        \"devices\": [\n          \"1018\"\n        ],\n        \"drivers\": [\n          \"mlx5_ib\"\n        ]\n      }\n    }\n  ]\n}\n"` | Device plugin configuration |
+| images.pullPolicy | string | `"IfNotPresent"` |  |
+| images.sriovCni.repository | string | `"ghcr.io/k8snetworkplumbingwg/sriov-network-device-plugin"` |  |
+| images.sriovCni.tag | string | `"latest"` |  |
+| images.sriovDevicePlugin.repository | string | `"nfvpe/sriov-device-plugin"` |  |
+| images.sriovDevicePlugin.tag | string | `"v3.1"` |  |
+| nodeSelector."kubernetes.io/arch" | string | `"amd64"` |  |
+| resources | object | `{"limits":{"cpu":"100m","memory":"50Mi"},"requests":{"cpu":"100m","memory":"50Mi"}}` | plugin pod resources |
+| securityContext.privileged | bool | `true` |  |
+| serviceAccount.name | string | `"sriov-device-plugin-test"` |  |
+| tolerations | list | `[{"effect":"NoSchedule","operator":"Exists"},{"effect":"NoExecute","operator":"Exists"}]` | Tolerations for pod assignment. |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

sriov/values.yaml

@@ -13,26 +13,27 @@
 # limitations under the License.
 
 images:
-  registry: docker.io
   sriovCni:
+    # sr-iov cni image
     repository: ghcr.io/k8snetworkplumbingwg/sriov-network-device-plugin
     tag: latest
   sriovDevicePlugin:
+    # sr-iov device plugin image
     repository: nfvpe/sriov-device-plugin
     tag: v3.1
   pullPolicy: IfNotPresent
 
 serviceAccount:
   name: sriov-device-plugin-test
 
-
+# -- plugin pod resources
 resources:
-    requests:
-      memory: "50Mi"
-      cpu: "100m"
-    limits:
-      memory: "50Mi"
-      cpu: "100m"
+  requests:
+    memory: "50Mi"
+    cpu: "100m"
+  limits:
+    memory: "50Mi"
+    cpu: "100m"
 
 securityContext:
   privileged: true
@@ -52,6 +53,7 @@ config:
     deviceSock: "/var/lib/kubelet/device-plugins/"
     log: "/var/log"
     configVolume: "/etc/pcidp/config.json"
+  # -- Device plugin configuration
   sriov_device_plugin: |
     {
       "resourceList": [
@@ -108,13 +110,11 @@ config:
       ]
     }
 
-
 # -- Tolerations for pod assignment.
 tolerations:
   - operator: Exists
     effect: NoSchedule
   - operator: Exists
     effect: NoExecute
 
-
 affinity: {}