Merge pull request #536 from openshift-assisted/post-discovery-ign

Add post discovery custom ignition

Author: openshift-merge-bot[bot]

bootstrap/api/v1alpha1/openshiftassistedconfig_types.go

@@ -23,7 +23,14 @@ import (
 	clusterv1beta1 "sigs.k8s.io/cluster-api/api/core/v1beta1"
 )
 
-const DiscoveryIgnitionOverrideAnnotation = "openshiftassistedconfig.cluster.x-k8s.io/discovery-ignition-override"
+const (
+	// DiscoveryIgnitionOverrideAnnotation is the annotation key for a JSON ignition config
+	// applied to the discovery ignition (pre-install boot).
+	DiscoveryIgnitionOverrideAnnotation = "openshiftassistedconfig.cluster.x-k8s.io/discovery-ignition-override"
+	// IgnitionOverrideAnnotation is the annotation key for a JSON ignition config (v3.1.0)
+	// to merge into host.IgnitionConfigOverrides (install-time / post-discovery ignition).
+	IgnitionOverrideAnnotation = "openshiftassistedconfig.cluster.x-k8s.io/ignition-override"
+)
 
 // OpenshiftAssistedConfigSpec defines the desired state of OpenshiftAssistedConfig
 type OpenshiftAssistedConfigSpec struct {

bootstrap/api/v1alpha2/openshiftassistedconfig_types.go

@@ -23,7 +23,14 @@ import (
 	clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
 )
 
-const DiscoveryIgnitionOverrideAnnotation = "openshiftassistedconfig.cluster.x-k8s.io/discovery-ignition-override"
+const (
+	// DiscoveryIgnitionOverrideAnnotation is the annotation key for a JSON ignition config
+	// applied to the discovery ignition (pre-install boot).
+	DiscoveryIgnitionOverrideAnnotation = "openshiftassistedconfig.cluster.x-k8s.io/discovery-ignition-override"
+	// IgnitionOverrideAnnotation is the annotation key for a JSON ignition config (v3.1.0)
+	// to merge into host.IgnitionConfigOverrides (install-time / post-discovery ignition).
+	IgnitionOverrideAnnotation = "openshiftassistedconfig.cluster.x-k8s.io/ignition-override"
+)
 
 // OpenshiftAssistedConfigSpec defines the desired state of OpenshiftAssistedConfig
 type OpenshiftAssistedConfigSpec struct {

bootstrap/internal/controller/agent_controller.go

@@ -138,6 +138,9 @@ func (r *AgentReconciler) canApproveAgent(ctx context.Context, agent *aiv1beta1.
 	return true, nil
 }
 
+// getIgnitionConfig builds the install-time (post-discovery) ignition config for the agent:
+// node registration (hostname, kubelet labels, provider ID) plus any override from the
+// openshiftassistedconfig.cluster.x-k8s.io/ignition-override annotation.
 func getIgnitionConfig(config *bootstrapv1alpha2.OpenshiftAssistedConfig) (string, error) {
 	dynamic, static, err := parseLabels(config.Spec.NodeRegistration.KubeletExtraLabels)
 	if err != nil {
@@ -198,7 +201,19 @@ fi
 	opts := ignition.IgnitionOptions{
 		NodeNameEnvVar: config.Spec.NodeRegistration.Name,
 	}
-	return ignition.GetIgnitionConfigOverrides(opts, kubeletCustomLabels)
+	baseIgnition, err := ignition.GetIgnitionConfigOverrides(opts, kubeletCustomLabels)
+	if err != nil {
+		return "", err
+	}
+	// Merge in install-time ignition override from annotation (openshiftassistedconfig.cluster.x-k8s.io/ignition-override)
+	if override, ok := config.GetAnnotations()[bootstrapv1alpha2.IgnitionOverrideAnnotation]; ok && override != "" && json.Valid([]byte(override)) {
+		merged, mergeErr := ignition.MergeIgnitionConfigStrings(baseIgnition, override)
+		if mergeErr != nil {
+			return "", fmt.Errorf("invalid %s annotation: %w", bootstrapv1alpha2.IgnitionOverrideAnnotation, mergeErr)
+		}
+		return merged, nil
+	}
+	return baseIgnition, nil
 }
 
 // parseEnvVarRef parses a value that may be an environment variable reference.

bootstrap/internal/controller/agent_controller_test.go

@@ -473,6 +473,70 @@ var _ = Describe("getIgnitionConfig", func() {
 			Entry("contains space", "$VAR NAME"),
 		)
 
+		Context("ignition-override annotation", func() {
+			const validOverride = `{"ignition":{"version":"3.1.0"},"storage":{"files":[{"path":"/etc/override-file","contents":{"source":"data:,"},"mode":384}]}}`
+
+			It("should merge valid ignition-override annotation into host ignition", func() {
+				config := &bootstrapv1alpha2.OpenshiftAssistedConfig{
+					ObjectMeta: metav1.ObjectMeta{
+						Annotations: map[string]string{
+							bootstrapv1alpha2.IgnitionOverrideAnnotation: validOverride,
+						},
+					},
+					Spec: bootstrapv1alpha2.OpenshiftAssistedConfigSpec{
+						NodeRegistration: bootstrapv1alpha2.NodeRegistrationOptions{
+							KubeletExtraLabels: []string{"zone=east"},
+						},
+					},
+				}
+
+				ignitionJSON, err := getIgnitionConfig(config)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(ignitionJSON).To(ContainSubstring(`/etc/override-file`))
+				Expect(ignitionJSON).To(ContainSubstring(`kubelet_custom_labels`))
+			})
+
+			It("should ignore annotation when value is not valid JSON", func() {
+				config := &bootstrapv1alpha2.OpenshiftAssistedConfig{
+					ObjectMeta: metav1.ObjectMeta{
+						Annotations: map[string]string{
+							bootstrapv1alpha2.IgnitionOverrideAnnotation: `not-json`,
+						},
+					},
+					Spec: bootstrapv1alpha2.OpenshiftAssistedConfigSpec{
+						NodeRegistration: bootstrapv1alpha2.NodeRegistrationOptions{
+							KubeletExtraLabels: []string{"zone=east"},
+						},
+					},
+				}
+
+				ignitionJSON, err := getIgnitionConfig(config)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(ignitionJSON).NotTo(ContainSubstring(`/etc/override-file`))
+				Expect(ignitionJSON).To(ContainSubstring(`kubelet_custom_labels`))
+			})
+
+			It("should return error when annotation is valid JSON but invalid ignition", func() {
+				config := &bootstrapv1alpha2.OpenshiftAssistedConfig{
+					ObjectMeta: metav1.ObjectMeta{
+						Annotations: map[string]string{
+							// Unknown ignition version so parse fails
+							bootstrapv1alpha2.IgnitionOverrideAnnotation: `{"ignition":{"version":"99.0.0"}}`,
+						},
+					},
+					Spec: bootstrapv1alpha2.OpenshiftAssistedConfigSpec{
+						NodeRegistration: bootstrapv1alpha2.NodeRegistrationOptions{
+							KubeletExtraLabels: []string{"zone=east"},
+						},
+					},
+				}
+
+				_, err := getIgnitionConfig(config)
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).To(ContainSubstring(bootstrapv1alpha2.IgnitionOverrideAnnotation))
+			})
+		})
+
 		Context("ProviderID", func() {
 			It("should write KUBELET_PROVIDERID with static value", func() {
 				config := &bootstrapv1alpha2.OpenshiftAssistedConfig{

bootstrap/internal/ignition/ignition.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"strings"
 
+	"github.com/coreos/ignition/v2/config/v3_1"
 	config_types "github.com/coreos/ignition/v2/config/v3_1/types"
 	"github.com/go-logr/logr"
 	logutil "github.com/openshift-assisted/cluster-api-provider-openshift-assisted/util/log"
@@ -225,3 +226,28 @@ func CreateIgnitionFile(path, user, content string, mode int, overwrite bool) co
 		},
 	}
 }
+
+// MergeIgnitionConfigStrings merges overrideIgnition into baseIgnition.
+// Both arguments must be valid Ignition config JSON (e.g. v3.1.0). The result is base plus
+// override merged: the override appends or overrides fields per Ignition merge semantics.
+// Returns the merged config as a JSON string. If overrideIgnition is empty, baseIgnition
+// is returned unchanged.
+func MergeIgnitionConfigStrings(baseIgnition, overrideIgnition string) (string, error) {
+	if overrideIgnition == "" {
+		return baseIgnition, nil
+	}
+	baseConfig, _, err := v3_1.ParseCompatibleVersion([]byte(baseIgnition))
+	if err != nil {
+		return "", err
+	}
+	overrideConfig, _, err := v3_1.ParseCompatibleVersion([]byte(overrideIgnition))
+	if err != nil {
+		return "", err
+	}
+	merged := v3_1.Merge(baseConfig, overrideConfig)
+	out, err := json.Marshal(merged)
+	if err != nil {
+		return "", err
+	}
+	return string(out), nil
+}

bootstrap/internal/ignition/ignition_test.go

@@ -110,4 +110,23 @@ var _ = Describe("Ignition utils", func() {
 			Expect(foundHostnameScript).To(BeTrue(), "set_hostname script should be present with ${VAR} notation")
 		})
 	})
+
+	When("merging ignition configs", func() {
+		const base = `{"ignition":{"version":"3.1.0"},"storage":{"files":[{"path":"/base","contents":{"source":"data:,"},"mode":384}]}}`
+		const override = `{"ignition":{"version":"3.1.0"},"storage":{"files":[{"path":"/override","contents":{"source":"data:,"},"mode":384}]}}`
+
+		It("MergeIgnitionConfigStrings merges override into base", func() {
+			merged, err := MergeIgnitionConfigStrings(base, override)
+			Expect(err).NotTo(HaveOccurred())
+			cfg, _, err := config_31.Parse([]byte(merged))
+			Expect(err).NotTo(HaveOccurred())
+			Expect(cfg.Storage.Files).To(HaveLen(2))
+		})
+
+		It("MergeIgnitionConfigStrings returns base when override is empty", func() {
+			merged, err := MergeIgnitionConfigStrings(base, "")
+			Expect(err).NotTo(HaveOccurred())
+			Expect(merged).To(Equal(base))
+		})
+	})
 })