fix: use registry instead of repository

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
-	KubernetesImageRepository *KubernetesImageRepository `json:"kubernetesImageRepository,omitempty"`
+	KubernetesImageRegistry *KubernetesImageRegistry `json:"kubernetesImageRegistry,omitempty"`
 
 	// +optional
 	Proxy *HTTPProxy `json:"proxy,omitempty"`
@@ -41,7 +41,7 @@ func (ClusterConfigSpec) VariableSchema() clusterv1.VariableSchema {
 			Description: "Cluster configuration",
 			Type:        "object",
 			Properties: map[string]clusterv1.JSONSchemaProps{
-				"kubernetesImageRepository": KubernetesImageRepository(
+				"kubernetesImageRegistry": KubernetesImageRegistry(
 					"",
 				).VariableSchema().
 					OpenAPIV3Schema,
@@ -52,19 +52,19 @@ func (ClusterConfigSpec) VariableSchema() clusterv1.VariableSchema {
 	}
 }
 
-// KubernetesImageRepository required for overriding Kubernetes image repository.
-type KubernetesImageRepository string
+// KubernetesImageRegistry required for overriding Kubernetes image registry.
+type KubernetesImageRegistry string
 
-func (KubernetesImageRepository) VariableSchema() clusterv1.VariableSchema {
+func (KubernetesImageRegistry) VariableSchema() clusterv1.VariableSchema {
 	return clusterv1.VariableSchema{
 		OpenAPIV3Schema: clusterv1.JSONSchemaProps{
-			Description: "Sets the Kubernetes imageRepository used for the KubeadmControlPlane.",
+			Description: "Sets the Kubernetes image registry used for the KubeadmControlPlane.",
 			Type:        "string",
 		},
 	}
 }
 
-func (v KubernetesImageRepository) String() string {
+func (v KubernetesImageRegistry) 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/kubernetesimagerepository"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/kubernetesimageregistry"
 	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/servicelbgc"
 )
 
@@ -126,8 +126,8 @@ func main() {
 
 		auditpolicy.NewPatch(),
 
-		kubernetesimagerepository.NewVariable(),
-		kubernetesimagerepository.NewPatch(kubernetesimagerepository.VariableName),
+		kubernetesimageregistry.NewVariable(),
+		kubernetesimageregistry.NewPatch(kubernetesimageregistry.VariableName),
 
 		clusterconfig.NewVariable(),
 		mutation.NewMetaGeneratePatchesHandler(
@@ -138,9 +138,9 @@ func main() {
 				extraapiservercertsans.VariableName,
 			),
 			auditpolicy.NewPatch(),
-			kubernetesimagerepository.NewPatch(
+			kubernetesimageregistry.NewPatch(
 				clusterconfig.VariableName,
-				kubernetesimagerepository.VariableName,
+				kubernetesimageregistry.VariableName,
 			),
 		),
 	)

cmd/main.go

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

docs/content/cluster-config.md

@@ -1,10 +1,10 @@
 ---
-title: "Kubernete Image Repository"
+title: "Kubernete Image Registry"
 ---
 
-Override the container image repository used when pulling Kubernetes images.
+Override the container image registry used when pulling Kubernetes images.
 
-To enable this handler set the `imagerepositorypatch` and `imagerepositoryvars` external patches on `ClusterClass`.
+To enable this handler set the `imageregistrypatch` and `imageregistryvars` external patches on `ClusterClass`.
 
 ```yaml
 apiVersion: cluster.x-k8s.io/v1beta1
@@ -13,13 +13,13 @@ metadata:
   name: <NAME>
 spec:
   patches:
-    - name: image-repository
+    - name: image-registry
       external:
-        generateExtension: "imagerepositorypatch.capi-runtime-extensions"
-        discoverVariablesExtension: "imagerepositoryvars.capi-runtime-extensions"
+        generateExtension: "imageregistrypatch.capi-runtime-extensions"
+        discoverVariablesExtension: "imageregistryvars.capi-runtime-extensions"
 ```
 
-On the cluster resource then specify desired Kubernetes image repository value:
+On the cluster resource then specify desired Kubernetes image registry value:
 
 ```yaml
 apiVersion: cluster.x-k8s.io/v1beta1
@@ -29,7 +29,7 @@ metadata:
 spec:
   topology:
     variables:
-      - name: kubernetesImageRepository
+      - name: kubernetesImageRegistry
         value: "my-registry.io/my-org/my-repo"
 ```
 

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

@@ -1,7 +1,7 @@
 // Copyright 2023 D2iQ, Inc. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package kubernetesimagerepository
+package kubernetesimageregistry
 
 import (
 	"context"
@@ -27,28 +27,28 @@ import (
 
 const (
 	// HandlerNamePatch is the name of the inject handler.
-	HandlerNamePatch = "ImageRepositoryPatch"
+	HandlerNamePatch = "ImageRegistryPatch"
 )
 
-type imageRepositoryPatchHandler struct {
+type imageRegistryPatchHandler struct {
 	decoder           runtime.Decoder
 	variableName      string
 	variableFieldPath []string
 }
 
 var (
-	_ handlers.Named           = &imageRepositoryPatchHandler{}
-	_ mutation.GeneratePatches = &imageRepositoryPatchHandler{}
+	_ handlers.Named           = &imageRegistryPatchHandler{}
+	_ mutation.GeneratePatches = &imageRegistryPatchHandler{}
 )
 
 func NewPatch(
 	variableName string,
 	variableFieldPath ...string,
-) *imageRepositoryPatchHandler {
+) *imageRegistryPatchHandler {
 	scheme := runtime.NewScheme()
 	_ = bootstrapv1.AddToScheme(scheme)
 	_ = controlplanev1.AddToScheme(scheme)
-	return &imageRepositoryPatchHandler{
+	return &imageRegistryPatchHandler{
 		decoder: serializer.NewCodecFactory(scheme).UniversalDecoder(
 			controlplanev1.GroupVersion,
 			bootstrapv1.GroupVersion,
@@ -58,11 +58,11 @@ func NewPatch(
 	}
 }
 
-func (h *imageRepositoryPatchHandler) Name() string {
+func (h *imageRegistryPatchHandler) Name() string {
 	return HandlerNamePatch
 }
 
-func (h *imageRepositoryPatchHandler) GeneratePatches(
+func (h *imageRegistryPatchHandler) GeneratePatches(
 	ctx context.Context,
 	req *runtimehooksv1.GeneratePatchesRequest,
 	resp *runtimehooksv1.GeneratePatchesResponse,
@@ -82,7 +82,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
 				"holderRef", holderRef,
 			)
 
-			imageRepositoryVar, found, err := variables.Get[v1alpha1.KubernetesImageRepository](
+			imageRegistryVar, found, err := variables.Get[v1alpha1.KubernetesImageRegistry](
 				vars,
 				h.variableName,
 				h.variableFieldPath...,
@@ -91,7 +91,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
 				return err
 			}
 			if !found {
-				log.V(5).Info("kubernetesImageRepository variable not defined")
+				log.V(5).Info("kubernetesImageRegistry variable not defined")
 				return nil
 			}
 
@@ -101,7 +101,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
 				"variableFieldPath",
 				h.variableFieldPath,
 				"variableValue",
-				imageRepositoryVar,
+				imageRegistryVar,
 			)
 
 			return patches.Generate(
@@ -110,12 +110,12 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
 					log.WithValues(
 						"patchedObjectKind", obj.GetObjectKind().GroupVersionKind().String(),
 						"patchedObjectName", client.ObjectKeyFromObject(obj),
-					).Info("setting kubernetesImageRepository in kubeadm config spec")
+					).Info("setting imageRepository in kubeadm config spec")
 
 					if obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration == nil {
 						obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration = &bootstrapv1.ClusterConfiguration{}
 					}
-					obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration.ImageRepository = imageRepositoryVar.String()
+					obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration.ImageRepository = imageRegistryVar.String()
 
 					return nil
 				},

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

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

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

@@ -1,7 +1,7 @@
 // Copyright 2023 D2iQ, Inc. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package kubernetesimagerepository
+package kubernetesimageregistry
 
 import (
 	"context"
@@ -15,37 +15,37 @@ import (
 )
 
 var (
-	_ handlers.Named             = &imageRepositoryVariableHandler{}
-	_ mutation.DiscoverVariables = &imageRepositoryVariableHandler{}
+	_ handlers.Named             = &imageRegistryVariableHandler{}
+	_ mutation.DiscoverVariables = &imageRegistryVariableHandler{}
 )
 
 const (
 	// VariableName is http proxy external patch variable name.
-	VariableName = "kubernetesImageRepository"
+	VariableName = "kubernetesImageRegistry"
 
 	// HandlerNameVariable is the name of the variable handler.
-	HandlerNameVariable = "ImageRepositoryVars"
+	HandlerNameVariable = "ImageRegistryVars"
 )
 
-func NewVariable() *imageRepositoryVariableHandler {
-	return &imageRepositoryVariableHandler{}
+func NewVariable() *imageRegistryVariableHandler {
+	return &imageRegistryVariableHandler{}
 }
 
-type imageRepositoryVariableHandler struct{}
+type imageRegistryVariableHandler struct{}
 
-func (h *imageRepositoryVariableHandler) Name() string {
+func (h *imageRegistryVariableHandler) Name() string {
 	return HandlerNameVariable
 }
 
-func (h *imageRepositoryVariableHandler) DiscoverVariables(
+func (h *imageRegistryVariableHandler) DiscoverVariables(
 	ctx context.Context,
 	_ *runtimehooksv1.DiscoverVariablesRequest,
 	resp *runtimehooksv1.DiscoverVariablesResponse,
 ) {
 	resp.Variables = append(resp.Variables, clusterv1.ClusterClassVariable{
 		Name:     VariableName,
 		Required: false,
-		Schema:   v1alpha1.KubernetesImageRepository("").VariableSchema(),
+		Schema:   v1alpha1.KubernetesImageRegistry("").VariableSchema(),
 	})
 	resp.SetStatus(runtimehooksv1.ResponseStatusSuccess)
 }

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

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