Skip to content

Commit 0df51a7

Browse files
committed
device_plugins: Update deploy_qat readme
Signed-off-by: chaitanya1731 <chaitanya.kulkarni@intel.com>
1 parent 64a6c86 commit 0df51a7

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

device_plugins/deploy_qat.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,44 @@ Output:
2626
```
2727
NAME DESIRED READY NODE SELECTOR AGE
2828
qatdeviceplugin-sample 1 1 {"intel.feature.node.kubernetes.io/qat":"true"} 3h27m
29-
```
29+
```
30+
31+
# Verify QAT Device Plugin
32+
After the plugin is deployed, use below command to verify QAT resources:
33+
```
34+
$ oc describe node <node name> | grep qat.intel.com
35+
qat.intel.com/cy: 32
36+
qat.intel.com/cy: 32
37+
qat.intel.com/dc: 32
38+
qat.intel.com/dc: 32
39+
```
40+
41+
# QAT Device Plugin Configuration
42+
> **Note**: The QAT device plugin can be configured with the flags. In this release, only the configurations in the table below are verified and supported on RHOCP.
43+
44+
For more details about the QAT device plugin configuration flags, see [Modes and Configurations Options](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/cmd/qat_plugin/README.md#modes-and-configuration-options).
45+
46+
| Flag | Configuration | Description |
47+
| ---- | ---- | ---- |
48+
| `-dpdk-driver` | vfio-pci | Using vfio-pci driver to manage QAT VFIO device. See details [here](https://doc.dpdk.org/guides/linux_gsg/linux_drivers.html) |
49+
| `-kernel-vf-drivers` | 4xxxvf | Supporting 4xxx QAT device </br> **Note**: Verified on 4th Gen Intel® Xeon® Scalable processors. See details [here](https://github.com/intel/qatlib/blob/main/INSTALL#L72) |
50+
| `-max-num-devices ` | 128 | 128 QAT VFIO Virtual Function (VF) devices provided to QAT device plugin to manage. It is the maximum VF device it can support for 4xxx QAT device. |
51+
| `-provisioning-config ` | qat-config or empty | See section [QAT resource configuration](/device_plugins/deploy_qat.md#qat-resource-configuration) |
52+
53+
## QAT Resource Configuration
54+
In this release, if the user does not configure the QAT resources through the device plugin `-provisioning-config` flag. The device plugin will configure half of the QAT VFIO VF devices for compression/decompression and the other half for cryptography.
55+
56+
Users can use the steps below to customize the QAT resource configuration:
57+
1. Create the configmap for qat resource configuration
58+
```
59+
$ oc create configmap --namespace=openshift-operators --from-literal "qat.conf=ServicesEnabled=<option>" qat-config
60+
```
61+
Options:
62+
`dc`: Configure all the QAT VF devices managed by the device plugin CR for compression/decompression.
63+
`sym` or `asym`: Configure all the QAT VF devices managed by the device plugin CR for cryptography
64+
2. Create QAT device plugin CR with `-provisioning-config` set as qat-config.
65+
66+
# Run Intel QAT based workloads on RHOCP
67+
To run the Intel QAT based workloads as an unprivileged pod (see [issue](https://github.com/intel/intel-technology-enabling-for-openshift/issues/122)). The customized `qat-scc` Security Context Constraint (SCC) is provided to bind with service account and run the QAT based workload.
68+
69+
See [Verify Intel QuickAssist Technology Provisioning](https://github.com/intel/intel-technology-enabling-for-openshift/tree/main/tests/l2#verify-intel-quickassist-technology-provisioning) for the detailed steps.

0 commit comments

Comments
 (0)