From e8b2d07396ce59f6148ce78824a03272114adeac Mon Sep 17 00:00:00 2001 From: solidDoWant Date: Wed, 30 Oct 2024 18:22:54 +0000 Subject: [PATCH] Fixed docs Signed-off-by: solidDoWant --- .../config/types/v1alpha1/v1alpha1_types.go | 4 ++-- .../reference/configuration/v1alpha1/config.md | 17 ++++++++++++++++- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go index 868c159bc3a..5bb9402abe7 100644 --- 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 index 630f09d6ae8..b481047bc74 100644 --- 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//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//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//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//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 >}} | | |`extraKernelArgs` |[]string |
Allows for supplying extra kernel args via the bootloader.Existing kernel args can be removed by prefixing the argument with a `-`.
For example `-console` removes all `console=` arguments, whereas `-console=tty0` removes the `console=tty0` default argument.
Show example(s){{< highlight yaml >}} extraKernelArgs: @@ -1902,6 +1909,10 @@ machine: diskSelector: size: '>= 1TB' # Disk size. model: WDC* # Disk model `/sys/block//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//uuid`. | | |`wwid` |string |Disk WWID `/sys/block//wwid`. | | |`type` |InstallDiskType |Disk Type. |`ssd`
`hdd`
`nvme`
`sd`
| -|`busPath` |string |
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/*"'
| | +|`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/* +{{< /highlight >}}
| |