summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorRageLtMan <sempervictus@users.noreply.github.com>2024-09-03 12:47:50 -0400
committerGitHub <noreply@github.com>2024-09-03 18:47:50 +0200
commite3e105c0167b23c59cac7331b59860c51317748a (patch)
treec7c5222640b1f6f0dce7c77cc2fe906251345995 /docs/contributing
parentac6681ca8baab2546ba4522913147582a058de64 (diff)
downloadvyos-documentation-e3e105c0167b23c59cac7331b59860c51317748a.tar.gz
vyos-documentation-e3e105c0167b23c59cac7331b59860c51317748a.zip
T6231: Add documentation for building Mellanox OFED drivers (#1488)
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/build-vyos.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst
index ea0a4765..93b492ae 100644
--- a/docs/contributing/build-vyos.rst
+++ b/docs/contributing/build-vyos.rst
@@ -741,6 +741,38 @@ binaries in ``vyos-build/packages/linux-kernel`` from which you can copy them
to the ``vyos-build/packages`` folder for inclusion during the ISO build.
+Mellanox OFED
+^^^^^^^^^^^^^
+
+The Mellanox OFED drivers do not come from a Git repository, instead we fetch the
+tarball from Nvidia and compile the sources its contains against our kernel tree.
+
+Simply use our wrapper script to build all of the driver modules.
+
+.. code-block:: none
+
+ ./build-mellanox-ofed.sh
+ ...
+ Below is the list of OFED packages that you have chosen
+ (some may have been added by the installer due to package dependencies):
+
+ ofed-scripts
+ mlnx-tools
+ mlnx-ofed-kernel-utils
+ mlnx-ofed-kernel-modules
+ ...
+ Building packages
+ Building DEB for ofed-scripts-24.04.OFED.24.04.0.6.6 (ofed-scripts)...
+ Running /usr/bin/dpkg-buildpackage -us -uc
+ Installing ofed-scripts-24.04.OFED.24.04.0.6.6...
+ Running /usr/bin/dpkg -i --force-confmiss '/vyos/packages/linux-kernel/MLNX_OFED_SRC-debian-24.04-0.6.6.0/DEBS/debian12.1/x86_64/ofed-scripts_24.04.OFED.24.04.0.6.6-1_amd64.deb'
+ Building DEB for mlnx-tools-24.04.0 (mlnx-tools)...
+
+
+After compiling the packages you will find yourself the newly generated `*.deb`
+binaries in ``vyos-build/packages/linux-kernel`` from which you can copy them
+to the ``vyos-build/packages`` folder for inclusion during the ISO build.
+
Packages
========