Skip to content

Commit

Permalink
Merge pull request intel#262 from mregmi/doc_split
Browse files Browse the repository at this point in the history
Documentation: Split the tests README and put it in their own folder
  • Loading branch information
uMartinXu authored Jun 14, 2024
2 parents 792c479 + c94f005 commit ede9d16
Show file tree
Hide file tree
Showing 4 changed files with 204 additions and 198 deletions.
202 changes: 4 additions & 198 deletions tests/l2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,205 +7,11 @@ After provisioning Intel hardware features on RHOCP, the respective hardware res

• Provisioning Intel HW features on RHOCP. Follow steps [here](/README.md#provisioning-intel-hardware-features-on-rhocp)

### Verify Intel® Software Guard Extensions (Intel® SGX) Provisioning
This [SampleEnclave](https://github.com/intel/linux-sgx/tree/master/SampleCode/SampleEnclave) application workload from the Intel SGX SDK runs an Intel SGX enclave utilizing the EPC resource from the Intel SGX provisioning.
* Build the container image.
```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/sgx/sgx_build.yaml
```

* Deploy and run the workload.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/sgx/sgx_job.yaml
```

* Check the results.
```
$ oc get pods
intel-sgx-job-4tnh5 0/1 Completed 0 2m10s
intel-sgx-workload-1-build 0/1 Completed 0 30s
```
```
$ oc logs intel-sgx-job-4tnh5
Checksum(0x0x7fffac6f41e0, 100) = 0xfffd4143
Info: executing thread synchronization, please wait...
Info: SampleEnclave successfully returned.
Enter a character before exit ...
```
### Verify Intel® Data Center GPU provisioning
It is supported for Intel® Data Center GPU Flex and Max Series.
#### clinfo
This workload runs [clinfo](https://github.com/Oblomov/clinfo) utilizing the i915 resource from GPU provisioning and displays the related GPU information.

* Build the workload container image.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/clinfo_build.yaml
```

* Deploy and execute the workload.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/clinfo_job.yaml
```

* Check the results.
```
$ oc get pods
intel-dgpu-clinfo-1-build 0/1 Completed 0 3m20s
intel-dgpu-clinfo-56mh2 0/1 Completed 0 35s
```
```
$ oc logs intel-dgpu-clinfo-56mh2
Platform Name Intel(R) OpenCL HD Graphics
Number of devices 1
Device Name Intel(R) Data Center GPU Flex Series 140 [0x56c1]
Device Vendor Intel(R) Corporation
Device Vendor ID 0x8086
Device Version OpenCL 3.0 NEO
Device UUID 86800000-c156-0000-0000-000000000000
Driver UUID 32322e34-332e-3234-3539-352e33350000
Valid Device LUID No
Device LUID 80c6-4e56fd7f0000
Device Node Mask 0
Device Numeric Version 0xc00000 (3.0.0)
Driver Version 22.43.24595.35
Device OpenCL C Version OpenCL C 1.2
Device OpenCL C all versions OpenCL
```
#### hwinfo

This workload runs ```hwinfo``` utilizing the i915 resource from GPU provisioning and displays the related GPU information. Refer to [link](https://dgpu-docs.intel.com/driver/installation.html#verify-install)


* Build the workload container image.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/hwinfo_build.yaml
```

* Deploy and execute the workload.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/hwinfo_job.yaml
```
Please refer to Intel DGPU provisioning validation tests [here](dgpu/README.md)

* Check the results
```
$ oc get pods
intel-dgpu-hwinfo-1-build 0/1 Completed 0 2m23s
intel-dgpu-hwinfo-44k4d 0/1 Completed 0 106s
```
```
$ oc logs intel-dgpu-hwinfo-44k4d
282: PCI aa00.0: 0380 Display controller
[Created at pci.386]
Unique ID: YxOB.+ER_Ec9Ujm4
Parent ID: xBFW.xbjkZcxCQYD
SysFS ID: /devices/pci0000:a7/0000:a7:01.0/0000:a8:00.0/0000:a9:01.0/0000:aa:00.0
SysFS BusID: 0000:aa:00.0
Hardware Class: graphics card
Model: "Intel Display controller"
Vendor: pci 0x8086 "Intel Corporation"
Device: pci 0x0bda
SubVendor: pci 0x8086 "Intel Corporation"
SubDevice: pci 0x0000
Revision: 0x2f
Driver: "i915"
Driver Modules: "i915"
Memory Range: 0x44fe3f000000-0x44fe3fffffff (ro,non-prefetchable)
Memory Range: 0x447000000000-0x447fffffffff (ro,non-prefetchable)
IRQ: 511 (140 events)
Module Alias: "pci:v00008086d00000BDAsv00008086sd00000000bc03sc80i00"
Config Status: cfg=new, avail=yes, need=no, active=unknown
Attached to: #89 (PCI bridge)
```
### Verify Intel® Software Guard Extensions (Intel® SGX) Provisioning
Please refer to Intel SGX provisioning validation tests [here](sgx/README.md)

### Verify Intel® QuickAssist Technology provisioning
This workload runs [qatlib](https://github.com/intel/qatlib) sample tests using RedHat built and distributed Qatlib RPM packages from the codeready-builder-for-rhel-9-x86_64-rpms repo. Refer to the [qatlib readme](https://github.com/intel/qatlib/blob/main/INSTALL) for more details.

* Build the workload container image

Please replace the credentials in buildconfig yaml with your RedHat account login credentials.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/qat/qatlib_build.yaml
```

* Create SCC intel-qat-scc for Intel QAT based workload, if this SCC is not created

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/security/qatlib_scc.yaml
```
* Create the intel-qat service account to use intel-qat-scc

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/security/qatlib_rbac.yaml
```

* Deploy the qatlib workload job with intel-qat service account

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/qat/qatlib_job.yaml
```

* Check the results.
```
$ oc get pods
intel-qat-workload-c6g9v 0/1 Completed 0 4m13s
```


* For all sample tests `cpa_sample_code`

```
$ oc logs intel-qat-workload-c6g9v
qaeMemInit started
icp_sal_userStartMultiProcess("SSL") started
There are no crypto instances
*** QA version information ***
device ID = 0
software = 23.2.0
*** END QA version information ***
Inst 0, Affin: 0, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 1, Affin: 1, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 2, Affin: 2, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 3, Affin: 3, Dev: 0, Accel 0, EE 0, BDF ED:00:01
---------------------------------------
API Traditional
Session State STATELESS
Algorithm DEFLATE
Huffman Type STATIC
Mode ASYNCHRONOUS
CNV Enabled YES
Direction COMPRESS
Packet Size 8192
Compression Level 1
Corpus CALGARY_CORPUS
Corpus Filename calgary
CNV Recovery Enabled YES
Number of threads 4
Total Responses 158400
Total Retries 2242671
Clock Cycles Start 126150916653843
Clock Cycles End 126151409143747
Total Cycles 492489904
CPU Frequency(kHz) 1700160
Throughput(Mbps) 35920
Compression Ratio 0.4897
---------------------------------------
Inst 0, Affin: 0, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 1, Affin: 1, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 2, Affin: 2, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 3, Affin: 3, Dev: 0, Accel 0, EE 0, BDF ED:00:01
---------------------------------------
```


## See Also
For Intel SGX demos on vanilla Kubernetes, refer to [link](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/main/demo/sgx-sdk-demo)

For GPU demos on vanilla Kubernetes, refer to [link](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/main/demo/intel-opencl-icd)
Please refer to Intel QAT provisioning validation tests [here](qat/README.md)
91 changes: 91 additions & 0 deletions tests/l2/dgpu/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
### Verify Intel® Data Center GPU provisioning
It is supported for Intel® Data Center GPU Flex and Max Series.
#### clinfo
This workload runs [clinfo](https://github.com/Oblomov/clinfo) utilizing the i915 resource from GPU provisioning and displays the related GPU information.

* Build the workload container image.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/clinfo_build.yaml
```

* Deploy and execute the workload.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/clinfo_job.yaml
```

* Check the results.
```
$ oc get pods
intel-dgpu-clinfo-1-build 0/1 Completed 0 3m20s
intel-dgpu-clinfo-56mh2 0/1 Completed 0 35s
```
```
$ oc logs intel-dgpu-clinfo-56mh2
Platform Name Intel(R) OpenCL HD Graphics
Number of devices 1
Device Name Intel(R) Data Center GPU Flex Series 140 [0x56c1]
Device Vendor Intel(R) Corporation
Device Vendor ID 0x8086
Device Version OpenCL 3.0 NEO
Device UUID 86800000-c156-0000-0000-000000000000
Driver UUID 32322e34-332e-3234-3539-352e33350000
Valid Device LUID No
Device LUID 80c6-4e56fd7f0000
Device Node Mask 0
Device Numeric Version 0xc00000 (3.0.0)
Driver Version 22.43.24595.35
Device OpenCL C Version OpenCL C 1.2
Device OpenCL C all versions OpenCL
```
#### hwinfo

This workload runs ```hwinfo``` utilizing the i915 resource from GPU provisioning and displays the related GPU information. Refer to [link](https://dgpu-docs.intel.com/driver/installation.html#verify-install)


* Build the workload container image.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/hwinfo_build.yaml
```

* Deploy and execute the workload.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/dgpu/hwinfo_job.yaml
```

* Check the results
```
$ oc get pods
intel-dgpu-hwinfo-1-build 0/1 Completed 0 2m23s
intel-dgpu-hwinfo-44k4d 0/1 Completed 0 106s
```
```
$ oc logs intel-dgpu-hwinfo-44k4d
282: PCI aa00.0: 0380 Display controller
[Created at pci.386]
Unique ID: YxOB.+ER_Ec9Ujm4
Parent ID: xBFW.xbjkZcxCQYD
SysFS ID: /devices/pci0000:a7/0000:a7:01.0/0000:a8:00.0/0000:a9:01.0/0000:aa:00.0
SysFS BusID: 0000:aa:00.0
Hardware Class: graphics card
Model: "Intel Display controller"
Vendor: pci 0x8086 "Intel Corporation"
Device: pci 0x0bda
SubVendor: pci 0x8086 "Intel Corporation"
SubDevice: pci 0x0000
Revision: 0x2f
Driver: "i915"
Driver Modules: "i915"
Memory Range: 0x44fe3f000000-0x44fe3fffffff (ro,non-prefetchable)
Memory Range: 0x447000000000-0x447fffffffff (ro,non-prefetchable)
IRQ: 511 (140 events)
Module Alias: "pci:v00008086d00000BDAsv00008086sd00000000bc03sc80i00"
Config Status: cfg=new, avail=yes, need=no, active=unknown
Attached to: #89 (PCI bridge)
```

## See Also
For GPU demos on vanilla Kubernetes, refer to [link](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/main/demo/intel-opencl-icd)
81 changes: 81 additions & 0 deletions tests/l2/qat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
### Verify Intel® QuickAssist Technology provisioning
This workload runs [qatlib](https://github.com/intel/qatlib) sample tests using RedHat built and distributed Qatlib RPM packages from the codeready-builder-for-rhel-9-x86_64-rpms repo. Refer to the [qatlib readme](https://github.com/intel/qatlib/blob/main/INSTALL) for more details.

* Build the workload container image

Please replace the credentials in buildconfig yaml with your RedHat account login credentials.

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/qat/qatlib_build.yaml
```

* Create SCC intel-qat-scc for Intel QAT based workload, if this SCC is not created

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/security/qatlib_scc.yaml
```
* Create the intel-qat service account to use intel-qat-scc

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/security/qatlib_rbac.yaml
```

* Deploy the qatlib workload job with intel-qat service account

```
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/tests/l2/qat/qatlib_job.yaml
```

* Check the results.
```
$ oc get pods
intel-qat-workload-c6g9v 0/1 Completed 0 4m13s
```


* For all sample tests `cpa_sample_code`

```
$ oc logs intel-qat-workload-c6g9v
qaeMemInit started
icp_sal_userStartMultiProcess("SSL") started
There are no crypto instances
*** QA version information ***
device ID = 0
software = 23.2.0
*** END QA version information ***
Inst 0, Affin: 0, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 1, Affin: 1, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 2, Affin: 2, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 3, Affin: 3, Dev: 0, Accel 0, EE 0, BDF ED:00:01
---------------------------------------
API Traditional
Session State STATELESS
Algorithm DEFLATE
Huffman Type STATIC
Mode ASYNCHRONOUS
CNV Enabled YES
Direction COMPRESS
Packet Size 8192
Compression Level 1
Corpus CALGARY_CORPUS
Corpus Filename calgary
CNV Recovery Enabled YES
Number of threads 4
Total Responses 158400
Total Retries 2242671
Clock Cycles Start 126150916653843
Clock Cycles End 126151409143747
Total Cycles 492489904
CPU Frequency(kHz) 1700160
Throughput(Mbps) 35920
Compression Ratio 0.4897
---------------------------------------
Inst 0, Affin: 0, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 1, Affin: 1, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 2, Affin: 2, Dev: 0, Accel 0, EE 0, BDF ED:00:01
Inst 3, Affin: 3, Dev: 0, Accel 0, EE 0, BDF ED:00:01
---------------------------------------
```
Loading

0 comments on commit ede9d16

Please sign in to comment.