NVIDIA DOCA Release Notes

NVIDIA DOCA SDK release notes containing information on new features, bug fixes, and known issues.

1. Introduction

DOCA 1.5.1 is an LTS update to DOCA 1.5 which includes feature completion and bug fixes from DOCA 1.5.0.

2. Issues Fixed

The following are the main fixes in this release:
  • Rocky Linux fixes
  • App Shield fixes
  • Compression compilation fix
  • PKA engine fix
  • RedHat 8.2 installation fix

3. Completed Features

The following items complete feature delivery of DOCA 1.5.0:
  • Support Rocky Linux on DPU and host (Comm Channel not supported)
  • Support CentOS 8.2 on DPU and host
  • GA support for DOCA BlueMan service
  • Beta support for IPsec tunnel mode and Security Gateway reference application

4. Installation Notes

Refer to the NVIDIA DOCA Installation Guide for Linux for information on:
  • Setting up NVIDIA DOCA SDK on your BlueField DPU
  • Supported BlueField platforms

4.1. DOCA Packages

Device Component Version Description

Host

DOCA SDK 1.5.1 Software development kit package for developing host software
DOCA Runtime 1.5.1 Runtime libraries required to run DOCA-based software applications on host
DOCA Tools 1.5.1 Tools for developers and administrators on host

Arm emulated (QEMU) development container

3.9.3.1 Linux-based BlueField Arm emulated container for developers

Target BlueField-2 DPU (Arm)

BlueField BSP 3.9.3.1 BlueField image and firmware
DOCA SDK 1.5.1 Software development kit packages for developing Arm software
DOCA Runtime 1.5.1 Runtime libraries requied to run DOCA-based software applications on Arm
DOCA Tools 1.5.1 Tools for developers and administrators for Arm target

4.2. Supported Operating System

The operating system supported on the BlueField DPU is Ubuntu 20.04.

The following operating systems are supported on the host machine:
  • Ubuntu 18.04/20.04/22.04
  • CentOS/RHEL 7.6/8.0/8.2
  • Rocky 8.6
  • Debian 10.8

4.3. Supported Kernel Versions

Note: Only the following generic kernel versions are supported for DOCA local repo package for host installation (whether by SDKM or manually).
Host Operation System Kernel Support Arch Support
CentOS 7.6 4.14.0-115.el7a.aarch64 aarch64
3.10.0-957.el7.x86_64 x86
CentOS 8.0 4.18.0-80.el8.x86_64
CentOS 8.2 4.18.0-193.el8.x86_64
RHEL 7.6 3.10.0-957.el7.x86_64
RHEL 8.0 4.18.0-80.el8.x86_64
RHEL 8.2 4.18.0-193.el8.x86_64
Rocky 8.6 4.18.0-372.9.1.el8.x86_64
Ubuntu 18.04 4.15.0-20-generic
Ubuntu 20.04 5.4.0-26-generic
Ubuntu 22.04 5.15.0-52-generic
Debian 10.8 4.19.0-14-amd64

5. Technical Support

Customers who purchased NVIDIA products directly from NVIDIA are invited to contact us through the following methods:

Customers who purchased NVIDIA M-1 Global Support Services, please see your contract for details regarding Technical Support.

Customers who purchased NVIDIA products through an NVIDIA-approved reseller should first seek assistance through their reseller.

6. Known Issues

The following table lists the known issues and limitations for this release of DOCA SDK.

