Skip to content

Latest commit

 

History

History
171 lines (131 loc) · 7.55 KB

README.md

File metadata and controls

171 lines (131 loc) · 7.55 KB
Raw

Precompiled Container Build Instructions for NVIDIA NIC Drivers

This document provides instructions on how to build container with NVIDIA NIC drivers, precompiled for specific kernel version.

Doca-driver container is designed to build and install NVIDIA NIC drivers as part of NVIDIA Network Operator solution.

Prerequisites

Before you begin, ensure that you have the following prerequisites:

Common:

  1. Docker (Ubuntu) / Podman (RH) installed on your build system.
  2. Web access to NVIDIA NIC drivers sources1.

RHEL:

  1. Active subscription and login credentials for registry.redhat.io2.

RHCOS:

  1. oc CLI tool 3.
  2. OpenShift pull secret 4.

SLES:

  1. Active subscription.

Dockerfile Overview

To build the precompiled container, the Dockerfile is constructed in a multistage fashion.
This approach is used to optimize the resulting container image size and reduce the number of dependencies included in the final image.

The Dockerfile consists of the following stages:

  1. Base Image Update: The base image is updated and common requirements are installed. This stage sets up the basic environment for the subsequent stages.

  2. Download Driver Sources: This stage downloads the Mellanox OFED driver sources to the specified path. It prepares the necessary files for the driver build process.

  3. Build Driver: The driver is built using the downloaded sources and installed on the container. This stage ensures that the driver is compiled and configured correctly for the target system.

  4. Install precompiled driver: Finally, the precompiled driver is installed on clean container. This stage sets up the environment to run the NVIDIA NIC drivers on the target system.

Important

For proper Network Operator functionality container tag name must be in following pattern: driver_ver-container_ver-kernel_ver-os-arch For example: 24.10-1.1.4.0-0-5.15.0-25-generic-ubuntu22.04-amd64

Common mandatory build parameters

Before building the container, you need to provide following parameters as build-arg for container build:

  1. D_OS: The Linux distribution (e.g., ubuntu22.04 / rhel9.2)
  2. D_ARCH: Compiled Architecture
  3. D_BASE_IMAGE: Base container image (e.g., ubuntu:22.04)
  4. D_KERNEL_VER: The target kernel version (e.g., 5.15.0-25-generic / 5.14.0-284.32.1.el9_2.x86_64)
  5. D_DOCA_VERSION: The NVIDIA DOCA version (e.g., 2.9.1)
  6. D_OFED_VERSION: NVIDIA NIC drivers version (e.g., 24.10-1.1.4.0)

Important

NVIDIA NIC driver sources are bundled as part of NVIDIA DOCA package. Both the DOCA package version and its corresponding NIC driver (MLNX_OFED) version need to be specified to fetch the correct driver sources when building the driver container. check 5 for more information.

Important

Check desired NVIDIA NIC drivers sources1 availability for designated container OS, only versions available on download page can be utilized

RHEL specific build parameters

  1. D_BASE_IMAGE: DriverToolKit container image

Important

DTK (DriverToolKit) is tightly coupled with specific kernel versions, verify match between kernel version to compile drivers for, versus DTK image.

  1. D_FINAL_BASE_IMAGE: Final container image, to install compiled driver

RHCOS specific build parameters

  1. D_BASE_IMAGE: DriverToolKit container image

Important

DTK (DriverToolKit) is tightly coupled with specific kernel version for an OpenShift release.

In order to get the specific DTK container image for a specific OpenShift release, run:

oc adm release info <OCP_VERSION> --image-for=driver-toolkit

For example, for OpenShift 4.16.0:

# oc adm release info 4.16.0 --image-for=driver-toolkit
quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:dde3cd6a75d865a476aa7e1cab6fa8d97742401e87e0d514f3042c3a881e301f

Then pull the DTK image locally using your pull-secret:

podman pull --authfile=/path/to/pull-secret.txt docker://quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:dde3cd6a75d865a476aa7e1cab6fa8d97742401e87e0d514f3042c3a881e301f
  1. D_FINAL_BASE_IMAGE: Final container image, to install compiled driver

Examples

RHEL example:

