docs: re-word talos_version

Re-word `talos_version`. Signed-off-by: Noel Georgi <[email protected]>
siderolabs · Jan 4, 2023 · 158dbbd · 158dbbd
1 parent f3b4a5b
commit 158dbbd
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/resources/machine_configuration_controlplane.md b/docs/resources/machine_configuration_controlplane.md
@@ -42,7 +42,7 @@ resource "talos_machine_configuration_controlplane" "machineconfig_cp" {
 - `docs_enabled` (Boolean) whether to render all machine configs adding the documentation for each field
 - `examples_enabled` (Boolean) whether to render all machine configs with the commented examples
 - `kubernetes_version` (String) desired kubernetes version to run
-- `talos_version` (String) The version of Talos for which to generate configs. **Note**: This parameter defines the machine config schema version generated. To override the installer image (and actually install a different version of talos than the default) please use a config patch.
+- `talos_version` (String) The version of Talos for which to generate configs. **Note**: This parameter defines the desired Talos schema version of configuration generated for backwards compatibility. To change the version of Talos installed, please use a config patch.
 
 ### Read-Only
 

diff --git a/docs/resources/machine_configuration_worker.md b/docs/resources/machine_configuration_worker.md
@@ -42,7 +42,7 @@ resource "talos_machine_configuration_worker" "machineconfig_worker" {
 - `docs_enabled` (Boolean) whether to render all machine configs adding the documentation for each field
 - `examples_enabled` (Boolean) whether to render all machine configs with the commented examples
 - `kubernetes_version` (String) desired kubernetes version to run
-- `talos_version` (String) The version of Talos for which to generate configs. **Note**: This parameter defines the machine config schema version generated. To override the installer image (and actually install a different version of talos than the default) please use a config patch.
+- `talos_version` (String) The version of Talos for which to generate configs. **Note**: This parameter defines the desired Talos schema version of configuration generated for backwards compatibility. To change the version of Talos installed, please use a config patch.
 
 ### Read-Only
 

diff --git a/talos/resource_talos_machine_configuration_controlplane.go b/talos/resource_talos_machine_configuration_controlplane.go
@@ -69,7 +69,7 @@ func resourceTalosMachineConfigurationControlPlane() *schema.Resource {
 			"talos_version": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "The version of Talos for which to generate configs. **Note**: This parameter defines the machine config schema version generated. To override the installer image (and actually install a different version of talos than the default) please use a config patch.",
+				Description: "The version of Talos for which to generate configs. **Note**: This parameter defines the desired Talos schema version of configuration generated for backwards compatibility. To change the version of Talos installed, please use a config patch.",
 				ValidateDiagFunc: func(v interface{}, p cty.Path) diag.Diagnostics {
 					value := v.(string)
 					_, err := validateVersionContract(value)

diff --git a/talos/resource_talos_machine_configuration_worker.go b/talos/resource_talos_machine_configuration_worker.go
@@ -65,7 +65,7 @@ func resourceTalosMachineConfigurationWorker() *schema.Resource {
 			"talos_version": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "The version of Talos for which to generate configs. **Note**: This parameter defines the machine config schema version generated. To override the installer image (and actually install a different version of talos than the default) please use a config patch.",
+				Description: "The version of Talos for which to generate configs. **Note**: This parameter defines the desired Talos schema version of configuration generated for backwards compatibility. To change the version of Talos installed, please use a config patch.",
 				ValidateDiagFunc: func(v interface{}, p cty.Path) diag.Diagnostics {
 					value := v.(string)
 					_, err := validateVersionContract(value)