Skip to content

Commit d92b528

Browse files
mythiDmitry Rozhkov
authored andcommitted
qat: document kerneldrv mode and build instructions
-mode kerneldrv comes with no documentation. This patch adds few notes about it and instructions how to get it build if a user chooses to have it enabled. Closes: #197 Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
1 parent cda77f5 commit d92b528

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

cmd/qat_plugin/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,16 @@ Use the `kernel-vf-drivers flag` to specify the vf Device Driver for the particu
6161

6262
`-dpdk-driver` is set to `vfio-pci` by default since it is more robust and secure driver compared with `igb_uio`. See [DPDK Linux Driver Guide](http://dpdk.org/doc/guides/linux_gsg/linux_drivers.html) for more information.
6363

64+
`-mode` parameter can be set to `kerneldrv` to override the default mode (`dpdkdrv`). With `-mode kerneldrv`, no other parameter documented above are valid, except `-debug` which is global for both modes. `kerneldrv` mode implements resource allocation based on system configured [logical instances](https://01.org/sites/default/files/downloads//336210-009qatswprogrammersguide.pdfhttps://01.org/sites/default/files/downloads//336210-009qatswprogrammersguide.pdf). The mode does not guarantee full device isolation between containers and therefore it's not recommended. Moreover, the mode will be deprecated and removed once `libqat` implements non-UIO based device access.
65+
6466
### Build QAT device plugin Docker image:
6567
```
6668
$ cd $GOPATH/src/github.com/intel/intel-device-plugins-for-kubernetes
6769
$ make intel-qat-plugin
6870
```
6971

72+
**Note**: `kerneldrv` mode is excluded from the build by default. Add `BUILDTAGS=kerneldrv` to `make` to get `kerneldrv` functionality added to the build.
73+
7074
### Deploy QAT device plugin as a DaemonSet:
7175
```
7276
$ cd $GOPATH/src/github.com/intel/intel-device-plugins-for-kubernetes

0 commit comments

Comments
 (0)