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>
siderolabs · Mar 20, 2023 · a3cf416 · a3cf416
1 parent df9b851
commit a3cf416
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 8 deletions.
diff --git a/pkg/machinery/config/types/v1alpha1/schemas/v1alpha1_config.schema.json b/pkg/machinery/config/types/v1alpha1/schemas/v1alpha1_config.schema.json
@@ -1808,9 +1808,9 @@
         "install": {
           "$ref": "#/$defs/InstallConfig",
           "title": "install",
-          "description": "Used to provide instructions for installations.\n",
-          "markdownDescription": "Used to provide instructions for installations.",
-          "x-intellij-html-description": "\u003cp\u003eUsed to provide instructions for installations.\u003c/p\u003e\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.\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\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": {
           "items": {

diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
@@ -747,6 +747,9 @@ type MachineConfig struct {
 	MachineDisks []*MachineDisk `yaml:"disks,omitempty"` // Note: `size` is in units of bytes.
 	//   description: |
 	//     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:
 	//     - name: MachineInstall config usage example.
 	//       value: machineInstallExample

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.4/reference/configuration.md b/website/content/v1.4/reference/configuration.md
@@ -258,7 +258,7 @@ disks:
           # # Precise value in bytes.
           # size: 1073741824
 {{< /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:
     disk: /dev/sda # The disk used for installations.
     # Allows for supplying extra kernel args via the bootloader.

diff --git a/website/content/v1.4/schemas/v1alpha1_config.schema.json b/website/content/v1.4/schemas/v1alpha1_config.schema.json
@@ -1808,9 +1808,9 @@
         "install": {
           "$ref": "#/$defs/InstallConfig",
           "title": "install",
-          "description": "Used to provide instructions for installations.\n",
-          "markdownDescription": "Used to provide instructions for installations.",
-          "x-intellij-html-description": "\u003cp\u003eUsed to provide instructions for installations.\u003c/p\u003e\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.\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\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": {
           "items": {