starlingx/docs
Code Issues Proposed changes

Document Updates for fec operator v2.9.0

Browse Source 
This commit includes following updates to the documentation.

- Configuration of Intel® vRAN Boost 2.0 (VRB2) using a new API
  `SriovVrbClusterConfig`.
- Re-arrange config specs.
- Replace ACC200 with VRB1 for documentation only, not in the config
  specs.
- Replace status output of SriovFecNodeConfig with latest results to
  include the pf_bb_config version used by the FEC Operator.

Story: 2011121
Task: 50460

Change-Id: I9cd93087636b3967c804f6bb6c4b24c3850f5aeb
Signed-off-by: Nidhi Shivashankara Belur <nidhi.shivashankara.belur@intel.com>
This commit is contained in:
Nidhi Shivashankara Belur 2024-06-26 16:46:09 -07:00
parent 91e9ae357b
commit 8562e0f2fb
4 changed files with 612 additions and 393 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

951
doc/source/node_management/kubernetes/hardware_acceleration_devices/configure-sriov-fec-operator-to-enable-hw-accelerators-for-hosted-vran-containarized-workloads.rst
View File

File diff suppressed because it is too large Load Diff

49
doc/source/node_management/kubernetes/hardware_acceleration_devices/set-up-pods-to-use-sriov.rst
View File

@ -2,28 +2,45 @@
.. ggs1611608368857
.. _set-up-pods-to-use-sriov:
================================================================
Set Up Pods to Use SRIOV to Access ACC100/ACC200 HW Accelerators
================================================================
==================================================
Set Up Pods to Use SRIOV to Access HW Accelerators
==================================================
You can configure pods with |SRIOV| access to a ACC100/ACC200 devices by adding the
appropriate 'resources' request in the pod specification.
You can configure pods with |SRIOV| access to a HW accelerator device by
adding the appropriate 'resources' request in the pod specification.
.. rubric:: |context|
The following procedure shows an example of launching a container image with
'resources' request for a |VF| to the ACC100/ACC200 devices.
'resources' request for a |VF| to the ACC100 device.
.. rubric:: |proc|
#. Source the platform environment.
#. Request the resource name of the desired accelerator.
.. code-block:: none
$ source /etc/platform/openrc ~(keystone_admin)$
~(keystone_admin)$ kubectl get node controller-0 -o json | json_pp | grep -A 15 '"allocatable"'
"allocatable" : {
"cpu" : "126",
"ephemeral-storage" : "9417620260",
"hugepages-1Gi" : "10Gi",
"hugepages-2Mi" : "0",
"intel.com/intel_fec_acc100" : "16",
"memory" : "503822580Ki",
"pods" : "110"
},
"capacity" : {
"cpu" : "128",
"ephemeral-storage" : "10218772Ki",
"hugepages-1Gi" : "10Gi",
"hugepages-2Mi" : "0",
"intel.com/intel_fec_acc100" : "16",
"memory" : "525674740Ki",
#. Create a pod.yml file that requests 16 ACC100/ACC200 VFs
(i.e. intel.com/intel_acc100_fec: '16')
#. Create a pod.yml file that requests 16 ACC100 VFs
(i.e. intel.com/intel_fec_acc100: '16')
.. code-block:: none
@ -64,12 +81,12 @@ The following procedure shows an example of launching a container image with
resources:
requests:
memory: 4Gi
intel.com/intel_acc100_fec: '16'
intel.com/intel_fec_acc100: '16'
windriver.com/isolcpus: 24
limits:
hugepages-1Gi: 2Gi
memory: 4Gi
intel.com/intel_acc100_fec: '16'
intel.com/intel_fec_acc100: '16'
windriver.com/isolcpus: 24
volumes:
- name: hugepage
@ -90,13 +107,13 @@ The following procedure shows an example of launching a container image with
.. code-block:: none
~(keystone_admin)$ kubectl exec -it pod0 -- bash echo
$PCIDEVICE_INTEL_COM_INTEL_ACC100_FEC
~(keystone_admin)$ kubectl exec -it pod0 -- env | grep PCIDEVICE_INTEL_COM_INTEL_FEC_ACC100
The following PCI addresses corresponding to the |SRIOVs| are displayed:
The following PCI addresses and "VFIO_TOKEN" corresponding to the |SRIOVs| are displayed:
.. code-block:: none
0000:86:01.1,0000:86:01.0,0000:86:01.7,0000:86:01.4,0000:86:00.3,0000:86:00.1,0000:86:00.5,0000:86:00.7,0000:86:00.2,0000:86:00.4,0000:86:01.5,0000:86:01.6,0000:86:01.2,0000:86:00.0,0000:86:00.6,0000:86:01.3
PCIDEVICE_INTEL_COM_INTEL_FEC_ACC100=0000:32:00.5,0000:32:00.1,0000:32:00.2,0000:32:00.4,0000:32:01.0,0000:32:01.1,0000:32:01.2,0000:32:01.3,0000:32:00.0,0000:32:00.6,0000:32:00.7,0000:32:01.4,0000:32:01.7,0000:32:00.3,0000:32:01.6,0000:32:01.5
PCIDEVICE_INTEL_COM_INTEL_FEC_ACC100_INFO={"0000:32:00.0":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.0"},"vfio":{"dev-mount":"/dev/vfio/315","mount":"/dev/vfio/vfio"}},"0000:32:00.1":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.1"},"vfio":{"dev-mount":"/dev/vfio/316","mount":"/dev/vfio/vfio"}},"0000:32:00.2":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.2"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:00.3":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.3"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:00.4":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.4"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:00.5":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.5"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:00.6":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.6"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:00.7":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:00.7"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.0":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.0"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.1":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.1"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.2":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.2"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.3":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.3"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.4":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.4"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.5":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.5"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.6":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.6"},"vfio":{"mount":"/dev/vfio/vfio"}},"0000:32:01.7":{"extra":{"VFIO_TOKEN":"02bddbbf-bbb0-4d79-886b-91bad3fbb510"},"generic":{"deviceID":"0000:32:01.7"},"vfio":{"mount":"/dev/vfio/vfio"}}}

