fix: pci driver rebind config validation

We need a field named `name` to distinguish between named documents, as decoder expects a `name` yaml key. Fixes: #10025 Fixes by using standard `name` field instead of `pciID`. Signed-off-by: Noel Georgi <[email protected]>
siderolabs · Dec 25, 2024 · 7e5d36d · 7e5d36d
1 parent 4b97bbc
commit 7e5d36d
Show file tree

Hide file tree

Showing 8 changed files with 11 additions and 52 deletions.
diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json
@@ -187,9 +187,9 @@
           "markdownDescription": "kind is the kind of the resource.",
           "x-intellij-html-description": "\u003cp\u003ekind is the kind of the resource.\u003c/p\u003e\n"
         },
-        "pciID": {
+        "name": {
           "type": "string",
-          "title": "pciID",
+          "title": "name",
           "description": "PCI device id\n",
           "markdownDescription": "PCI device id",
           "x-intellij-html-description": "\u003cp\u003ePCI device id\u003c/p\u003e\n"
@@ -207,7 +207,7 @@
       "required": [
         "apiVersion",
         "kind",
-        "pciID",
+        "name",
         "targetDriver"
       ]
     },

diff --git a/pkg/machinery/config/types/hardware/hardware_doc.go b/pkg/machinery/config/types/hardware/hardware_doc.go
diff --git a/pkg/machinery/config/types/hardware/pci_driver_rebind_config.go b/pkg/machinery/config/types/hardware/pci_driver_rebind_config.go
@@ -51,7 +51,7 @@ type PCIDriverRebindConfigV1Alpha1 struct {
 	//   description: |
 	//     PCI device id
 	//   schemaRequired: true
-	MetaName string `yaml:"pciID"`
+	MetaName string `yaml:"name"`
 	//   description: |
 	//     Target driver to rebind the PCI device to.
 	//   schemaRequired: true

diff --git a/pkg/machinery/config/types/hardware/testdata/pcidriverrebindconfig.yaml b/pkg/machinery/config/types/hardware/testdata/pcidriverrebindconfig.yaml
@@ -1,4 +1,4 @@
 apiVersion: v1alpha1
 kind: PCIDriverRebindConfig
-pciID: "0000:04:00.00"
+name: "0000:04:00.00"
 targetDriver: vfio-pci
diff --git a/website/content/v1.10/reference/configuration/hardware/pcidriverrebindconfig.md b/website/content/v1.10/reference/configuration/hardware/pcidriverrebindconfig.md
@@ -16,14 +16,14 @@ title: PCIDriverRebindConfig
 {{< highlight yaml >}}
 apiVersion: v1alpha1
 kind: PCIDriverRebindConfig
-pciID: 0000:04:00.00 # PCI device id
+name: 0000:04:00.00 # PCI device id
 targetDriver: vfio-pci # Target driver to rebind the PCI device to.
 {{< /highlight >}}
 
 
 | Field | Type | Description | Value(s) |
 |-------|------|-------------|----------|
-|`pciID` |string |PCI device id  | |
+|`name` |string |PCI device id  | |
 |`targetDriver` |string |Target driver to rebind the PCI device to.  | |
 
 

diff --git a/website/content/v1.10/schemas/config.schema.json b/website/content/v1.10/schemas/config.schema.json
@@ -187,9 +187,9 @@
           "markdownDescription": "kind is the kind of the resource.",
           "x-intellij-html-description": "\u003cp\u003ekind is the kind of the resource.\u003c/p\u003e\n"
         },
-        "pciID": {
+        "name": {
           "type": "string",
-          "title": "pciID",
+          "title": "name",
           "description": "PCI device id\n",
           "markdownDescription": "PCI device id",
           "x-intellij-html-description": "\u003cp\u003ePCI device id\u003c/p\u003e\n"
@@ -207,7 +207,7 @@
       "required": [
         "apiVersion",
         "kind",
-        "pciID",
+        "name",
         "targetDriver"
       ]
     },

diff --git a/website/content/v1.9/reference/configuration/hardware/_index.md b/website/content/v1.9/reference/configuration/hardware/_index.md
diff --git a/website/content/v1.9/reference/configuration/hardware/pcidriverrebindconfig.md b/website/content/v1.9/reference/configuration/hardware/pcidriverrebindconfig.md