# podman build \  
    --build-arg D_OS=rhel9.2 \  
    --build-arg D_ARCH=x86_64 \  
    --build-arg D_KERNEL_VER=5.14.0-284.32.1.el9_2.x86_64 \ 
    --build-arg D_DOCA_VERSION=2.9.1 \ 
    --build-arg D_OFED_VERSION=24.10-1.1.4.0 \ 
    --build-arg D_BASE_IMAGE="registry.redhat.io/openshift4/driver-toolkit-rhel9:v4.13.0-202309112001.p0.gd719bdc.assembly.stream" \  
    --build-arg D_FINAL_BASE_IMAGE=registry.access.redhat.com/ubi9/ubi:latest \  
    --tag 24.10-1.1.4.0-0-5.14.0-284.32.1.el9_2-rhel9.2-amd64 \  
    -f RHEL_Dockerfile \  
    --target precompiled .

RHCOS example:

# podman build \
    --build-arg D_OS=rhcos4.16 \ 
    --build-arg D_ARCH=x86_64 \ 
    --build-arg D_KERNEL_VER=5.14.0-427.22.1.el9_4.x86_64 \ 
    --build-arg D_DOCA_VERSION=2.9.1 \ 
    --build-arg D_OFED_VERSION=24.10-1.1.4.0 \ 
    --build-arg D_BASE_IMAGE="quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:dde3cd6a75d865a476aa7e1cab6fa8d97742401e87e0d514f3042c3a881e301f" \ 
    --build-arg D_FINAL_BASE_IMAGE=registry.access.redhat.com/ubi9/ubi:9.4 \ 
    --tag 24.10-1.1.4.0-0-5.14.0-427.22.1.el9_4.x86_64-rhcos4.16-amd64 \ 
    -f RHEL_Dockerfile \ 
    --target precompiled .

Ubuntu example:

# docker build \  
    --build-arg D_OS=ubuntu22.04 \  
    --build-arg D_ARCH=x86_64 \  
    --build-arg D_BASE_IMAGE=ubuntu:22.04 \  
    --build-arg D_KERNEL_VER=5.15.0-25-generic \  
    --build-arg D_DOCA_VERSION=2.9.1 \ 
    --build-arg D_OFED_VERSION=24.10-1.1.4.0 \ 
    --tag 24.10-1.1.4.0-0-5.15.0-25-generic-ubuntu22.04-amd64 \  
    -f Ubuntu_Dockerfile \  
    --target precompiled .

SLES example:

# docker build \
    --build-arg D_OS=sles15.5 \ 
    --build-arg D_ARCH=x86_64 \ 
    --build-arg D_BASE_IMAGE=registry.suse.com/suse/sle15:15.5 \ 
    --build-arg D_KERNEL_VER=5.14.21-150500.55.83-default \ 
    --build-arg D_DOCA_VERSION=2.9.1 \ 
    --build-arg D_OFED_VERSION=24.10-1.1.4.0 \ 
    --tag 24.10-1.1.4.0-0-5.14.21-150500.55.83-default-sles15.5-amd64 \ 
    -f SLES_Dockerfile \ 
    --target precompiled .

Important

Dockerfiles contain default build parameters, which may fail build proccess on your system if not overridden.

Warning

Modification of D_OFED_SRC_DOWNLOAD_PATH must be tighdly coupled with corresponding update to entrypoint.sh script

Footnotes

  1. Latest NIC drivers published at NIC drivers download center, for example:
    https://linux.mellanox.com/public/repo/doca/2.9.1/SOURCES/MLNX_OFED/MLNX_OFED_SRC-debian-24.10-1.1.4.0.tgz ↩ ↩2

  2. To build RHEL based container from official repository, you need to log in to registry.redhat.io, run the following command:
    podman login registry.redhat.io --username=${RH_USERNAME} --password=${RH_PASSWORD}
    Replace RH_USERNAME and RH_PASSWORD with your Red Hat account username and password. ↩

  3. Download 'oc' CLI tool from here ↩

  4. Download your OpenShift pull secret from here ↩

  5. For a given DOCA package version (e.g 2.9.1) you can find the corresponding MLNX_OFED version at the link: https://linux.mellanox.com/public/repo/doca/2.9.1/SOURCES/MLNX_OFED/ which is 24.10-1.1.4.0 ↩