Reference Architecture 22.11.1

New Components/Features:
- N/A (same as RA22.11)
Updates/Changes:
- Intel(R) QAT 2.0 drivers for the 4th Gen Intel(R) Xeon(R) Scalable processors (formerly
code named Sapphire Rapids [SPR]) are sourced from public repo. No longer under NDA; please
ignore Guide requirement to provide the "QAT20.L.0.9.9-00019.tar.gz" driver package file.
- Resolved issue regarding downloading CPUID for Rocky Linux 9 and RHEL 9
New Hardware (Platforms/CPUs/GPUs/Accelerators):
- N/A (same as RA22.11)
Removed Support:
- N/A (same as RA22.11)
Known Limitations/Restrictions:
- N/A (same as RA22.11)

Co-authored-by: Ali Shah, Syed Faraz <[email protected]>
Co-authored-by: Gherghe, Calin <[email protected]>
Co-authored-by: Pedersen, Michael <[email protected]>

Author: 3 people

generate/profiles_templates/common/host_vars.j2

@@ -257,10 +257,6 @@ enabled_qat_service: "qat"
 disabled_qat_service: "qat_service"
 
 {%- if arch in ['spr'] %}
-# SPR platform QAT drivers requirements
-# the folder must exist on the machine that will run Ansible playbooks
-qat_drivers_folder: "/tmp/qat/" # QAT "QAT20.L.0.9.9-00019.tar.gz" driver package is expected to be present in this folder
-qat_drivers_version: "QAT20.L.0.9.9-00019" # CEK has been validated with QAT drivers version "QAT20.L.0.9.9-00019.tar.gz"
 # This package provides user space libraries that allow access to Intel(R) QuickAssist devices and expose the Intel(R) QuickAssist APIs and sample codes.
 enable_intel_qatlibs: {% if qat == "on" %}true{% else %}false{% endif %} # Make sure "openssl_install" is set to "true" else this feature will be skipped in deployment.
 enable_qat_svm: {% if qat == "on" %}true{% else %}false{% endif %} # Enable QAT Shared Virtual Memory (SVM).

playbooks/preflight.yml

@@ -673,14 +673,6 @@
           Please be aware that by using CPU model that is not confirmed, some features may not work properly."
       when: (not vm_enabled) or (vm_enabled and (not on_vms | default(false)))
 
-    - name: check QAT requirements
-      include_role:
-        name: ../roles/bootstrap/install_qat_drivers_services
-        tasks_from: qat_drivers_preflight
-      when:
-        - configured_arch == "spr"
-        - update_qat_drivers is defined and update_qat_drivers
-
     - name: check QAT Devices list is configured properly
       block:
         - debug:

roles/bootstrap/install_packages/tasks/rhel.yml

@@ -72,34 +72,50 @@
     - ansible_distribution in ['RedHat', 'Rocky']
     - ansible_distribution_version >= '8'
 
+- name: obtain RPM-GPG-KEY-EPEL-9
+  rpm_key:
+    state: present
+    key: https://dl.fedoraproject.org/pub/epel/RPM-GPG-KEY-EPEL-9
+  when:
+    - ansible_distribution in ["RedHat", "Rocky"]
+    - ansible_distribution_version >= "9"
+
+- name: install RPM-GPG-KEY-EPEL-9
+  package:
+    name: https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
+  when:
+    - ansible_distribution in ["RedHat", "Rocky"]
+    - ansible_distribution_version >= "9"
+
 # CPUID package is missing on RHEL 9.0 / Rocky 9.0
 - name: block for downloading CPUID on RHEL / Rocky >= 9.0
   block:
+    - name: get list of packages
+      uri:
+        url: "https://download-ib01.fedoraproject.org/pub/epel/9/Everything/x86_64/Packages/c/"
+        return_content: true
+      register: epel_output
+
+    - name: get CPUID package name
+      set_fact:
+        cpuid_rpm: "{{ epel_output.content|split('\n') | select('match', '.*cpuid.*') |
+                    regex_search('(?=cpuid\\-)(.*?)(rpm?)') }}"
+      failed_when: cpuid_rpm | length==0
+
     - name: download CPUID on Rocky >= 9.0
       get_url:
-        url: "https://download-ib01.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/c/cpuid-20200427-1.el8.x86_64.rpm"
+        url: "https://download-ib01.fedoraproject.org/pub/epel/9/Everything/x86_64/Packages/c/{{ cpuid_rpm }}"
         dest: "{{ project_root_dir }}"
         mode: 0755
 
     - name: install downloaded CPUID package on RHEL / Rocky >= 9.0
       package:
