mirror of
https://github.com/siderolabs/talos.git
synced 2025-10-10 07:01:12 +02:00
docs: add InstallConfig ignored notice to doc
Mention that `.machine.install` gets ignored on pre-installed images. Signed-off-by: Dzerom Dzenkins <dzeri96@proton.me> Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
This commit is contained in:
parent
df9b851fba
commit
a3cf416475
@ -1808,9 +1808,9 @@
|
|||||||
"install": {
|
"install": {
|
||||||
"$ref": "#/$defs/InstallConfig",
|
"$ref": "#/$defs/InstallConfig",
|
||||||
"title": "install",
|
"title": "install",
|
||||||
"description": "Used to provide instructions for installations.\n",
|
"description": "Used to provide instructions for installations.\n\nNote that this configuration section gets silently ignored by Talos images that are considered pre-installed.\nTo make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.\n",
|
||||||
"markdownDescription": "Used to provide instructions for installations.",
|
"markdownDescription": "Used to provide instructions for installations.\n\nNote that this configuration section gets silently ignored by Talos images that are considered pre-installed.\nTo make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.",
|
||||||
"x-intellij-html-description": "\u003cp\u003eUsed to provide instructions for installations.\u003c/p\u003e\n"
|
"x-intellij-html-description": "\u003cp\u003eUsed to provide instructions for installations.\u003c/p\u003e\n\n\u003cp\u003eNote that this configuration section gets silently ignored by Talos images that are considered pre-installed.\nTo make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.\u003c/p\u003e\n"
|
||||||
},
|
},
|
||||||
"files": {
|
"files": {
|
||||||
"items": {
|
"items": {
|
||||||
|
@ -747,6 +747,9 @@ type MachineConfig struct {
|
|||||||
MachineDisks []*MachineDisk `yaml:"disks,omitempty"` // Note: `size` is in units of bytes.
|
MachineDisks []*MachineDisk `yaml:"disks,omitempty"` // Note: `size` is in units of bytes.
|
||||||
// description: |
|
// description: |
|
||||||
// Used to provide instructions for installations.
|
// Used to provide instructions for installations.
|
||||||
|
//
|
||||||
|
// Note that this configuration section gets silently ignored by Talos images that are considered pre-installed.
|
||||||
|
// To make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.
|
||||||
// examples:
|
// examples:
|
||||||
// - name: MachineInstall config usage example.
|
// - name: MachineInstall config usage example.
|
||||||
// value: machineInstallExample
|
// value: machineInstallExample
|
||||||
|
@ -215,7 +215,7 @@ func init() {
|
|||||||
MachineConfigDoc.Fields[9].Name = "install"
|
MachineConfigDoc.Fields[9].Name = "install"
|
||||||
MachineConfigDoc.Fields[9].Type = "InstallConfig"
|
MachineConfigDoc.Fields[9].Type = "InstallConfig"
|
||||||
MachineConfigDoc.Fields[9].Note = ""
|
MachineConfigDoc.Fields[9].Note = ""
|
||||||
MachineConfigDoc.Fields[9].Description = "Used to provide instructions for installations."
|
MachineConfigDoc.Fields[9].Description = "Used to provide instructions for installations.\n\nNote that this configuration section gets silently ignored by Talos images that are considered pre-installed.\nTo make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted."
|
||||||
MachineConfigDoc.Fields[9].Comments[encoder.LineComment] = "Used to provide instructions for installations."
|
MachineConfigDoc.Fields[9].Comments[encoder.LineComment] = "Used to provide instructions for installations."
|
||||||
|
|
||||||
MachineConfigDoc.Fields[9].AddExample("MachineInstall config usage example.", machineInstallExample)
|
MachineConfigDoc.Fields[9].AddExample("MachineInstall config usage example.", machineInstallExample)
|
||||||
|
@ -258,7 +258,7 @@ disks:
|
|||||||
# # Precise value in bytes.
|
# # Precise value in bytes.
|
||||||
# size: 1073741824
|
# size: 1073741824
|
||||||
{{< /highlight >}}</details> | |
|
{{< /highlight >}}</details> | |
|
||||||
|`install` |<a href="#installconfig">InstallConfig</a> |Used to provide instructions for installations. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
|
|`install` |<a href="#installconfig">InstallConfig</a> |<details><summary>Used to provide instructions for installations.</summary><br />Note that this configuration section gets silently ignored by Talos images that are considered pre-installed.<br />To make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.</details> <details><summary>Show example(s)</summary>{{< highlight yaml >}}
|
||||||
install:
|
install:
|
||||||
disk: /dev/sda # The disk used for installations.
|
disk: /dev/sda # The disk used for installations.
|
||||||
# Allows for supplying extra kernel args via the bootloader.
|
# Allows for supplying extra kernel args via the bootloader.
|
||||||
|
@ -1808,9 +1808,9 @@
|
|||||||
"install": {
|
"install": {
|
||||||
"$ref": "#/$defs/InstallConfig",
|
"$ref": "#/$defs/InstallConfig",
|
||||||
"title": "install",
|
"title": "install",
|
||||||
"description": "Used to provide instructions for installations.\n",
|
"description": "Used to provide instructions for installations.\n\nNote that this configuration section gets silently ignored by Talos images that are considered pre-installed.\nTo make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.\n",
|
||||||
"markdownDescription": "Used to provide instructions for installations.",
|
"markdownDescription": "Used to provide instructions for installations.\n\nNote that this configuration section gets silently ignored by Talos images that are considered pre-installed.\nTo make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.",
|
||||||
"x-intellij-html-description": "\u003cp\u003eUsed to provide instructions for installations.\u003c/p\u003e\n"
|
"x-intellij-html-description": "\u003cp\u003eUsed to provide instructions for installations.\u003c/p\u003e\n\n\u003cp\u003eNote that this configuration section gets silently ignored by Talos images that are considered pre-installed.\nTo make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.\u003c/p\u003e\n"
|
||||||
},
|
},
|
||||||
"files": {
|
"files": {
|
||||||
"items": {
|
"items": {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user