Skip to content

Commit 92634e5

Browse files
committed
device_plugins: Update QAT device plugin readme
Signed-off-by: vbedida79 <veenadhari.bedida@intel.com>
1 parent f9c3ebb commit 92634e5

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

device_plugins/deploy_qat.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ $ oc describe node <node name> | grep qat.intel.com
3737
qat.intel.com/dc: 32
3838
qat.intel.com/dc: 32
3939
```
40+
**Note**: By default the device plugin registers half resources each for `qat.intel.com/cy` and `qat.intel.com/dc` respectively. For more details about the QAT resources configuration, please refer to the QAT Device Plugin Configuration section below.
4041

4142
# QAT Device Plugin Configuration
4243
> **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.
@@ -54,16 +55,25 @@ For more details about the QAT device plugin configuration flags, see [Modes and
5455

5556
**NOTE**: In this release, this is an experimental feature. The efforts to [enhance this feature](https://github.com/intel/intel-device-plugins-for-kubernetes/issues/1529) and [make it more stable](https://github.com/intel/intel-device-plugins-for-kubernetes/issues/1542) are on going.
5657

57-
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.
58-
5958
Users can use the steps below to customize the QAT resource configuration:
6059
1. Create the configmap for qat resource configuration
6160
```
62-
$ oc create configmap --namespace=openshift-operators --from-literal "qat.conf=ServicesEnabled=<option>" Name of ConfigMap
61+
$ oc create configmap --namespace=openshift-operators --from-literal "qat.conf=ServicesEnabled=<option>" <name-of-configmap>
6362
```
64-
Options:
65-
`dc`: Configure all the QAT VF devices managed by the device plugin CR for compression/decompression.
66-
`sym;asym`: Configure all the QAT VF devices managed by the device plugin CR for cryptography
63+
Options- (refer to [link](https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-driver-qat) for more details):
64+
`dc` : Configure all the QAT VF devices managed by the device plugin CR for compression services. The resource created is `qat.intel.com/dc`.
65+
66+
`sym;asym` and `asym;sym`: Configure all the QAT VF devices managed by the device plugin CR for crypto services. The resource created is `qat.intel.com/cy`.
67+
68+
`sym;dc` and `dc;sym` : Configure all the QAT VF devices managed by the device plugin CR for symmetric crypto and compression services. The resource created is `qat.intel.com/sym-dc`.
69+
70+
`asym;dc` and `dc;asym`: Configure all the QAT VF devices managed by the device plugin CR for asymmetric crypto and compression services. The resource created is `qat.intel.com/asym-dc`.
71+
72+
`sym`: Configure all the QAT VF devices managed by the device plugin CR for running symmetric crypto services. The resource created is `qat.intel.com/cy`.
73+
74+
`asym`: Configure all the QAT VF devices managed by the device plugin CR for running asymmetric crypto services. The resource created is `qat.intel.com/cy`.
75+
76+
6777
2. Create QAT device plugin CR with -provisioning-config set as the name of the ConfigMap (created in step 1) in the qat_device_plugin.yaml file or set ConfigMap name in the provisioning-config option from web console.
6878
6979
# Run Intel QAT based workloads on RHOCP

0 commit comments

Comments
 (0)