Reference Description
3282113 Description: Some DPUs experience AN issue with the clock settings after installing a BlueField OS in an HBN setting in which the date reverts back to "Thu Sep 8, 2022".
Workaround: Issue the following commands to enable NTP and sync the clock:
sudo apt update
sudo apt install ntp
sudo systemctl stop ntp
sudo systemctl disable ntp
sudo systemctl enable ntp@mgmt
sudo systemctl start ntp@mgmt
sudo systemctl daemon-reload
sudo systemctl status ntp@mgmt
Keyword: HBN; Time; NTP
Reported in version: 1.5.1
3274589 Description: To install DOCA on an Ubuntu 22.04 host, use the following command:
apt-get install doca-runtime doca-sdk doca-tools openvswitch-switch -y
Workaround: N/A
Keyword: Installation; Ubuntu 22.04; OVS; openvswitch-switch
Reported in version: 1.5.1
3274589 Description: Comm channel fails to initiated in Rocky Linux.
Workaround: N/A
Keyword: Comm channel; Rocky
Reported in version: 1.5.1
3270534 Description: The Security Gateway reference application fails to forward traffic when used with a ConnectX setup in full-offload mode.
Workaround: Change the number of queues passed to doca_flow_init() at the application level instead of using the current value.
Keyword: Security Gateway; IPSec; flow
Reported in version: 1.5.1
3264749 Description: In Rocky and CentOS 8.2 inbox-kernel BFBs, RegEx requires the following extra huge page configuration for it to function properly:
sudo hugeadm --pool-pages-min DEFAULT:2048M
sudo systemctl start mlx-regex.service
systemctl status mlx-regex.service

If these commands have executed successfully you should see active (running) in the last line of the output.

