docs: add warning about NVMe bus path bug

Document NVMe bus path. Signed-off-by: solidDoWant <[email protected]> Signed-off-by: Andrey Smirnov <[email protected]>
siderolabs · Oct 31, 2024 · d8b6521 · d8b6521
1 parent 3e16ab1
commit d8b6521
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 9 deletions.
diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json
@@ -2245,9 +2245,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.\nWarning: 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.\nWarning: This requires special configuration for NVMe drives. For details, see \u003ca href=\"https://github.com/siderolabs/go-blockdevice/issues/114\" target=\"_blank\"\u003ehttps://github.com/siderolabs/go-blockdevice/issues/114\u003c/a\u003e.\u003c/p\u003e\n"
         }
       },
       "additionalProperties": false,

diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/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/*"'

diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
diff --git a/website/content/v1.9/reference/configuration/v1alpha1/config.md b/website/content/v1.9/reference/configuration/v1alpha1/config.md
@@ -1976,7 +1976,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` |string |<details><summary>Disk bus path.</summary>Warning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.</details> <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/*

diff --git a/website/content/v1.9/schemas/config.schema.json b/website/content/v1.9/schemas/config.schema.json
@@ -2245,9 +2245,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.\nWarning: 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.\nWarning: This requires special configuration for NVMe drives. For details, see \u003ca href=\"https://github.com/siderolabs/go-blockdevice/issues/114\" target=\"_blank\"\u003ehttps://github.com/siderolabs/go-blockdevice/issues/114\u003c/a\u003e.\u003c/p\u003e\n"
         }
       },
       "additionalProperties": false,