chore: default talos_machine_configuration docs and examples to false

Generating talos machine configs with docs and examples enabled makes them too large. Fixes #181 Signed-off-by: Noel Georgi <[email protected]>
siderolabs · Aug 5, 2024 · d614bcc · d614bcc
1 parent 80c5534
commit d614bcc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 14 deletions.
diff --git a/pkg/talos/talos_machine_configuration_data_source.go b/pkg/talos/talos_machine_configuration_data_source.go
@@ -197,15 +197,6 @@ func (d *talosMachineConfigurationDataSource) Read(ctx context.Context, req data
 		return
 	}
 
-	// set default values
-	if !state.Docs.IsUnknown() && state.Docs.IsNull() {
-		state.Docs = basetypes.NewBoolValue(true)
-	}
-
-	if !state.Examples.IsUnknown() && state.Examples.IsNull() {
-		state.Examples = basetypes.NewBoolValue(true)
-	}
-
 	if !state.KubernetesVersion.IsUnknown() && state.KubernetesVersion.IsNull() {
 		state.KubernetesVersion = basetypes.NewStringValue(constants.DefaultKubernetesVersion)
 	}

diff --git a/pkg/talos/talos_machine_configuration_data_source_test.go b/pkg/talos/talos_machine_configuration_data_source_test.go
@@ -157,8 +157,8 @@ func TestAccTalosMachineConfigurationDataSource(t *testing.T) {
 							constants.DefaultKubernetesVersion,
 							"controlplane",
 							value,
-							true,
 							false,
+							true,
 							func(t *testing.T, config v1alpha1.Config) error {
 								assert.NotEmpty(t, config.Cluster().AESCBCEncryptionSecret())
 								assert.Empty(t, config.Cluster().SecretboxEncryptionSecret())
@@ -351,14 +351,18 @@ func validateGeneratedTalosMachineConfig(
 	if examples {
 		// verifying there's examples
 		assert.Contains(t, mc, (`
-        # diskSelector:
-        #     size: 4GB # Disk size.
+    #   # Uncomment this to enable SANs.
+    #   - 10.0.0.10
+    #   - 172.16.0.10
+    #   - 192.168.0.10
 `))
 	} else {
 		// verifying there's no examples
 		assert.NotContains(t, mc, (`
-	        # diskSelector:
-	        #     size: 4GB # Disk size.
+    #   # Uncomment this to enable SANs.
+    #   - 10.0.0.10
+    #   - 172.16.0.10
+    #   - 192.168.0.10
 `))
 	}