Workaround: N/A
Keyword: RegEx; hugepages
Reported in version: 1.5.1
3168683 Description: If many interfaces are participating in EVPN/routing, it is possible for the routing process to run out of memory.
Workaround: Have a maximum of 8 VF interfaces participating in routing/VXLAN.
Keyword: HBN; routing; memory
Reported in version: 1.5.0
3240785 Description: DTS might fail to connect to DPE if started after DTS is already running.
Workaround: Start the DTS container only after starting DPE.
Keyword: DTS; DPE; BlueMan
Reported in version: 1.5.0
3250391 Description: dpdk_queues_and_ports_init fails when given 0 DPDK ports.
Workaround: N/A
Keyword: doca_dpi_grpc server; DPDK
Reported in version: 1.5.0
3219539 Description: TC rules are programmed by OVS to map uplink and host representor ports to HBN service. These rules are ageable and can result in packets needing to get software forwarded periodically to refresh the rules.
Workaround: The timeout value can be adjusted by changing the OVS parameter other_config : max-idle as documented here. The shipped default value is 10000ms (10s).
Keyword: HBN; SFC; aging
Reported in version: 1.5.0
3184745 Description: The command nv show interface <intf> acl does not show correct information if there are multiple ACLs bound to the interface.
Workaround: Use the command nv show interface <intf> to view the ACLs bound to an interface.
Keyword: HBN; ACLs
Reported in version: 1.5.0
3158934 Description: Deleting an NVUE user by removing their password file and restarting the decrypt-user-add service on the HBN container does not work.
Workaround: Either respawn the container after deleting the file, or delete the password file corresponding to the user by running userdel -r username.
Keyword: HBN; user deletion
Reported in version: 1.5.0
3191433 Description: ECMP selection for the underlay path uses the ingress port and identifies uplink ports via round robin. This may not result in uniform spread of the traffic.
Workaround: N/A
Keyword: HBN; ECMP
Reported in version: 1.5.0
3185003 Description: When a packet is encapsulated with a VXLAN header, it adds extra bytes which may cause the packet to exceed the MTU of link. Typically, the packet would be fragmented but its silently dropped and no fragmentation happens.
Workaround: Make sure that the MTU on the uplink port is always 50 bytes more than host ports so that even after adding VXLAN headers, ingress packets do not exceed the MTU.
Keyword: HBN; MTU; VXLAN
Reported in version: 1.5.0
3184905 Description: On VXLAN encapsulation, the DF flag is not propagated to the outer header. Such a packet may be truncated when forwarded in the kernel, and it may be dropped when hardware offloaded.
Workaround: Make sure that the MTU on the uplink port is always 50 bytes more than host ports so that even after adding VXLAN headers, ingress packets do not exceed the MTU.
Keyword: HBN; VXLAN
Reported in version: 1.5.0
3188688 Description: When stopping the container using the command crictl stop an error may be reported because the command uses a timeout of 0 which is not enough to stop all the processes in the HBN container.
Workaround: Pass a timeout value when stopping the HBN container by running:
crictl stop --timeout 60 <hbn-container>
Keyword: HBN; timeout
Reported in version: 1.5.0
3129749 Description: The same ACL rule cannot be applied in both the inbound and outbound direction on a port.
Workaround: N/A
Keyword: HBN; ACLs
Reported in version: 1.5.0
3126560 Description: The system's time zone cannot be modified using NVUE in the HBN container.
Workaround: The timezone can be manually changed by symlinking the /etc/localtime file to a binary time zone's identifier in the /usr/share/zoneinfo directory. For example:
sudo ln -sf /usr/share/zoneinfo/GMT /etc/localtime
Keyword: HBN; time zone; NVUE
Reported in version: 1.5.0
3118204 Description: Auto-BGP functionality (where the ASN does not need to be configured but is dynamically inferred by the system based on the system's role as a leaf or spine device) is not supported on HBN.
Workaround: If BGP is configured and used on HBN, the BGP ASN must be manually configured.
Keyword: HBN; BGP
Reported in version: 1.5.0
3233088 Description: Since checksum calculation is offloaded to the hardware (not done by the kernel), it is expected to see an incorrect checksum in the tcpdump for locally generated, outgoing packets. BGP keepalives and updates are some of the packets that show such incorrect checksum in tcpdump.
Workaround: N/A
Keyword: HBN; BGP
Reported in version: 1.5.0
3240153 Description: DOCA kernel support only works on a non-default kernel.
Workaround: N/A
Keyword: Kernel
Reported in version: 1.5.0
3239668 Description: The l2_reflector reference application fails to start due to missing libflexio.so library.
Workaround: Define LD_LIBRARY_PATH as specified in the NVIDIA DOCA Troubleshooting Guide.
Keyword: FlexIO; DOCA applications; l2_reflector
Reported in version: 1.5.0
3239630 Description: FlexIO sample flexio_rpc fails to compile.
Workaround: Add the following at line 34 in the file /opt/mellanox/doca/samples/flexio/flexio_rpc/meson.build:
source_file = meson.current_source_dir() + '/device/flexio_rpc_device.c'
Keyword: FlexIO; DOCA samples; flexio_rpc
Reported in version: 1.5.0
3217627 Description: The doca_devinfo_rep_list_create API returns success on the host instead of "Operation not supported".
Workaround: N/A
Keyword: DOCA core; InfiniBand
Reported in version: 1.5.0
3048250 Description: When configuring the DPU to operate in NIC Mode, the following parameters must be set to default (i.e., =0): HIDE_PORT2_PF, NVME_EMULATION_ENABLE, and VIRTIO_NET_EMULATION_ENABLE.
Workaround: N/A
Keyword: DPU operation mode
Reported in version: 1.3.0
3049879 Description: When reloading (ifreload) an empty /etc/network/interfaces file, the previously created interfaces are not deleted.
Workaround: To delete all previously created interfaces, at least one interface must be present in /etc/network/interfaces. The following configuration can be used as a safe "empty" file to delete all other virtual devices:
auto p0
iface p0
auto p1
iface p1
Keyword: HBN; unsupported NVUE commands
Reported in version: 1.3.0
2821785 Description: Due to disabled backend foundation units, some commands show 500 INTERNAL SERVER ERROR/ 404 NOT FOUND. These commands are related to features or sub-systems which are not supported on HBN.
Workaround: N/A
Keyword: HBN; unsupported NVUE commands
Reported in version: 1.3.0
2821785 Description: MAC addresses are not learned in the hardware but only in software. This may affect performance in pure L2 unicast traffic. This should not affect performance of IPv4/IPv6 traffic or L2 control traffic (i.e., STP, LLDP).
Workaround: N/A
Keyword: HBN
Reported in version: 1.3.0
2828838 Description: NetworkManager and other services not directly related to HBN may display the following message in syslog:
"netlink: read: too many netlink events. Need to resynchronize platform cache"
The message has no functional impact and may be ignored.
Workaround: N/A
Keyword: HBN
Reported in version: 1.3.0

Notices

Notice

This document is provided for information purposes only and shall not be regarded as a warranty of a certain functionality, condition, or quality of a product. NVIDIA Corporation nor any of its direct or indirect subsidiaries and affiliates (collectively: “NVIDIA”) make no representations or warranties, expressed or implied, as to the accuracy or completeness of the information contained in this document and assume no responsibility for any errors contained herein. NVIDIA shall have no liability for the consequences or use of such information or for any infringement of patents or other rights of third parties that may result from its use. This document is not a commitment to develop, release, or deliver any Material (defined below), code, or functionality.

NVIDIA reserves the right to make corrections, modifications, enhancements, improvements, and any other changes to this document, at any time without notice.

Customer should obtain the latest relevant information before placing orders and should verify that such information is current and complete.

NVIDIA products are sold subject to the NVIDIA standard terms and conditions of sale supplied at the time of order acknowledgement, unless otherwise agreed in an individual sales agreement signed by authorized representatives of NVIDIA and customer (“Terms of Sale”). NVIDIA hereby expressly objects to applying any customer general terms and conditions with regards to the purchase of the NVIDIA product referenced in this document. No contractual obligations are formed either directly or indirectly by this document.

NVIDIA products are not designed, authorized, or warranted to be suitable for use in medical, military, aircraft, space, or life support equipment, nor in applications where failure or malfunction of the NVIDIA product can reasonably be expected to result in personal injury, death, or property or environmental damage. NVIDIA accepts no liability for inclusion and/or use of NVIDIA products in such equipment or applications and therefore such inclusion and/or use is at customer’s own risk.

NVIDIA makes no representation or warranty that products based on this document will be suitable for any specified use. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to evaluate and determine the applicability of any information contained in this document, ensure the product is suitable and fit for the application planned by customer, and perform the necessary testing for the application in order to avoid a default of the application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additional or different conditions and/or requirements beyond those contained in this document. NVIDIA accepts no liability related to any default, damage, costs, or problem which may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this document or (ii) customer product designs.

No license, either expressed or implied, is granted under any NVIDIA patent right, copyright, or other NVIDIA intellectual property right under this document. Information published by NVIDIA regarding third-party products or services does not constitute a license from NVIDIA to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property rights of the third party, or a license from NVIDIA under the patents or other intellectual property rights of NVIDIA.

Reproduction of information in this document is permissible only if approved in advance by NVIDIA in writing, reproduced without alteration and in full compliance with all applicable export laws and regulations, and accompanied by all associated conditions, limitations, and notices.

THIS DOCUMENT AND ALL NVIDIA DESIGN SPECIFICATIONS, REFERENCE BOARDS, FILES, DRAWINGS, DIAGNOSTICS, LISTS, AND OTHER DOCUMENTS (TOGETHER AND SEPARATELY, “MATERIALS”) ARE BEING PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL NVIDIA BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the products described herein shall be limited in accordance with the Terms of Sale for the product.

Trademarks

NVIDIA, the NVIDIA logo, and Mellanox are trademarks and/or registered trademarks of Mellanox Technologies Ltd. and/or NVIDIA Corporation in the U.S. and in other countries. The registered trademark Linux® is used pursuant to a sublicense from the Linux Foundation, the exclusive licensee of Linus Torvalds, owner of the mark on a world¬wide basis. Other company and product names may be trademarks of the respective companies with which they are associated.