Extend NicFirmwareSource CR with BFB URL Source

almaslennikov · almaslennikov · commit d225adb62f18 · 2025-07-10T08:57:03.000+02:00
Signed-off-by: Alexander Maslennikov &lt;amaslennikov@nvidia.com&gt;
diff --git a/README.md b/README.md
@@ -135,6 +135,15 @@ spec:
   # a list of firmware binaries from mlnx website if they are zipped try to unzip before placing
   binUrlSources:
     - https://www.mellanox.com/downloads/firmware/fw-ConnectX6Dx-rel-22_44_1036-MCX623106AC-CDA_Ax-UEFI-14.37.14-FlexBoot-3.7.500.signed.bin.zip
+  bfbUrlSource: https://example.com/bluefield3-31.41.0.bfb
+status:
+  state: Success
+  binaryVersions:
+    22.44.1036:
+    - mt_0000000436
+  bfbVersions:
+    a2dc: 34.41.0 # BF3 NIC FW
+    a2d6: 25.21.0 # BF2 NIC FW
 ```
 
 ### NICFirmwareTemplate
diff --git a/api/v1alpha1/nicfirmwaresource_types.go b/api/v1alpha1/nicfirmwaresource_types.go
@@ -18,11 +18,15 @@ package v1alpha1
 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 // NicFirmwareSourceSpec represents a list of url sources for FW
+// +kubebuilder:validation:XValidation:rule="size(self.binUrlSources) > 0 || size(self.bfbUrlSource) > 0",message="At least one of binUrlSources or bfbUrlSource must be specified"
 type NicFirmwareSourceSpec struct {
-	// BinUrlSources represents a list of url sources for FW
+	// BinUrlSources represents a list of url sources for ConnectX Firmware
 	// +kubebuilder:validation:MinItems=1
-	// +required
-	BinUrlSources []string `json:"binUrlSources"`
+	// +optional
+	BinUrlSources []string `json:"binUrlSources,omitempty"`
+	// BFBUrlSource represents a url source for BlueField Bundle
+	// +optional
+	BFBUrlSource string `json:"bfbUrlSource,omitempty"`
 }
 
 // NicFirmwareSourceStatus represents the status of the FW from given sources, e.g. version available for PSIDs
@@ -33,9 +37,11 @@ type NicFirmwareSourceStatus struct {
 	State string `json:"state"`
 	// Reason shows an error message if occurred
 	Reason string `json:"reason,omitempty"`
-	// Versions is a map of available FW versions to PSIDs
+	// Versions is a map of available FW binaries versions to PSIDs
 	// a PSID should have only a single FW version available for it
-	Versions map[string][]string `json:"versions,omitempty"`
+	BinaryVersions map[string][]string `json:"binaryVersions,omitempty"`
+	// BFBVersions represents the FW versions available in the provided BFB bundle
+	BFBVersions map[string]string `json:"bfbVersions,omitempty"`
 }
 
 //+kubebuilder:object:root=true
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/configuration.net.nvidia.com_nicfirmwaresources.yaml b/config/crd/bases/configuration.net.nvidia.com_nicfirmwaresources.yaml
@@ -40,19 +40,39 @@ spec:
             description: NicFirmwareSourceSpec represents a list of url sources for
               FW
             properties:
+              bfbUrlSource:
+                description: BFBUrlSource represents a url source for BlueField Bundle
+                type: string
               binUrlSources:
-                description: BinUrlSources represents a list of url sources for FW
+                description: BinUrlSources represents a list of url sources for ConnectX
+                  Firmware
                 items:
                   type: string
                 minItems: 1
                 type: array
-            required:
-            - binUrlSources
             type: object
+            x-kubernetes-validations:
+            - message: At least one of binUrlSources or bfbUrlSource must be specified
+              rule: size(self.binUrlSources) > 0 || size(self.bfbUrlSource) > 0
           status:
             description: NicFirmwareSourceStatus represents the status of the FW from
               given sources, e.g. version available for PSIDs
             properties:
+              bfbVersions:
+                additionalProperties:
+                  type: string
+                description: BFBVersions represents the FW versions available in the
+                  provided BFB bundle
+                type: object
+              binaryVersions:
+                additionalProperties:
+                  items:
+                    type: string
+                  type: array
+                description: |-
+                  Versions is a map of available FW binaries versions to PSIDs
+                  a PSID should have only a single FW version available for it
+                type: object
               reason:
                 description: Reason shows an error message if occurred
                 type: string
@@ -66,15 +86,6 @@ spec:
                 - DownloadFailed
                 - CacheVerificationFailed
                 type: string
-              versions:
-                additionalProperties:
-                  items:
-                    type: string
-                  type: array
-                description: |-
-                  Versions is a map of available FW versions to PSIDs
-                  a PSID should have only a single FW version available for it
-                type: object
             required:
             - state
             type: object
diff --git a/deployment/nic-configuration-operator-chart/crds/configuration.net.nvidia.com_nicfirmwaresources.yaml b/deployment/nic-configuration-operator-chart/crds/configuration.net.nvidia.com_nicfirmwaresources.yaml
@@ -40,19 +40,39 @@ spec:
             description: NicFirmwareSourceSpec represents a list of url sources for
               FW
             properties:
+              bfbUrlSource:
+                description: BFBUrlSource represents a url source for BlueField Bundle
+                type: string
               binUrlSources:
-                description: BinUrlSources represents a list of url sources for FW
+                description: BinUrlSources represents a list of url sources for ConnectX
+                  Firmware
                 items:
                   type: string
                 minItems: 1
                 type: array
-            required:
-            - binUrlSources
             type: object
+            x-kubernetes-validations:
+            - message: At least one of binUrlSources or bfbUrlSource must be specified
+              rule: size(self.binUrlSources) > 0 || size(self.bfbUrlSource) > 0
           status:
             description: NicFirmwareSourceStatus represents the status of the FW from
               given sources, e.g. version available for PSIDs
             properties:
+              bfbVersions:
+                additionalProperties:
+                  type: string
+                description: BFBVersions represents the FW versions available in the
+                  provided BFB bundle
+                type: object
+              binaryVersions:
+                additionalProperties:
+                  items:
+                    type: string
+                  type: array
+                description: |-
+                  Versions is a map of available FW binaries versions to PSIDs
+                  a PSID should have only a single FW version available for it
+                type: object
               reason:
                 description: Reason shows an error message if occurred
                 type: string
@@ -66,15 +86,6 @@ spec:
                 - DownloadFailed
                 - CacheVerificationFailed
                 type: string
-              versions:
-                additionalProperties:
-                  items:
-                    type: string
-                  type: array
-                description: |-
-                  Versions is a map of available FW versions to PSIDs
-                  a PSID should have only a single FW version available for it
-                type: object
             required:
             - state
             type: object
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -57,7 +57,7 @@ ConfigurationTemplateSpec is a set of configurations for the NICs
 
 ### FirmwareTemplateSpec
 
-(*Appears on:*[NicFirmwareTemplateSpec](#NicFirmwareTemplateSpec))
+(*Appears on:*[NicDeviceSpec](#NicDeviceSpec), [NicFirmwareTemplateSpec](#NicFirmwareTemplateSpec))
 
 FirmwareTemplateSpec specifies a FW update policy for a given FW source ref
 
@@ -183,7 +183,7 @@ each PF - Mstconfig -d set ADVANCED_PCI_SETTINGS=1 * Node reboot - Applies new N
 </tr>
 <tr>
 <td><code>status</code><br />
-<em><a href="#NicConfigurationTemplateStatus">NicConfigurationTemplateStatus</a></em></td>
+<em><a href="#NicTemplateStatus">NicTemplateStatus</a></em></td>
 <td><p>Defines the observed state of NicConfigurationTemplate</p></td>
 </tr>
 </tbody>
@@ -232,32 +232,6 @@ each PF - Mstconfig -d set ADVANCED_PCI_SETTINGS=1 * Node reboot - Applies new N
 </tbody>
 </table>
 
-### NicConfigurationTemplateStatus
-
-(*Appears on:*[NicConfigurationTemplate](#NicConfigurationTemplate))
-
-NicConfigurationTemplateStatus defines the observed state of NicConfigurationTemplate
-
-<table>
-<colgroup>
-<col style="width: 50%" />
-<col style="width: 50%" />
-</colgroup>
-<thead>
-<tr>
-<th>Field</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td><code>nicDevices</code><br />
-<em>[]string</em></td>
-<td><p>NicDevice CRs matching this configuration template</p></td>
-</tr>
-</tbody>
-</table>
-
 ### NicDevice
 
 NicDevice is the Schema for the nicdevices API
@@ -295,6 +269,11 @@ NicDevice is the Schema for the nicdevices API
 <em><a href="#NicDeviceConfigurationSpec">NicDeviceConfigurationSpec</a></em></td>
 <td><p>Configuration specifies the configuration requested by NicConfigurationTemplate</p></td>
 </tr>
+<tr>
+<td><code>firmware</code><br />
+<em><a href="#FirmwareTemplateSpec">FirmwareTemplateSpec</a></em></td>
+<td><p>Firmware specifies the fw upgrade policy requested by NicFirmwareTemplate</p></td>
+</tr>
 </tbody>
 </table></td>
 </tr>
@@ -398,6 +377,11 @@ NicDeviceSpec defines the desired state of NicDevice
 <em><a href="#NicDeviceConfigurationSpec">NicDeviceConfigurationSpec</a></em></td>
 <td><p>Configuration specifies the configuration requested by NicConfigurationTemplate</p></td>
 </tr>
+<tr>
+<td><code>firmware</code><br />
+<em><a href="#FirmwareTemplateSpec">FirmwareTemplateSpec</a></em></td>
+<td><p>Firmware specifies the fw upgrade policy requested by NicFirmwareTemplate</p></td>
+</tr>
 </tbody>
 </table>
 
@@ -497,7 +481,14 @@ NicFirmwareSource is the Schema for the nicfirmwaresources API
 <tr>
 <td><code>binUrlSources</code><br />
 <em>[]string</em></td>
-<td><p>BinUrlSources represents a list of url sources for FW</p></td>
+<td><em>(Optional)</em>
+<p>BinUrlSources represents a list of url sources for ConnectX Firmware</p></td>
+</tr>
+<tr>
+<td><code>bfbUrlSource</code><br />
+<em>string</em></td>
+<td><em>(Optional)</em>
+<p>BFBUrlSource represents a url source for BlueField Bundle</p></td>
 </tr>
 </tbody>
 </table></td>
@@ -531,7 +522,14 @@ NicFirmwareSourceSpec represents a list of url sources for FW
 <tr>
 <td><code>binUrlSources</code><br />
 <em>[]string</em></td>
-<td><p>BinUrlSources represents a list of url sources for FW</p></td>
+<td><em>(Optional)</em>
+<p>BinUrlSources represents a list of url sources for ConnectX Firmware</p></td>
+</tr>
+<tr>
+<td><code>bfbUrlSource</code><br />
+<em>string</em></td>
+<td><em>(Optional)</em>
+<p>BFBUrlSource represents a url source for BlueField Bundle</p></td>
 </tr>
 </tbody>
 </table>
@@ -569,6 +567,11 @@ NicFirmwareSourceStatus represents the status of the FW from given sources, e.g.
 <em>map[string][]string</em></td>
 <td><p>Versions is a map of available FW versions to PSIDs a PSID should have only a single FW version available for it</p></td>
 </tr>
+<tr>
+<td><code>bfbVersions</code><br />
+<em>map[string]string</em></td>
+<td><p>BFBVersions represents the FW versions available in the provided BFB bundle</p></td>
+</tr>
 </tbody>
 </table>
 
@@ -624,7 +627,7 @@ NicFirmwareTemplate is the Schema for the nicfirmwaretemplates API
 </tr>
 <tr>
 <td><code>status</code><br />
-<em><a href="#NicFirmwareTemplateStatus">NicFirmwareTemplateStatus</a></em></td>
+<em><a href="#NicTemplateStatus">NicTemplateStatus</a></em></td>
 <td></td>
 </tr>
 </tbody>
@@ -666,11 +669,12 @@ NicFirmwareTemplateSpec defines the FW templates and node/nic selectors for it
 </tbody>
 </table>
 
-### NicFirmwareTemplateStatus
+### NicSelectorSpec
 
-(*Appears on:*[NicFirmwareTemplate](#NicFirmwareTemplate))
+(*Appears on:*[NicConfigurationTemplateSpec](#NicConfigurationTemplateSpec),
+[NicFirmwareTemplateSpec](#NicFirmwareTemplateSpec))
 
-NicFirmwareTemplateStatus lists the NicDevice CRs matching the FW template
+NicSelectorSpec is a desired configuration for NICs
 
 <table>
 <colgroup>
@@ -685,19 +689,28 @@ NicFirmwareTemplateStatus lists the NicDevice CRs matching the FW template
 </thead>
 <tbody>
 <tr>
-<td><code>nicDevices</code><br />
+<td><code>nicType</code><br />
+<em>string</em></td>
+<td><p>Type of the NIC to be selected, e.g. 101d,1015,a2d6 etc.</p></td>
+</tr>
+<tr>
+<td><code>pciAddresses</code><br />
+<em>[]string</em></td>
+<td><p>Array of PCI addresses to be selected, e.g. “0000:03:00.0”</p></td>
+</tr>
+<tr>
+<td><code>serialNumbers</code><br />
 <em>[]string</em></td>
-<td><p>NicDevice CRs matching this firmware template</p></td>
+<td><p>Serial numbers of the NICs to be selected, e.g. MT2116X09299</p></td>
 </tr>
 </tbody>
 </table>
 
-### NicSelectorSpec
+### NicTemplateStatus
 
-(*Appears on:*[NicConfigurationTemplateSpec](#NicConfigurationTemplateSpec),
-[NicFirmwareTemplateSpec](#NicFirmwareTemplateSpec))
+(*Appears on:*[NicConfigurationTemplate](#NicConfigurationTemplate), [NicFirmwareTemplate](#NicFirmwareTemplate))
 
-NicSelectorSpec is a desired configuration for NICs
+NicTemplateStatus defines the observed state of NicConfigurationTemplate and NicFirmwareTemplate
 
 <table>
 <colgroup>
@@ -712,19 +725,9 @@ NicSelectorSpec is a desired configuration for NICs
 </thead>
 <tbody>
 <tr>
-<td><code>nicType</code><br />
-<em>string</em></td>
-<td><p>Type of the NIC to be selected, e.g. 101d,1015,a2d6 etc.</p></td>
-</tr>
-<tr>
-<td><code>pciAddresses</code><br />
-<em>[]string</em></td>
-<td><p>Array of PCI addresses to be selected, e.g. “0000:03:00.0”</p></td>
-</tr>
-<tr>
-<td><code>serialNumbers</code><br />
+<td><code>nicDevices</code><br />
 <em>[]string</em></td>
-<td><p>Serial numbers of the NICs to be selected, e.g. MT2116X09299</p></td>
+<td><p>NicDevice CRs matching this configuration / firmware template</p></td>
 </tr>
 </tbody>
 </table>
@@ -829,4 +832,4 @@ RoceOptimizedSpec specifies RoCE optimization settings
 
 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
-*Generated with `gen-crd-api-reference-docs` on git commit `7bb08b0`.*
+*Generated with `gen-crd-api-reference-docs` on git commit `5c0e1e9`.*
