Merge pull request kubernetes-sigs#6927 from ykakarap/rename-clonetemplate

🌱 rename CloneTemplate to CreateFromTemplate

Author: k8s-ci-robot

controllers/external/util.go

@@ -60,6 +60,7 @@ func Delete(ctx context.Context, c client.Writer, ref *corev1.ObjectReference) e
 }
 
 // CloneTemplateInput is the input to CloneTemplate.
+// Deprecated: use CreateFromTemplateInput instead. This type will be removed in a future release.
 type CloneTemplateInput struct {
 	// Client is the controller runtime client.
 	Client client.Client
@@ -87,6 +88,7 @@ type CloneTemplateInput struct {
 }
 
 // CloneTemplate uses the client and the reference to create a new object from the template.
+// Deprecated: use CreateFromTemplate instead. This function will be removed in a future release.
 func CloneTemplate(ctx context.Context, in *CloneTemplateInput) (*corev1.ObjectReference, error) {
 	from, err := Get(ctx, in.Client, in.TemplateRef, in.Namespace)
 	if err != nil {
@@ -114,6 +116,61 @@ func CloneTemplate(ctx context.Context, in *CloneTemplateInput) (*corev1.ObjectR
 	return GetObjectReference(to), nil
 }
 
+// CreateFromTemplateInput is the input to CreateFromTemplate.
+type CreateFromTemplateInput struct {
+	// Client is the controller runtime client.
+	Client client.Client
+
+	// TemplateRef is a reference to the template that needs to be cloned.
+	TemplateRef *corev1.ObjectReference
+
+	// Namespace is the Kubernetes namespace the cloned object should be created into.
+	Namespace string
+
+	// ClusterName is the cluster this object is linked to.
+	ClusterName string
+
+	// OwnerRef is an optional OwnerReference to attach to the cloned object.
+	// +optional
+	OwnerRef *metav1.OwnerReference
+
+	// Labels is an optional map of labels to be added to the object.
+	// +optional
+	Labels map[string]string
+
+	// Annotations is an optional map of annotations to be added to the object.
+	// +optional
+	Annotations map[string]string
+}
+
+// CreateFromTemplate uses the client and the reference to create a new object from the template.
+func CreateFromTemplate(ctx context.Context, in *CreateFromTemplateInput) (*corev1.ObjectReference, error) {
+	from, err := Get(ctx, in.Client, in.TemplateRef, in.Namespace)
+	if err != nil {
+		return nil, err
+	}
+	generateTemplateInput := &GenerateTemplateInput{
+		Template:    from,
+		TemplateRef: in.TemplateRef,
+		Namespace:   in.Namespace,
+		ClusterName: in.ClusterName,
+		OwnerRef:    in.OwnerRef,
+		Labels:      in.Labels,
+		Annotations: in.Annotations,
+	}
+	to, err := GenerateTemplate(generateTemplateInput)
+	if err != nil {
+		return nil, err
+	}
+
+	// Create the external clone.
+	if err := in.Client.Create(ctx, to); err != nil {
+		return nil, err
+	}
+
+	return GetObjectReference(to), nil
+}
+
 // GenerateTemplateInput is the input needed to generate a new template.
 type GenerateTemplateInput struct {
 	// Template is the TemplateRef turned into an unstructured.

controllers/external/util_test.go

@@ -97,7 +97,7 @@ func TestCloneTemplateResourceNotFound(t *testing.T) {
 	}
 
 	fakeClient := fake.NewClientBuilder().Build()
-	_, err := CloneTemplate(ctx, &CloneTemplateInput{
+	_, err := CreateFromTemplate(ctx, &CreateFromTemplateInput{
 		Client:      fakeClient,
 		TemplateRef: testResourceReference,
 		Namespace:   metav1.NamespaceDefault,
@@ -169,7 +169,7 @@ func TestCloneTemplateResourceFound(t *testing.T) {
 
 	fakeClient := fake.NewClientBuilder().WithObjects(template.DeepCopy()).Build()
 
-	ref, err := CloneTemplate(ctx, &CloneTemplateInput{
+	ref, err := CreateFromTemplate(ctx, &CreateFromTemplateInput{
 		Client:      fakeClient,
 		TemplateRef: templateRef.DeepCopy(),
 		Namespace:   metav1.NamespaceDefault,
@@ -261,7 +261,7 @@ func TestCloneTemplateResourceFoundNoOwner(t *testing.T) {
 
 	fakeClient := fake.NewClientBuilder().WithObjects(template.DeepCopy()).Build()
 
-	ref, err := CloneTemplate(ctx, &CloneTemplateInput{
+	ref, err := CreateFromTemplate(ctx, &CreateFromTemplateInput{
 		Client:      fakeClient,
 		TemplateRef: templateRef,
 		Namespace:   metav1.NamespaceDefault,
@@ -315,7 +315,7 @@ func TestCloneTemplateMissingSpecTemplate(t *testing.T) {
 
 	fakeClient := fake.NewClientBuilder().WithObjects(template.DeepCopy()).Build()
 
-	_, err := CloneTemplate(ctx, &CloneTemplateInput{
+	_, err := CreateFromTemplate(ctx, &CreateFromTemplateInput{
 		Client:      fakeClient,
 		TemplateRef: templateRef,
 		Namespace:   metav1.NamespaceDefault,

controlplane/kubeadm/internal/controllers/helpers.go

@@ -167,7 +167,7 @@ func (r *KubeadmControlPlaneReconciler) cloneConfigsAndGenerateMachine(ctx conte
 	}
 
 	// Clone the infrastructure template
-	infraRef, err := external.CloneTemplate(ctx, &external.CloneTemplateInput{
+	infraRef, err := external.CreateFromTemplate(ctx, &external.CreateFromTemplateInput{
 		Client:      r.Client,
 		TemplateRef: &kcp.Spec.MachineTemplate.InfrastructureRef,
 		Namespace:   kcp.Namespace,

docs/book/src/developer/providers/v1.2-to-v1.3.md

@@ -18,7 +18,7 @@ in Cluster API are kept in sync with the versions used by `sigs.k8s.io/controlle
 
 ### Deprecation
 
--
+- `sigs.k8s.io/cluster-api/controllers/external.CloneTemplate` has been deprecated and will be removed in a future release. Please use `sigs.k8s.io/cluster-api/controllers/external.CreateFromTemplate` instead.
 
 ### Removals
 

internal/controllers/machineset/machineset_controller.go

@@ -378,7 +378,7 @@ func (r *Reconciler) syncReplicas(ctx context.Context, ms *clusterv1.MachineSet,
 			)
 
 			if machine.Spec.Bootstrap.ConfigRef != nil {
-				bootstrapRef, err = external.CloneTemplate(ctx, &external.CloneTemplateInput{
+				bootstrapRef, err = external.CreateFromTemplate(ctx, &external.CreateFromTemplateInput{
 					Client:      r.Client,
 					TemplateRef: machine.Spec.Bootstrap.ConfigRef,
 					Namespace:   machine.Namespace,
@@ -399,7 +399,7 @@ func (r *Reconciler) syncReplicas(ctx context.Context, ms *clusterv1.MachineSet,
 				machine.Spec.Bootstrap.ConfigRef = bootstrapRef
 			}
 
-			infraRef, err = external.CloneTemplate(ctx, &external.CloneTemplateInput{
+			infraRef, err = external.CreateFromTemplate(ctx, &external.CreateFromTemplateInput{
 				Client:      r.Client,
 				TemplateRef: &machine.Spec.InfrastructureRef,
 				Namespace:   machine.Namespace,