diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json index 97c0c0a11e..a65352f266 100644 --- 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 index 0e1ffe938f..0834a6a908 100644 --- 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 index 42e1385e00..c2e97e798f 100644 --- a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go +++ b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go @@ -1150,7 +1150,7 @@ func (InstallDiskSelector) Doc() *encoder.Doc { Name: "busPath", Type: "string", Note: "", - Description: "Disk bus path.", + Description: "Disk bus path.\nWarning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.", Comments: [3]string{"" /* encoder.HeadComment */, "Disk bus path." /* encoder.LineComment */, "" /* encoder.FootComment */}, }, }, diff --git a/website/content/v1.9/reference/configuration/v1alpha1/config.md b/website/content/v1.9/reference/configuration/v1alpha1/config.md index 108c046526..cb315cc783 100644 --- 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//uuid`. | | |`wwid` |string |Disk WWID `/sys/block//wwid`. | | |`type` |InstallDiskType |Disk Type. |`ssd`
`hdd`
`nvme`
`sd`
| -|`busPath` |string |Disk bus path.
Show example(s){{< highlight yaml >}} +|`busPath` |string |
Disk bus path.Warning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.
Show example(s){{< 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 index 97c0c0a11e..a65352f266 100644 --- 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,