From 406c844aac785819b4c7b96f16f436bddb0d65ee Mon Sep 17 00:00:00 2001 From: waleedm Date: Thu, 25 May 2023 10:47:26 +0000 Subject: [PATCH] Follow-up Add documentation for MellanoxDeviceHardwareManager Add a follow-up documentation for "update NVIDIA NIC firmware images and settings by ironic-python-agent" Icfaffd7c58c3c73c3fa28cfc2a6c954d2c93c16e Change-Id: I481cdd622f360cbba3312c6f3d4af45383bb7e1b --- doc/source/admin/hardware_managers.rst | 51 ++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/doc/source/admin/hardware_managers.rst b/doc/source/admin/hardware_managers.rst index 90e6c2985..e62cfcfd0 100644 --- a/doc/source/admin/hardware_managers.rst +++ b/doc/source/admin/hardware_managers.rst @@ -143,3 +143,54 @@ VmWare Virtual Machine File System (VMFS), and Red Hat Global File System For information on troubleshooting, and disabling this check, see :doc:`/admin/troubleshooting`. + +========================== +Custom hardware managers +========================== + +MellanoxDeviceHardwareManager +============================= + +This is a custom hardware manager for ironic-python-agent. It provides +support for Nvidia/Mellanox NICs. + +* You can get the binraies firmware for all Nvidia/Mellanox NICs from here `Nvidia firmware downloads `_ + +* And you can get the deviceID from here `Nvidia/Mellanox NICs list `_ + +* Also you can check here `MFT decumentation `_ for some supported parameters + +Clean steps +----------- + +``update_nvidia_nic_firmware_image(node, ports, images)`` + +A clean step used to update Nvidia/Mellanox NICs firmware images from the +required parameter ``images`` list. it's disabled by default. +Each image in the list is a dictionary with the following fields: + +``url`` (required) + The url of the firmware image (file://, http://). +``checksum`` (required) + checksum of the provided image. +``checksumType`` (required) + checksum type, it could be (md5/sha512/sha256). +``componentFlavor`` (required) + The PSID of the nic. +``version`` (required) + version of the firmware image , it must be the same as in the image file. + +``update_nvidia_nic_firmware_settings(node, ports, settings)`` + +A clean step used to update Nvidia/Mellanox NICs firmware settings from the +required parameter ``settings`` list. it's disabled by default. +Each settings in the list is a dictionary with the following fields: + +``deviceID`` (required) + The ID of the NIC +``globalConfig`` + The global configuration for NIC +``function0Config`` + The per-function configuration of the first port of the NIC +``function1Config`` + The per-function configuration of the second port of the NIC