2
doc/source/sample_apps/flexran/deploy-flexran-2203-on-starlingx-1d1b15ecb16f.rst
View File

@ -142,7 +142,7 @@ platform: **Coyote Pass** (housing ICX-SP).
system host-unlock $NODE
#. After the system has been unlocked and available for the first time,
configure ACC100/ACC200 :
configure ACC100/VRB1 :
.. code:: bash

3
doc/source/shared/abbrevs.txt
View File

@ -221,6 +221,7 @@
.. |VNIs| replace:: :abbr:`VNIs (VXLAN Network Interfaces)`
.. |VPC| replace:: :abbr:`VPC (Virtual Port Channel)`
.. |vRAN| replace:: :abbr:`vRAN (virtualized Radio Access Network)`
.. |VRB| replace:: :abbr:`VRB (vRAN Boost)`
.. |VRF| replace:: :abbr:`VRF (Virtual Routing and Forwarding)`
.. |VRFs| replace:: :abbr:`VRFs (Virtual Routing and Forwarding)`
.. |VTEP| replace:: :abbr:`VTEP (Virtual Tunnel End Point)`
@ -228,4 +229,4 @@
.. |VXLANs| replace:: :abbr:`VXLANs (Virtual eXtensible Local Area Networks)`
.. |WAD| replace:: :abbr:`WAD (Windows Active Directory)`
.. |XML| replace:: :abbr:`XML (eXtensible Markup Language)`
.. |YAML| replace:: :abbr:`YAML (YAML Ain't Markup Language)`
.. |YAML| replace:: :abbr:`YAML (YAML Ain't Markup Language)`