From 0df51a791ff78e527dd1e2df6aa419cc82b482c2 Mon Sep 17 00:00:00 2001
From: chaitanya1731 <chaitanya.kulkarni@intel.com>
Date: Mon, 18 Sep 2023 13:16:37 -0700
Subject: [PATCH] device_plugins: Update deploy_qat readme

Signed-off-by: chaitanya1731 <chaitanya.kulkarni@intel.com>
---
 device_plugins/deploy_qat.md | 42 +++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/device_plugins/deploy_qat.md b/device_plugins/deploy_qat.md
index d9fce219..4bdc326b 100644
--- a/device_plugins/deploy_qat.md
+++ b/device_plugins/deploy_qat.md
@@ -26,4 +26,44 @@ Output:
 ```
 NAME		        DESIRED		READY	NODE SELECTOR	                                    AGE
 qatdeviceplugin-sample  1 	        1       {"intel.feature.node.kubernetes.io/qat":"true"}     3h27m
-```
\ No newline at end of file
+```
+
+# Verify QAT Device Plugin 
+After the plugin is deployed, use below command to verify QAT resources: 
+```
+$ oc describe node <node name> | grep qat.intel.com  
+ qat.intel.com/cy: 32 
+ qat.intel.com/cy: 32 
+ qat.intel.com/dc: 32 
+ qat.intel.com/dc: 32 
+ ```
+
+# QAT Device Plugin Configuration
+> **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. 
+
+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).
+
+| Flag | Configuration | Description |
+| ---- | ---- | ---- |
+| `-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) |
+| `-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) |
+| `-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. |
+| `-provisioning-config ` | qat-config or empty | See section [QAT resource configuration](/device_plugins/deploy_qat.md#qat-resource-configuration)  |
+
+## QAT Resource Configuration
+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.
+
+Users can use the steps below to customize the QAT resource configuration:  
+1. Create the configmap for qat resource configuration 
+    ```
+    $ oc create configmap --namespace=openshift-operators --from-literal "qat.conf=ServicesEnabled=<option>" qat-config 
+    ```
+    Options:  
+    `dc`: Configure all the QAT VF devices managed by the device plugin CR for compression/decompression.  
+    `sym` or `asym`: Configure all the QAT VF devices managed by the device plugin CR for cryptography 
+2. Create QAT device plugin CR with `-provisioning-config` set as qat-config.  
+
+# Run Intel QAT based workloads on RHOCP
+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. 
+
+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.  
\ No newline at end of file