-        name: "{{ project_root_dir }}/cpuid-20200427-1.el8.x86_64.rpm"
+        name: "{{ project_root_dir }}/{{ cpuid_rpm }}"
         state: present
   when:
     - ansible_distribution in ['RedHat', 'Rocky']
     - ansible_distribution_version >= '9'
 
-- name: obtain RPM-GPG-KEY-EPEL-9
-  rpm_key:
-    state: present
-    key: https://dl.fedoraproject.org/pub/epel/RPM-GPG-KEY-EPEL-9
-  when: ansible_distribution == "RedHat" and ansible_distribution_version >= "9"
-
-- name: install RPM-GPG-KEY-EPEL-9
-  package:
-    name: https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
-  when: ansible_distribution == "RedHat" and ansible_distribution_version >= "9"
-
 - name: get current kernel version
   command: uname -r
   register: current_kernel_version

roles/bootstrap/install_qat_drivers_services/defaults/main.yml

@@ -14,9 +14,16 @@
 ##   limitations under the License.
 ##
 ---
+# QAT 1.x (for QAT add-on cards)
 qat_drivers_version: 'QAT.L.4.20.0-00001'
 qat_drivers_download_url: 'https://downloadmirror.intel.com/761891/{{ qat_drivers_version }}.tar.gz'
 qat_drivers_pkg_checksum: 'sha1:A78B360F33D270A1FBF7BBD60B2BA69253771771'
+
+# QAT 2.x (for QAT embedded into SPR)
+qat_spr_drivers_version: 'QAT20.L.1.0.0-00021'
+qat_spr_drivers_download_url: 'https://downloadmirror.intel.com/765523/{{ qat_spr_drivers_version }}.tar.gz'
+qat_spr_drivers_pkg_checksum: 'sha1:BF74086B364E45E9A7DB305C15CF92C67E9D287A'
+
 # If updating mentioned below folder location kindly update similar in roles/redeploy_cleanup/defaults/main.yml
 qat_drivers_dir: "{{ (project_root_dir, 'qat_drivers') | path_join }}"
 

roles/bootstrap/install_qat_drivers_services/tasks/main.yml

@@ -49,33 +49,46 @@
     state: directory
     mode: "u=rwx,g=rx,o=rx"
 
-- name: download QAT drivers package {{ qat_drivers_version }}
-  get_url:
-    url: "{{ qat_drivers_download_url }}"
-    checksum: "{{ qat_drivers_pkg_checksum }}"
-    dest: "{{ qat_drivers_dir }}"
-    mode: 0755
-  register: qat_driver
-  until: qat_driver is not failed
-  retries: 5
+- name: block for QAT 1.x
+  block:
+    - name: download QAT drivers package {{ qat_drivers_version }}
+      get_url:
+        url: "{{ qat_drivers_download_url }}"
+        checksum: "{{ qat_drivers_pkg_checksum }}"
+        dest: "{{ qat_drivers_dir }}"
+        mode: 0755
+      register: qat_driver_sw
+      until: qat_driver_sw is not failed
+      retries: 5
+
+    - name: unarchive QAT drivers package
+      unarchive:
+        src: "{{ qat_drivers_dir }}/{{ qat_drivers_version }}.tar.gz"
+        dest: "{{ qat_drivers_dir }}"
+        remote_src: yes
+        mode: 0755
   when: configured_arch != "spr"
 
-- name: copy QAT driver package
-  copy:
-    dest: "{{ qat_drivers_dir }}/{{ qat_drivers_version }}.tar.gz"
-    src: "{{ qat_drivers_folder }}/{{ qat_drivers_version }}.tar.gz"
-    owner: root
-    group: root
-    mode: 0644
+- name: block for QAT 2.x
+  block:
+    - name: download QAT drivers package {{ qat_spr_drivers_version }}
+      get_url:
+        url: "{{ qat_spr_drivers_download_url }}"
+        checksum: "{{ qat_spr_drivers_pkg_checksum }}"
+        dest: "{{ qat_drivers_dir }}"
+        mode: 0755
+      register: qat_driver_sw
+      until: qat_driver_sw is not failed
+      retries: 5
+
+    - name: unarchive QAT drivers package
+      unarchive:
+        src: "{{ qat_drivers_dir }}/{{ qat_spr_drivers_version }}.tar.gz"
+        dest: "{{ qat_drivers_dir }}"
+        remote_src: yes
+        mode: 0755
   when: configured_arch == "spr"
 
-- name: unarchive QAT drivers package
-  unarchive:
-    src: "{{ qat_drivers_dir }}/{{ qat_drivers_version }}.tar.gz"
-    dest: "{{ qat_drivers_dir }}"
-    remote_src: yes
-    mode: 0755
-
 - name: check all packages are present for QAT drivers installation
   command: ./configure
   args: