fixup! feat: new imageRepository patch

Author: dkoshkin

api/v1alpha1/clusterconfig_types.go

@@ -26,7 +26,7 @@ type ClusterConfigSpec struct {
 	// Important: Run "make" to regenerate code after modifying this file
 
 	// +optional
-	ImageRepository *ImageRepository `json:"imageRepository,omitempty"`
+	KubernetesImageRepository *KubernetesImageRepository `json:"kubernetesImageRepository,omitempty"`
 
 	// +optional
 	Proxy *HTTPProxy `json:"proxy,omitempty"`
@@ -41,27 +41,30 @@ func (ClusterConfigSpec) VariableSchema() clusterv1.VariableSchema {
 			Description: "Cluster configuration",
 			Type:        "object",
 			Properties: map[string]clusterv1.JSONSchemaProps{
-				"imageRepository":        ImageRepository("").VariableSchema().OpenAPIV3Schema,
+				"kubernetesImageRepository": KubernetesImageRepository(
+					"",
+				).VariableSchema().
+					OpenAPIV3Schema,
 				"proxy":                  HTTPProxy{}.VariableSchema().OpenAPIV3Schema,
 				"extraAPIServerCertSANs": ExtraAPIServerCertSANs{}.VariableSchema().OpenAPIV3Schema,
 			},
 		},
 	}
 }
 
-// ImageRepository required for overriding Kubernetes image repository.
-type ImageRepository string
+// KubernetesImageRepository required for overriding Kubernetes image repository.
+type KubernetesImageRepository string
 
