feat: add a helper module to generate standard patches

smira · shanduur · commit f17d07cb7a36 · 2026-02-06T09:28:58.000+01:00
Allow some patches to be generated correctly according to the version contract of the machine configuration. Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com> (cherry picked from commit a907831)
diff --git a/pkg/machinery/config/generate/stdpatches/stdpatches.go b/pkg/machinery/config/generate/stdpatches/stdpatches.go
@@ -0,0 +1,50 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+// Package stdpatches contains standard patches applied to Talos machine configurations.
+package stdpatches
+
+import (
+	"github.com/siderolabs/go-pointer"
+	"go.yaml.in/yaml/v4"
+
+	"github.com/siderolabs/talos/pkg/machinery/config"
+	configconfig "github.com/siderolabs/talos/pkg/machinery/config/config"
+	"github.com/siderolabs/talos/pkg/machinery/config/container"
+	"github.com/siderolabs/talos/pkg/machinery/config/encoder"
+	"github.com/siderolabs/talos/pkg/machinery/config/types/network"
+	"github.com/siderolabs/talos/pkg/machinery/nethelpers"
+)
+
+// WithStaticHostname returns a patch that sets a static hostname in the machine configuration.
+func WithStaticHostname(versionContract *config.VersionContract, hostname string) ([]byte, error) {
+	if versionContract.MultidocNetworkConfigSupported() {
+		hostnameConfig := network.NewHostnameConfigV1Alpha1()
+		hostnameConfig.ConfigAuto = pointer.To(nethelpers.AutoHostnameKindOff)
+		hostnameConfig.ConfigHostname = hostname
+
+		return patchFromDocument(hostnameConfig)
+	}
+
+	return patchFromV1Alpha1(map[string]any{
+		"machine": map[string]any{
+			"network": map[string]any{
+				"hostname": hostname,
+			},
+		},
+	})
+}
+
+func patchFromDocument(doc configconfig.Document) ([]byte, error) {
+	ctr, err := container.New(doc)
+	if err != nil {
+		return nil, err
+	}
+
+	return ctr.EncodeBytes(encoder.WithComments(encoder.CommentsDisabled))
+}
+
+func patchFromV1Alpha1(doc any) ([]byte, error) {
+	return yaml.Marshal(doc)
+}
diff --git a/pkg/machinery/config/generate/stdpatches/stdpatches_test.go b/pkg/machinery/config/generate/stdpatches/stdpatches_test.go
@@ -0,0 +1,104 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package stdpatches_test
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/siderolabs/talos/pkg/machinery/config"
+	"github.com/siderolabs/talos/pkg/machinery/config/configpatcher"
+	"github.com/siderolabs/talos/pkg/machinery/config/generate"
+	"github.com/siderolabs/talos/pkg/machinery/config/generate/stdpatches"
+	"github.com/siderolabs/talos/pkg/machinery/config/machine"
+	"github.com/siderolabs/talos/pkg/machinery/config/validation"
+)
+
+func TestPatches(t *testing.T) {
+	t.Parallel()
+
+	for _, test := range []struct {
+		name string
+
+		patch             func(*config.VersionContract) ([]byte, error)
+		versionContracts  []*config.VersionContract
+		kubernetesVersion string
+
+		assertion func(t *testing.T, cfg config.Config)
+	}{
+		{
+			name: "WithStaticHostname",
+
+			patch: func(vc *config.VersionContract) ([]byte, error) {
+				return stdpatches.WithStaticHostname(vc, "hostname-1")
+			},
+
+			versionContracts: []*config.VersionContract{
+				config.TalosVersion1_11,
+				config.TalosVersion1_12,
+			},
+			kubernetesVersion: "1.34.0",
+
+			assertion: func(t *testing.T, cfg config.Config) {
+				assert.Equal(t, "hostname-1", cfg.NetworkHostnameConfig().Hostname())
+			},
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+
+			for _, vc := range test.versionContracts {
+				t.Run(vc.String(), func(t *testing.T) {
+					t.Parallel()
+
+					in, err := generate.NewInput(
+						strings.ToLower(test.name),
+						"https://127.0.0.1/",
+						test.kubernetesVersion,
+						generate.WithVersionContract(vc),
+					)
+					require.NoError(t, err)
+
+					cfg, err := in.Config(machine.TypeControlPlane)
+					require.NoError(t, err)
+
+					bytesPatch, err := test.patch(vc)
+					require.NoError(t, err)
+
+					patch, err := configpatcher.LoadPatch(bytesPatch)
+					require.NoError(t, err)
+
+					patched, err := configpatcher.Apply(configpatcher.WithConfig(cfg), []configpatcher.Patch{patch})
+					require.NoError(t, err)
+
+					patchedCfg, err := patched.Config()
+					require.NoError(t, err)
+
+					_, err = patchedCfg.Validate(mockValidationMode{}, validation.WithLocal())
+					require.NoError(t, err)
+
+					test.assertion(t, patchedCfg)
+				})
+			}
+		})
+	}
+}
+
+type mockValidationMode struct{}
+
+func (mockValidationMode) String() string {
+	return "mock"
+}
+
+func (mockValidationMode) RequiresInstall() bool {
+	return false
+}
+
+func (mockValidationMode) InContainer() bool {
+	return false
+}
