Added warning about NVMe bus path bug

Signed-off-by: solidDoWant <[email protected]>

pkg/machinery/config/schemas/config.schema.json

@@ -2225,9 +2225,9 @@
         "busPath": {
           "type": "string",
           "title": "busPath",
-          "description": "Disk bus path.\n",
-          "markdownDescription": "Disk bus path.",
-          "x-intellij-html-description": "\u003cp\u003eDisk bus path.\u003c/p\u003e\n"
+          "description": "Disk bus path.\nWarning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.\n",
+          "markdownDescription": "Disk bus path. Warning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.",
+          "x-intellij-html-description": "\u003cp\u003eDisk bus path.\u003c/p\u003e\nWarning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.\n"
         }
       },
       "additionalProperties": false,

pkg/machinery/config/types/v1alpha1/v1alpha1_types.go

@@ -972,7 +972,9 @@ type InstallDiskSelector struct {
 	//     - nvme
 	//     - sd
 	Type InstallDiskType `yaml:"type,omitempty"`
-	//   description: Disk bus path.
+	//   description: |
+	//	    Disk bus path.
+	//	    Warning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.
 	//   examples:
 	//     - value: '"/pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0"'
 	//     - value: '"/pci0000:00/*"'

website/content/v1.9/reference/configuration/v1alpha1/config.md

@@ -53,7 +53,6 @@ machine:
         # diskSelector:
         #     size: 4GB # Disk size.
         #     model: WDC* # Disk model `/sys/block/<dev>/device/model`.
-        #     busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0 # Disk bus path.
 
         # # Allows for supplying additional system extension images to install on top of base Talos image.
         # extensions:
@@ -286,7 +285,6 @@ install:
     # diskSelector:
     #     size: 4GB # Disk size.
     #     model: WDC* # Disk model `/sys/block/<dev>/device/model`.
-    #     busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0 # Disk bus path.
 
     # # Allows for supplying additional system extension images to install on top of base Talos image.
     # extensions:
@@ -1855,7 +1853,6 @@ machine:
         # diskSelector:
         #     size: 4GB # Disk size.
         #     model: WDC* # Disk model `/sys/block/<dev>/device/model`.
-        #     busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0 # Disk bus path.
 
         # # Allows for supplying additional system extension images to install on top of base Talos image.
         # extensions:
@@ -1874,10 +1871,6 @@ disk: /dev/nvme0
 diskSelector:
     size: '>= 1TB' # Disk size.
     model: WDC* # Disk model `/sys/block/<dev>/device/model`.
-
-    # # Disk bus path.
-    # busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0
-    # busPath: /pci0000:00/*
 {{< /highlight >}}</details> | |
 |`extraKernelArgs` |[]string |<details><summary>Allows for supplying extra kernel args via the bootloader.</summary>Existing kernel args can be removed by prefixing the argument with a `-`.<br />For example `-console` removes all `console=<value>` arguments, whereas `-console=tty0` removes the `console=tty0` default argument.</details> <details><summary>Show example(s)</summary>{{< highlight yaml >}}
 extraKernelArgs:
@@ -1909,10 +1902,6 @@ machine:
         diskSelector:
             size: '>= 1TB' # Disk size.
             model: WDC* # Disk model `/sys/block/<dev>/device/model`.
-
-            # # Disk bus path.
-            # busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0
-            # busPath: /pci0000:00/*
 {{< /highlight >}}
 
 
@@ -1932,11 +1921,7 @@ size: <= 2TB
 |`uuid` |string |Disk UUID `/sys/block/<dev>/uuid`.  | |
 |`wwid` |string |Disk WWID `/sys/block/<dev>/wwid`.  | |
 |`type` |InstallDiskType |Disk Type.  |`ssd`<br />`hdd`<br />`nvme`<br />`sd`<br /> |
-|`busPath` |string |Disk bus path. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
-busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0
-{{< /highlight >}}{{< highlight yaml >}}
-busPath: /pci0000:00/*
-{{< /highlight >}}</details> | |
+|`busPath` |string |<details><summary>description: |</summary>    Disk bus path.<br />    Warning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.<br />  examples:<br />    - value: '"/pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0"'<br />    - value: '"/pci0000:00/*"'<br /></details>  | |
 
 
 

website/content/v1.9/schemas/config.schema.json

@@ -2225,9 +2225,9 @@
         "busPath": {
           "type": "string",
           "title": "busPath",
-          "description": "Disk bus path.\n",
-          "markdownDescription": "Disk bus path.",
-          "x-intellij-html-description": "\u003cp\u003eDisk bus path.\u003c/p\u003e\n"
+          "description": "Disk bus path.\nWarning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.\n",
+          "markdownDescription": "Disk bus path. Warning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.",
+          "x-intellij-html-description": "\u003cp\u003eDisk bus path.\u003c/p\u003e\nWarning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.\n"
         }
       },
       "additionalProperties": false,