-func (ImageRepository) VariableSchema() clusterv1.VariableSchema {
+func (KubernetesImageRepository) VariableSchema() clusterv1.VariableSchema {
 	return clusterv1.VariableSchema{
 		OpenAPIV3Schema: clusterv1.JSONSchemaProps{
-			Description: "Sets the imageRepository used for the KubeadmControlPlane.",
+			Description: "Sets the Kubernetes imageRepository used for the KubeadmControlPlane.",
 			Type:        "string",
 		},
 	}
 }
 
-func (v ImageRepository) String() string {
+func (v KubernetesImageRepository) String() string {
 	return string(v)
 }
 

api/v1alpha1/zz_generated.deepcopy.go

@@ -31,7 +31,7 @@ import (
 	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/cni/calico"
 	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/extraapiservercertsans"
 	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/httpproxy"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/imagerepository"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/kubernetesimagerepository"
 	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/servicelbgc"
 )
 
@@ -126,8 +126,8 @@ func main() {
 
 		auditpolicy.NewPatch(),
 
-		imagerepository.NewVariable(),
-		imagerepository.NewPatch(imagerepository.VariableName),
+		kubernetesimagerepository.NewVariable(),
+		kubernetesimagerepository.NewPatch(kubernetesimagerepository.VariableName),
 
 		clusterconfig.NewVariable(),
 		mutation.NewMetaGeneratePatchesHandler(
@@ -138,7 +138,10 @@ func main() {
 				extraapiservercertsans.VariableName,
 			),
 			auditpolicy.NewPatch(),
-			imagerepository.NewPatch(clusterconfig.VariableName, imagerepository.VariableName),
+			kubernetesimagerepository.NewPatch(
+				clusterconfig.VariableName,
+				kubernetesimagerepository.VariableName,
+			),
 		),
 	)
 	if err := mgr.Add(runtimeWebhookServer); err != nil {

cmd/main.go

@@ -35,7 +35,7 @@ spec:
     variables:
       - name: clusterConfig
         value:
-          imageRepository: "my-registry.io/my-org/my-repo"
+          kubernetesImageRepository: "my-registry.io/my-org/my-repo"
           extraAPIServerCertSANs:
             - a.b.c.example.com
             - d.e.f.example.com

docs/content/cluster-config.md

@@ -1,5 +1,5 @@
 ---
-title: "Image Repository"
+title: "Kubernete Image Repository"
 ---
 
 Override the container image repository used when pulling Kubernetes images.
@@ -19,7 +19,7 @@ spec:
         discoverVariablesExtension: "imagerepositoryvars.capi-runtime-extensions"
 ```
 
-On the cluster resource then specify desired image repository value:
+On the cluster resource then specify desired Kubernetes image repository value:
 
 ```yaml
 apiVersion: cluster.x-k8s.io/v1beta1
@@ -29,7 +29,7 @@ metadata:
 spec:
   topology:
     variables:
-      - name: imageRepository
+      - name: kubernetesImageRepository
         value: "my-registry.io/my-org/my-repo"
 ```
 

docs/content/image-repository.md renamed to docs/content/kubernetes-image-repository.md

@@ -1,7 +1,7 @@
 // Copyright 2023 D2iQ, Inc. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package imagerepository
+package kubernetesimagerepository
 
 import (
 	"context"
@@ -82,7 +82,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
 				"holderRef", holderRef,
 			)
 
-			imageRepositoryVar, found, err := variables.Get[v1alpha1.ImageRepository](
+			imageRepositoryVar, found, err := variables.Get[v1alpha1.KubernetesImageRepository](
 				vars,
 				h.variableName,
 				h.variableFieldPath...,
@@ -91,7 +91,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
 				return err
 			}
 			if !found {
-				log.V(5).Info("imageRepository variable not defined")
+				log.V(5).Info("kubernetesImageRepository variable not defined")
 				return nil
 			}
 
@@ -110,7 +110,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
 					log.WithValues(
 						"patchedObjectKind", obj.GetObjectKind().GroupVersionKind().String(),
 						"patchedObjectName", client.ObjectKeyFromObject(obj),
-					).Info("setting imageRepository in kubeadm config spec")
+					).Info("setting kubernetesImageRepository in kubeadm config spec")
 
 					if obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration == nil {
 						obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration = &bootstrapv1.ClusterConfiguration{}

pkg/handlers/imagerepository/inject.go renamed to pkg/handlers/kubernetesimagerepository/inject.go

@@ -1,7 +1,7 @@
 // Copyright 2023 D2iQ, Inc. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package imagerepository
+package kubernetesimagerepository
 
 import (
 	"testing"
@@ -22,11 +22,11 @@ func TestGeneratePatches(t *testing.T) {
 			Name: "unset variable",
 		},
 		capitest.PatchTestDef{
-			Name: "imageRepository set",
+			Name: "kubernetesImageRepository set",
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
 					VariableName,
-					v1alpha1.ImageRepository("my-registry.io/my-org/my-repo"),
+					v1alpha1.KubernetesImageRepository("my-registry.io/my-org/my-repo"),
 				),
 			},
 			RequestItem: capitest.NewKubeadmControlPlaneTemplateRequestItem(),

pkg/handlers/imagerepository/inject_test.go renamed to pkg/handlers/kubernetesimagerepository/inject_test.go

@@ -1,7 +1,7 @@
 // Copyright 2023 D2iQ, Inc. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package imagerepository
+package kubernetesimagerepository
 
 import (
 	"context"
@@ -21,7 +21,7 @@ var (
 
 const (
 	// VariableName is http proxy external patch variable name.
-	VariableName = "imageRepository"
+	VariableName = "kubernetesImageRepository"
 
 	// HandlerNameVariable is the name of the variable handler.
 	HandlerNameVariable = "ImageRepositoryVars"
@@ -45,7 +45,7 @@ func (h *imageRepositoryVariableHandler) DiscoverVariables(
 	resp.Variables = append(resp.Variables, clusterv1.ClusterClassVariable{
 		Name:     VariableName,
 		Required: false,
-		Schema:   v1alpha1.ImageRepository("").VariableSchema(),
+		Schema:   v1alpha1.KubernetesImageRepository("").VariableSchema(),
 	})
 	resp.SetStatus(runtimehooksv1.ResponseStatusSuccess)
 }

pkg/handlers/imagerepository/variables.go renamed to pkg/handlers/kubernetesimagerepository/variables.go

@@ -1,7 +1,7 @@
 // Copyright 2023 D2iQ, Inc. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package imagerepository
+package kubernetesimagerepository
 
 import (
 	"testing"
@@ -16,7 +16,7 @@ func TestVariableValidation(t *testing.T) {
 	capitest.ValidateDiscoverVariables(
 		t,
 		VariableName,
-		ptr.To(v1alpha1.ImageRepository("").VariableSchema()),
+		ptr.To(v1alpha1.KubernetesImageRepository("").VariableSchema()),
 		NewVariable,
 		capitest.VariableTestDef{
 			Name: "set",