Fixed docs

Signed-off-by: solidDoWant <[email protected]>
siderolabs · Oct 30, 2024 · e8b2d07 · e8b2d07
1 parent 0907aa8
commit e8b2d07
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
@@ -973,8 +973,8 @@ type InstallDiskSelector struct {
 	//     - sd
 	Type InstallDiskType `yaml:"type,omitempty"`
 	//   description: |
-	//	    Disk bus path.
-	//	    Warning: This requires special configuration for NVMe drives. For details, see https://github.com/siderolabs/go-blockdevice/issues/114.
+	//      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/website/content/v1.9/reference/configuration/v1alpha1/config.md b/website/content/v1.9/reference/configuration/v1alpha1/config.md
@@ -53,6 +53,7 @@ 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:
@@ -285,6 +286,7 @@ 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:
@@ -1853,6 +1855,7 @@ 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:
@@ -1871,6 +1874,10 @@ 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:
@@ -1902,6 +1909,10 @@ 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 >}}
 
 
@@ -1921,7 +1932,11 @@ 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 |<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>  | |
+|`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/*
+{{< /highlight >}}</details> | |